Рабочие процессы

Основная платформа
workflow_definitions_readРабочие процессы

Читает автоматизации рабочих процессов объекта: рабочие процессы, полный граф одного рабочего процесса, типы узлов, доступные для графа, и подобранные шаблоны. Прочитайте node_types перед созданием или изменением графа, чтобы каждый тип и параметр был допустим на объекте.

Действия:

  • list: Список рабочих процессов. Каждый рабочий процесс с признаком активности, опубликованной версией, числом запусков, последним запуском и узлами (id, name, type). Рабочие процессы бренда и организации не перечисляются.
  • get: Получить рабочий процесс. Полный граф черновика (nodes, connections, notes, settings) и meta: active, publishedVersionId и после публикации publishedWorkflow — граф, действующий сейчас. Только рабочие процессы этого объекта. Требуется workflowId.
  • node_types: Типы узлов. Элементы палитры с type, label, category, outputs (ветви) и inputSchema — параметрами для заполнения. available равно false с указанием причины, если на объекте нет модуля, необходимого узлу. Инструменты MCP отображаются как узлы mcp...
  • templates: Шаблоны. Отправные точки для типичных автоматизаций с risk и riskNote (что может пойти не так при неосторожной публикации), типами узлов, необходимыми модулями, доступностью на этом объекте и графом предварительного просмотра. Превратите шаблон в граф с помощью workflow_definitions_write instantiate_template.

Параметры

ИмяТипОписание
action*"list" | "get" | "node_types" | "templates"Что сделать; каждое действие описано в описании инструмента.
limitintegerЭлементов на странице (по умолчанию 25, не более 100) (list, node_types, templates)
cursorstringnextCursor с предыдущей страницы (list, node_types, templates)
facilityIdstringID объекта. Необязателен, если имеется в виду подключённый объект.
workflowIdstringID рабочего процесса из workflow_definitions_read list (get)
querystringСлова для поиска в типе, метке, описании или поисковых терминах (node_types)
categorystringТолько эта категория: trigger, action, logic или ai (node_types)
typesarrayТочные типы для описания, например типы в изменяемом рабочем процессе. Включает выведенные из употребления типы, которых больше нет в палитре; query и category игнорируются. (node_types)
workflow_definitions_writeРабочие процессы

Создаёт, изменяет, публикует, останавливает и удаляет автоматизации рабочих процессов объекта. Порядок работы: прочитайте node_types с помощью workflow_definitions_read, постройте граф (или начните с instantiate_template), создайте его как черновик, опробуйте с помощью workflow_runs_write test (в режиме имитации), затем опубликуйте. Изменения черновика не влияют на действующую версию, пока он не опубликован.

Действия:

  • 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 будет пересчитано, результат содержит код 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"Что сделать; каждое действие описано в описании инструмента.
namestringНазвание рабочего процесса (create, update, patch_meta)
descriptionstringЧто делает рабочий процесс (create, update, patch_meta)
nodesarrayВсе узлы: { id, name, type, position, parameters }. Типы и параметры берутся из workflow_definitions_read node_types. (create, update)
connectionsobjectСвязи с ключами по названию исходного узла; может быть пустым для одного узла (create, update)
notesarrayЗаметки на холсте (create, update)
settingsobjectНастройки рабочего процесса (create, update)
facilityIdstringID объекта. Необязателен, если имеется в виду подключённый объект.
workflowIdstringID рабочего процесса из workflow_definitions_read list (update, patch_meta, duplicate, delete, discard_draft, publish, set_active)
confirmWaitRetargetsbooleanПересчитать время ожидающих шагов Delay, перечисленных в impacts предыдущего результата (publish)
confirmedWaitRetargetsarrayimpacts из результата WAIT_RETARGET_CONFIRMATION_REQUIRED, отправленные обратно без изменений (publish)
activebooleantrue, чтобы включить, false, чтобы остановить (set_active)
templateIdstringID шаблона из workflow_definitions_read templates (instantiate_template)
promptstringЧто должен делать рабочий процесс (generate)
workflowobjectПолный рабочий процесс из workflow_definitions_read get, чтобы доработать его, а не начинать с нуля (generate)
confirmbooleanЗадавайте только после того, как пользователь подтвердил предпросмотр, возвращённый первым вызовом
workflow_runs_readРабочие процессы

