BYOKSBYOKS Docs

使用者

BYOK 模式

BYOK(Bring Your Own Key)让你使用自己的 Provider API Key,费用直接计入你的 Provider 账户。

优势

  • 费用透明:直接使用你的 Provider 账户,无中间商加价
  • 完整控制:保持你的配额、限制和计费关系
  • 数据安全:请求直接转发到你的 Provider 账户

配置 Provider

进入 Provider 设置

在 Dashboard 中,点击 Providers > Add Provider

选择 Provider 类型

Provider需要的信息
OpenAIAPI Key
AnthropicAPI Key
GoogleAPI Key
Azure OpenAIEndpoint, API Key, Deployment Name
MistralAPI Key
xAIAPI Key
DeepSeekAPI Key

输入凭证

{
  "provider": "openai",
  "apiKey": "sk-..."
}
{
  "provider": "anthropic",
  "apiKey": "sk-ant-..."
}
{
  "provider": "google",
  "apiKey": "AIza..."
}
{
  "provider": "azure",
  "endpoint": "https://your-resource.openai.azure.com",
  "apiKey": "...",
  "deploymentName": "gpt-4o"
}

选择可用模型

配置该 Provider 下你想使用的模型。

使用配置的 Provider

配置完成后,你可以通过 BYOKS 调用这些模型:

import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://api.byoks.com/v1',
  apiKey: 'your-byoks-key',
});

// 调用你配置的 OpenAI
const response = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: '你好' }],
});

// 调用你配置的 Claude(使用 OpenAI SDK)
const claudeResponse = await client.chat.completions.create({
  model: 'claude-3-5-sonnet-20241022',
  messages: [{ role: 'user', content: '你好' }],
});

多 Provider 配置

你可以配置多个 Provider,BYOKS 会根据你的路由策略选择使用哪个。

┌─────────────────────────────────────────────────┐
│                 你的配置                         │
├─────────────────────────────────────────────────┤
│                                                  │
│  Provider 1: OpenAI (sk-xxx)                    │
│    └── gpt-4o, gpt-4-turbo                      │
│                                                  │
│  Provider 2: Anthropic (sk-ant-xxx)             │
│    └── claude-3-5-sonnet, claude-3-opus         │
│                                                  │
│  Provider 3: Google (AIza-xxx)                  │
│    └── gemini-1.5-pro, gemini-1.5-flash         │
│                                                  │
└─────────────────────────────────────────────────┘

Key 安全

BYOKS 不会存储你的完整 API Key

  • Key 加密存储,只有处理请求时实时解密使用
  • 你可以随时删除或更新配置
  • 建议为 BYOKS 创建专用的 API Key,方便追踪用量

常见问题

我可以配置多个同类型 Provider 吗?

可以。例如你有多个 OpenAI 账户,可以都配置上,通过路由策略分配流量。

配置后原来的 Key 还能用吗?

当然。BYOKS 只是转发请求,不影响你直接使用原来的 Key。

如何追踪通过 BYOKS 产生的用量?

建议为 BYOKS 创建专用的 API Key,这样在 Provider 后台可以独立追踪 BYOKS 产生的用量。

下一步