Workflow ทดสอบ API (อัปเดต / เผยแพร่)
รองรับให้นักพัฒนานำเข้าการตั้งค่าไฟล์ .flow ที่สร้างจาก Skills ในเครื่องมือ AI เช่น CodeX, Claude (ที่ติดตั้ง GPTBots Agent Skill แล้ว) เข้าสู่ Workflow เป้าหมายบนแพลตฟอร์ม GPTBots และเผยแพร่ขึ้นใช้งานจริง
⚠️ เรียกใช้ได้เฉพาะ Workflow ใน «โหมดทดสอบ» เท่านั้น การเรียกใช้ในโหมดทางการจะคืนค่า
403200โหมดทดสอบจะถูกเลือกตอนสร้าง Workflow และไม่สามารถแก้ไขได้หลังจากสร้างแล้ว
Workflow อัปเดต API (นำเข้า .flow เพื่อแทนที่เวอร์ชันปัจจุบัน)
นำเข้าไฟล์ .flow เข้าสู่ Workflow เป้าหมาย (โหมดทดสอบ) แล้วบันทึกการตั้งค่าปัจจุบันที่ถูกแทนที่เป็นเวอร์ชันร่างใหม่ (และกลายเป็น «เวอร์ชันปัจจุบัน» ในเวลาเดียวกัน) โดยมีกฎดังต่อไปนี้:
- ฐานความรู้ (กลุ่มข้อมูล) / ตารางฐานข้อมูล / เอกสารความรู้ในโหนด: พิจารณาตามมิติ WorkflowID หากยังเป็นของ Workflow เป้าหมายจะถูกเก็บไว้ มิฉะนั้นจะถูกทิ้ง
- workflow / เครื่องมือ (ปลั๊กอิน) ที่เชื่อมโยง: พิจารณาตามมิติ องค์กร หากยังใช้งานได้จะถูกเก็บไว้ มิฉะนั้นจะถูกทิ้ง
- ข้อมูลรับรองจากบุคคลที่สาม: เมื่อนำเข้าสู่ Workflow ที่มีอยู่ จะเติมข้อมูลรับรองที่เป้าหมายตั้งค่าไว้กลับตาม «ID ของโหนด/ปลั๊กอินที่เหมือนกัน» โดยไม่ล้างโหนดที่ผ่านการยืนยันตัวตนแล้ว เพื่อให้มั่นใจว่าใช้งานได้
วิธีการร้องขอ
POST
URL สำหรับร้องขอ
https://api-${endpoint}.gptbots.ai/v1/workflow/version/import
การร้องขอ
ตัวอย่างการร้องขอ
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/workflow/version/import' \
-H 'Authorization: Bearer {WORKFLOW_API_KEY}' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@my-workflow.flow' \
-F 'versionDesc=Imported by AI tool'
Request Headers
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| Authorization | Bearer {API Key} | ใช้ Authorization: Bearer {API Key} เพื่อยืนยันตัวตนในการเรียกใช้ โปรดรับคีย์จากช่องทาง «Integration / API» ของ Workflow เป้าหมายเพื่อใช้เป็น API Key |
| Content-Type | multipart/form-data | ประเภทข้อมูล ต้องเป็น multipart/form-data |
พารามิเตอร์การร้องขอ
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| file | file | ใช่ | ไฟล์ .flow แบบไบนารี |
| versionDesc | text | ไม่ | คำอธิบายเวอร์ชัน |
หมายเลขเวอร์ชันถูกสร้างโดยอัตโนมัติที่ฝั่งเซิร์ฟเวอร์ (นำส่วนท้ายของเวอร์ชันล่าสุด +1 หากไม่มีเวอร์ชันในประวัติจะเป็น
1.0.0)
การตอบกลับ
ตัวอย่างการตอบกลับ
{
"code": 0,
"msg": "OK",
"data": {
"botId": "xxx",
"botType": "Workflow",
"version": "1.0.3"
}
}
การตอบกลับเมื่อสำเร็จ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| botId | string | ID ของ Workflow เป้าหมาย |
| botType | string | คงที่เป็น Workflow |
| version | string | หมายเลขเวอร์ชันที่บันทึกครั้งนี้ (คือเวอร์ชันปัจจุบัน) |
การตอบกลับเมื่อผิดพลาด
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| code | int | รหัสข้อผิดพลาด |
| msg | string | รายละเอียดข้อผิดพลาด |
Workflow เผยแพร่ API (เผยแพร่ตามหมายเลขเวอร์ชันเป็นเวอร์ชันออนไลน์)
เผยแพร่หมายเลขเวอร์ชันที่ระบุของ Workflow เป้าหมาย (โหมดทดสอบ) เป็นเวอร์ชันการผลิตออนไลน์ (เวอร์ชันนั้นจะกลายเป็น «ออนไลน์» ส่วนเวอร์ชันอื่น ๆ จะกลับสู่สถานะร่าง)
วิธีการร้องขอ
POST
URL สำหรับร้องขอ
https://api-${endpoint}.gptbots.ai/v1/workflow/version/release
การร้องขอ
ตัวอย่างการร้องขอ
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/workflow/version/release' \
-H 'Authorization: Bearer {WORKFLOW_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"version": "1.0.3"
}'
Request Headers
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| Authorization | Bearer {API Key} | ใช้ Authorization: Bearer {API Key} เพื่อยืนยันตัวตนในการเรียกใช้ โปรดรับคีย์จากช่องทาง «Integration / API» ของ Workflow เป้าหมายเพื่อใช้เป็น API Key |
| Content-Type | application/json | ประเภทข้อมูล ต้องเป็น application/json |
พารามิเตอร์การร้องขอ
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| version | string | ใช่ | หมายเลขเวอร์ชันที่ต้องการเผยแพร่เป็นออนไลน์ (เช่น 1.0.3) โดยปกติจะนำค่า version ที่คืนจากอินเทอร์เฟซ «อัปเดต» มาใช้ |
การตอบกลับ
ตัวอย่างการตอบกลับ
{
"code": 0,
"msg": "OK"
}
การตอบกลับเมื่อสำเร็จ
ไม่มีเนื้อหาข้อมูล หาก code เป็น 0 แสดงว่าเผยแพร่สำเร็จ
การตอบกลับเมื่อผิดพลาด
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| code | int | รหัสข้อผิดพลาด |
| msg | string | รายละเอียดข้อผิดพลาด |
รหัสข้อผิดพลาด
อินเทอร์เฟซอัปเดตและเผยแพร่ใช้ชุดรหัสข้อผิดพลาดเดียวกัน:
| Code | Message |
|---|---|
| 0 | สำเร็จ |
| 40348 | ไม่พบ Workflow |
| 403200 | ไม่ใช่โหมดทดสอบ: มีเพียง Workflow ในโหมดทดสอบเท่านั้นที่สามารถอัปเดตหรือเผยแพร่ด้วย API นี้ได้ |
| 403201 | ประเภทไฟล์ที่นำเข้าไม่ตรงกับประเภทของ Workflow เป้าหมาย |
| 403202 | แยกวิเคราะห์ไฟล์ .flow ที่นำเข้าไม่สำเร็จ |
| 403203 | ไม่พบหมายเลขเวอร์ชันที่ระบุ |
| 403204 | ประเภท API Key ไม่ตรงกับอินเทอร์เฟซ: อินเทอร์เฟซนี้รับเฉพาะ Workflow Key เท่านั้น |
| 40353 | จำนวนที่เผยแพร่เกินขีดจำกัดของแพ็กเกจ |
