> ## 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. # Obter um assistente da etapa > Retorna a configuração de um assistente, já com a etapa e o agente de IA associados. ## OpenAPI ````yaml /api-reference/openapi.json get /api/management/steps/{step}/assistants/{assistant} 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/{assistant}: parameters: - name: step in: path required: true description: ID da etapa do funil. schema: type: string example: '' - name: assistant in: path required: true description: ID (UUID) do assistente de etapa. schema: type: string example: '' get: tags: - step-assistants - Assistentes summary: Obter um assistente da etapa description: >- Retorna a configuração de um assistente, já com a etapa e o agente de IA associados. operationId: obterAssistenteDaEtapa responses: '200': description: Sucesso content: application/json: schema: description: Assistente consultado. type: object properties: response: type: boolean description: Sempre true quando a operação é concluída. assistant: 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. required: - response - assistant example: response: true assistant: 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 '404': description: Não encontrado content: application/json: schema: type: object properties: response: type: boolean description: Sempre false em respostas de erro. message: type: string description: >- Identificador do erro, usado pelo cliente para tratar o caso. error: type: string description: Descrição legível do erro. required: - response - message - error example: response: false message: step_assistant_model_not_found error: >- No query results for model [App\Models\StepAssistant] 9f1c4b02-6f3a-4b8e-9d21-7c5e0a41b8d3 components: securitySchemes: BearerAuth: type: http scheme: bearer ````