latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-1919701.3 MB

063de6e2e93c

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

activenumber
ai_agent_idstring
execute_onstring
failure_funnel_step_idstring
funnel_step_idnumber
manual_execution_enablednumber
namestring
promptstring
result_as_medianumber

Example request

{
  "active": 1,
  "ai_agent_id": "sample_text",
  "execute_on": "sample_text",
  "failure_funnel_step_id": "sample_text",
  "funnel_step_id": 3,
  "name": "sample_text",
  "prompt": "sample_text",
  "result_as_dynamic_form": {
    "edge_id": 9,
    "form_id": 8,
    "funnel_step_id": "sample_text",
    "id": "sample_text",
    "loose_form_id": "sample_text",
    "pivot_class": "sample_text",
    "project_funnel_id": "sample_text",
    "project_id": "sample_text"
  },
  "result_as_media": 1
}

Response

Criado

responseboolean