云舟 · 接入文档

01准备账户与密钥

在客户控制台登录，首次登录自动创建零余额账户。充值确认入账后，前往「API 密钥」创建密钥，立即复制保存。

进入客户控制台

02配置 API 地址

将下面的地址作为应用的 Base URL：

https://your-relay-domain/v1

通过 Authorization: Bearer YOUR_RELAY_API_KEY 传入你自己的 API Key。模型名称须使用「模型与价格」中显示的模型别名。公开站点的 API 不需要 ChatGPT 浏览器登录 Cookie。

03发起文本对话

cURL · 文本对话

curl 'https://your-relay-domain/v1/chat/completions' \
  -H 'Authorization: Bearer YOUR_RELAY_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "your-model-alias",
    "messages": [{"role": "user", "content": "你好！"}],
    "stream": false,
    "max_tokens": 1024
  }'

也可以发送 GET https://your-relay-domain/v1/models，携带相同 Bearer 密钥获取当前可用模型列表。

计费与余额

费用按上游返回的实际输入 / 输出 Token 用量及模型价格计算。请求前按文本体积与输出上限预授权，完成后退还未使用部分，失败请求退还预授权。余额不足时接口返回 HTTP 402。

充值申请仅登记待核对金额，不代表付款成功。请先与管理员确认收款方式；管理员核实实际收款并入账后，余额才会增加。

当前支持范围

文本对话支持响应模式非流式（stream: false）输出上限1–8192 Token图片 / 音频 / 工具调用暂不支持

常见状态码：401 密钥无效或账户停用；402 余额不足；404 模型不可用；429 上游限流；502 上游请求或用量异常。请妥善保管密钥，不要把完整密钥写入公开代码。