API
Models API
获取你配置的所有可用模型。
列出模型
端点
GET /v1/models请求示例
curl https://api.byoks.com/v1/models \
-H "Authorization: Bearer your-byoks-key"响应示例
{
"object": "list",
"data": [
{
"id": "gpt-4o",
"object": "model",
"created": 1234567890,
"owned_by": "openai",
"permission": [],
"root": "gpt-4o",
"parent": null
},
{
"id": "claude-3-5-sonnet-20241022",
"object": "model",
"created": 1234567890,
"owned_by": "anthropic",
"permission": [],
"root": "claude-3-5-sonnet-20241022",
"parent": null
},
{
"id": "gemini-1.5-pro",
"object": "model",
"created": 1234567890,
"owned_by": "google",
"permission": [],
"root": "gemini-1.5-pro",
"parent": null
}
]
}获取单个模型
端点
GET /v1/models/{model_id}请求示例
curl https://api.byoks.com/v1/models/gpt-4o \
-H "Authorization: Bearer your-byoks-key"响应示例
{
"id": "gpt-4o",
"object": "model",
"created": 1234567890,
"owned_by": "openai",
"permission": [],
"root": "gpt-4o",
"parent": null
}模型 ID 说明
标准模型 ID
直接使用官方模型 ID：
| Provider | 模型 ID 示例 |
|---|---|
| OpenAI | gpt-4o, gpt-4-turbo, gpt-3.5-turbo |
| Anthropic | claude-3-5-sonnet-20241022, claude-3-opus-20240229 |
gemini-1.5-pro, gemini-1.5-flash | |
| Mistral | mistral-large-latest, mistral-medium |
| xAI | grok-2, grok-2-mini |
| DeepSeek | deepseek-chat, deepseek-coder |
指定 Provider
如果你配置了多个同模型的 Provider，可以指定使用哪个：
model: gpt-4o@provider-xyz使用别名
如果你配置了模型映射，可以使用别名：
model: fast # 映射到 gpt-4o-mini
model: smart # 映射到 claude-3-5-sonnet-20241022模型能力
不同模型支持的能力不同：
| 模型 | 文本 | 图片输入 | 工具调用 | 流式 |
|---|---|---|---|---|
| gpt-4o | 是 | 是 | 是 | 是 |
| gpt-4-turbo | 是 | 是 | 是 | 是 |
| claude-3-5-sonnet | 是 | 是 | 是 | 是 |
| claude-3-opus | 是 | 是 | 是 | 是 |
| gemini-1.5-pro | 是 | 是 | 是 | 是 |
| gemini-1.5-flash | 是 | 是 | 是 | 是 |
代码示例
TypeScript
import OpenAI from 'openai';
const client = new OpenAI({
baseURL: 'https://api.byoks.com/v1',
apiKey: 'your-byoks-key',
});
// 列出所有模型
const models = await client.models.list();
for (const model of models.data) {
console.log(model.id, '-', model.owned_by);
}
// 获取单个模型
const model = await client.models.retrieve('gpt-4o');
console.log(model);Python
from openai import OpenAI
client = OpenAI(
base_url="https://api.byoks.com/v1",
api_key="your-byoks-key",
)
# 列出所有模型
models = client.models.list()
for model in models.data:
print(f"{model.id} - {model.owned_by}")
# 获取单个模型
model = client.models.retrieve("gpt-4o")
print(model)