跳转到内容

对话补全 API

POST /v1/chat/completions 是核心调用端点,完全兼容 OpenAI Chat Completions API,可直接使用 OpenAI 官方 SDK。

Header
AuthorizationBearer <api-key>
Content-Typeapplication/json

API Key 获取与鉴权流程见 认证与调用

参数类型必填说明
modelstring模型 ID,如 gpt-4o,可用模型见 模型与定价
messagesarray消息数组,每项含 rolesystem/user/assistant/tool)与 content
max_tokensinteger最大生成 token 数
temperaturenumber采样温度
stoparray停止序列
frequency_penaltynumber频率惩罚
presence_penaltynumber存在惩罚
response_formatobjectJSON 模式,{"type":"json_object"}
seedinteger随机种子
toolsarrayFunction Calling 工具定义
tool_choicestring工具选择(auto / none / 工具名)
streamboolean是否流式,默认 false
{
"id": "chatcmpl-xxx",
"choices": [
{
"index": 0,
"message": { "role": "assistant", "content": "你好!" },
"finish_reason": "stop"
}
],
"usage": { "prompt_tokens": 10, "completion_tokens": 5, "total_tokens": 15 }
}

流式响应(stream: true)以 SSE 返回,每个片段为 data: <chunk>\n\n,以 data: [DONE] 结束。

状态码说明响应格式
200成功OpenAI 格式
400请求错误(协议校验失败)OpenAI 错误格式
401API Key 无效{"code":"UNAUTHORIZED","message":...}
403权限不足(应用未授权该渠道)或 IP 黑名单{"code":"ACCESS_DENIED","message":...}
429限流{"error":{"code":"RATE_LIMIT_EXCEEDED","message":...}}
500服务器错误ApiResponse 格式(INTERNAL_ERROR
502上游 Provider 错误ApiResponse 格式(code 为错误类型名,如 UPSTREAM_ERRORMODEL_NOT_FOUND
503熔断开启ApiResponse 格式(code 为 UPSTREAM_ERROR

错误格式详见 错误码与重试

Terminal window
curl https://{gateway-host}/v1/chat/completions \
-H "Authorization: Bearer sk-xxx" \
-H "Content-Type: application/json" \
-d '{"model":"gpt-4o","messages":[{"role":"user","content":"你好"}]}'
Terminal window
curl https://{gateway-host}/v1/chat/completions \
-H "Authorization: Bearer sk-xxx" \
-H "Content-Type: application/json" \
-d '{"model":"gpt-4o","messages":[{"role":"user","content":"讲个故事"}],"stream":true}'
Terminal window
curl https://{gateway-host}/v1/chat/completions \
-H "Authorization: Bearer sk-xxx" \
-H "Content-Type: application/json" \
-d '{
"model":"gpt-4o",
"messages":[{"role":"user","content":"北京天气如何?"}],
"tools":[{"type":"function","function":{"name":"get_weather","description":"获取天气","parameters":{"type":"object","properties":{"location":{"type":"string"}},"required":["location"]}}}],
"tool_choice":"auto"
}'