Skip to main content
PUT
Atualizar um assistente da etapa

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

step
string
required

ID da etapa do funil.

assistant
string
required

ID (UUID) do assistente de etapa.

Body

application/json

Configuração do assistente. Pelo menos um destino de resultado é obrigatório: result_as_media ou result_as_dynamic_form.

name
string
required

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

funnel_step_id
integer
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_id
string<uuid>
required

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

prompt
string
required

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

execute_on
enum<string>
required

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

Available options:
moved,
unlinked,
manual
active
boolean

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

manual_execution_enabled
boolean

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

failure_funnel_step_id
integer

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_media
boolean

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

result_as_dynamic_form
object

Grava o resultado em um campo de formulário dinâmico. Os identificadores são resolvidos a cada execução pela sintaxe avançada, então aceitam variáveis como {{ project.id }} e {{ step.id }} em vez de valores fixos. Obrigatório quando result_as_media não é enviado.

Response

200 - application/json

Sucesso

Assistente gravado. A etapa e o agente de IA não vêm carregados nesta resposta.

response
boolean
required

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

assistant
object
required

Assistente de etapa.