建立 API Key

支援組織擁有者為組織內的 Agent 或 Workflow 建立 API Key。

可以透過此介面為指定的 Agent 或 Workflow 簽發新的 API Key，並設定該 Key 是否具備版本管理權限。建立成功後，可使用回傳的 API Key 調用該 Agent 或 Workflow 的資源級介面。

請求方式

POST

調用地址

https://api.${endpoint}/v1/org/api-key/create

調用驗證

使用帳號級 DevKey / DevSecret 的 Basic 鑑權，並要求調用帳號為該組織的擁有者。

請求

請求範例

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0",
    "is_publish": true
  }'

                    

請求標頭

請求參數（Body Parameters）

說明：

• agent_id 與 workflow_id 必須且只能傳入一個非空值；兩者都傳、都不傳或傳入空白字串時，回傳參數錯誤。
• 傳入的 ID 必須與資源類型一致：透過 agent_id 傳入 Workflow ID，或透過 workflow_id 傳入 Agent ID，會回傳類型不符錯誤。
• 每個 Agent 或 Workflow 最多擁有 10 個 API Key，達到上限後需先刪除既有 Key 再建立。
• 新建立的 API Key 名稱由系統自動產生，格式為 api- 加 12 位隨機字元，可在控制台的 API 金鑰頁面查看或修改。
• 此介面依帳號限流，每個帳號每分鐘最多調用 10 次。

回應

回應範例

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

                    

成功回應

請妥善保管回傳的 API Key。此介面回應標頭包含 Cache-Control: no-store，請勿在日誌或快取中留存明文 Key。

失敗回應

錯誤碼

狀態碼