--- title: "Ask Eddy AI API" slug: "ask-eddy-ai-api" updated: 2026-06-18T08:59:28Z published: 2026-06-18T08:59:28Z canonical: "docs.document360.com/ask-eddy-ai-api" --- > ## 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. # Ask Eddy AI API A **Eddy AI Public API** permite que você incorpore a busca assistiva da Eddy AI diretamente na sua própria plataforma ou serviço, para que os usuários possam consultar sua base de conhecimento sem precisar acessar seu site de documentação. Você chama o endpoint da API com um prompt e recebe uma resposta gerada por IA extraída do conteúdo da sua base de conhecimento. Isso lhe dá controle total sobre a interface de busca — incluindo como ela se apresenta, onde aparece e como se comporta dentro do seu produto. A API está disponível pelo [hub de API Document360](https://apihub.document360.io/index.html). NOTA Para uma lista completa de idiomas suportados pelo Eddy AI, [veja Suporte multilíngue para o Eddy AI Search Suite](/help/docs/pt/ai-search-suite#multilingual-support-for-eddy-ai-search-suite). --- ## Quando usar a API Pública da Eddy AI - **Busca embutida no seu produto** — respondem à base de conhecimento dentro da interface da sua aplicação, sem redirecionar os usuários para um site separado de documentação. - **Interfaces de busca personalizadas** — construa uma experiência de busca que combine com o esquema de cores, terminologia e layout da sua marca. - **Fluxos de trabalho automatizados de suporte** — integre a IA Eddy em chatbots, sistemas de tickets ou fluxos de integração que consultam sua base de conhecimento programáticamente. --- ## Antes de começar - A API Pública da Eddy AI deve estar ativada nas configurações do seu projeto (veja [Como ativar a API Pública](https://docs.document360.com/docs/pt/ask-eddy-ai-api#how-to-enable-the-public-api) abaixo). - Você precisa de um token API com o método POST ativado (veja [Como criar um token API](https://docs.document360.com/docs/pt/ask-eddy-ai-api#how-to-create-an-api-token) abaixo). - A opção de **busca assistida por IA** exige que pelo menos uma caixa de seleção de entrega (**API pública** ou outras) permaneça selecionada — desmarcar todas as caixas desativará automaticamente o botão de alternar. --- ## Como habilitar a API Pública 1. No portal da Base de Conhecimento, selecione **Configurações** (⚙) na barra de navegação da esquerda. 2. No painel de navegação esquerdo, vá para **recursos de IA** > **Eddy AI**. 3. Expanda o **conjunto de busca de IA** acordeão. 4. Na seção **de busca assistida por IA** , selecione a caixa **de seleção da API Pública** . ![Eddy AI settings page showing the AI assistive search section with the Public API checkbox selected.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/Screenshot-Eddy_ai_public_api.png) AVISO Se a API pública não estiver habilitada, todas as chamadas de API retornarão uma `500` resposta (erro de serviço) ou `400` (acesso à API desativado). Certifique-se de que a caixa de seleção esteja selecionada antes de fazer qualquer chamada de API. --- ## Como criar um token API Você precisa de um token API para autenticar as requisições na API Pública da Eddy AI. 1. No portal da Base de Conhecimento, selecione **Configurações** (⚙) na barra de navegação da esquerda. 2. No painel de navegação à esquerda, vá para **o portal da base de conhecimento** > **Tokens da API**. 3. Clique **em Criar Token de API**, insira o nome do token e defina o método para **POST**. 4. Clique **em Criar**, depois copie o token da API gerado e armazene-o de forma segura. --- ## Como testar a API Você pode testar a API pública da Eddy AI de duas maneiras — através da documentação da API do Document360 ou pelo hub da API Swagger. ### Teste via documentação da API 1. Acesse a [documentação da API do Document360](https://apidocs.document360.com/apidocs/perform-ai-assistive-search-ask-eddy-within-project-version). 2. No lado direito da página, selecione a seção **Experimentar** . 3. No campo **Token** , insira seu token de API. 4. Preencha os campos **Corpo** : | Campo | Descrição | | --- | --- | | **Prompt** | A pergunta ou consulta a enviar para a Eddy AI | | **ID de Versão** | O ID da versão do projeto da sua base de conhecimento | | **Código de idioma** | O código da linguagem para a consulta (por exemplo, `en`) | 1. **Clique em Tentar e veja a resposta**. A resposta gerada por IA aparece abaixo. ![Document360 API documentation showing the Try it section with Token, Prompt, Version ID, and Language code fields filled in.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/5_Screenshot-Ask_Eddy_in_API_Documentation.png) ### Teste via Swagger 1. Vá para o [hub da API do Swagger](https://apihub.document360.io/index.html). A API de IA do Ask Eddy está listada em **versões do projeto**. 2. No canto superior direito, clique **em Autorizar**. 3. No **painel de Autorizações Disponíveis** , cole seu token API e clique **em Autorizar**. 4. Navegue até **as versões do projeto** > `/v2/ProjectVersions/ask-Eddy AI` e clique **em Experimentar**. A caixa de solicitação padrão aparece com os seguintes campos para completar: | Campo | Descrição | | --- | --- | | **Prompt** | A pergunta ou consulta a enviar para a Eddy AI | | **ID de Versão** | Recupere isso do `/v2/ProjectVersions` ponto final | | **Código de idioma** | O código da linguagem para a consulta | Para recuperar seu ID de Versão, ligue primeiro para o `/v2/ProjectVersions` endpoint: ![Swagger API hub showing the /v2/ProjectVersions endpoint response with the version ID highlighted.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/6_Screenshot-Updating_Getting_Project_version.png) 1. Clique **em Executar**. Uma resposta bem-sucedida contém a resposta gerada pela IA e os detalhes do artigo fonte. ![Screen recording of the Swagger API hub — authorizing with an API token and executing the Ask Eddy AI endpoint.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/4_ScreenGIF-Using_Eddy_API_Token_in_Swagger.gif) NOTA Se você receber um erro de "serviço indisponível" no Swagger, verifique se a caixa **de seleção da API Pública** está selecionada nas **Configurações** > **recursos de IA** > **suíte de busca Eddy AI** > AI. --- ## Melhores práticas - **Armazene tokens API de forma segura** — trate seu token API como um segredo. Não exponha isso em código do lado do cliente ou repositórios públicos. Gire se estiver comprometido. - **Use o tipo de ID correto para seu conteúdo** — artigos padrão usam `articleID`, mas artigos de categoria de página exigem `categoryID`. Usar o ID errado retorna campos nulos na resposta. Veja o [FAQ](/docs/pt/ask-eddy-ai-api#faq) para mais detalhes. - **Especifique explicitamente o código da linguagem** — sempre passe o código correto no corpo da solicitação para garantir que a Eddy AI busque a versão correta da sua base de conhecimento. - **Gerencie respostas de erro** — implemente o tratamento de erros para `400` respostas (acesso à API desativado) e `500` (erro de serviço). Ambos normalmente indicam que a caixa de seleção da API Pública não está ativada. --- ## FAQ   **Por que os campos do artigo fonte retornam nulo na resposta da API?**               Isso acontece quando você consulta um artigo **Pagecategory** usando um `articleID`arquivo . Para o conteúdo da Pagecategory, os `article_id`campos , `article_title`, e `article_slug` retornam `null` porque o conteúdo é nível categoria, não nível artigo. Use o `categoryID` Instead para recuperar os dados corretos. Uma resposta da API da Pagecategory é assim:       ``` { ```           **Por que estou recebendo um erro 400 ou 500 ao chamar a API?**               Uma `400` resposta (acesso à API desativado) ou `500` (erro de serviço) significa que a API pública não está ativada no seu projeto. Vá em **Configurações** > **recursos de IA** > **suíte de busca Eddy AI** > AI e confirme que a caixa **de seleção da API Pública** está selecionada.           **A Documentação pode ser integrada a uma ferramenta de terceiros ou a um chatbot?**               Sim, você pode usar o endpoint Ask Eddy AI para recuperar respostas da documentação e fornecer respostas por meio da ferramenta ou chatbot de terceiros.