История запусков рабочего процесса, сначала новые, и пошаговый просмотр одного запуска. Используйте, чтобы проверить, выполнялась ли автоматизация, отследить запуск, начатый с помощью workflow_runs_write, или найти, какой узел дал сбой и почему.

Действия:

  • list: Список запусков. Каждый запуск со статусом, режимом (live или test), побочными эффектами, триггером, инициатором, временем, числом шагов, узлом, на котором он ожидает, и ошибкой, если есть. Требуется workflowId.
  • get: Получить запуск. Статус запуска и все шаги по порядку с input, output, note и error каждого узла. Запуски асинхронны: запуск с шагами Delay ожидает, пока не наступит время продолжения. Требуются workflowId, executionId.

Параметры

ИмяТипОписание
action*"list" | "get"Что сделать; каждое действие описано в описании инструмента.
workflowIdstringID рабочего процесса из workflow_definitions_read list
limitintegerЭлементов на странице (по умолчанию 25, не более 100) (list)
cursorstringnextCursor с предыдущей страницы (list)
facilityIdstringID объекта. Необязателен, если имеется в виду подключённый объект.
executionIdstringID запуска из workflow_runs_read list (get)
workflow_runs_writeРабочие процессы

Запускает, тестирует, отменяет и повторяет запуски рабочих процессов. Предпочитайте test, который выполняет черновик с имитацией побочных эффектов; run выполняет опубликованный рабочий процесс по-настоящему. Запуски асинхронны: отслеживайте их с помощью workflow_runs_read get.

Действия:

  • run: Запустить сейчас. Запускает опубликованный рабочий процесс с его ручного триггера (custom.manualTrigger) с реальными побочными эффектами. Триггеры по расписанию, веб-хуку и событию срабатывают сами. Возвращает executionId запуска и первый статус. Требуется workflowId. Запрашивает подтверждение.
  • test: Протестировать черновик. Выполняет сохранённый черновик без публикации, записывая его как тестовый запуск. По умолчанию побочные эффекты имитируются: ничего не отправляется и не переключается, а каждый узел сообщает, что он сделал бы. Для sideEffects live сначала запрашивается подтверждение. Требуется workflowId. Может запросить подтверждение.
  • cancel: Отменить ожидающий запуск. Отменяет запуск, ожидающий на шаге Delay: его ожидания закрываются, а последующие шаги никогда не выполняются. Завершённые запуски и запуски в середине шага отменить нельзя. Требуются workflowId, executionId. Запрашивает подтверждение.
  • retry: Повторить запуск. Повторяет завершённый запуск с записанными входными данными триггера, связывая его через retryOf. published (по умолчанию) повторно выполняет использованную версию по-настоящему и сначала запрашивает подтверждение; draft-test выполняет текущий черновик в режиме имитации — правильный выбор при исправлении сбоя. Требуются workflowId, executionId. Может запросить подтверждение.

Параметры

ИмяТипОписание
action*"run" | "test" | "cancel" | "retry"Что сделать; каждое действие описано в описании инструмента.
workflowIdstringID рабочего процесса из workflow_definitions_read list
nodeIdstringID узла триггера, с которого начинать; не указывайте для ручного триггера (run, test)
payloadobjectВходные данные для узлов после триггера, например { "visitorName": "Ada" } (run, test)
facilityIdstringID объекта. Необязателен, если имеется в виду подключённый объект.
sideEffects"simulate" | "live"Выполняются ли действия узлов на самом деле (test)
executionIdstringID запуска из workflow_runs_read list (cancel, retry)
mode"published" | "draft-test"С чем выполнять повтор (retry)
confirmbooleanЗадавайте только после того, как пользователь подтвердил предпросмотр, возвращённый первым вызовом