Agent のインポート

.bot ファイルをアップロードして組織配下の Agent としてインポートできます。

本インターフェースを使用して、.bot ファイルをアップロードし、組織配下の Agent としてインポートできます。インポートに成功すると API Key が自動的に作成されますが、その Key はデフォルトでバージョン管理が無効になっています。

リクエストメソッド

POST

リクエストURL

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	サーバーエラー