https://api.yourouter.ai/v1,所以大多数已有的 OpenAI SDK 集成只需要替换 base_url 和 API key。
需要 API Key?请前往 YouRouter Dashboard 创建。
接入基础信息
1. 设置 API Key
在运行下面的示例前,先把 API Key 存到环境变量中。- macOS/Linux
- Windows
- .env
2. 发起第一条测试请求
最快的接入验证方式,是直接请求 Chat Completions 接口。请求成功后,可以从choices[0].message.content 读取模型输出。你可以使用 cURL 或任意标准 HTTP 客户端;下面的示例覆盖 Python、Node.js、Go、Java、PHP 和 Rust。
- cURL
- Python requests
- Node.js 18+ fetch
- Go
- Java 11+
- PHP
- Rust
3. 迁移现有 OpenAI SDK 代码
如果你的应用已经在使用 OpenAI SDK,通常可以保留原有请求体结构,只替换两个字段:api_key 和 base_url。
- Python
- Node.js
Go、Java、PHP 和 Rust 也使用同样的自定义 Base URL 思路:如果你使用的 OpenAI 兼容 SDK 支持设置 base URL,就指向
https://api.yourouter.ai/v1;如果 SDK 不支持,就直接用上面的 HTTP 示例请求 /v1/chat/completions。4. 选择模型与路由方式
通过model 字段选择模型。你可以用同一种 API 形式调用多种模型家族,例如 OpenAI GPT、Claude、Gemini、DeepSeek、Grok、Doubao 和 Kimi。需要图像等多模态输入时,参考 多模态指南。
如果示例中的模型尚未在你的账号中启用,请替换为 YouRouter Dashboard 中显示的任意可用模型 ID。
vendor 请求头,或者设置 vendor: auto,即可让 YouRouter 选择当前最合适的可用上游。
只有当你的集成明确依赖某个上游的行为、模型变体、账号隔离或合规要求时,才建议固定 vendor。
- cURL
- Python SDK
- Node.js SDK
5. 处理响应与错误
对于 OpenAI 兼容接口,成功响应遵循 OpenAI 风格格式。生成文本通常位于choices[0].message.content。
6. 流式输出
如果你在做聊天 UI 或 agent,可以设置stream: true,让模型边生成边返回分片。
下一步
API Reference
查看接口、参数与响应格式。
模型说明
了解如何传入模型 ID,并通过 API 切换模型。
多模态
发送图片输入,并调用提供商原生多模态 API。
路由指南
了解自动路由和指定上游的适用场景。
Chat Completions
构建对话、流式 UI、工具调用和多模态流程。