--- title: "Usando o Eddy AI na referência da API" slug: "using-eddy-ai-in-the-api-reference" updated: 2026-08-03T07:59:16Z published: 2026-08-03T07:59:16Z canonical: "docs.document360.com/using-eddy-ai-in-the-api-reference" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.document360.com/llms.txt > Use this file to discover all available pages before exploring further. # Usando o Eddy AI na referência da API O Eddy AI está embutido na sua referência publicada da API, para que os desenvolvedores possam fazer perguntas sobre um endpoint e obter respostas sem sair da documentação. Em vez de juntar como um endpoint funciona apenas a partir dos parâmetros, esquema e exemplo de código, um desenvolvedor pode perguntar diretamente ao Eddy — como o endpoint se comporta, qual autenticação ele precisa, ou um exemplo de código em uma linguagem específica — e obter uma resposta baseada na própria especificação desse endpoint. Este artigo explica como os desenvolvedores usam o Eddy AI na referência da API e como habilitá-lo para a documentação da sua API. Para uma visão geral da experiência do leitor, veja *fundamentos da API*. --- ## Onde encontrar a IA do Eddy O Eddy AI está disponível diretamente nos painéis em uma página de endpoint. Procure o ícone **Ask Eddy AI** em cada um dos seguintes dispositivos: - **Painel de código** — pergunte sobre o exemplo de solicitação, por exemplo, para explicá-lo ou convertê-lo para outra linguagem. - **Painel de solicitações** — pergunte sobre o pedido que você está construindo no Try It!. - **Painel de resposta** — pergunte sobre a resposta, como o que significa um campo ou status específico. Clicar no ícone abre o painel de IA do Eddy, que já está direcionado para o ponto final que você está visualizando. ![The Ask Eddy AI icon shown on the Code and Response panels of an endpoint page.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/Ask-eddy-ai-in-api-docs.png) --- ## Fazendo uma pergunta Ao abrir o Eddy AI, pode escolher um dos prompts sugeridos ou digitar sua própria pergunta. Os prompts sugeridos são: - **Explique esse ponto final** - **Mostre um exemplo de curl** - **Qual autenticação isso precisa?** Para perguntar outra coisa, digite sua pergunta no campo **Faça uma pergunta...** e envie. Eddy responde usando a especificação do endpoint atual, então suas respostas refletem o caminho real, parâmetros, autenticação e esquema desse endpoint — não exemplos genéricos. Por exemplo, pedir um exemplo de solicitação em uma linguagem específica retorna um trecho pronto para uso criado para aquele endpoint, incluindo sua URL correta e autenticação, com um controle para copiar o código. --- ## Ativando o Eddy AI para a documentação da sua API O Eddy AI deve ser ativado na documentação da sua API antes de aparecer na referência publicada. Isso é configurado por um administrador no portal da Knowledge Base. 1. Vá em **Configurações** > **configurações de IA** > **configurações de IA do Eddy**. 2. Na seção **do Search suite** , selecione a caixa **de seleção de documentação da API** . 3. Salve suas mudanças. Uma vez ativado, o ícone Ask Eddy AI aparece nos painéis de endpoint na sua referência de API publicada. --- ## Coisas para ter em mente - **As respostas da IA Eddy são direcionadas para o ponto final.** As respostas são geradas a partir da especificação do endpoint que você está visualizando, então refletem os detalhes reais desse endpoint, e não exemplos genéricos. - **O uso da IA consome créditos.** Dependendo do seu plano, o uso da IA Eddy pode contar para a permissão de crédito de IA do seu projeto. Verifique os termos de crédito de IA do seu plano se você espera uso intenso. --- ## FAQ **Onde o Eddy AI aparece na referência da API?** O ícone Ask Eddy AI aparece nos painéis de Código, Solicitação e Resposta de uma página de endpoint. Ao clicar nele, abre o painel de IA do Eddy com escopo para esse ponto final. **O que posso perguntar para a Eddy AI?** Você pode usar um dos prompts sugeridos — Explique esse endpoint, Mostre um exemplo de rotulação ou Que autenticação isso precisa? — ou digite sua própria pergunta. Eddy responde usando a especificação do endpoint atual, então suas respostas refletem o caminho real, parâmetros e autenticação desse endpoint. **Por que eu não vejo o ícone Ask Eddy AI na minha referência de API?** A Eddy AI deve ser ativada primeiro para a documentação da API. Um administrador pode ativar isso em Configurações > configurações de IA > configurações de IA do Eddy, selecionando a caixa de seleção de documentação da API na seção do Conjunto de Busca.