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 已核准的資料使用