快速开始

以 Markdown 格式查看

几分钟内即可发出第一个 OpenModels 请求。OpenModels 使用兼容 OpenAI 的 API,因此只需更换基础 URL 和 API 密钥,大多数现有 OpenAI SDK 代码即可使用。

1. 创建 API 密钥

打开 OpenModels 控制台,进入 API Keys,然后创建密钥。密钥采用 ale-... 格式,且仅显示一次。

  • 将密钥存储在密钥管理器或环境变量中。
  • 不要将 API 密钥提交到源代码管理系统。
  • 为开发、预发布和生产环境使用不同密钥。
  • 若密钥可能泄露,请立即轮换。
export OM_API_KEY="ale-your-api-key"

2. 添加积分

在路由生产流量前打开 积分 并充值余额。积分在受支持的模型和 API 密钥之间共享。

  • 使用一次性充值进行手动注资。
  • 在可用时使用银行卡支付或受支持的加密货币支付方式。
  • 若希望余额低于阈值时自动补充,请启用自动充值。
  • 积分按所选路由的计价单位消耗。

3. 选择模型

打开 Models 并复制模型 ID。模型 ID 就是传入 model 字段的值。

测试时,可先使用 qwen3.5-flash 等低成本对话模型;之后只需修改 model 的值即可切换模型。

下面的示例包含可选的 routeroute_mode 字段。请将提供商占位符替换为 Models 表或 OpenModels 控制台中的路由名称;也可以删除这两个字段以使用默认可用路由。

首次请求成功后,如果希望应用代码调用 route:coding-agent 这类稳定的路由 ID,请创建一个模型路由

4. 发送请求

基础 URL:

https://api.getopenmodels.com/v1

端点:

POST /chat/completions

cURL

curl https://api.getopenmodels.com/v1/chat/completions \
-H "Authorization: Bearer $OM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "qwen3.5-flash",
"route": { "provider": "<provider-for-this-model>" },
"route_mode": "balanced",
"messages": [
{
"role": "user",
"content": "Hello! Give me a one-sentence explanation of OpenModels."
}
],
"max_tokens": 256
}'

Python

import os
from openai import OpenAI
client = OpenAI(
base_url="https://api.getopenmodels.com/v1",
api_key=os.environ["OM_API_KEY"],
)
response = client.chat.completions.create(
model="qwen3.5-flash",
messages=[
{
"role": "user",
"content": "Hello! Give me a one-sentence explanation of OpenModels.",
}
],
max_tokens=256,
extra_body={
"route": {"provider": "<provider-for-this-model>"},
"route_mode": "balanced",
},
)
print(response.choices[0].message.content)

Node.js

import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://api.getopenmodels.com/v1",
apiKey: process.env.OM_API_KEY,
});
const response = await client.chat.completions.create({
model: "qwen3.5-flash",
route: { provider: "<provider-for-this-model>" },
route_mode: "balanced",
messages: [
{
role: "user",
content: "Hello! Give me a one-sentence explanation of OpenModels.",
},
],
max_tokens: 256,
});
console.log(response.choices[0].message.content);

5. 首次请求失败时

根据错误状态和代码选择下一篇文档:

响应检查项
401invalid_api_key身份验证
402key_market_insufficient_balance积分与计费
403key_market_spend_limit_exceeded速率限制
400 或模型不可用模型
429502503504 或超时错误

6. 跟踪用量与消费

请求开始运行后,使用 用量积分 监控请求量、令牌用量、支出、余额、充值和月度限额。

相比 OpenAI 的变化

变化项
基础 URLhttps://api.getopenmodels.com/v1
API 密钥OM_API_KEY 或你的 ale-... 密钥
模型Models 页面中的任一受支持模型 ID,或 route:coding-agent 这类模型路由 ID
路由可选的 route.providerroute_mode 控制项;删除它们即可使用默认路由
SDK标准 OpenAI 兼容 SDK

OpenModels API 访问由 Alephant 网关基础设施提供支持。