应用接口与密钥管理
功能概述
应用 API 供业务系统调用已发布的流程、对话编排或专家团。在应用工作区的 API 页签查看接口地址、示例与在线调试,在 密钥 页签签发限定调用范围的资源密钥。
前置条件
应用已保存、调试并发布,可从发布左侧 运行 核对线上效果。外部接入使用发布配置,草稿改动重新发布后才对接口生效。
1. 查看接口示例
打开 API 页签,选择需要的接口。以下示例使用 DOCS_咨询受理流程:
| 接口 | 使用方式 |
|---|---|
| /app/{id}/v1/chat/completions | 以 messages 提交问题,支持同步或流式对话 |
| /app/{id}/v1/execute | 直接提交开始节点定义的业务变量 |
| /app/{id}/v1/models | 获取当前应用的模型标识 |

页面展示 cURL、JavaScript 和 Python 示例,也提供在线调试。接入时保持地址、资源主键与请求配置一致。
本页截图取自本地部署,接口地址显示为 http://localhost:1888/api/blade-ai,路径中的数字为示例应用的主键。接入时以 API 页显示的地址和当前应用主键为准。
2. 签发资源密钥
进入 密钥 或点击 管理密钥,选择 签发密钥。填写用途名称和到期时间,确认当前工作区就是要授权的应用。


签发时保存一次性展示的明文;列表只显示前缀,无法从列表恢复完整密钥。修改名称或到期时间不会重新签发明文。
凭证用途
API 密钥与登录会话令牌用途不同。程序调用开放接口时使用 API 密钥;浏览器工作区使用登录身份与资源权限。
3. 调用原生执行接口
咨询流程的开始字段为 message,原生请求体直接使用该名称:
{
"message": "如何配置知识库的召回参数?",
"stream": false
}请求头设置 Authorization: Bearer <API_KEY> 和 Content-Type: application/json。核对返回状态、result 和节点执行信息;对话接口按 messages / choices 协议解析。
请求成功时返回 HTTP 200,result 包含结束节点定义的输出(示例流程为 result.answer),并附带各节点执行状态与 totalTokens;示例流程不调用模型,totalTokens 为 0。

设置 stream: true 时,原生接口返回 text/event-stream,每条 data 为 FlowExecuteResult;兼容对话接口返回 chat.completion.chunk。

模型列表接口返回 bladex@app_id:<应用主键> 形式的模型标识。兼容对话接口以该标识作为 model 参数,流式响应包含对话片段与节点进度。


密钥到期后,使用该密钥的请求返回 HTTP 401(请求未授权)。
4. 管理调用方
不同调用方分别签发密钥,名称写清用途,按使用周期设置有效期。到期或吊销后原密钥不能继续调用。更换调用凭证时,先在调用方验证新凭证,再处理旧凭证。
完整请求、流式协议与错误处理见 应用执行与流式对话 和 接口认证与密钥作用域。
