开发文档

接入指南，5 分钟上手

完全兼容 OpenAI 协议，切换 base_url 即可迁移。

快速开始

调用接口前，请先在控制台创建 API Key。所有接口都兼容 OpenAI 协议，下面是各语言的调用示例。

接口地址（Base URL）：https://api.yourcompany.com/v1

bash

curl https://api.yourcompany.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $YOUR_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "你好"}]
  }'

鉴权方式

所有请求需在 Header 中携带 API Key 进行鉴权，格式如下：

http

Authorization: Bearer YOUR_API_KEY

安全提示

请勿将 API Key 暴露在前端代码或公开仓库中。建议通过后端服务转发请求。

对话补全

POST /v1/chat/completions 是核心接口，支持多轮对话、函数调用、JSON 模式等能力。

json

{
  "model": "gpt-4o",
  "messages": [
    { "role": "system", "content": "你是一个友好的助手。" },
    { "role": "user", "content": "用一句话介绍你自己。" }
  ],
  "temperature": 0.7,
  "max_tokens": 1024
}

流式输出

设置 stream: true 即可开启流式返回，逐字输出，显著降低首字延迟、提升用户体验。

python

# Python 流式输出示例
stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "讲一个笑话"}],
    stream=True,
)

for chunk in stream:
    delta = chunk.choices[0].delta.content
    if delta:
        print(delta, end="", flush=True)

错误码

常见错误码及处理建议如下：

状态码	说明	处理建议
400	请求格式错误	请求参数缺失或格式不正确，请检查请求体。
401	鉴权失败	API Key 无效或已过期，请前往控制台重新获取。
403	无权访问	当前账号无权调用该模型，请确认权限或升级套餐。
429	请求过多	触发限流，请降低请求频率或联系商务提升配额。
500	服务内部错误	服务端异常，请稍后重试；持续报错请联系技术支持。
503	服务不可用	对应模型暂时不可用，可尝试切换至备用模型。