Scenario API

场景 API 接入

读取当前场景配置后,会自动生成对应的接口地址和请求示例。

Knowledge Q&A

加载场景中…

正在请求场景的公开配置。

场景 ID
-
API Base -
场景信息接口
-

GET 请求,无需鉴权。返回场景名称、描述以及 ui_config,适合前端初始化页面时先请求。

流式问答接口
-

POST 请求,响应类型是 text/event-stream。必须带 Authorization: Bearer YOUR_SCENARIO_API_KEY。

公开问答页
-

联调时可直接打开真实问答页,验证场景模板、欢迎语和真实对话体验。

Flow

接入步骤

  1. 先在问答管理的 API 密钥 标签页里为当前场景创建一个密钥。
  2. 调用场景信息接口,拿到 name、description 和 ui_config 初始化页面。
  3. 再向流式问答接口发送 messages 数组;服务端会基于当前场景绑定的知识片段做检索增强。
  4. 流中会依次返回 token 和 citations,最后用 [DONE] 结束整个响应。
场景信息请求示例 GET

        
流式问答 curl 示例 POST

        
fetch 流式示例 JS

        
SSE 事件格式 STREAM