跳到主要内容

API Key 管理


模型部署服务提供了完整的 API Key 管理功能，让你能够安全地访问和调用已部署的模型。本文将介绍如何创建、管理和使用 API Key。

访问控制说明​

默认情况下，新创建的模型部署是公开访问的，即任何人都可以调用该服务，无需认证。这种模式适用于：

  • 公开的演示服务
  • 测试环境
  • 不需要访问控制的场景

如果需要限制访问，你可以：

  1. 进入模型部署的设置页面
  2. 找到「访问控制」部分
  3. 开启访问控制开关

API Key 管理界面

开启访问控制后，所有的访问请求都需要提供有效的 API Key。

API Key 概述​

API Key 是访问模型部署服务的凭证，它提供了以下优势：

  • 安全性：每个 API Key 都是唯一的，可以独立管理和撤销
  • 灵活控制：支持用户级别和模型部署级别的访问控制
  • 简单易用：符合业界标准实践（如 OpenAI、HuggingFace 等）

访问入口​

你可以通过以下三种方式访问 API Key 管理功能：

  1. 模型部署级别

    • 进入具体的模型部署页面
    • 开启「访问控制」后
    • 可以在设置中管理该模型部署的 API Key

  2. 对于个人用户

    • 点击左下角的「账号设置」
    • 在右侧面板中找到「API Key」选项
    • 管理你的个人 API Key

  3. 对于组织用户

    • 点击左下角的「组织设置」
    • 在右侧面板中访问「API Key」
    • 管理组织的 API Key

API Key 类型​

OpenBayes 提供两种类型的 API Key：

  1. 用户级别 API Key

    • 可以访问该用户下的所有模型部署
    • 适合需要统一管理多个模型部署的场景

  2. 模型部署级别 API Key

    • 只能访问特定的模型部署
    • 支持绑定一个或多个模型部署
    • 可以根据需要更改绑定的模型部署

API Key 管理界面

提示

API Key 的类型可以根据需要进行变更，你可以调整一个 Key 可以访问的模型部署范围。

注意

API Key 的创建、更新或删除操作可能需要大约 5 分钟才能生效。在此期间，请耐心等待并避免重复操作。

创建 API Key​

  1. 进入模型部署的设置页面
  2. 找到「API Key 管理」部分
  3. 点击「创建 API Key」按钮
  4. 在弹出的对话框中：
    • 输入 API Key 的名称（用于识别用途）
    • 选择 API Key 类型（用户级别或模型部署级别）
    • 如果选择模型部署级别，选择要绑定的模型部署
    • 点击「创建」按钮

创建 API Key

注意

新创建的 API Key 只会显示一次。请确保立即复制并安全保存，因为之后将无法再次查看完整的 Key。

编辑 API Key 权限​

你可以随时调整模型部署级别 API Key 可以访问的模型：

  1. 在 API Key 列表中找到要编辑的 Key
  2. 点击「编辑」按钮
  3. 在弹出的对话框中修改可访问的模型部署
  4. 点击「确认」确认更改

编辑 API Key 权限

删除 API Key​

如果不再需要某个 API Key，或者怀疑 Key 已经泄露，你可以：

  1. 在 API Key 列表中找到要删除的 Key
  2. 点击「删除」按钮
  3. 确认删除操作

删除 API Key

警告

删除 API Key 是不可逆操作。删除后，使用该 Key 的所有应用都将无法访问模型部署服务。请注意删除操作可能需要大约 5 分钟才能完全生效。

使用 API Key​

在调用模型部署服务时，需要在请求头中包含 API Key。以下是一个调用大语言模型服务的示例：

curl --location 'https://open-tutorials-2obiahfo3kig.serv-c1.openbayes.net/v1/chat/completions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer sk-5cyqtxxxxxdevjuiife5zpz8tsj' \
--data '{
    "model": "DeepSeek-R1-Distill-Qwen-1.5B",
    "messages": [
        {
            "role": "user",
            "content": "hi"
        }
    ]
}'

HTTP 请求头说明​

在发送请求时，需要在 HTTP 请求头中包含以下信息：

Authorization 头：

  • 格式：Bearer sk-xxxxxx（注意 Bearer 和 key 之间有一个空格）
  • 示例：Authorization: Bearer sk-5cyqtxxxxxdevjuiife5zpz8tsj

状态码说明​

服务器会返回以下状态码：

  • 200 - 300: 请求成功
  • 401: 未授权（API Key 无效或未提供）
  • 403: 禁止访问（API Key 有效但没有访问特定服务的权限）

示例响应：

{
    "id": "chatcmpl-5b543fe0122745a89fb1002342442ab1",
    "object": "chat.completion",
    "created": 1745213042,
    "model": "DeepSeek-R1-Distill-Qwen-1.5B",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "reasoning_content": null,
                "content": "Hello! How can I assist you today?",
                "tool_calls": []
            },
            "logprobs": null,
            "finish_reason": "stop",
            "stop_reason": null
        }
    ],
    "usage": {
        "prompt_tokens": 6,
        "total_tokens": 64,
        "completion_tokens": 58,
        "prompt_tokens_details": null
    },
    "prompt_logprobs": null
}

安全建议​

  1. 妥善保管：

    • 将 API Key 存储在安全的地方
    • 不要在代码仓库中直接保存 API Key
    • 使用环境变量或配置管理系统存储 Key

  2. 定期轮换：

    • 定期创建新的 API Key 并更新应用
    • 删除长期未使用的 Key
    • 发现安全问题时立即轮换 Key

  3. 最小权限：

    • 优先使用模型部署级别的 Key，除非确实需要访问多个模型
    • 及时删除不需要的 Key
    • 定期审查 Key 的权限范围
最后由 xushanchuan 于 更新