Docs/用户中心/API Key 管理

API Key 管理

API Key(前缀 cpk_)是 CodePus 颁发给当前账号、用于在 IDE 客户端或第三方程序中调用 CodePus 官方 AI 网关的访问凭证。它不是用于填写 OpenAI / Claude / DeepSeek 等第三方模型厂商的 Key(那些由管理员在后台 /admin/settings/ai 统一配置)。

它能做什么

  • CodePus IDE 客户端或任意支持 OpenAI 协议的工具,以你的账号身份访问 CodePus 的 AI 网关(proxyBaseUrl)。
  • 所有调用都会按你当前的套餐配额计费、限流,并在 用量详情账单 中实时累计。
  • 每张 Key 可独立命名、设置过期时间、单独吊销,便于多设备 / 多脚本场景隔离与离职回收。
  • 安全模型

  • 每张 Key 在创建那一刻仅明文显示一次,之后系统只保留 SHA-256 哈希与前缀 (cpk_xxxxxxxx),无法再取回原文。
  • 单账号最多保留 20 张 Key;过期天数范围 1 ~ 365 天(不设置则永不过期)。
  • 任何被识破或离开使用环境的 Key 应立刻在本页 删除,删除即吊销,新的请求会立即返回 401
  • 创建步骤

  • 进入 用户中心 → 🔑 API Key 管理(即本页 /dashboard/api-keys)。
  • 点击右上角 创建 Key,填写一个易识别的名称(例如 My Laptop IDE / CI Bot)。
  • 提交后页面会一次性弹出形如 cpk_xxxxxxxx... 的完整 Key——立即复制并保存到密钥管理工具,关闭弹窗后无法再次查看。
  • 在 CodePus IDE 中使用

  • 打开 IDE,进入 设置 → 账号 / Account
  • 把上一步复制的 cpk_... Key 粘贴到「API Key」输入框。
  • 「Base URL」请填写 用户中心首页 顶部「API 端点」面板里展示的 proxyBaseUrl(生产环境通常是 https://api.codepus.ai/v1)。
  • 保存后即可在编辑器中使用 AI 对话、补全、Agent 等所有功能,配额变化实时反映在 用量详情
  • 在第三方程序 / 脚本中使用

    CodePus 网关兼容 OpenAI Chat Completions 协议。以 cURL 为例:
    curl https://api.codepus.ai/v1/chat/completions \   -H "Authorization: Bearer cpk_你的key" \   -H "Content-Type: application/json" \   -d '{     "model": "gpt-4o-mini",     "messages": [{"role": "user", "content": "你好"}]   }' 
    Node.js / OpenAI SDK:
    import OpenAI from "openai"; const client = new OpenAI({   apiKey: process.env.CPK_KEY,                  // cpk_xxx   baseURL: "https://api.codepus.ai/v1", }); const res = await client.chat.completions.create({   model: "gpt-4o-mini",   messages: [{ role: "user", content: "hi" }], }); 

    字段与状态说明

    字段含义
    名称你为这张 Key 设置的备注,便于区分用途 前缀cpk_xxxxxxxx...**,用于在日志和列表里识别,不暴露完整 Key 创建于Key 的创建时间 最后使用上次成功携带该 Key 调用网关的时间,可用来识别闲置 Key 过期于到期后系统自动拒绝,需重新创建 启用 / 已停用已停用 = 已被你手动删除或被管理员风控吊销

    常见问题

    Q:我能再次查看已创建 Key 的完整值吗? 不能。系统只保存哈希。请使用密码管理器保存,丢失后请删除并重新创建。
    Q:能用同一张 Key 在多台机器登录 IDE 吗? 技术上可以,但强烈建议每台设备 / 每个脚本一张独立 Key,便于按设备吊销,避免单点泄漏导致全部设备失效。
    Q:Key 调用是否独立计费? 所有 Key 的调用都计入同一个账号的套餐配额与用量统计——它们只是身份凭证,不是独立钱包。
    Q:为什么调用返回 401? 常见原因:Key 已被删除 / 已过期 / 复制时丢字符 / 误填到了第三方厂商的 Base URL(应填 proxyBaseUrl,而非 OpenAI 官方地址)。
    Q:我看到 "API key limit reached (20)" 怎么办?** 请先到本页删除不再使用的 Key,再创建新的。

    相关页面

  • 用户中心首页 —— 查看 proxyBaseUrl 与套餐概览
  • 用量详情 —— Key 的实时调用、Credits、费用统计
  • 账单 —— 升级套餐以提升配额
  • 安全设置 —— 修改密码、登录设备管理