Versão 1.0.0

Hey Otlet API

Carregando…

https://app.heyotlet.com/api/v1

1. 1. Crie uma chaveEm Configurações › Chaves de API, escolha as permissões e copie a chave.
2. 2. Envie no cabeçalhoToda chamada leva Authorization: Bearer com a sua chave.
3. 3. Faça a primeira perguntaUse POST /company/chat com stream: false para receber a resposta em JSON.

curl -X POST "https://app.heyotlet.com/api/v1/company/chat" \
  -H "Authorization: Bearer $HEYOTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Qual o prazo de reembolso?", "stream": false}'

Autenticação

A API usa chaves secretas no formato hok_…, enviadas no cabeçalho Authorization de toda chamada. A empresa vem da própria chave: não é preciso informar mais nada.

Authorization: Bearer hok_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

• Cada chave só faz o que as permissões dela permitem, e nunca mais do que a pessoa que a criou pode fazer.
• Trate a chave como senha: use só no servidor, nunca em código que roda no navegador ou no celular.
• Se uma chave vazar, revogue em Chaves de API. Ela para de funcionar na hora.

Respostas e erros

Respostas de sucesso vêm dentro de data; listas também trazem meta com total, page e pageSize. Erros trazem message e, quando for um problema nos dados enviados, errors com o motivo de cada campo.

{
  "message": "Os dados enviados são inválidos.",
  "errors": {
    "message": "Campo obrigatório."
  }
}

• 200Sucesso.
• 201Criado.
• 204Feito, sem conteúdo na resposta.
• 401Chave ausente, inválida, revogada ou expirada.
• 403A chave não tem permissão para esta ação.
• 404Não encontrado, ou fora do alcance da chave.
• 413Arquivo grande demais.
• 422Dados inválidos.
• 429Limite de perguntas do mês atingido.

Limites

• Perguntas contam no limite mensal da empresa. Ao atingir o limite, POST /company/chat responde 429 até o mês virar.
• Até 20 arquivos por envio, 50 MB cada, nos formatos PDF, DOCX, MD e TXT.
• Listas aceitam pageSize de até 100 itens.
• Links de download valem por 10 minutos.
• Respostas em streaming usam Server-Sent Events. Para integrações simples, prefira stream: false.