Para desenvolvedores
Usar workflows de IA como uma API
Ativar, verificar os resultados, responder às aprovações e buscar artefatos – em todo o REST, sem chamadas de modelo, repetições ou filas para se manter.
# Activar uma execução POST /api/webhooks/{id}/trigger → {"executionId": "exec_51a2"} # Situação da pesquisa: esta pausa na aprovação manual GET /api/v1/executions/exec_51a2 → {"status": "AWAITING_APPROVAL"} # Continuar após a aprovação (valores podem ser editados antes da aprovação) POST /api/v1/approvals/{approvalId}/approve Vai buscar o resultado e os artefactos uma vez feitos GET /api/v1/executions/exec_51a2/result GET /api/v1/executions/exec_51a2/artifacts
Caminho de integração
15 minutos, desde a criação de um Webhook até obter seu primeiro resultado
Quatro requisições HTTP executam todo o fluxo, nenhum SDK necessário; qualquer idioma que possa fazer requisições pode integrar.
01Criar um Webhook, obter o URL e chaveAdicione um gatilho Webhook ao seu workflow no console para obter uma URL dedicada; em seguida, crie uma chave API com o escopo WEBHOOK TRIGGER.
02Um POST dispara uma execuçãoOs campos JSON de nível superior mapeiam automaticamente as variáveis de workflow com o mesmo nome, ou você pode mapear explicitamente com a variávelMapping; a carga útil é fechada em 1MB.
03Pesquisa o estado da execução e obtém o resultadoUse o executionId retornado para verificar detalhes de execução; uma vez feito, obtenha a saída do endpoint do resultado e baixe arquivos do endpoint de artefatos.
04Ações que necessitam de revisão humana passam pela API de aprovaçãoA execução pausa em uma etapa de aprovação manual; use os endpoints de aprovação para listar itens pendentes e aprovar ou rejeitar, e na rejeição ou tempo limite nada muda.
Passo 2: envie um POST do seu sistema curl -X POST https://your-host/api/webhooks/{id}/trigger \ -H "X-API-Key: <your-api-key>" \ -d '{"ticket_id": "T-1024", "lang": "zh"}' # Campos de nível superior mapeiam automaticamente as variáveis de workflow do mesmo nome → {"executionId": "exec_51a2"} # Passo 3: status da pesquisa e obter o resultado uma vez feito curl https://your-host/api/v1/executions/exec_51a2/result \ -H "X-API-Key: <your-api-key>"
Lista de capacidades
Seis coisas que os desenvolvedores se importam
Passos de código Sandboxed em 7 idiomasEscreva em Python, JavaScript, TypeScript, Bash, Ruby, Lua ou CLI; as variáveis são injetadas como variáveis de ambiente WF VAR *, o tempo limite padrão é de 30 segundos, e em produção é executado em uma caixa de areia Docker com saída controlada.
Definições YAML que se encaixam no seu workflow GitUm workflow é um único arquivo YAML: commit, diff e roll back tudo acontece no repo que você já conhece; o canvas e YAML permanecem em sincronização bidirecional, então edite ambos os lados.
MCP para conectar suas próprias ferramentasEnrole um serviço interno como um Servidor MCP e anexá-lo a um Agente, e as etapas de IA podem chamar seu sistema diretamente, sem esperar que a plataforma construa um conector.
Depurador com breakpoints9 tipos de breakpoint pausam em um hit para que você possa editar variáveis e continuar; após uma falha, reexecute de um passo especificado, com os passos LLM completados não faturados novamente.
14-endpoint v1 API, menos privilégioAcionar execuções, verificar resultados, responder a aprovações e baixar artefatos cada um tem seu próprio escopo de permissão; combinar os 6 escopos conforme necessário e emitir cada sistema conectado sua própria chave.
Gatilhos acorrentados com COMPLEÇÃO DELAYEDApós A terminar, B dispara automaticamente N segundos depois, com uma tampa maxRuns setable; dividir um longo processo em segmentos, cada um com seus próprios logs e custo.
Limites honestos
Três coisas, disse de antemão
Então você não descobre metade através da integração.
Sem centenas de conectores SaaSChamados para sistemas externos vão em passos de código, ou embrulhá-los como ferramentas MCP anexados a um Agente; para uma equipe que escreve código, este passo é apenas algumas linhas de solicitações HTTP.
Nenhuma API de estimativa de custos pré- executadaO uso e o custo do token de cada execução são registrados por execução, então a contabilidade pós-fato é granular; mas não há citação antes de ser executado, então o controle do orçamento depende de portas de aprovação e maxRuns.
Limites claramente avançadosA carga útil do Webhook está limitada a 1MB; passos de código padrão para 30 segundos; assinaturas HMAC-SHA256 são mantidas apenas como um modo de compatibilidade, e novas integrações usam API Key.
Docs
Três vale a pena ler antes de integrar
v1 Referência da APICampos de solicitação e resposta e códigos de erro para os 14 endpoints, além de como configurar os 6 escopos de permissão.Abrir os documentos →Acionamento por WebhookObtendo o URL e chave, regras de mapeamento variável, o modo de compatibilidade HMAC e o limite de 1MB.Abrir os documentos →Sintaxe YAMLOs tipos de 8 passos, além de como escrever modificadores como condição, repetição e aprovação manual.Abrir os documentos →
Conecte seu primeiro workflow ao seu sistema
O plano Livre permite criar um workflow e executá-lo manualmente; atualizar para Pro quando você precisar Webhook gatilhos e agendamento.