API 集成
用于提示词分析与优化的 HTTP API
把提示词分析与优化直接集成到你的应用中。无状态的 JSON 接口,无需密钥,不存储任何内容,并且与 PromptFlowEngine 的所有其他产品使用同一个引擎。
- 已上线
- 无需 API 密钥
- 每分钟 60 次请求
功能介绍
HTTP API 在 https://promptflowengine.com/api/v1 提供引擎服务。你发送 JSON,就会收到 JSON。无需注册,也无需密钥,因为 API 不保存任何用户数据:每个响应都根据请求体计算得出,随后即被丢弃。
接口覆盖整个引擎:analyze、validate、optimize、restructure、compare、tokens、scan 和 sanitize,另外还有只读的规则目录和模型目录。OpenAI 模型的 token 数是精确的。
API 对每个客户端的限制为每分钟 60 次 POST 请求。对于批量任务或敏感文本,请用 CLI 在本地运行同一个引擎,既不联网也没有限制。
实际示例
一次请求
一次对 analyze 接口的调用。所示的响应值由引擎在构建本页面时针对请求中的提示词计算得出。 引擎的检查结果和生成的提示词以英文显示,与引擎和 API 返回的内容完全一致。
curl -s https://promptflowengine.com/api/v1/analyze \
-H 'content-type: application/json' \
-d '{"prompt":"Write something about our product.","model":"gpt-4.1"}'{
"quality": {
"overall": 84,
"grade": "good"
},
"tokens": {
"tokens": 6,
"method": "exact"
},
"findings": [
{
"code": "vague_language",
"severity": "warning"
},
{
"code": "missing_output_format",
"severity": "info"
},
{
"code": "missing_length_guidance",
"severity": "info"
}
]
}由引擎在构建本页面时计算得出。 完整响应还包括每个问题的消息、解释和修复建议,以及安全与需求的详细信息。
主要优势
无需任何准备
没有账号、密钥轮换或计费。CORS 开放,浏览器可以直接调用。
无状态
提示词文本在内存中处理,从不存储或记录日志。
带类型的错误
统一的错误结构,包含类型、消息和请求 ID。
与本地结果一致
API 运行的引擎版本与工作区和 CLI 相同。
功能
POST /analyze
问题、质量、token、安全、需求和意图。
POST /optimize
选中的候选、带验证结果的全部候选、修改内容和差异。
POST /restructure
分节的提示词,每一行都标注为你的原文或新增的指导。
POST /compare
两个提示词之间的 token、成本和质量差异。
POST /scan 与 /sanitize
注入风险和敏感数据位置,以及脱敏后的文本。
GET /rules 与 /models
带扣分规则的规则目录,以及带参考价格的模型列表。
适用人群
- 应用开发者只需一次 HTTP 调用,就能为后端、表单或内部工具加上提示词检查。
- 自动化与无代码构建者无需安装任何东西,即可从工作流工具或脚本中调用。
- 正在做原型的团队先用 curl 试用引擎,再决定是否嵌入软件包。
使用场景
- 01
验证用户编写的提示词
检查用户在你的产品中保存的提示词,并向他们展示检查结果。
- 02
在流水线中预检
在任务把文本发送给模型服务商之前,先扫描其中的密钥。
- 03
在界面中估算 token
在提示词编辑器旁显示精确的 token 数和预估成本。
- 04
服务端重构
在调用模型之前,把用户简短的请求转换为结构化提示词。
常见问题
我需要 API 密钥吗?
不需要。API 不接受任何密钥、token 或 Cookie。滥用通过每个客户端 IP 每分钟 60 次 POST 请求的速率限制来控制。
我的提示词会被存储或记录吗?
不会。请求在内存中处理。日志只记录路由、状态、耗时和大小区间,从不记录提示词文本或结果。
我可以从浏览器调用 API 吗?
可以。CORS 在不带凭据的情况下开放,因此前端代码可以直接调用。
大小限制是多少?
请求体最大 256 KB,每个文本字段最多 100,000 个字符。
PromptFlowEngine 的相关功能
所有产品都运行同一个引擎,组合使用时不会出现意外差异。
了解背后的技巧
来自提示词工程知识中心的指南,讲解本产品所运用的理念。