Skip to main content

使用 API 运行

当你想从自己的应用或服务调用提示词时,请使用公共调用端点。先在仪表板中创建提示词部署和变体,然后使用你的工作区 API 密钥调用该部署。

身份验证

有关如何创建和管理密钥,请参阅 API 密钥

端点

POST https://api.fetchhive.com/v1/prompt/invoke 在调用此端点之前,请先从提示词编辑器创建或更新提示词部署。请参阅 发布与版本管理 了解 UI 流程。

请求

使用以下请求结构: metadata 必须是扁平的且仅包含标量:字符串、数字、布尔值或 null。嵌套对象和数组会在运行启动之前返回验证错误。 此端点不接受顶层的 image_urls 或文档 attachments。如果已部署的提示词使用了图像 URL 消息部分,请在提示词编辑器中配置该图像 URL,或通过提示词内容中的 inputs 变量绑定它。对于运行时的图像/文档附件,请使用 POST /v1/agent/invoke 调用智能体。

基本示例

请将 YOUR_API_KEYYOUR_DEPLOYMENT_NAMEYOUR_VARIANT_NAMEinputs 对象替换为你的真实值。 metadata 用于你希望在日志中查看或过滤的审计字段,例如客户 ID、套餐名称、地区或实验名称。不要把提示词变量放在那里;提示词变量应放在 inputs 中。请参阅 调用元数据 获取示例和日志过滤详情。

响应

如果 streamingtrue,则 API 会返回 data: 事件流,而不是一个最终的 JSON 对象。如果提供商在流打开后失败,API 会在关闭流之前发送一个最终的 error 事件。

流式响应

你可以在流期间接收不同类型的事件。例如: 推理或思考事件:
响应事件:
最终用量事件:
错误事件:

非流式响应

如果 streamingfalse,API 返回单个 JSON 响应。提供商执行失败会返回 502 Bad Gatewayerror 消息。例如:

后续步骤