Fluxos de trabalho

Lê as automações de workflow de uma instalação: os workflows, o grafo completo de um workflow, os tipos de nó que um grafo pode usar e modelos selecionados. Leia node_types antes de criar ou editar um grafo para que todos os tipos e parâmetros sejam válidos na instalação.

Ações:

• list: Listar workflows. Cada workflow com indicação de se está ativo, sua versão publicada, contagem de execuções, última execução e seus nós (id, name, type). Workflows de marca e de organização não são listados.
• get: Obter workflow. O grafo de rascunho completo (nós, conexões, notas, configurações) e meta: active, publishedVersionId e, depois de publicado, publishedWorkflow, o grafo que está ativo agora. Somente workflows desta instalação. Exige workflowId.
• node_types: Tipos de nó. Entradas da paleta com type, label, category, outputs (ramificações) e inputSchema, os parâmetros a preencher. available é false, com o motivo, quando falta à instalação um módulo de que o nó precisa. As ferramentas MCP aparecem como nós mcp...
• templates: Modelos. Pontos de partida para automações comuns, com risk e riskNote (o que dá errado se publicado sem cuidado), tipos de nó, módulos necessários, disponibilidade nesta instalação e um grafo de prévia. Transforme um deles em grafo com workflow_definitions_write instantiate_template.

Cria, edita, publica, interrompe e exclui as automações de workflow de uma instalação. Ciclo de criação: leia node_types com workflow_definitions_read, monte o grafo (ou comece com instantiate_template), crie-o como rascunho, experimente-o com workflow_runs_write test (simulado) e depois publique. Edições em um rascunho nunca alteram o que está ativo até que ele seja publicado.

Ações:

• create: Criar workflow. Salva um novo rascunho inativo a partir de um grafo completo com pelo menos um nó; name tem como padrão "Untitled workflow". Os problemas de validação voltam em errors com detalhes do nó. Exige nodes.
• update: Salvar rascunho. Substitui o rascunho inteiro: envie todos os nós e conexões, não apenas as alterações. O que está ativo continua em execução até você publicar. Os problemas de validação voltam em errors com detalhes do nó. Exige workflowId, nodes.
• patch_meta: Renomear. Altera apenas o nome ou a descrição; o grafo e o que está ativo permanecem como estão. changed é false quando ambos já correspondem. Exige workflowId.
• duplicate: Duplicar. Copia um workflow para um novo rascunho chamado " (copy)" com novos ids de nó, nunca publicado nem ativo. O original não é alterado. Exige workflowId.
• delete: Excluir. Exclui o workflow definitivamente: rascunho, versões publicadas, histórico de execuções e roteamento de gatilhos. set_active false o interrompe, mas o mantém; discard_draft apenas redefine as edições do rascunho. Exige workflowId. Pede confirmação.
• discard_draft: Descartar as edições do rascunho. Redefine o rascunho para a última versão publicada, descartando as edições feitas desde então. A versão ativa nunca é afetada; exige uma versão publicada. Exige workflowId. Pede confirmação.
• publish: Publicar. Valida o rascunho, salva-o como versão ativa e ativa o workflow, para que seus gatilhos disparem e suas ações sejam executadas de verdade. As execuções em andamento terminam na versão antiga. Se etapas Delay em espera tiverem o horário recalculado, o resultado terá o código WAIT_RETARGET_CONFIRMATION_REQUIRED e impacts: chame novamente com confirmWaitRetargets e esses impacts. Exige workflowId. Pede confirmação.
• set_active: Ativar ou desativar. active true reativa um workflow publicado. active false o interrompe: os gatilhos deixam de disparar e as etapas Delay pendentes são canceladas e nunca terminam. Nada é excluído. Pede confirmação antes, a menos que ele já esteja nesse estado. Exige workflowId, active. Pode pedir confirmação.
• instantiate_template: Grafo a partir de modelo. Transforma um modelo em um grafo pronto para create: { name, description, nodes, connections } com novos ids de nó. Os modelos deixam destinatários, portas e horários em branco de propósito; preencha-os antes. Não salva nada. Exige templateId.
• generate: Gerar grafo. Monta um grafo a partir de um prompt em linguagem simples com a IA da instalação e retorna { name, description, nodes, connections } usando apenas tipos de nó válidos. Passe workflow para revisar um; o grafo revisado completo é retornado. Não salva nada, mas consome os créditos de IA da instalação. Exige prompt. Pede confirmação.

O histórico de execuções de um workflow, das mais recentes para as mais antigas, e uma execução passo a passo. Use-o para verificar se uma automação foi executada, acompanhar uma execução iniciada com workflow_runs_write ou descobrir qual nó falhou e por quê.

Ações:

• list: Listar execuções. Cada execução com status, modo (live ou test), efeitos colaterais, gatilho, quem a iniciou, horários, contagem de etapas, o nó em que está aguardando e qualquer erro. Exige workflowId.
• get: Obter execução. O status da execução mais todas as etapas em ordem, com a entrada, saída, nota e erro de cada nó. As execuções são assíncronas: uma com Delays aguarda até a hora de sua continuação. Exige workflowId, executionId.

Inicia, testa, cancela e reexecuta execuções de workflow. Prefira test, que executa o rascunho com efeitos colaterais simulados; run executa o workflow publicado de verdade. As execuções são assíncronas: acompanhe-as com workflow_runs_read get.

Ações:

• run: Executar agora. Executa o workflow publicado a partir do seu gatilho manual (custom.manualTrigger), com efeitos colaterais reais. Gatilhos agendados, de webhook e de evento disparam sozinhos. Retorna o executionId da execução e o primeiro status. Exige workflowId. Pede confirmação.
• test: Testar rascunho. Executa o rascunho salvo sem publicá-lo, registrado como execução de teste. Os efeitos colaterais são simulados por padrão: nada é enviado nem acionado, e cada nó informa o que teria feito. sideEffects live pede confirmação antes. Exige workflowId. Pode pedir confirmação.
• cancel: Cancelar execução em espera. Cancela uma execução que aguarda um Delay: suas esperas pendentes são encerradas e as etapas seguintes nunca são executadas. Execuções concluídas e execuções no meio de uma etapa não podem ser canceladas. Exige workflowId, executionId. Pede confirmação.
• retry: Reexecutar. Reexecuta uma execução concluída a partir da entrada de gatilho registrada, vinculada por retryOf. published (padrão) executa novamente a versão usada, de verdade, e pede confirmação antes; draft-test executa o rascunho atual de forma simulada, a escolha certa ao corrigir uma falha. Exige workflowId, executionId. Pode pedir confirmação.