接入文档

接入 MAX API API 所需的一切。

快速开始

MAX API API 兼容 OpenAI API。如果你已在使用 OpenAI SDK，只需修改两项配置：Base URL 和 API Key。

Base URL

https://clubs.byte-ai.cn/v1

API Key

在控制台创建

鉴权

每个请求都需在 Authorization 头中携带 API Key。请妥善保管密钥，切勿在浏览器或移动端代码中暴露。

Authorization: Bearer YOUR_API_KEY

对话补全

发送消息列表，获取模型回复。目录中的任意对话模型 ID 均可使用。

curl https://clubs.byte-ai.cn/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-terra",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

流式输出

将 stream 设为 true，即可以服务器推送事件（SSE）的形式边生成边接收。流以 data: [DONE] 结束。

curl https://clubs.byte-ai.cn/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-terra",
    "messages": [{"role": "user", "content": "Hello!"}],
    "stream": true
  }'

图片生成

使用 Images API 生成图片，请从目录中选择图像模型。

curl https://clubs.byte-ai.cn/v1/images/generations \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-1",
    "prompt": "A lighthouse on a cliff at sunset, watercolor",
    "size": "1024x1024"
  }'

Anthropic 格式

Claude 模型也可以通过 /v1/messages 以 Anthropic 原生 Messages 格式调用，使用 x-api-key 请求头（Authorization 头同样可用）。这样可以直接使用 Anthropic 官方 SDK，无需改动。

curl https://clubs.byte-ai.cn/v1/messages \
  -H "x-api-key: $API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "max_tokens": 1024,
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

模型列表

获取你的密钥可用的模型列表。

curl https://clubs.byte-ai.cn/v1/models \
  -H "Authorization: Bearer $API_KEY"

错误码

错误使用标准 HTTP 状态码，并返回 OpenAI 风格的 JSON：

{
  "error": {
    "message": "Invalid API key",
    "type": "invalid_request_error",
    "code": "invalid_api_key"
  }
}

状态码	含义
400	请求错误：参数无效或 JSON 格式不正确。
401	API Key 无效或缺失。
403	余额不足，或该密钥无权使用此模型。
404	接口不存在或模型不可用。
429	请求过于频繁：请降低频率并退避重试。
500	内部错误：可以安全重试。
502 / 503	上游暂时不可用：请稍后重试。

限流

默认限额充足，可满足生产环境需求。超出限额时会返回 429，请使用指数退避重试。需要更高吞吐量？请通过控制台联系我们。

推理模型生成长内容可能需要数分钟。请把客户端超时设置为至少 300 秒，或使用流式输出。

常见问题

支持哪些 SDK？+

任何兼容 OpenAI 的 SDK 或 HTTP 客户端：OpenAI 官方 Python / Node.js SDK、LangChain、LlamaIndex 等。Claude 模型也可使用 Anthropic SDK。

支持函数调用和 JSON 输出吗？+

支持（取决于模型本身是否支持）。tools、tool_choice、response_format 等参数会透传给模型。

一个密钥能调用所有模型吗？+

可以。同一个 API Key 可调用目录中的全部模型，按各模型原价分别计费。

如何切换模型？+

修改请求中的 model 字段即可，无需其他改动。