API调用接口配置文档

接口地址:https://shh.qyyidc.cn/openapi/v1/chat/stream

模型ID:pool

接口类型:SSE 流式输出对话接口

鉴权密钥:qy-******,完整密钥请前往官网申请获取

1、基础调用信息

项目 配置值
请求URL https://shh.qyyidc.cn/openapi/v1/chat/stream
请求方式 POST
Content‑Type application/json
响应类型 text/event‑stream(SSE流式)
模型标识 pool

2、请求头 Headers

Header字段 是否必填 说明
Authorization 是 格式:Bearer {qy‑密钥}
Content‑Type 是 application/json
Authorization: Bearer qy-******
Content-Type: application/json

3、请求体参数说明

参数名 类型 必填 说明
model string 是 固定填写:pool
messages array 是 对话消息数组,支持多轮对话
temperature float 否 随机性0‑1,推荐0.7,数值越高回答越发散
max_tokens int 否 最大输出Token数量,限制返回长度
stream boolean 是 流式开关,必须设置 true

messages子项结构

参数 类型 说明
role string 角色:system / user / assistant
content string 对话文本内容

4、完整请求JSON示例

{
    "model": "pool",
    "stream": true,
    "temperature": 0.7,
    "max_tokens": 1024,
    "messages": [
        {
            "role": "system",
            "content": "你是一名专业AI助手,回答简洁清晰"
        },
        {
            "role": "user",
            "content": "你好,介绍一下自己"
        }
    ]
}

5、SSE流式返回格式

接口为标准SSE流式输出,每行以 data: 开头;data: [DONE]代表流式传输结束。

data: {"id":"xxx","object":"chat.completion.chunk","created":1752000000,"model":"pool","choices":[{"delta":{"content":"你好"},"index":0,"finish_reason":null}]}

data: {"id":"xxx","object":"chat.completion.chunk","created":1752000000,"model":"pool","choices":[{"delta":{"content":",我是AI助手"},"index":0,"finish_reason":null}]}

data: [DONE]
返回字段 说明
choices[0].delta.content 增量文本片段,前端需要不断拼接实现打字输出效果
finish_reason 结束标识,stop=正常结束

6、错误码对照表

HTTP状态码 说明
200 请求成功,开始流式输出
401 密钥错误、密钥不存在,请检查qy‑密钥
403 密钥被禁用 / 账户额度耗尽
400 请求参数格式错误,请校验JSON
429 请求频率超限,请稍后重试
⚠️重要提示:密钥以 qy‑ 开头,示例密钥仅作演示使用,请前往官网申请属于你自己的密钥,请勿泄露密钥给第三方。

7、Curl调用示例

curl --location --request POST 'https://shh.qyyidc.cn/openapi/v1/chat/stream' \
--header 'Authorization: Bearer qy-******' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model":"pool",
    "stream":true,
    "temperature":0.7,
    "max_tokens":1024,
    "messages":[
        {"role":"user","content":"你好"}
    ]
}'