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.

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 abaixo).
• Você precisa de um token API com o método POST ativado (veja Como criar um token API 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 .

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.
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 :

5. Clique em Tentar e veja a resposta. A resposta gerada por IA aparece abaixo.

Teste via Swagger

1. Vá para o hub da API do Swagger. 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:

Para recuperar seu ID de Versão, ligue primeiro para o /v2/ProjectVersions endpoint:

5. Clique em Executar. Uma resposta bem-sucedida contém a resposta gerada pela IA e os detalhes do artigo fonte.

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 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

{
"category_id": "_categoryid",

"category_title": "Title",

"category_slug": "slug",

"version_name": "v1",

"version_slug": "v1",

"article_id": null,

"article_title": null,

"article_slug": null,

"version_display_name": null

}