Skip to content

调用 API

云枢支持 OpenAI 兼容接口、OpenAI Responses API 和 Anthropic Messages API。使用前请准备好访问令牌与控制台中的模型 ID。

接口地址

协议Base URL常用端点
OpenAI Compatiblehttps://yunshuapi.org/v1/chat/completions/models
OpenAI Responseshttps://yunshuapi.org/v1/responses
Anthropic Messageshttps://yunshuapi.org/v1/messages

填写客户端的 Base URL 时,请确认客户端是否会自动追加 /v1。最终请求地址不应出现 /v1/v1/...

查询可用模型

bash
curl https://yunshuapi.org/v1/models \
  -H "Authorization: Bearer sk-your-token"

Chat Completions

bash
curl https://yunshuapi.org/v1/chat/completions \
  -H "Authorization: Bearer sk-your-token" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-id",
    "messages": [
      { "role": "system", "content": "你是一个简洁的助手。" },
      { "role": "user", "content": "你好" }
    ]
  }'

Responses API

Codex 等工具使用 Responses API。调用前请确认所选模型支持该协议。

bash
curl https://yunshuapi.org/v1/responses \
  -H "Authorization: Bearer sk-your-token" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-id",
    "input": "请用一句话介绍你自己"
  }'

Anthropic Messages

bash
curl https://yunshuapi.org/v1/messages \
  -H "x-api-key: sk-your-token" \
  -H "anthropic-version: 2023-06-01" \
  -H "content-type: application/json" \
  -d '{
    "model": "your-model-id",
    "max_tokens": 256,
    "messages": [
      { "role": "user", "content": "你好" }
    ]
  }'

流式输出

在请求 JSON 中加入 "stream": true 即可请求流式响应。客户端需要按 Server-Sent Events(SSE)逐条处理事件,不能把整个响应当作一次性 JSON 解析。

常见状态码

状态码含义优先检查
401认证失败令牌、请求头格式、令牌状态
403没有权限模型权限、分组或 IP 限制
404路径或模型不存在Base URL、端点、模型 ID
429请求过快或额度不足速率限制、令牌额度、账户余额
5xx服务或上游异常稍后重试,并保存请求时间与错误信息

排查问题时不要公开完整令牌。向管理员反馈时提供请求时间、模型 ID、端点、状态码和脱敏后的错误内容。

云枢使用文档