YouRouter 通过一个统一网关暴露模型 API。大多数集成场景都应从 OpenAI 兼容的 Chat Completions 端点开始。
Base URL
https://api.yourouter.ai/v1
本参考中的所有模型 API 路径都相对于这个 base URL。
请把 YouRouter API Key 作为 Bearer Token 发送:
Authorization: Bearer <YOUR_YOUROUTER_API_KEY>
对于 JSON 请求,还需要发送:
Content-Type: application/json
API Key 只能用于服务端代码、后端服务、CI 任务或可信的内部工具。不要把 API Key 放在浏览器端代码或移动客户端中。
第一条 API 请求
curl https://api.yourouter.ai/v1/chat/completions \
-H "Authorization: Bearer $YOUROUTER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o",
"messages": [
{
"role": "user",
"content": "Reply with exactly: connected"
}
]
}'
生成结果通常位于:
choices[0].message.content
核心概念
| 概念 | 使用方式 |
|---|
| 模型选择 | 在请求体中设置 model 字段。 |
| 多模态输入 | 在 messages[].content 中发送文本和图片内容块,或使用 provider 原生多模态端点。 |
| 自动路由 | 省略 vendor 请求头,或发送 vendor: auto。 |
| 固定上游 | 发送 vendor: openai、vendor: anthropic、vendor: google 等 provider 值。 |
| 流式输出 | 设置 stream: true,按 SSE 增量返回内容。 |
| Provider 原生 API | Anthropic 使用 /messages;Gemini 使用 generateContent 路径。 |
主要端点
| 端点 | 用途 |
|---|
POST /chat/completions | OpenAI 兼容的文本和图片输入调用。适合大多数集成。 |
POST /embeddings | 生成文本向量。 |
POST /messages | Anthropic Messages 兼容调用。 |
POST /projects/.../models/{model}:generateContent | Google Gemini generateContent 兼容调用。 |
POST /api/v3/contents/generations/tasks | 任务式视频生成调用。 |
状态码
| 状态码 | 含义 |
|---|
200 | 请求成功。 |
400 | 请求体、模型或参数格式无效。 |
401 | API Key 缺失或无效。 |
429 | 命中了 provider 的限流或并发限制。 |
500 | 网关或上游 provider 返回内部错误。 |
核心请求格式请参考 Create Chat Completion,图片和视频示例请参考 多模态。