导入创建 Agent

支持上传 .bot 文件并导入为组织下的 Agent。

可以通过该接口，上传 .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	服务器错误