นำเข้าสร้าง Agent
นำเข้าสร้าง Agent
รองรับการอัปโหลดไฟล์ .bot และนำเข้าเป็น Agent ภายใต้องค์กร
คุณสามารถใช้อินเทอร์เฟซนี้เพื่ออัปโหลดไฟล์ .bot และนำเข้าเป็น Agent ภายใต้องค์กร หลังจากนำเข้าสำเร็จ ระบบจะสร้าง API Key ให้โดยอัตโนมัติ แต่ Key นี้จะปิดการจัดการเวอร์ชันเป็นค่าเริ่มต้น
วิธีการร้องขอ
POST
URL สำหรับร้องขอ
https://api.${endpoint}/v1/org/agent/import
การยืนยันตัวตนในการร้องขอ
ใช้การยืนยันตัวตนแบบ Basic ด้วย DevKey / DevSecret ระดับบัญชี และกำหนดให้บัญชีที่เรียกใช้ต้องมีสิทธิ์สร้าง 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'
บล็อกโค้ดนี้ในหน้าต่างลอย
Header สำหรับร้องขอ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | Basic Token ที่ได้จากการเข้ารหัส Base64 ของ DevKey:DevSecret |
| 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 | ID ของ Agent หลังการนำเข้า |
| 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 | ข้อผิดพลาดของเซิร์ฟเวอร์ |
