API

Cada espaço de trabalho tem uma chave de API pública, usada para autenticar chamadas à API REST do Docsbook a partir do seu próprio backend. Hoje, a API expõe uma capacidade: exportar o chat de documentos de IA do seu espaço de trabalho como um endpoint REST simples — o mesmo mecanismo de resposta fundamentada que alimenta o widget de chat de IA no seu site de documentos publicado, para que você possa construir seu próprio bot de suporte, integração com Slack ou CLI em cima disso.

Obtendo sua chave de API#

Abra Integrações — acessível a partir do menu suspenso do seu avatar no campo /chat, ou no menu suspenso do seu perfil no painel de administração. A partir daí, você pode visualizar (mascarada ou revelada), copiar ou redefinir sua chave.

Há uma chave ativa por espaço de trabalho. Redefinir revoga imediatamente a antiga — não há histórico de chaves, então atualize qualquer chamador antes de redefinir.

Autenticação#

Cada solicitação é autenticada com um token Bearer — a chave da API do seu espaço de trabalho.

Authorization: Bearer dbk_<your_api_key>

Mantenha sua chave em segredo — ela concede acesso total ao chat de IA do seu espaço de trabalho, cobrado contra o orçamento de IA da sua conta (o mesmo orçamento que o widget de chat-docs usa; não há cota separada apenas para API).

curl -X POST https://docsbook.io/api/v1/chat \
  -H "Authorization: Bearer dbk_<your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{"question": "How do I set a custom domain?"}'

{
  "answer": "You can set a custom domain from the Branding tab...",
  "refs": [{ "pagePath": "design/domains", "title": "Custom Domains", "heading": "Setup" }],
  "follow_up_questions": ["What SSL certificate is used?", "Can I use a subdomain?"]
}