ตรวจสอบไฟล์นำเข้า Agent ล่วงหน้า
ตรวจสอบไฟล์นำเข้า Agent ล่วงหน้า
รองรับการตรวจสอบไฟล์ .bot ล่วงหน้าว่าสามารถนำเข้าได้หรือไม่ โดยไม่เขียนทรัพยากรทางธุรกิจ
คุณสามารถใช้อินเทอร์เฟซนี้เพื่อตรวจสอบล่วงหน้าว่าไฟล์ .bot สามารถนำเข้าได้หรือไม่ การตรวจสอบล่วงหน้าจะทำเพียงการแยกวิเคราะห์และสแกนความปลอดภัยของไฟล์เท่านั้น โดยไม่เขียน Agent, API Key, Skill, กลุ่มข้อมูล หรือความสัมพันธ์ของปลั๊กอิน
วิธีการร้องขอ
POST
URL สำหรับร้องขอ
https://api.${endpoint}/v1/org/agent/import/precheck
การยืนยันตัวตนในการร้องขอ
ใช้การยืนยันตัวตนแบบ Basic ด้วย DevKey / DevSecret ระดับบัญชี และกำหนดให้บัญชีที่เรียกใช้ต้องมีสิทธิ์สร้าง Agent ขององค์กร
การร้องขอ
ตัวอย่างการร้องขอ
curl -X POST 'https://api.${endpoint}/v1/org/agent/import/precheck' \
-H 'Authorization: Basic ${BASIC_TOKEN}' \
-F 'file=@/path/to/agent.bot' \
-F 'org_id=p-xxxx'
curl -X POST 'https://api.${endpoint}/v1/org/agent/import/precheck' \
-H 'Authorization: Basic ${BASIC_TOKEN}' \
-F 'file=@/path/to/agent.bot' \
-F 'org_id=p-xxxx'
บล็อกโค้ดนี้ในหน้าต่างลอย
Header สำหรับร้องขอ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | Basic Token ที่ได้จากการเข้ารหัส Base64 ของ DevKey:DevSecret |
| Content-Type | multipart/form-data | ฟอร์มสำหรับอัปโหลดไฟล์ |
พารามิเตอร์การร้องขอ (Form Data)
| พารามิเตอร์ | ประเภท | คำอธิบาย | required |
|---|---|---|---|
| file | File | ไฟล์ .bot |
true |
| org_id | String | ID ขององค์กร | true |
การตอบกลับ
ตัวอย่างการตอบกลับ
{
"code": 0,
"message": "OK",
"data": {
"valid": true,
"error_message": null,
"export_type": "BOT",
"bot_type": "Agent",
"name": "Imported Agent",
"logo": "https://cdn.example.com/agent.png",
"introduction": "Agent introduction",
"format_version": "1.0"
}
}
{
"code": 0,
"message": "OK",
"data": {
"valid": true,
"error_message": null,
"export_type": "BOT",
"bot_type": "Agent",
"name": "Imported Agent",
"logo": "https://cdn.example.com/agent.png",
"introduction": "Agent introduction",
"format_version": "1.0"
}
}
บล็อกโค้ดนี้ในหน้าต่างลอย
การตอบกลับเมื่อสำเร็จ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| valid | Boolean | ไฟล์สามารถนำเข้าได้หรือไม่ |
| error_message | String | ข้อความแสดงข้อผิดพลาดเมื่อไม่สามารถนำเข้าได้ |
| export_type | String | ประเภทไฟล์ที่ส่งออก |
| bot_type | String | ประเภท Agent: Agent, FlowAgent, LoopAgent, Audio |
| name | String | ชื่อทรัพยากรภายในไฟล์ |
| logo | String | URL ไอคอน |
| introduction | String | บทนำ |
| format_version | String | เวอร์ชันรูปแบบไฟล์ |
การตอบกลับเมื่อผิดพลาด
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| code | Integer | รหัสข้อผิดพลาด |
| message | String | รายละเอียดข้อผิดพลาด |
รหัสสถานะ
| รหัสสถานะ | คำอธิบาย |
|---|---|
| 200 | สำเร็จ |
| 400 | พารามิเตอร์ไม่ถูกต้อง |
| 401 | ไม่ได้รับอนุญาต |
| 403 | สิทธิ์ไม่เพียงพอ |
| 429 | คำขอถี่เกินไป |
| 500 | ข้อผิดพลาดของเซิร์ฟเวอร์ |
