Codex API 密钥，开发者指南

理解 API 密钥格式

当你注册提供 codex api key 的服务时，你会收到一个唯一的字母数字字符串。该密钥作为你发送到后端的每个请求的身份验证凭据。格式通常遵循标准模式，例如 sk-... 或类似前缀，具体取决于提供者的实现。然而，由于你使用的是独立代理，确切的前缀可能会有所不同。关键因素不是格式本身，而是确保密钥作为 Bearer <your_key> 正确传递到 HTTP Authorization 标头中。

你的 API 密钥与特定账户和使用层级绑定。与某些为不同环境（开发 vs 生产）生成多个密钥的服务不同，我们的设置很简单：一个账户，一个密钥。如果你丢失了密钥或怀疑它已泄露，你可以立即从仪表板重新生成它。这将立即撤销旧密钥，确保没有未经授权的访问持续存在。请记住，在轮换密钥时更新环境变量或配置文件。

安全最佳实践

• 将密钥存储在环境变量中，而不是源代码中。
• 切勿将你的 codex api key 提交到公共存储库。
• 如果怀疑密钥暴露，请使用重新生成功能。

常见错误：401 未授权

401 未授权错误是集成新 API 密钥时最常见的问题。它表明服务器拒绝了你的身份验证凭据。在 claude code proxy 或任何 OpenAI 兼容接口的上下文中，这几乎总是意味着密钥缺失、不正确或已过期。

要排查问题，首先验证你是否完全按照提供的内容复制了密钥。密钥通常区分大小写，如果复制不正确可能包含空格。确保你使用的是适用于你的区域或服务层级的正确基础 URL。如果你最近重新生成了密钥，请确保客户端使用的是新值。401 错误与你的使用余额或速率限制无关；它纯粹是身份验证失败。

解决检查清单

1. 确认 API 密钥字符串与仪表板完全匹配。
2. 验证 Authorization 头格式：Authorization: Bearer YOUR_KEY。
3. 检查基础 URL 是否适用于你的账户类型。
4. 确保复制粘贴时没有添加多余的空格。

超出速率限制：429 错误

当你超出允许的请求量时，API 返回 429 Too Many Requests 错误。对于我们的服务，限制设置为每密钥每分钟 300 次请求。此限制旨在确保公平使用并为所有用户保持低延迟。如果你运行高容量的编程会话，可能会很快达到此限制，特别是当你的代码触发多个内部请求时。

当发生 429 错误时，响应通常包含一个 Retry-After 标头，指示重试前应等待的秒数。在客户端代码中实现指数退避是优雅处理这些错误的标准方法。不要立即重试，而是等待一小段时间，然后加倍后续重试的等待时间。这可以防止你的应用程序在限制重置前向服务器发送大量请求。

需要注意的是，速率限制是按密钥计算的，而不是按账户。如果你有多个设备或进程使用同一个密钥，它们共享 300 次请求/分钟的预算。如果需要更高的聚合吞吐量，请考虑为不同环境使用单独的密钥。

正确配置基础 URL

基础 URL 是任何 API 集成的基础。对于 OpenAI 兼容服务，基础 URL 决定了你的请求发送到的位置。我们的基础 URL 是 https://api.claudecodeapikey.com/v1。在发起任何请求之前，必须在客户端库或 SDK 中配置此 URL。如果使用错误的基础 URL，你将收到连接错误或意外响应。

许多开发人员使用官方的 Python、Node.js 或其他语言的 OpenAI SDK。要切换到我们的代理，只需更新基础 URL 配置即可。例如，在 Python 中，你可能需要设置 base_url='https://api.claudecodeapikey.com/v1'。确保协议（https）和路径（/v1）正确。省略 /v1 路径是导致 404 错误的常见原因。

始终验证客户端是否向正确的接口发送请求。你可以通过检查网络日志或使用 curl 等工具测试连接来做到这一点。成功连接到基础 URL 确认你的配置是正确的。

处理流式响应

流式响应允许你接收 API 响应的一部分，而不是等待整个响应完成。这对于实时显示代码片段的编程代理至关重要。我们的 API 支持通过服务器发送事件 (SSE) 进行流式输出。当你在客户端启用流式输出时，你将收到一个块流，每个块包含部分响应。

要启用流式输出，请在请求中将 stream 参数设置为 true。客户端库将自动处理 SSE 协议。你可以处理每个到达的数据块，更新你的 UI 或记录进度。这能提供更好的用户体验，尤其是在生成长代码时。

流式输出不会改变底层模型或其功能。它纯粹是一种传输机制。模型仍然处理整个提示词并生成完整响应；区别在于输出如何交付给你的客户端。

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.claudecodeapikey.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

工具调用配置问题

工具调用（或函数调用）允许 LLM 请求特定操作，例如运行代码片段或查询数据库。我们的 API 支持工具调用，意味着你可以在请求中定义函数并从模型接收结构化的 JSON 响应。这对于需要与外部系统交互的高级编程代理至关重要。

要配置工具调用，你必须在 tools 参数中提供函数定义列表。每个工具应包含名称、描述和参数模式。然后，模型将根据提示词决定何时调用工具。如果模型决定调用工具，响应将包含一个 tool_calls 数组，其中包含函数名称和参数。

常见问题源于不正确的 JSON 模式定义。确保准确指定参数类型和必填字段。如果模式无效，模型可能无法正确调用工具。使用简单提示词测试你的工具定义，以验证模型是否理解预期行为。

上下文窗口限制

上下文窗口定义了模型在单个请求中可以处理的最大文本量，包括提示词（输入）和补全（输出）。我们的模型上下文窗口为 100,000 token。这是大量的文本，但并非无限。如果你的提示词加上预期输出超出此限制，API 将返回错误。

为了有效管理上下文，请监控提示词的 token 使用情况。长文件或广泛的对话历史可能会迅速消耗可用的 token。如果接近限制，请考虑截断较旧的消息或总结之前的交互。一些客户端通过滑动窗口自动处理此问题，但最好了解限制以避免意外错误。

请记住，上下文窗口包括发送给模型的所有 token，包括系统消息、用户消息和助手消息。相应地规划你的 token 预算，以确保在长编程会话期间顺利运行。

重新生成密钥

重新生成 API 密钥是一个简单的过程，可确保安全性。如果你怀疑密钥已泄露或想定期轮换凭据，可以从仪表板生成新密钥。旧密钥将立即失效，因此使用旧密钥进行的任何正在进行请求都将失败。

当你重新生成密钥时，请确保使用新值更新所有客户端和配置。这包括环境变量、配置文件以及代码中的任何硬编码值。如果未更新所有位置，可能会导致应用程序的部分出现身份验证错误。

我们的服务允许无限次重新生成密钥。频繁轮换密钥没有惩罚。这是保持安全的良好做法，特别是在共享环境中或向团队成员分发密钥时。

Copycurl https://api.claudecodeapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'