Sign in
step-assistants
Assistentes

Criar um assistente da etapa

Cria um assistente na etapa. Se active for verdadeiro, ele já entra em operação e passa a disparar no gatilho escolhido em execute_on: ao entrar na etapa (moved), ao sair dela (unlinked) ou somente sob demanda (manual).

É obrigatório indicar pelo menos um destino para o resultado: result_as_media grava como conteúdo do projeto e result_as_dynamic_form grava em um campo de formulário dinâmico. Os dois podem ser usados juntos.

A etapa do assistente é a do corpo (funnel_step_id) — é ela que vale, e não a da URL.

Cada execução consome créditos de IA. Veja Assistentes de etapa e Créditos de IA.

post/api/management/steps/{step}/assistants

Request body

namestring required

Nome do assistente. Obrigatório, até 255 caracteres.

activeboolean

Define se o assistente entra em operação. Padrão true.

funnel_step_idinteger required

ID da etapa do funil à qual o assistente pertence. Obrigatório — é este campo que vale, e não o ID da URL.

ai_agent_idstring uuid required

ID (UUID) do agente de IA que executa a tarefa. Obrigatório e precisa pertencer à mesma conta.

promptstring required

Instrução dada ao agente. Obrigatória. Aceita a sintaxe avançada, com dados do projeto e da etapa.

execute_on'moved' | 'unlinked' | 'manual' required

Gatilho do assistente: moved ao entrar na etapa, unlinked ao sair dela e manual só sob demanda.

manual_execution_enabledboolean

Permite disparar o assistente sob demanda mesmo com gatilho automático. Padrão false.

failure_funnel_step_idinteger

Etapa para onde o projeto vai se a execução falhar. Precisa ser da mesma conta e diferente de funnel_step_id. null deixa o projeto onde está.

result_as_mediaboolean

Grava o resultado como conteúdo do projeto. Obrigatório quando result_as_dynamic_form não é enviado.

Response

Criado

responseboolean required

Sempre true quando a operação é concluída.

Changes