匯入建立 Agent

支援上傳 .bot 檔案並匯入為組織下的 Agent。

可以透過該 API，上傳 .bot 檔案並匯入為組織下的 Agent。匯入成功後會自動建立 API Key，但該 Key 預設關閉版本管理。

請求方式

POST

調用地址

https://api.${endpoint}/v1/org/agent/import

調用驗證

使用帳號級 DevKey / DevSecret 的 Basic 驗證，並要求調用帳號具備組織 Agent 建立權限。

請求

請求範例

curl -X POST 'https://api.${endpoint}/v1/org/agent/import' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -F 'file=@/path/to/agent.bot' \ -F 'org_id=p-xxxx' \ -F 'custom_name=Imported Agent' \ -F 'enable_api=true' \ -F 'group_id=group-xxxx'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/agent/import' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -F 'file=@/path/to/agent.bot' \
  -F 'org_id=p-xxxx' \
  -F 'custom_name=Imported Agent' \
  -F 'enable_api=true' \
  -F 'group_id=group-xxxx'

此代碼塊在浮窗中顯示

請求標頭

欄位	類型	說明
Authorization	Basic ${BASIC_TOKEN}	使用 `DevKey:DevSecret` Base64 後的 Basic Token。
Content-Type	multipart/form-data	檔案上傳表單。

請求參數（Form Data）

參數	類型	說明	required
file	File	`.bot` 檔案。MultiAgent 檔案不支援。	true
org_id	String	組織 ID。	true
custom_name	String	匯入後的自訂 Agent 名稱。	false
enable_api	Boolean	是否嘗試開啟 API，預設 `true`。方案不支援 API 時匯入仍會成功，回傳 `api_enabled=false`。	false
group_id	String	匯入成功後加入指定 Agent 分組。	false

回應

回應範例

{ "code": 0, "message": "OK", "data": { "agent_id": "bot-xxxx", "name": "Imported Agent", "bot_type": "AGENT", "api_key": "app-xxxx", "api_enabled": true, "version_manage_enabled": false, "warning": null } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "agent_id": "bot-xxxx",
    "name": "Imported Agent",
    "bot_type": "AGENT",
    "api_key": "app-xxxx",
    "api_enabled": true,
    "version_manage_enabled": false,
    "warning": null
  }
}

此代碼塊在浮窗中顯示

成功回應

欄位	類型	說明
agent_id	String	匯入後的 Agent ID。
name	String	Agent 名稱。
bot_type	String	Agent 類型：`Agent`、`FlowAgent`、`LoopAgent`、`Audio`。
api_key	String	自動建立的 API Key，僅回傳一次。該 key 不具備發布權限，若需發布必須手動建立 Key。
api_enabled	Boolean	是否已開啟 API。
version_manage_enabled	Boolean	是否允許版本管理；匯入預設關閉。
warning	String	匯入警告。

失敗回應

欄位	類型	說明
code	Integer	錯誤碼。
message	String	錯誤詳情。

狀態碼

狀態碼	說明
200	成功
400	參數錯誤
401	未授權
403	權限不足
429	請求過於頻繁
500	伺服器錯誤