API Reference

Essa página te ajuda a buscar as informações salvas nos chatbots

Fazendo a busca

Fazer buscas por similaridade de conteúdos é uma parte importante para alimentar nossos chatbots com informações relevantes.

Endpoint

GET https://kodagpt.com.br/api/v1/embed

Cabeçalhos de Solicitação

A solicitação à API deve incluir os seguintes cabeçalhos:

  • Content-Type: application/json - O tipo de conteúdo do payload da solicitação.
  • API_KEY: "<API-Key>" - A chave secreta para autenticar a solicitação à API.

Corpo da Solicitação

Os parâmetros (params) para buscar os conteúdos são:

  • chatbot_id (string, obrigatório): Refere-se ao ID do chatbot com o qual você deseja interagir (encontrado na página de "Integrações" do chatbot).
  • question (string, obrigatório): É a pergunta feita pelo usuário para o chatbot.

Exemplo de requisição

const response = await fetch(`https://kodagpt.com.br/api/v1/embed/${chatbot_id}/${question}`);
if (!response.ok) {
  throw new Error(`HTTP error! status: ${response.status}`);
}
const data = await response.json();
console.log(data)

Considerações de Segurança

Nunca exponha sua chave de API em locais acessíveis ao público, como repositórios públicos no GitHub.
Limite as permissões da sua chave de API o quanto possível para reduzir o impacto potencial caso ela seja comprometida.
Sempre utilize HTTPS para garantir que as suas interações com a API sejam criptografadas e seguras.

Suporte

Se você encontrar qualquer problema ou tiver sugestões de melhoria, não hesite em entrar em contato conosco através do nosso email [email protected]