เวิร์กโฟลว์
แพลตฟอร์มหลักworkflow_definitions_readเวิร์กโฟลว์อ่านเวิร์กโฟลว์อัตโนมัติของสถานที่: เวิร์กโฟลว์ กราฟทั้งหมดของเวิร์กโฟลว์หนึ่งรายการ ประเภทโหนดที่กราฟใช้ได้ และเทมเพลตที่คัดสรรไว้ อ่าน node_types ก่อนสร้างหรือแก้ไขกราฟ เพื่อให้ทุกประเภทและพารามิเตอร์ใช้ได้ที่สถานที่
การดำเนินการ:
- list: แสดงรายการเวิร์กโฟลว์ แต่ละเวิร์กโฟลว์พร้อมสถานะว่าใช้งานจริงหรือไม่ เวอร์ชันที่เผยแพร่ จำนวนการทำงาน การทำงานล่าสุด และโหนด (id, name, type) ไม่แสดงเวิร์กโฟลว์ระดับแบรนด์และองค์กร
- get: ดูเวิร์กโฟลว์ กราฟฉบับร่างทั้งหมด (โหนด การเชื่อมต่อ บันทึก การตั้งค่า) และ meta: active, publishedVersionId และเมื่อเผยแพร่แล้วจะมี publishedWorkflow ซึ่งเป็นกราฟที่ใช้งานจริงในขณะนี้ เฉพาะเวิร์กโฟลว์ของสถานที่นี้ ต้องระบุ workflowId
- node_types: ประเภทโหนด รายการในจานเครื่องมือพร้อม type, label, category, outputs (สาขา) และ inputSchema ซึ่งเป็นพารามิเตอร์ที่ต้องกรอก available เป็น false พร้อมเหตุผล เมื่อสถานที่ไม่มีโมดูลที่โหนดต้องใช้ เครื่องมือ MCP จะแสดงเป็นโหนด mcp.
. - templates: เทมเพลต จุดเริ่มต้นสำหรับระบบอัตโนมัติทั่วไป พร้อม risk และ riskNote (สิ่งที่อาจผิดพลาดหากเผยแพร่โดยไม่ระมัดระวัง) ประเภทโหนด โมดูลที่จำเป็น ความพร้อมใช้งานที่สถานที่นี้ และกราฟตัวอย่าง แปลงเทมเพลตเป็นกราฟด้วย instantiate_template ของ workflow_definitions_write
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "list" | "get" | "node_types" | "templates" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
limit | integer | จำนวนรายการต่อหน้า (ค่าเริ่มต้น 25 สูงสุด 100) (list, node_types, templates) |
cursor | string | nextCursor จากหน้าก่อนหน้า (list, node_types, templates) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
workflowId | string | ID ของเวิร์กโฟลว์จาก list ของ workflow_definitions_read (get) |
query | string | คำที่จะค้นหาใน type, label, คำอธิบาย หรือคำค้นหา (node_types) |
category | string | เฉพาะหมวดหมู่นี้: trigger, action, logic หรือ ai (node_types) |
types | array | ประเภทที่ตรงกันทุกตัวอักษรที่จะอธิบาย เช่น ประเภทในเวิร์กโฟลว์ที่คุณกำลังแก้ไข รวมถึงประเภทที่เลิกใช้แล้วซึ่งจานเครื่องมือไม่แสดงอีก โดยไม่สนใจ query และ category (node_types) |
workflow_definitions_writeเวิร์กโฟลว์สร้าง แก้ไข เผยแพร่ หยุด และลบเวิร์กโฟลว์อัตโนมัติของสถานที่ ขั้นตอนการสร้าง: อ่าน node_types ด้วย workflow_definitions_read สร้างกราฟ (หรือเริ่มจาก instantiate_template) สร้างเป็นฉบับร่าง ทดลองด้วย test ของ workflow_runs_write (แบบจำลอง) แล้วจึงเผยแพร่ การแก้ไขฉบับร่างจะไม่เปลี่ยนสิ่งที่ใช้งานจริงจนกว่าจะเผยแพร่
การดำเนินการ:
- create: สร้างเวิร์กโฟลว์ บันทึกฉบับร่างใหม่ที่ไม่ได้ใช้งานจากกราฟทั้งหมดที่มีอย่างน้อยหนึ่งโหนด name มีค่าเริ่มต้นเป็น "Untitled workflow" ปัญหาการตรวจสอบความถูกต้องจะส่งกลับมาใน errors พร้อมรายละเอียดโหนด ต้องระบุ nodes
- update: บันทึกฉบับร่าง แทนที่ฉบับร่างทั้งหมด: ส่งทุกโหนดและการเชื่อมต่อ ไม่ใช่เฉพาะส่วนที่เปลี่ยน สิ่งที่ใช้งานจริงจะทำงานต่อไปจนกว่าคุณจะเผยแพร่ ปัญหาการตรวจสอบความถูกต้องจะส่งกลับมาใน errors พร้อมรายละเอียดโหนด ต้องระบุ workflowId, nodes
- patch_meta: เปลี่ยนชื่อ เปลี่ยนเฉพาะชื่อหรือคำอธิบาย กราฟและสิ่งที่ใช้งานจริงคงเดิม changed เป็น false เมื่อทั้งสองค่าตรงกันอยู่แล้ว ต้องระบุ workflowId
- duplicate: ทำสำเนา คัดลอกเวิร์กโฟลว์เป็นฉบับร่างใหม่ชื่อ "
(copy)" พร้อม ID โหนดใหม่ ไม่เผยแพร่และไม่เปิดใช้งาน ต้นฉบับไม่ถูกแตะต้อง ต้องระบุ workflowId - delete: ลบ ลบเวิร์กโฟลว์อย่างถาวร: ฉบับร่าง เวอร์ชันที่เผยแพร่ ประวัติการทำงาน และการกำหนดเส้นทางทริกเกอร์ set_active false จะหยุดเวิร์กโฟลว์แต่ยังคงเก็บไว้ ส่วน discard_draft จะรีเซ็ตเฉพาะการแก้ไขฉบับร่าง ต้องระบุ workflowId ขอการยืนยัน
- discard_draft: ยกเลิกการแก้ไขฉบับร่าง รีเซ็ตฉบับร่างเป็นเวอร์ชันที่เผยแพร่ล่าสุด โดยทิ้งการแก้ไขที่ทำหลังจากนั้น เวอร์ชันที่ใช้งานจริงจะไม่ได้รับผลกระทบ ต้องมีเวอร์ชันที่เผยแพร่แล้ว ต้องระบุ workflowId ขอการยืนยัน
- publish: เผยแพร่ ตรวจสอบความถูกต้องของฉบับร่าง บันทึกเป็นเวอร์ชันที่ใช้งานจริง และเปิดใช้งานเวิร์กโฟลว์ เพื่อให้ทริกเกอร์ทำงานและการดำเนินการเกิดขึ้นจริง การทำงานที่กำลังดำเนินอยู่จะเสร็จสิ้นด้วยเวอร์ชันเดิม หากขั้นตอน Delay ที่กำลังรอจะถูกปรับเวลาใหม่ ผลลัพธ์จะมี code WAIT_RETARGET_CONFIRMATION_REQUIRED และ impacts: ให้เรียกอีกครั้งพร้อม confirmWaitRetargets และ impacts เหล่านั้น ต้องระบุ workflowId ขอการยืนยัน
- set_active: เปิดหรือปิด active true จะเปิดเวิร์กโฟลว์ที่เผยแพร่แล้วอีกครั้ง active false จะหยุดเวิร์กโฟลว์: ทริกเกอร์หยุดทำงาน และขั้นตอน Delay ที่รออยู่จะถูกยกเลิกจึงไม่มีวันเสร็จสิ้น ไม่มีสิ่งใดถูกลบ จะขอการยืนยันก่อน เว้นแต่อยู่ในสถานะนั้นอยู่แล้ว ต้องระบุ workflowId, active อาจขอการยืนยัน
- instantiate_template: สร้างกราฟจากเทมเพลต แปลงเทมเพลตเป็นกราฟที่พร้อมสำหรับ create: { name, description, nodes, connections } พร้อม ID โหนดใหม่ เทมเพลตจงใจเว้นผู้รับ ประตู และเวลาไว้ว่าง ให้กรอกก่อน ไม่มีการบันทึกใด ๆ ต้องระบุ templateId
- generate: สร้างกราฟอัตโนมัติ สร้างกราฟจากคำสั่งภาษาธรรมดาด้วย AI ของสถานที่ และส่งคืน { name, description, nodes, connections } โดยใช้เฉพาะประเภทโหนดที่ใช้ได้ ส่ง workflow เพื่อปรับปรุงเวิร์กโฟลว์ที่มีอยู่ ระบบจะส่งกราฟที่ปรับปรุงแล้วทั้งหมดกลับมา ไม่มีการบันทึกใด ๆ แต่จะใช้เครดิต AI ของสถานที่ ต้องระบุ prompt ขอการยืนยัน
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "create" | "update" | "patch_meta" | "duplicate" | "delete" | "discard_draft" | "publish" | "set_active" | "instantiate_template" | "generate" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
name | string | ชื่อเวิร์กโฟลว์ (create, update, patch_meta) |
description | string | สิ่งที่เวิร์กโฟลว์ทำ (create, update, patch_meta) |
nodes | array | ทุกโหนด: { id, name, type, position, parameters } ประเภทและพารามิเตอร์มาจาก node_types ของ workflow_definitions_read (create, update) |
connections | object | การเชื่อมต่อที่ใช้ชื่อโหนดต้นทางเป็นคีย์ อาจว่างได้หากมีโหนดเดียว (create, update) |
notes | array | บันทึกบนแคนวาส (create, update) |
settings | object | การตั้งค่าเวิร์กโฟลว์ (create, update) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
workflowId | string | ID ของเวิร์กโฟลว์จาก list ของ workflow_definitions_read (update, patch_meta, duplicate, delete, discard_draft, publish, set_active) |
confirmWaitRetargets | boolean | ปรับเวลาใหม่ให้ขั้นตอน Delay ที่กำลังรอซึ่งแสดงใน impacts ของผลลัพธ์ก่อนหน้า (publish) |
confirmedWaitRetargets | array | impacts จากผลลัพธ์ WAIT_RETARGET_CONFIRMATION_REQUIRED ที่ส่งกลับโดยไม่เปลี่ยนแปลง (publish) |
active | boolean | true เพื่อเปิด false เพื่อหยุด (set_active) |
templateId | string | ID ของเทมเพลตจาก templates ของ workflow_definitions_read (instantiate_template) |
prompt | string | สิ่งที่เวิร์กโฟลว์ควรทำ (generate) |
workflow | object | เวิร์กโฟลว์ทั้งหมดจาก get ของ workflow_definitions_read เพื่อปรับปรุงแทนการเริ่มใหม่ (generate) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |
workflow_runs_readเวิร์กโฟลว์ประวัติการทำงานของเวิร์กโฟลว์ เรียงจากใหม่ไปเก่า และรายละเอียดการทำงานหนึ่งครั้งทีละขั้นตอน ใช้เพื่อตรวจสอบว่าระบบอัตโนมัติทำงานหรือไม่ ติดตามการทำงานที่เริ่มด้วย workflow_runs_write หรือหาว่าโหนดใดล้มเหลวและเพราะเหตุใด
การดำเนินการ:
- list: แสดงรายการการทำงาน การทำงานแต่ละครั้งพร้อมสถานะ โหมด (live หรือ test) ผลข้างเคียง ทริกเกอร์ ผู้เริ่ม เวลา จำนวนขั้นตอน โหนดที่กำลังรอ และข้อผิดพลาด ต้องระบุ workflowId
- get: ดูการทำงาน สถานะของการทำงานพร้อมทุกขั้นตอนตามลำดับ โดยมีอินพุต เอาต์พุต บันทึก และข้อผิดพลาดของแต่ละโหนด การทำงานเป็นแบบอะซิงโครนัส: การทำงานที่มี Delay จะรอจนกว่าจะถึงเวลาทำงานต่อ ต้องระบุ workflowId, executionId
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "list" | "get" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
workflowId | string | ID ของเวิร์กโฟลว์จาก list ของ workflow_definitions_read |
limit | integer | จำนวนรายการต่อหน้า (ค่าเริ่มต้น 25 สูงสุด 100) (list) |
cursor | string | nextCursor จากหน้าก่อนหน้า (list) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
executionId | string | ID ของการทำงานจาก list ของ workflow_runs_read (get) |
workflow_runs_writeเวิร์กโฟลว์เริ่ม ทดลอง ยกเลิก และเล่นซ้ำการทำงานของเวิร์กโฟลว์ ควรใช้ test ซึ่งเรียกใช้ฉบับร่างโดยจำลองผลข้างเคียง ส่วน run จะเรียกใช้เวิร์กโฟลว์ที่เผยแพร่แล้วจริง การทำงานเป็นแบบอะซิงโครนัส: ติดตามด้วย get ของ workflow_runs_read
การดำเนินการ:
- run: เรียกใช้ทันที เรียกใช้เวิร์กโฟลว์ที่เผยแพร่แล้วจากทริกเกอร์แบบเรียกใช้ด้วยตนเอง (custom.manualTrigger) พร้อมผลข้างเคียงจริง ทริกเกอร์แบบกำหนดเวลา webhook และเหตุการณ์จะทำงานเอง ส่งคืน executionId ของการทำงานและสถานะแรก ต้องระบุ workflowId ขอการยืนยัน
- test: ทดสอบฉบับร่าง เรียกใช้ฉบับร่างที่บันทึกไว้โดยไม่เผยแพร่ และบันทึกเป็นการทำงานแบบทดสอบ ผลข้างเคียงจะถูกจำลองโดยค่าเริ่มต้น: ไม่มีการส่งหรือสลับสิ่งใด และแต่ละโหนดจะรายงานสิ่งที่จะทำ sideEffects live จะขอการยืนยันก่อน ต้องระบุ workflowId อาจขอการยืนยัน
- cancel: ยกเลิกการทำงานที่รออยู่ ยกเลิกการทำงานที่รอ Delay: การรอที่ค้างอยู่จะปิด และขั้นตอนถัดไปจะไม่ทำงาน การทำงานที่เสร็จแล้วและการทำงานที่อยู่ระหว่างขั้นตอนยกเลิกไม่ได้ ต้องระบุ workflowId, executionId ขอการยืนยัน
- retry: เล่นซ้ำการทำงาน เล่นซ้ำการทำงานที่เสร็จแล้วจากอินพุตทริกเกอร์ที่บันทึกไว้ โดยเชื่อมโยงกลับผ่าน retryOf published (ค่าเริ่มต้น) จะเรียกใช้เวอร์ชันที่ใช้ครั้งนั้นซ้ำจริงและขอการยืนยันก่อน draft-test จะเรียกใช้ฉบับร่างปัจจุบันแบบจำลอง ซึ่งเหมาะเมื่อกำลังแก้ไขความล้มเหลว ต้องระบุ workflowId, executionId อาจขอการยืนยัน
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
action* | "run" | "test" | "cancel" | "retry" | สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ |
workflowId | string | ID ของเวิร์กโฟลว์จาก list ของ workflow_definitions_read |
nodeId | string | ID ของโหนดทริกเกอร์ที่จะเริ่ม ไม่ต้องส่งเพื่อใช้ทริกเกอร์แบบเรียกใช้ด้วยตนเอง (run, test) |
payload | object | อินพุตสำหรับโหนดหลังทริกเกอร์ เช่น { "visitorName": "Ada" } (run, test) |
facilityId | string | ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่ |
sideEffects | "simulate" | "live" | การดำเนินการของโหนดเกิดขึ้นจริงหรือไม่ (test) |
executionId | string | ID ของการทำงานจาก list ของ workflow_runs_read (cancel, retry) |
mode | "published" | "draft-test" | สิ่งที่จะใช้เล่นซ้ำ (retry) |
confirm | boolean | ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น |