API

ArchibotChat API 密钥

创建、复制、轮换和吊销生成的 API 密钥，并将外部协作工具连接到公开的 Archibot 端点。

客户管理员客户成员平台运维人员

最近更新 2026年6月18日

API 密钥让你能够从脚本、本地代理工具以及在托管工作区之外运行的集成中调用公开的 Archibot 端点。它们与驱动浏览器聊天界面的隐藏凭据是分开的，该凭据从不向用户显示。

托管的 Archibot 工作区已经自动配置了自己的密钥。仅在本地代理工具、编辑器扩展或应作为外部协作者调用 Archibot 的客户自有框架中使用生成的 API 密钥。

何时使用 API 密钥

在你需要执行以下操作时创建生成的密钥：

• 从脚本或计划作业中调用 Archibot。
• 将本地代理工具或编辑器扩展连接到端点。
• 针对 Archibot 端点运行 OpenAI 兼容客户端。
• 将工作区之外的客户自有框架连接到 Archibot。

对于交互式问题，请改用浏览器聊天界面。请参阅使用 ArchibotChat。

打开 API 密钥选项卡

1. 从左侧导航打开设置。
2. 选择 Archibot account 视图。
3. 打开 API Keys 选项卡。

该选项卡与 Setup、Git access、CI & Review、Support、Activity 和 Billing 位于同一行。如果该账户未启用 API 访问，选项卡会显示消息 API access is not enabled for this account.，并且 Create key 按钮处于禁用状态。请先请客户管理员或 ISM 启用 API 产品门控。请参阅 ArchibotChat 设置。

创建密钥

1. 在 API Keys 选项卡上，选择 Create key。
2. 新密钥出现在列表顶部，其完整值会在一个写着 Copy this key now. It will not be shown again. 的高亮提示框中显示一次。
3. 选择密钥值旁边的 Copy。
4. 将其存储在你已批准的密钥管理器或运行时环境中。

密钥会自动命名（例如 Console generated key 1）并被赋予 api 范围。原始值仅在此提示框中显示。一旦你离开该选项卡或创建另一个密钥，就只会保留可见的密钥前缀和元数据。

如果复制按钮无法访问你的剪贴板，选项卡会显示 Clipboard copy unavailable。在离开之前，请手动选择密钥文本并复制。

连接外部协作工具

External coworker access 卡片会构建一个可直接运行的设置脚本，因此你无需手动组装环境变量。

该卡片显示两个参考字段：

在这些字段下方，预览显示一个 shell 脚本，它导出端点和密钥环境变量并运行示例协作者命令。当你刚刚创建或轮换密钥时，脚本会包含该一次性密钥值；否则它会使用 <new-api-key> 占位符。

1. 创建或轮换密钥，使 Key source 字段显示 New one-time key included。
2. 在 External coworker access 卡片上选择 Copy setup。
3. 将脚本粘贴到你的本地 shell、密钥管理器或工具配置中。

该脚本会设置标准的 OpenAI 兼容变量（OPENAI_BASE_URL、OPENAI_API_KEY）以及 Archibot 协作者变量，以便 OpenAI 兼容客户端和 Archibot 协作者工具都使用相同的端点和密钥。请使用 ISM 为你的账户提供的生产端点 URL，而不要从本地示例中推断。

使用密钥

将密钥用作针对 Archibot OpenAI 兼容端点的 bearer 令牌。

curl https://chat.example.archibot.cloud/v1/responses \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "archibot",
    "input": "Summarize this Archibus request queue export."
  }'

在 API 密钥和额度检查通过后，该端点会将 OpenAI 兼容的 Responses API 字段（例如 tools、tool_choice、reasoning、metadata 和结构化的 input 内容）转发到 Archibot 端点。

对于流式响应，发送 stream: true：

curl -N https://chat.example.archibot.cloud/v1/responses \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "archibot",
    "input": "Draft a short work plan for this Archibus data cleanup.",
    "stream": true
  }'

流式响应通过 X-Archibot-* 响应标头返回计费凭据，而不是重写每个事件块。

OpenAI 兼容的模型发现使用相同的 bearer 密钥：

curl https://chat.example.archibot.cloud/v1/models \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY"

模型发现不会消耗你的使用额度。

速率限制

生成的 API 密钥具有按密钥的请求限制。响应包含 X-RateLimit-Limit、X-RateLimit-Remaining 和 X-RateLimit-Reset 标头。超过限制时，端点会返回 429 并带有 Retry-After 标头。

过期

生成的 API 密钥在创建一年后过期。每个密钥行会在密钥前缀旁边显示其创建、过期和上次使用的日期。

过期的密钥仍按名称、前缀和元数据可见，以便你审计旧的集成，但它们无法再调用模型发现或响应端点。过期密钥的拒绝发生在计入任何使用量之前。轮换过期的密钥以在相同名称和范围下签发替换密钥，或者如果该集成已停用，则将其吊销。

轮换密钥

当某个集成应在相同名称和范围下继续运行，但密钥值必须更改时，轮换密钥。

1. 在 API Keys 选项卡上，按名称或前缀找到活动密钥。
2. 在该密钥行上选择 Rotate。
3. 从一次性提示框中复制替换值。
4. 更新受影响的脚本、密钥管理器条目或运行时环境。

轮换会吊销之前的密钥并创建一个具有相同名称和范围的替换密钥。替换值仅在用于新密钥的同一提示框中显示一次。轮换会立即生效，没有单独的确认对话框，因此请在旧流量失败之前准备好更新该集成。

吊销密钥

在以下情况下吊销密钥：

• 它不再被使用。
• 它被粘贴到聊天、电子邮件、工单、仓库或共享文档中。
• 所有者离开团队。
• 该集成被替换。

1. 在 API Keys 选项卡上，按名称或前缀找到密钥。
2. 在该密钥行上选择 Revoke。
3. 更新或移除任何依赖它的脚本或集成。

吊销会立即生效，并且没有单独的确认对话框，因此在选择 Revoke 之前请确认该密钥是正确的那个。

计费

生成的 API 密钥从 Billing 中显示的同一共享聊天和 API 使用额度中扣除。失败的预检检查和被拒绝的上游请求不应消耗额度；一旦 Archibot 端点接受流，流式请求即开始计费。请参阅 ArchibotChat 计费与额度。

安全规则

• 切勿将 API 密钥提交到源代码管理。
• 切勿将 API 密钥粘贴到支持工单或共享文档中。
• 使用环境变量或密钥管理器，而不是内联值。
• 在可能的情况下，每个集成使用一个密钥。
• 对于长期运行的集成，定期轮换密钥。
• 如果怀疑泄露，请立即吊销密钥。

聊天凭据与 API 密钥对比

不要请 ISM 支持披露隐藏的聊天凭据。它被有意设置为对用户不可见。

相关指南

• ArchibotChat 设置
• 使用 ArchibotChat
• ArchibotChat 计费与额度
• ArchibotChat 安全概述
• ArchibotChat 已批准的数据使用