---
title: "Obter um assistente da etapa"
method: GET
path: "/api/management/steps/{step}/assistants/{assistant}"
tags: ["step-assistants", "Assistentes"]
---

# Obter um assistente da etapa

`GET /api/management/steps/{step}/assistants/{assistant}`

Retorna a configuração de um assistente, já com a etapa e o agente de IA associados.

## Response `200`

Sucesso

- object — Assistente consultado.
  - `response` boolean, required — Sempre true quando a operação é concluída.
  - `assistant` object, required — Assistente de etapa com a etapa e o agente de IA associados.
    - `id` string, uuid — ID (UUID) do assistente.
    - `name` string — Nome do assistente, usado nas listas e nos registros de execução.
    - `active` boolean — Indica se o assistente está em operação. Inativo, ele nunca dispara.
    - `funnel_step_id` integer — ID da etapa do funil à qual o assistente pertence.
    - `ai_agent_id` string, uuid — ID (UUID) do agente de IA que executa a tarefa.
    - `prompt` string — Instrução dada ao agente. Aceita a sintaxe avançada, com dados do projeto e da etapa.
    - `execute_on` 'moved' | 'unlinked' | 'manual' — Gatilho do assistente: `moved` ao entrar na etapa, `unlinked` ao sair dela e `manual` só sob demanda.
    - `manual_execution_enabled` boolean — Indica se o assistente também pode ser disparado sob demanda, mesmo tendo gatilho automático.
    - `result_as_media` boolean — Indica se o resultado é gravado como conteúdo do projeto.
    - `result_as_dynamic_form` object — Destino do resultado em campo de formulário dinâmico. `null` quando o assistente não grava em formulário.
      - `pivot_class` string — Classe do registro que guarda as respostas, no formato `App\Models\<Modelo>`. Define quais chaves de identificação abaixo são exigidas.
      - `form_id` integer — ID do formulário dinâmico que receberá a resposta.
      - `edge_id` integer — ID do campo do formulário que receberá o resultado gerado pelo assistente.
      - `id` string — Identificador do registro alvo, quando a classe se identifica por `id` (por exemplo `App\Models\Project`).
      - `project_id` string — ID do projeto alvo, quando a classe se identifica pelo projeto.
      - `funnel_step_id` string — ID da etapa alvo, quando a classe se identifica pela etapa.
      - `loose_form_id` string — ID do formulário avulso alvo, quando a classe se identifica por ele.
      - `project_funnel_id` string — ID do funil alvo, quando a classe se identifica por ele.
    - `failure_funnel_step_id` integer — Etapa para onde o projeto é movido quando a execução falha. `null` deixa o projeto onde está.
    - `created_at` string, date-time — Data de criação.
    - `updated_at` string, date-time — Data da última alteração.
    - `deleted_at` string, date-time — Data de exclusão, quando o assistente foi removido.
    - `funnel_step` object — Etapa à qual o assistente pertence.
      - `id` integer — ID da etapa.
      - `name` string — Nome da etapa.
      - `project_funnel_id` integer — ID do funil dono da etapa. Presente apenas na listagem geral.
    - `ai_agent` object — Agente de IA que executa o assistente.
      - `id` string, uuid — ID (UUID) do agente de IA.
      - `name` string — Nome do agente de IA.

## Other responses

- `404` — Não encontrado

## Changes

- **2026-08-24** `3c590152d5b5` — 3 breaking, 3 warning, 14 info
  - the response property `assistant/failure_funnel_step_id` became nullable for the status `200`
  - the `assistant/deleted_at` response's property type changed from no type to `string`, and format from no format to `date-time` for status `200`
  - the `assistant/result_as_dynamic_form` response's property type changed from no type to `object` for status `200`
  - added the new `manual` enum value to the `assistant/execute_on` response property for the response status `200`
  - …16 more
- **2026-08-19** `d49d48cd1ce0` — 1 info
  - api tag `Assistentes` added
- **2026-08-19** `69f9300dc045` — 2 info
  - added the media type `application/json` for the response with the status `200`
  - added the non-success response with the status `404`

[Change history](https://skmtc.dev/olie-ai/apis/olie-api/changes/api/management/steps/:step/assistants/:assistant/get.md)

---

[API](https://skmtc.dev/olie-ai/apis/olie-api.md) · [All operations](https://skmtc.dev/olie-ai/apis/olie-api/llms.txt) · [OpenAPI document](https://skmtc.dev/olie-ai/apis/olie-api/revisions/d7bda7d32f67?raw)