51cowork API文档
打开文档导航

API Reference

模型网关 API Reference

当前公开网关 https://api.51cowork.com 支持 GPT、Claude、Grok、DeepSeek、GLM 和 Kimi,并提供 Anthropic 与 OpenAI 兼容入口。API Key 来自控制台。

快速答案

模型请求直接发送到 https://api.51cowork.com。推荐使用 Authorization: Bearer;Anthropic 客户端也可以使用 x-api-key。实际模型 ID 通过 GET /v1/models 获取。

Gateway
https://api.51cowork.com
认证
Bearer / x-api-key
内容类型
application/json
模型目录
GET /v1/models
01

Base URL 与认证

模型请求发送到 Gateway https://api.51cowork.com 的 /v1/... 路径;账户操作通过控制台完成。

Environmentbash
export COWORK_GATEWAY_URL="https://api.51cowork.com"
export COWORK_API_KEY="<key-from-dashboard>"
export COWORK_MODEL="<model-from-gateway>"
客户端Base URL客户端追加的路径
直接 HTTPhttps://api.51cowork.com使用完整 /v1/... 路径
OpenAI SDK / OpenCode / Cursorhttps://api.51cowork.com/v1/chat/completions 或 /responses
Cherry Studio(OpenAI)https://api.51cowork.com/v1/chat/completions
WorkBuddy(自定义协议)https://api.51cowork.com/v1/chat/completions完整 URL,不再追加
Anthropic SDK / Claude Codehttps://api.51cowork.com/v1/messages
Codexhttps://api.51cowork.comwire_api = responses
认证方式Header
推荐Authorization: Bearer <API_KEY>
Anthropic 兼容x-api-key: <API_KEY>
Gemini 兼容(若当前分组提供)x-goog-api-key: <API_KEY>
02

GET /v1/models

读取当前 Key 所属分组实际提供的模型目录。

cURLbash
curl "$COWORK_GATEWAY_URL/v1/models" \
  -H "Authorization: Bearer $COWORK_API_KEY"
  • 支持的模型系列包括 GPT、Claude、Grok、DeepSeek、GLM 和 Kimi。
  • 使用响应中的精确模型 ID,不把系列名称直接作为 ID,也不根据品牌名猜测。
  • 模型列表为空或目标模型缺失时,先核对 Key、分组和运营配置。
  • 缓存模型列表时设置短有效期,并允许用户手动刷新。
03

POST /v1/messages

Anthropic Messages 兼容入口。

Anthropic Messagesbash
curl "$COWORK_GATEWAY_URL/v1/messages" \
  -H "x-api-key: $COWORK_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "content-type: application/json" \
  -d '{
    "model": "'"$COWORK_MODEL"'",
    "max_tokens": 256,
    "messages": [{"role": "user", "content": "Hello"}]
  }'

发起生成前,可以用相同的模型和 messages 请求 POST /v1/messages/count_tokens 预计输入 Token。

Count tokensbash
curl "$COWORK_GATEWAY_URL/v1/messages/count_tokens" \
  -H "x-api-key: $COWORK_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "content-type: application/json" \
  -d '{
    "model": "'"$COWORK_MODEL"'",
    "messages": [{"role": "user", "content": "Hello"}]
  }'
字段要求
model使用 /v1/models 返回的 ID
max_tokens正整数;由客户端和模型能力共同限制
messages至少包含一条合法消息
stream可选;true 时返回事件流
04

POST /v1/chat/completions

OpenAI Chat Completions 兼容入口。

Chat Completionsbash
curl "$COWORK_GATEWAY_URL/v1/chat/completions" \
  -H "Authorization: Bearer $COWORK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "'"$COWORK_MODEL"'",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

常用字段包括 model、messages、stream 以及模型支持的采样或工具字段。上游不接受的字段可能被拒绝或按兼容层规则处理,因此不要假设不同模型能力完全相同。

05

POST /v1/responses

OpenAI Responses 兼容入口,也是 Codex 配置使用的 wire API。

Responsesbash
curl "$COWORK_GATEWAY_URL/v1/responses" \
  -H "Authorization: Bearer $COWORK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "'"$COWORK_MODEL"'",
    "input": "Explain this repository in three bullets."
  }'
06

流式响应

把 stream 设为 true,并让客户端逐个处理服务器发送的事件。cURL 使用 -N 关闭输出缓冲。

Streaming requestbash
curl -N "$COWORK_GATEWAY_URL/v1/chat/completions" \
  -H "Authorization: Bearer $COWORK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "'"$COWORK_MODEL"'",
    "stream": true,
    "messages": [{"role": "user", "content": "Count to five"}]
  }'
  • 设置足够长的读取超时,不要把流式空闲误判为连接失败。
  • 客户端主动取消时关闭响应体,避免继续占用连接。
  • 响应已经开始后发生错误时,可能无法改写为普通 JSON 错误;保留已收到事件用于诊断。
07

HTTP 状态与错误处理

状态常见含义建议
400请求 JSON、字段或模型参数无效修正请求,不要原样重试
401Key 缺失、错误或已停用重新读取配置;Rotate 后更新旧 Key
402 / 403额度或访问权限不足检查 Key 额度与账户状态
404路径、模型或当前分组能力不存在刷新模型目录并核对入口
429当前限流或上游暂不可用读取 Retry-After;带抖动退避
5xx网关或上游暂时失败记录请求信息后有限重试