跳到主要内容
SDK & HTTP Clients

客户端 SDK

使用 OpenAI SDK、Anthropic SDK 或任意 HTTP 客户端接入 ClawdRouter。 推荐优先使用 OpenAI-compatible 接口完成文本、流式输出、图片等常规调用; 只有在需要 Anthropic 原生 Messages 协议时,再使用 Anthropic SDK 或 /v1/messages

准备 API Key安装 SDK发起请求处理响应或任务

选择接入方式

Claude 原生Anthropic SDK
适合已经使用 Anthropic SDK,或必须保留 Claude 原生 Messages 请求格式的项目。
Base URL
DOCS_API_ORIGIN
主要接口
/v1/messages
查看 Messages 示例
异步任务HTTP 客户端
适合 Go、Java、PHP、Ruby、C# 等语言,或需要直接控制请求头、超时、重试和日志的服务端接入。
Base URL
按接口选择
主要接口
所有 API endpoint
查看视频生成示例
语言切换会保持同步本页所有示例共享同一组 Tab。切换一次语言后,安装、聊天、流式、视频和 Anthropic 示例都会保持同一个语言视图。

准备 API Key

所有示例都使用同一个 API Key。建议通过环境变量管理密钥:

export CLAWDROUTER_API_KEY="YOUR_API_KEY"
export CLAWDROUTER_BASE_URL="__DOCS_API_ORIGIN__"

如果项目直接使用 OpenAI SDK 的默认环境变量,也可以这样配置:

export OPENAI_API_KEY="YOUR_API_KEY"
export OPENAI_BASE_URL="__DOCS_API_ORIGIN__/v1"

Anthropic SDK 使用同一个 API Key,但 base_url 应设置为 __DOCS_API_ORIGIN__,不要带 /v1

安装 SDK

cURL 通常已经内置在 macOS 和 Linux 中。Windows 用户可以使用 PowerShell、Git Bash 或 WSL。

发起文本生成请求

以下示例使用 OpenAI-compatible Chat Completions 接口。适合大多数聊天、问答和文本生成场景。

POST __DOCS_API_ORIGIN__/v1/chat/completions
curl __DOCS_API_ORIGIN__/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $CLAWDROUTER_API_KEY" \
-d '{
"model": "gpt-4o",
"messages": [
{"role": "system", "content": "你是一个有用的助手"},
{"role": "user", "content": "用简单的话解释什么是机器学习"}
]
}'

成功后,非流式响应会返回 choices[].message.content;如果需要完整字段说明,请查看 Chat Completions API 参考

流式输出

流式输出适合聊天界面、长文本生成和需要更快首字响应的场景。请求体中设置 stream: true 即可。

curl __DOCS_API_ORIGIN__/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $CLAWDROUTER_API_KEY" \
-N \
-d '{
"model": "gpt-4o",
"messages": [
{"role": "user", "content": "写一篇关于人工智能的短文"}
],
"stream": true
}'

-N 会关闭 cURL 输出缓冲,让内容实时显示。

调用 Veo 视频生成

视频生成是异步任务。提交成功后会返回 task_id,请到控制台任务中心下载生成结果。

curl __DOCS_API_ORIGIN__/v1/video/generations \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $CLAWDROUTER_API_KEY" \
-d '{
"model": "veo-3.1-fast-generate-001",
"prompt": "A cute small bird dancing on a tree branch, moving rhythmically to cheerful music. The bird gently sways its body, lightly flaps its wings, and playfully tilts its head. Bright forest background with soft sunlight and subtle shadows. Semi-realistic, slightly cartoon style, vivid but not over-saturated colors. Static camera, centered subject, smooth motion, medium detail. 720p resolution, clear and stable output.",
"duration": 4,
"metadata": {
"durationSeconds": 4,
"aspectRatio": "16:9",
"resolution": "720p",
"negativePrompt": "low quality, blurry, distorted",
"personGeneration": "allow_adult",
"generateAudio": true
}
}'

典型受理响应:

{
"id": "task_MrvezeP3uOim5bWo8texognLwHHHVgpB",
"task_id": "task_MrvezeP3uOim5bWo8texognLwHHHVgpB",
"object": "video",
"model": "veo-3.1-fast-generate-001",
"status": "queued",
"progress": 0,
"created_at": 1779265222
}

调用 Anthropic 原生协议

如果你需要直接使用 Anthropic Messages 协议,请调用 /v1/messages。该协议使用 x-api-key 认证头,而不是 Authorization: Bearer

curl __DOCS_API_ORIGIN__/v1/messages \
-H "Content-Type: application/json" \
-H "x-api-key: $CLAWDROUTER_API_KEY" \
-H "anthropic-version: 2023-06-01" \
-d '{
"model": "claude-sonnet-4-6",
"max_tokens": 1024,
"messages": [
{"role": "user", "content": "用简单的话解释什么是机器学习"}
]
}'

常见配置

配置推荐值说明
OpenAI-compatible Base URL__DOCS_API_ORIGIN__/v1OpenAI SDK、Chat Completions、Responses、Images API 使用
Anthropic Base URL__DOCS_API_ORIGIN__Anthropic SDK 和 Messages API 使用
认证头Authorization: Bearer YOUR_API_KEYOpenAI-compatible 接口使用
Anthropic 认证头x-api-key: YOUR_API_KEYAnthropic 原生协议使用
Content-Typeapplication/json所有 JSON 请求都需要
Request-Id自定义唯一字符串可选,用于业务侧幂等和排查

错误处理建议

  • 401 通常表示 API Key 无效、缺失或被禁用。
  • 429 通常表示请求频率或额度达到限制,可以稍后重试或调整并发。
  • 5xx 通常表示平台或上游模型服务异常,建议保留 request_id 后重试或提交工单。
  • 视频生成返回 queued 只代表任务已受理,不代表视频已经完成。

下一步