> ## Documentation Index
> Fetch the complete documentation index at: https://docs.4096bytes.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取 API Key

> 创建一个用于客户端接入的 4096bytes API Key

API Key 是客户端调用 4096bytes 的访问凭证。无论你要接入 Codex、Claude Code、Cursor、Cherry Studio，还是用其他工具统一管理多个客户端，都需要先创建一个可用的 API Key。

建议按客户端或设备分别创建 API Key。例如 Codex 一个、Cursor 一个、Cherry Studio 一个。这样你可以按工具查看消耗来源；如果某个客户端泄露，也只需要停用对应的 Key，不会影响其他工具。

<Warning>
  API Key 等同于账号调用凭证。公开 Key 可能导致额度被他人消耗。发现泄露后，请立即删除旧 Key 并重新创建。
</Warning>

## 进入 API 密钥页面

<Steps>
  <Step title="登录控制台">
    访问 [https://dash.4096bytes.com/login](https://dash.4096bytes.com/login)，并登录你的 4096bytes 账号。
  </Step>

  <Step title="打开 API 密钥">
    在左侧菜单进入 **API 密钥** 页面。
  </Step>

  <Step title="查看现有 Key">
    页面会显示当前账号下已经创建的 API Key。你可以刷新列表，也可以创建新的 Key。
  </Step>
</Steps>

<img src="https://mintcdn.com/4096bytes/92zL9C5RTBxmIwvG/images/screenshots/quickstart/get-api-key/02-api-key-page.png?fit=max&auto=format&n=92zL9C5RTBxmIwvG&q=85&s=d813230d0d6b7493db7c2dc814df6e0f" alt="API 密钥页面" width="2040" height="194" data-path="images/screenshots/quickstart/get-api-key/02-api-key-page.png" />

如果列表中已经有旧 Key，不建议直接复用到所有工具。更推荐按用途新建，例如 `claude-code-mac`、`codex-work`、`cursor-desktop`。

## 创建密钥

点击 **创建密钥** 后，控制台会打开创建弹窗。最少需要填写 **名称** 并选择 **分组**。其他开关默认可以保持关闭，等你有明确限制需求时再开启。

<img src="https://mintcdn.com/4096bytes/92zL9C5RTBxmIwvG/images/screenshots/quickstart/get-api-key/03-create-api-key.png?fit=max&auto=format&n=92zL9C5RTBxmIwvG&q=85&s=ccfd54ed00c4f4ffa09967870ae2dbfd" alt="创建密钥弹窗" width="768" height="906" data-path="images/screenshots/quickstart/get-api-key/03-create-api-key.png" />

<Steps>
  <Step title="填写名称">
    在 **名称** 中填写一个能看懂用途的名字，例如 `macbook-codex`、`cursor-work`、`cherry-studio-home`。
  </Step>

  <Step title="选择分组">
    在 **分组** 中选择这个 Key 要使用的模型线路、套餐或分组。不同分组的倍率、可用模型和额度规则可能不同，请以控制台展示为准。
  </Step>

  <Step title="保持自定义密钥关闭">
    **自定义密钥** 默认不需要开启。除非你明确知道为什么要固定 Key 字符串，否则建议使用系统自动生成的 Key。
  </Step>

  <Step title="按需开启 IP 限制">
    如果你只允许固定服务器或固定出口 IP 调用，可以开启 **IP 限制**。个人电脑、移动网络或经常切换网络的设备，一般不建议开启。
  </Step>

  <Step title="按需设置额度限制">
    **额度限制** 用于设置此密钥最多可消耗的 USD 金额。`0` 表示不限制。个人测试可以先保持不限制；给临时项目、团队成员或不常用设备时，建议设置较小额度。
  </Step>

  <Step title="按需设置速率限制">
    **速率限制** 用于限制请求频率或并发。只有在你需要防止某个工具异常消耗时，再开启这个选项。
  </Step>

  <Step title="按需设置有效期">
    **密钥有效期** 用于控制 Key 什么时候失效。临时测试 Key 建议设置过期时间；长期使用的本机工具可以保持长期有效。
  </Step>

  <Step title="创建并复制">
    确认后点击 **创建**。创建成功后立即复制 API Key，并保存到安全位置。
  </Step>
</Steps>

<Tip>
  API Key 通常只会完整展示一次。如果忘记保存，请删除旧 Key 后重新创建。
</Tip>

## 命名建议

| 场景            | 示例名称                 |
| ------------- | -------------------- |
| Codex CLI     | `codex-macbook`      |
| Claude Code   | `claude-code-work`   |
| Cursor        | `cursor-desktop`     |
| Cherry Studio | `cherry-studio-home` |

## 保存和使用

创建成功后，请把 Key 存到密码管理器、系统钥匙串，或只在本机可读的环境变量中。不要把 Key 写进公开仓库、截图、聊天记录或共享文档。

如果你要接入 Claude Code，可以在 API 密钥列表中查看是否有 **使用密钥** 入口。控制台可能会展示对应的环境变量或配置片段。

如果你使用支持导入的管理工具，可以查看控制台是否提供一键导入入口。具体名称和可用能力以控制台当前页面为准。

## 测试 Key 是否可用

创建后，优先用对应客户端的连接测试功能验证。也可以用 OpenAI 兼容接口测试当前 Key 是否能访问模型列表。

### macOS 或 Linux

在终端中运行下面的命令。

```bash theme={null}
curl "https://api.4096bytes.com/v1/models" \
  -H "Authorization: Bearer YOUR_4096BYTES_API_KEY"
```

### Windows PowerShell

在 PowerShell 中运行下面的命令。

```powershell theme={null}
Invoke-RestMethod `
  -Uri "https://api.4096bytes.com/v1/models" `
  -Headers @{ Authorization = "Bearer YOUR_4096BYTES_API_KEY" }
```

请把 `YOUR_4096BYTES_API_KEY` 替换为你刚创建的 API Key。

如果返回模型列表，说明 API Key 和 Base URL 基本可用。

如果测试失败，先检查下面几项。

| 检查项           | 说明                            |
| ------------- | ----------------------------- |
| Key 是否完整      | 复制时不要漏字符，也不要带上多余空格或换行。        |
| 分组是否可用        | 分组需要启用，并且包含你要调用的模型。           |
| 余额或额度         | 账号余额、订阅额度、Key 额度都可能影响请求。      |
| Base URL 是否正确 | 直接复制控制台显示的 Base URL，不要手动猜测路径。 |

## 后续维护

定期清理不用的 Key。长期不用、用途不明、疑似泄露的 Key 都应该禁用或删除。

删除 Key 后，已经配置到客户端里的旧 Key 会立即失效。你需要重新创建 Key，并更新对应客户端配置。

## 下一步

继续选择你要接入的客户端：[CC Switch](/clients/cc-switch)、[Codex](/clients/codex)、[Claude Code](/clients/claude-code)、[Cursor](/clients/cursor) 或 [Cherry Studio](/clients/cherry-studio)。
