--- title: "Listar assistentes da etapa" method: GET path: "/api/management/steps/{step}/assistants" tags: ["step-assistants", "Assistentes"] --- # Listar assistentes da etapa `GET /api/management/steps/{step}/assistants` Lista os assistentes de uma etapa específica, do mesmo formato da listagem geral e já restrita à etapa informada. Aceita filtros e paginação por query params, consulte: - [Filtro básico](https://docs.olie.ai/api-reference/general/basic-filters) - [Paginação](https://docs.olie.ai/api-reference/general/pagination) Os campos de paginação (`current_page`, `per_page`, `total`, ...) vêm na raiz da resposta, ao lado de `data`, e não dentro de `meta` como no restante da API. ## Query parameters - `page` string - `perPage` string - `filter[name]` string - `filter[active]` string - `filter[funnel_step_id]` string - `filter[ai_agent_id]` string ## Response `200` Sucesso - object — Resposta paginada. Diferente do restante da API, os campos de paginação vêm na raiz, e não dentro de `meta`. - `current_page` integer, required — Página retornada. - `data` object[], required — Assistentes encontrados na página atual. - `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, nullable — 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\`. 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, nullable — Identificador do registro alvo, quando a classe se identifica por `id` (por exemplo `App\Models\Project`). - `project_id` string, nullable — ID do projeto alvo, quando a classe se identifica pelo projeto. - `funnel_step_id` string, nullable — ID da etapa alvo, quando a classe se identifica pela etapa. - `loose_form_id` string, nullable — ID do formulário avulso alvo, quando a classe se identifica por ele. - `project_funnel_id` string, nullable — ID do funil alvo, quando a classe se identifica por ele. - `failure_funnel_step_id` integer, nullable — 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, nullable — 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. - `first_page_url` string — Endereço da primeira página. - `from` integer, nullable — Posição do primeiro item da página no total. - `last_page` integer — Número da última página. - `last_page_url` string — Endereço da última página. - `links` object[] — Links de navegação prontos para uma barra de paginação. - `url` string, nullable — Endereço da página, ou `null` quando não há para onde ir. - `label` string — Rótulo do link, já traduzido. - `page` integer, nullable — Número da página do link. - `active` boolean — Indica se o link aponta para a página atual. - `next_page_url` string, nullable — Endereço da próxima página, ou `null` na última. - `path` string — Endereço base usado para montar os links. - `per_page` integer, required — Itens por página. - `prev_page_url` string, nullable — Endereço da página anterior, ou `null` na primeira. - `to` integer, nullable — Posição do último item da página no total. - `total` integer, required — Total de itens encontrados. ## Changes - **2026-08-24** `3c590152d5b5` — 12 breaking, 3 warning, 13 info - the response property `data/items/failure_funnel_step_id` became nullable for the status `200` - the response property `from` became nullable for the status `200` - the response property `to` became nullable for the status `200` - the `data/items/deleted_at` response's property type changed from no type to `string`, and format from no format to `date-time` for status `200` - …24 more - **2026-08-19** `d49d48cd1ce0` — 1 info - api tag `Assistentes` added - **2026-08-19** `69f9300dc045` — 1 info - added the media type `application/json` for the response with the status `200` - **2026-08-19** `3227b85304ca` — 6 info - added the new optional `query` request parameter `filter[active]` - added the new optional `query` request parameter `filter[ai_agent_id]` - added the new optional `query` request parameter `filter[funnel_step_id]` - added the new optional `query` request parameter `filter[name]` - …2 more [Change history](https://skmtc.dev/olie-ai/apis/olie-api/changes/api/management/steps/:step/assistants/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-service-production.skmtc.workers.dev/v1/apis/olie-ai/olie-api/revisions/85cb24130071/schema)