BYOKSBYOKS Docs

提供者

配置指南

本指南介绍如何配置你的 API Key 并开启 Provider 模式。

步骤概览

  1. 添加 API Key
  2. 配置可用模型
  3. 开启 Provider 模式
  4. 设置定价(见定价策略

添加 API Key

进入 Provider 设置

在 Dashboard 中,点击 Provider > My Keys

添加新的 Key

点击 Add Key,选择 Provider 类型:

{
  "provider": "openai",
  "name": "我的 OpenAI Key",
  "apiKey": "sk-...",
  "models": ["gpt-4o", "gpt-4-turbo", "gpt-3.5-turbo"]
}
{
  "provider": "anthropic",
  "name": "我的 Claude Key",
  "apiKey": "sk-ant-...",
  "models": ["claude-3-5-sonnet-20241022", "claude-3-opus-20240229"]
}
{
  "provider": "google",
  "name": "我的 Gemini Key",
  "apiKey": "AIza...",
  "models": ["gemini-1.5-pro", "gemini-1.5-flash"]
}

配置可用模型

选择你想提供的模型:

{
  "models": [
    {
      "id": "gpt-4o",
      "enabled": true,
      "maxConcurrent": 10
    },
    {
      "id": "gpt-4-turbo",
      "enabled": true,
      "maxConcurrent": 5
    },
    {
      "id": "gpt-3.5-turbo",
      "enabled": false
    }
  ]
}
参数说明
id模型 ID
enabled是否启用
maxConcurrent最大并发请求数

开启 Provider 模式

配置完成后,开启 Provider 模式:

{
  "providerMode": {
    "enabled": true,
    "public": true,
    "name": "MyProvider"
  }
}
参数说明
enabled是否启用 Provider 模式
public是否在市场中公开显示
name你的 Provider 名称(用于展示)

配置限制

为了保护你的 Key,建议设置使用限制:

{
  "limits": {
    "maxRequestsPerMinute": 60,
    "maxTokensPerDay": 1000000,
    "maxCostPerDay": 100
  }
}
参数说明
maxRequestsPerMinute每分钟最大请求数
maxTokensPerDay每天最大 Token 数
maxCostPerDay每天最大成本(美元)

当达到限制时,BYOKS 会自动将请求路由到其他 Provider。

监控状态

在 Dashboard 中可以查看:

  • 请求量:每小时/每天的请求统计
  • Token 用量:输入/输出 Token 统计
  • 收入:预估收入和已结算收入
  • 错误率:失败请求的比例

暂停服务

如果需要临时暂停,可以关闭 Provider 模式:

{
  "providerMode": {
    "enabled": false
  }
}

暂停后,新的请求不会路由到你的 Key,但不影响已配置的限制和定价。

最佳实践

创建专用 Key

建议为 BYOKS Provider 模式创建专用的 API Key:

  • 方便追踪用量
  • 不影响你自己的使用
  • 安全隔离

设置合理的限制

根据你的配额设置限制,避免超支:

  • 日限额设为配额的 80%,留有余地
  • 并发限制根据 Provider 的 Rate Limit 设置

定期检查

定期检查:

  • Key 的有效性
  • 余额是否充足
  • 错误率是否正常

下一步