快速开始
几分钟完成接入:配置 base_url、API Key 和 model 后即可发起调用。
接入速览
| 你需要填的 | 值 |
|---|---|
| OpenAI Chat Completions | https://openapi.youdao.com/llmgateway/api/v1/chat/completions |
| OpenAI Responses | https://openapi.youdao.com/llmgateway/api/v1/responses |
| Anthropic Messages | https://openapi.youdao.com/llmgateway/anthropic/v1/messages |
| api_key | 控制台创建的 TokenPlan API Key |
| model | auto(自动路由)或具体模型 ID |
不同工具和 SDK 的配置位置可能不同,请以对应工具接入文档为准;例如可参考 AI 工具接入文档 。base_url 不包含
/chat/completions 或 /v1/messages,由客户端自动拼接;直接发起 HTTP 请求时使用上方完整请求地址。 一、订阅套餐
登录 TokenPlan,选择适合你的套餐并完成 订阅 。个人版提供 Lite / Pro / Max 三档,订阅费 1:1 到账为可用额度,调用时按套餐折扣扣费。额度用完可随时增量充值。
二、创建 API Key
订阅后进入控制台 创建 API Key 并复制保存。API Key 用于鉴权和调用 TokenPlan 服务。
API Key 等同于访问凭证,完整值仅在创建时展示一次。不要分享给他人,也不要提交到公开代码仓库。
三、配置 API Key
推荐通过环境变量配置。
macOS / Linux
export YOUDAO_LLM_API_KEY="你的_API_Key"Windows PowerShell
$env:YOUDAO_LLM_API_KEY="你的_API_Key"四、发起模型调用
OpenAI 兼容 API 地址为 https://openapi.youdao.com/llmgateway/api/v1。将 model 设为 auto,即可交给系统自动路由到合适的模型。 除了 auto,你也可以将 model 修改为具体 模型 ID ,例如 deepseek-flash(V4.1 flash)。可用模型 ID 请以控制台模型列表当前展示为准。
curl https://openapi.youdao.com/llmgateway/api/v1/chat/completions \
-H "Authorization: Bearer $YOUDAO_LLM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "auto",
"messages": [
{
"role": "user",
"content": "你好,请介绍一下 TokenPlan。"
}
]
}' 调用成功后响应体中包含 choices 数组,回复内容在 choices[0].message.content。其中 model 是 Auto 实际命中的模型,cost 是本次消耗的额度。
同一个服务中不要混用 OpenAI 和 Anthropic 两种协议。鉴权统一使用
Authorization: Bearer <API Key>。 五、Python 调用
如果项目使用 OpenAI Python SDK,只需替换 base_url。示例已包含在上方 Python 标签中。
response.cost 是 TokenPlan 的扩展字段,用于回显本次调用消耗的额度;OpenAI 原生 SDK 无此字段。 六、流式输出
需要边生成边展示内容时,可以开启 stream。
stream = client.chat.completions.create(
model="auto",
messages=[
{
"role": "user",
"content": "请介绍一下大模型 API 的应用场景。"
}
],
stream=True
)
for chunk in stream:
if chunk.choices:
content = chunk.choices[0].delta.content
if content:
print(content, end="", flush=True)首次调用排查
| 现象 | 可能原因 | 处理 |
|---|---|---|
| 401 鉴权失败 | base_url 填成了控制台网址;Key 不完整或带空格 | 确认使用 API 地址,重新复制完整 Key |
| 401 余额不足 | 额度用尽或未订阅 | 充值额度或检查订阅状态 |
| 找不到模型 | 模型 ID 拼写错、大小写不符 | 使用 auto,或以控制台模型列表为准 |
| 429 请求受限 | 请求过密或触发限流 | 稍后重试并增加指数退避 |
