> ## Documentation Index > Fetch the complete documentation index at: https://docs.olie.ai/llms.txt > Use this file to discover all available pages before exploring further. # Listar assistentes da etapa > 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. ## OpenAPI ````yaml /api-reference/openapi.json get /api/management/steps/{step}/assistants openapi: 3.0.0 info: title: Olie API version: 1.0.0 description: > # Introdução 👋 Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/). Aqui você encontra as referências e exemplos de uso dos nossos endpoints. Para uma visão completa, recomendamos fortemente que você leia a [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá estão detalhados tópicos essenciais como [autenticação](https://docs.olie.ai/api-reference/introduction/authentication), [estrutura de respostas](https://docs.olie.ai/api-reference/general/response-structure), [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros guias de integração. No Postman, esta coleção foca nas informações específicas de cada requisição (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e desenvolvimento. servers: - url: https://api.olie.ai security: - BearerAuth: [] paths: /api/management/steps/{step}/assistants: parameters: - name: step in: path required: true description: ID da etapa do funil. schema: type: string example: '' get: tags: - step-assistants - Assistentes summary: Listar assistentes da etapa description: >- 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. operationId: listarAssistentesDeUmaEtapaEspecFica parameters: - name: page in: query description: Página desejada. Padrão `1`. schema: type: string example: '' - name: perPage in: query description: Itens por página. Padrão `30`, máximo `100`. schema: type: string example: '' - name: filter[name] in: query description: Trecho do nome do assistente. schema: type: string example: '' - name: filter[active] in: query description: '`1` retorna apenas os ativos, `0` apenas os inativos.' schema: type: string example: '' - name: filter[funnel_step_id] in: query description: ID da etapa do funil. Redundante aqui, já que a etapa vem da URL. schema: type: string example: '' - name: filter[ai_agent_id] in: query description: ID (UUID) do agente de IA que executa o assistente. schema: type: string example: '' responses: '200': description: Sucesso content: application/json: schema: description: >- Resposta paginada. Diferente do restante da API, os campos de paginação vêm na raiz, e não dentro de `meta`. type: object properties: current_page: type: integer description: Página retornada. data: type: array description: Assistentes encontrados na página atual. items: description: >- Assistente de etapa com a etapa e o agente de IA associados. type: object properties: id: type: string description: ID (UUID) do assistente. format: uuid name: type: string description: >- Nome do assistente, usado nas listas e nos registros de execução. active: type: boolean description: >- Indica se o assistente está em operação. Inativo, ele nunca dispara. funnel_step_id: type: integer description: ID da etapa do funil à qual o assistente pertence. ai_agent_id: type: string description: ID (UUID) do agente de IA que executa a tarefa. format: uuid prompt: type: string description: >- Instrução dada ao agente. Aceita a sintaxe avançada, com dados do projeto e da etapa. execute_on: type: string enum: - moved - unlinked - manual description: >- Gatilho do assistente: `moved` ao entrar na etapa, `unlinked` ao sair dela e `manual` só sob demanda. manual_execution_enabled: type: boolean description: >- Indica se o assistente também pode ser disparado sob demanda, mesmo tendo gatilho automático. result_as_media: type: boolean description: >- Indica se o resultado é gravado como conteúdo do projeto. result_as_dynamic_form: type: object description: >- Destino do resultado em campo de formulário dinâmico. `null` quando o assistente não grava em formulário. properties: pivot_class: type: string description: >- Classe do registro que guarda as respostas, no formato `App\Models\`. Define quais chaves de identificação abaixo são exigidas. form_id: type: integer description: >- ID do formulário dinâmico que receberá a resposta. edge_id: type: integer description: >- ID do campo do formulário que receberá o resultado gerado pelo assistente. id: type: string description: >- Identificador do registro alvo, quando a classe se identifica por `id` (por exemplo `App\Models\Project`). project_id: type: string description: >- ID do projeto alvo, quando a classe se identifica pelo projeto. funnel_step_id: type: string description: >- ID da etapa alvo, quando a classe se identifica pela etapa. loose_form_id: type: string description: >- ID do formulário avulso alvo, quando a classe se identifica por ele. project_funnel_id: type: string description: >- ID do funil alvo, quando a classe se identifica por ele. failure_funnel_step_id: type: integer description: >- Etapa para onde o projeto é movido quando a execução falha. `null` deixa o projeto onde está. created_at: type: string description: Data de criação. format: date-time updated_at: type: string description: Data da última alteração. format: date-time deleted_at: type: string description: Data de exclusão, quando o assistente foi removido. format: date-time funnel_step: type: object description: Etapa à qual o assistente pertence. properties: id: type: integer description: ID da etapa. name: type: string description: Nome da etapa. project_funnel_id: type: integer description: >- ID do funil dono da etapa. Presente apenas na listagem geral. ai_agent: type: object description: Agente de IA que executa o assistente. properties: id: type: string description: ID (UUID) do agente de IA. format: uuid name: type: string description: Nome do agente de IA. first_page_url: type: string description: Endereço da primeira página. from: type: integer description: Posição do primeiro item da página no total. last_page: type: integer description: Número da última página. last_page_url: type: string description: Endereço da última página. links: type: array description: Links de navegação prontos para uma barra de paginação. items: description: Link de navegação. type: object properties: url: type: string description: >- Endereço da página, ou `null` quando não há para onde ir. label: type: string description: Rótulo do link, já traduzido. page: type: integer description: Número da página do link. active: type: boolean description: Indica se o link aponta para a página atual. next_page_url: type: string description: Endereço da próxima página, ou `null` na última. path: type: string description: Endereço base usado para montar os links. per_page: type: integer description: Itens por página. prev_page_url: type: string description: Endereço da página anterior, ou `null` na primeira. to: type: integer description: Posição do último item da página no total. total: type: integer description: Total de itens encontrados. required: - current_page - data - per_page - total example: current_page: 1 data: - id: 9f1c4b02-6f3a-4b8e-9d21-7c5e0a41b8d3 name: Resumo do atendimento active: true funnel_step_id: 312 ai_agent_id: 2b7d94f6-0c31-4a85-b6e2-58f1c0d93a47 prompt: >- Resuma em até cinco linhas o histórico de conversas do projeto e destaque o que ficou pendente. execute_on: moved manual_execution_enabled: true result_as_media: true result_as_dynamic_form: null failure_funnel_step_id: 318 created_at: '2026-07-28T14:12:03.000000Z' updated_at: '2026-08-11T09:41:57.000000Z' deleted_at: null funnel_step: id: 312 name: Triagem ai_agent: id: 2b7d94f6-0c31-4a85-b6e2-58f1c0d93a47 name: Analista de atendimento - id: c4e2a7d1-58b6-4f09-a3c7-1e9d24b7f065 name: Classificar urgência active: false funnel_step_id: 312 ai_agent_id: 7a3f16c8-9e42-4d70-8b15-c2064ef3d891 prompt: >- Leia a descrição do projeto e responda apenas com uma das opções: baixa, média ou alta. execute_on: manual manual_execution_enabled: false result_as_media: false result_as_dynamic_form: pivot_class: App\Models\Project form_id: 118 edge_id: 2231 id: '{{project.id}}' failure_funnel_step_id: null created_at: '2026-08-02T10:03:44.000000Z' updated_at: '2026-08-02T10:03:44.000000Z' deleted_at: null funnel_step: id: 312 name: Triagem ai_agent: id: 7a3f16c8-9e42-4d70-8b15-c2064ef3d891 name: Classificador first_page_url: https://api.olie.ai/api/management/steps/312/assistants?page=1 from: 1 last_page: 1 last_page_url: https://api.olie.ai/api/management/steps/312/assistants?page=1 links: - url: null label: '« Anterior' page: null active: false - url: >- https://api.olie.ai/api/management/steps/312/assistants?page=1 label: '1' page: 1 active: true - url: null label: Próximo » page: null active: false next_page_url: null path: https://api.olie.ai/api/management/steps/312/assistants per_page: 30 prev_page_url: null to: 2 total: 2 components: securitySchemes: BearerAuth: type: http scheme: bearer ````