Aliran Kerja
Platform Terasworkflow_definitions_readAliran KerjaMembaca automasi workflow sesebuah kemudahan: workflow, graf penuh satu workflow, jenis nod yang boleh digunakan oleh graf, dan templat pilihan. Baca node_types sebelum membina atau mengedit graf supaya setiap jenis dan parameter sah di kemudahan itu.
Tindakan:
- list: Senaraikan workflow. Setiap workflow dengan maklumat sama ada ia langsung, versi yang diterbitkan, bilangan larian, larian terakhir dan nodnya (id, name, type). Workflow jenama dan organisasi tidak disenaraikan.
- get: Dapatkan workflow. Graf draf penuh (nodes, connections, notes, settings) dan meta: active, publishedVersionId dan, setelah diterbitkan, publishedWorkflow, iaitu graf yang langsung sekarang. Hanya workflow kemudahan ini. Memerlukan workflowId.
- node_types: Jenis nod. Entri palet dengan type, label, category, outputs (cabang) dan inputSchema, iaitu parameter yang perlu diisi. available bernilai false, berserta sebabnya, apabila kemudahan tidak mempunyai modul yang diperlukan oleh nod itu. Alat MCP dipaparkan sebagai nod mcp.
. . - templates: Templat. Titik permulaan untuk automasi biasa, dengan risk dan riskNote (perkara yang boleh menjadi salah jika diterbitkan secara cuai), jenis nod, modul yang diperlukan, ketersediaan di kemudahan ini dan graf pratonton. Tukar templat menjadi graf dengan workflow_definitions_write instantiate_template.
Parameter
| Nama | Jenis | Penerangan |
|---|---|---|
action* | "list" | "get" | "node_types" | "templates" | Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat. |
limit | integer | Item setiap halaman (lalai 25, maksimum 100) (list, node_types, templates) |
cursor | string | nextCursor daripada halaman sebelumnya (list, node_types, templates) |
facilityId | string | ID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan. |
workflowId | string | ID workflow daripada workflow_definitions_read list (get) |
query | string | Perkataan untuk dicari dalam jenis, label, penerangan atau istilah carian (node_types) |
category | string | Kategori ini sahaja: trigger, action, logic atau ai (node_types) |
types | array | Jenis tepat yang hendak diterangkan, cth. jenis dalam workflow yang sedang anda edit. Termasuk jenis yang telah dihentikan dan tidak lagi dipaparkan oleh palet; mengabaikan query dan category. (node_types) |
workflow_definitions_writeAliran KerjaMencipta, mengedit, menerbitkan, menghentikan dan memadam automasi workflow sesebuah kemudahan. Kitaran penulisan: baca node_types dengan workflow_definitions_read, bina graf (atau mulakan daripada instantiate_template), cipta sebagai draf, cuba dengan workflow_runs_write test (disimulasikan), kemudian terbitkan. Suntingan pada draf tidak pernah mengubah versi langsung sehingga ia diterbitkan.
Tindakan:
- create: Cipta workflow. Menyimpan draf baharu yang tidak aktif daripada graf penuh dengan sekurang-kurangnya satu nod; name lalai kepada "Untitled workflow". Masalah pengesahan dikembalikan dalam errors dengan butiran nod. Memerlukan nodes.
- update: Simpan draf. Menggantikan keseluruhan draf: hantar setiap nod dan sambungan, bukan perubahan sahaja. Versi langsung terus berjalan sehingga anda menerbitkan. Masalah pengesahan dikembalikan dalam errors dengan butiran nod. Memerlukan workflowId, nodes.
- patch_meta: Namakan semula. Hanya mengubah nama atau penerangan; graf dan versi langsung kekal seperti sedia ada. changed bernilai false apabila kedua-duanya sudah sepadan. Memerlukan workflowId.
- duplicate: Duplikasi. Menyalin workflow ke dalam draf baharu bernama "
(copy)" dengan ID nod baharu, tidak pernah diterbitkan atau aktif. Yang asal tidak disentuh. Memerlukan workflowId. - delete: Padam. Memadam workflow secara kekal: draf, versi yang diterbitkan, sejarah larian dan penghalaan pencetus. set_active false menghentikannya tetapi mengekalkannya; discard_draft hanya menetapkan semula suntingan draf. Memerlukan workflowId. Meminta pengesahan.
- discard_draft: Buang suntingan draf. Menetapkan semula draf kepada versi terakhir yang diterbitkan, membuang suntingan yang dibuat sejak itu. Versi langsung tidak pernah terjejas; memerlukan versi yang diterbitkan. Memerlukan workflowId. Meminta pengesahan.
- publish: Terbitkan. Mengesahkan draf, menyimpannya sebagai versi langsung dan menghidupkan workflow, supaya pencetusnya dicetuskan dan tindakannya dijalankan secara sebenar. Larian yang sedang berjalan selesai pada versi lama. Jika langkah Delay yang sedang menunggu akan dijadualkan semula masanya, hasilnya mempunyai code WAIT_RETARGET_CONFIRMATION_REQUIRED dan impacts: panggil semula dengan confirmWaitRetargets dan impacts tersebut. Memerlukan workflowId. Meminta pengesahan.
- set_active: Hidupkan atau matikan. active true menghidupkan semula workflow yang diterbitkan. active false menghentikannya: pencetus berhenti dicetuskan dan langkah Delay yang belum selesai dibatalkan supaya tidak akan selesai. Tiada apa-apa yang dipadam. Meminta pengesahan dahulu melainkan ia sudah berada dalam keadaan itu. Memerlukan workflowId, active. Mungkin meminta pengesahan.
- instantiate_template: Graf daripada templat. Menukar templat menjadi graf yang sedia untuk create: { name, description, nodes, connections } dengan ID nod baharu. Templat sengaja membiarkan penerima, pintu dan masa kosong; isikannya dahulu. Tidak menyimpan apa-apa. Memerlukan templateId.
- generate: Jana graf. Membina graf daripada gesaan bahasa biasa dengan AI kemudahan dan mengembalikan { name, description, nodes, connections } menggunakan jenis nod yang sah sahaja. Hantar workflow untuk menyemak semula satu workflow; graf penuh yang disemak semula akan dikembalikan. Tidak menyimpan apa-apa, tetapi menggunakan kredit AI kemudahan. Memerlukan prompt. Meminta pengesahan.
Parameter
| Nama | Jenis | Penerangan |
|---|---|---|
action* | "create" | "update" | "patch_meta" | "duplicate" | "delete" | "discard_draft" | "publish" | "set_active" | "instantiate_template" | "generate" | Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat. |
name | string | Nama workflow (create, update, patch_meta) |
description | string | Fungsi workflow (create, update, patch_meta) |
nodes | array | Setiap nod: { id, name, type, position, parameters }. Jenis dan parameter diambil daripada workflow_definitions_read node_types. (create, update) |
connections | object | Sambungan dikunci mengikut nama nod sumber; boleh kosong untuk satu nod (create, update) |
notes | array | Nota kanvas (create, update) |
settings | object | Tetapan workflow (create, update) |
facilityId | string | ID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan. |
workflowId | string | ID workflow daripada workflow_definitions_read list (update, patch_meta, duplicate, delete, discard_draft, publish, set_active) |
confirmWaitRetargets | boolean | Jadualkan semula masa langkah Delay yang sedang menunggu yang disenaraikan dalam impacts hasil sebelumnya (publish) |
confirmedWaitRetargets | array | impacts daripada hasil WAIT_RETARGET_CONFIRMATION_REQUIRED, dihantar semula tanpa diubah (publish) |
active | boolean | true untuk menghidupkannya, false untuk menghentikannya (set_active) |
templateId | string | ID templat daripada workflow_definitions_read templates (instantiate_template) |
prompt | string | Perkara yang perlu dilakukan oleh workflow (generate) |
workflow | object | Workflow penuh daripada workflow_definitions_read get, untuk disemak semula dan bukannya bermula dari awal (generate) |
confirm | boolean | Tetapkan hanya selepas pengguna mengesahkan pratonton yang dikembalikan oleh panggilan pertama |
workflow_runs_readAliran KerjaSejarah larian workflow, yang terbaharu dahulu, dan satu larian langkah demi langkah. Gunakannya untuk menyemak sama ada automasi telah dijalankan, mengikuti larian yang dimulakan dengan workflow_runs_write, atau mencari nod yang gagal dan sebabnya.
Tindakan:
- list: Senaraikan larian. Setiap larian dengan status, mod (live atau test), kesan sampingan, pencetus, siapa yang memulakannya, masa, bilangan langkah, nod yang sedang ditunggu dan sebarang ralat. Memerlukan workflowId.
- get: Dapatkan larian. Status larian serta setiap langkah mengikut urutan, dengan input, output, nota dan ralat setiap nod. Larian adalah tak segerak: larian dengan Delay menunggu sehingga sambungannya tiba masanya. Memerlukan workflowId, executionId.
Parameter
| Nama | Jenis | Penerangan |
|---|---|---|
action* | "list" | "get" | Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat. |
workflowId | string | ID workflow daripada workflow_definitions_read list |
limit | integer | Item setiap halaman (lalai 25, maksimum 100) (list) |
cursor | string | nextCursor daripada halaman sebelumnya (list) |
facilityId | string | ID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan. |
executionId | string | ID larian daripada workflow_runs_read list (get) |
workflow_runs_writeAliran KerjaMemulakan, menguji, membatalkan dan memainkan semula larian workflow. Utamakan test, yang menjalankan draf dengan kesan sampingan disimulasikan; run melaksanakan workflow yang diterbitkan secara sebenar. Larian adalah tak segerak: ikutinya dengan workflow_runs_read get.
Tindakan:
- run: Jalankan sekarang. Menjalankan workflow yang diterbitkan daripada pencetus manualnya (custom.manualTrigger), dengan kesan sampingan sebenar. Pencetus berjadual, webhook dan peristiwa dicetuskan dengan sendirinya. Mengembalikan executionId larian dan status pertamanya. Memerlukan workflowId. Meminta pengesahan.
- test: Uji draf. Menjalankan draf yang disimpan tanpa menerbitkannya, direkodkan sebagai larian ujian. Kesan sampingan disimulasikan secara lalai: tiada apa-apa yang dihantar atau ditukar, dan setiap nod melaporkan apa yang akan dilakukannya. sideEffects live akan meminta pengesahan dahulu. Memerlukan workflowId. Mungkin meminta pengesahan.
- cancel: Batalkan larian yang sedang menunggu. Membatalkan larian yang sedang menunggu pada Delay: penantian yang belum selesai ditutup dan langkah selepasnya tidak akan dijalankan. Larian yang telah selesai dan larian yang berada di tengah-tengah langkah tidak boleh dibatalkan. Memerlukan workflowId, executionId. Meminta pengesahan.
- retry: Main semula larian. Memainkan semula larian yang telah selesai daripada input pencetus yang direkodkan, dipautkan semula melalui retryOf. published (lalai) menjalankan semula versi yang digunakannya, secara sebenar, dan meminta pengesahan dahulu; draft-test menjalankan draf semasa secara simulasi, pilihan yang betul semasa membaiki kegagalan. Memerlukan workflowId, executionId. Mungkin meminta pengesahan.
Parameter
| Nama | Jenis | Penerangan |
|---|---|---|
action* | "run" | "test" | "cancel" | "retry" | Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat. |
workflowId | string | ID workflow daripada workflow_definitions_read list |
nodeId | string | ID nod pencetus untuk dimulakan; tinggalkan untuk pencetus manual (run, test) |
payload | object | Input untuk nod selepas pencetus, cth. { "visitorName": "Ada" } (run, test) |
facilityId | string | ID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan. |
sideEffects | "simulate" | "live" | Sama ada tindakan nod benar-benar berlaku (test) |
executionId | string | ID larian daripada workflow_runs_read list (cancel, retry) |
mode | "published" | "draft-test" | Perkara yang hendak dimainkan semula (retry) |
confirm | boolean | Tetapkan hanya selepas pengguna mengesahkan pratonton yang dikembalikan oleh panggilan pertama |