跳轉到

API Access

當你想讓自己的產品、後端服務,或內部流程系統直接呼叫 Agent 時,就該用 API access。

這不是初學者的預設路徑。當 Web 已經不夠,因為你想自己掌握 client experience 時,才是它最適合的時候。

工作空間中的 API access 畫面

步驟 1:在 workspace 打開 API Keys

API key 是以 workspace 為單位發出的。先進入目標 workspace,切到 API Keys

這一頁其實就是 operator workflow 和工程整合流程的交界:

  • operator 決定哪個 workspace、哪個 Agent 要被整合
  • 工程端再把 key 用到後端請求與產品整合裡

步驟 2:發出新 key

按下 Issue New Key

Issue New API Key 視窗

key 名稱請直接寫清楚用途,例如:

  • production-web-app
  • internal-automation
  • staging-checkout-pilot

如果只是短期測試,可以順手設定過期日。

完整 key 只會出現一次

請在建立當下立刻複製並妥善保存。若遺失,正確做法是重發新的 key,而不是嘗試找回舊的。

步驟 3:把 key 存進後端基礎設施

請把它當成正式憑證來管理:

  • 存在環境變數或 secret manager
  • 不要放進前端程式碼
  • 不要提交到版本控制
  • staging 和 production 分開用不同 key

步驟 4:開始整合並測試

key 發好之後,就往 API reference 和範例流程走:

官方範例:

步驟 5:有意識地輪替與撤銷 key

只要整合的 owner、環境或安全要求改變了,就應該發新 key,並把舊 key 撤銷。

幾個實務習慣很有幫助:

  • 用系統名稱和環境來命名 key
  • 沒有明確 owner 的 key 要清掉
  • 重大 production 轉換時主動輪替 key

相關指南