Aperçu

API

Chaque espace de travail a une clé API publique, utilisée pour authentifier les appels à l'API REST de Docsbook depuis votre propre backend. Aujourd'hui, l'API expose une capacité : exporter le chat de docs AI de votre espace de travail en tant que point de terminaison REST simple — le même moteur de réponse ancrée qui alimente le widget de chat AI sur votre site de docs publié, afin que vous puissiez construire votre propre bot de support, intégration Slack ou CLI par-dessus.

Obtenir votre clé API#

Ouvrez Intégrations — accessible depuis le menu déroulant de votre avatar dans le /chat input, ou depuis le menu déroulant de votre profil dans le panneau d'administration. De là, vous pouvez voir (masquée ou révélée), copier ou réinitialiser votre clé.

Il y a une clé active par espace de travail. La réinitialisation révoque immédiatement l'ancienne — il n'y a pas d'historique de clés, donc mettez à jour tous les appelants avant de réinitialiser.

Authentification#

Chaque requête est authentifiée avec un jeton Bearer — la clé API de votre espace de travail.

Authorization: Bearer dbk_<your_api_key>

Gardez votre clé secrète — elle accorde un accès complet au chat AI de votre espace de travail, facturé sur le budget AI de votre compte (le même budget que le widget docs-chat utilise ; il n'y a pas de quota séparé uniquement pour l'API).

POST/api/v1/chat

Posez une question concernant la documentation de votre espace de travail et obtenez une réponse basée sur vos propres pages.

Autorisation
Authorizationstring

Envoyé en tant qu'en-tête Authorization. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

Corps
questionstringrequis

La question à poser

currentPathstring

Le slug de la page doc à partir de laquelle la question est posée, pour l'exclure de ses propres citations

langstring

Code de langue de la réponse ; par défaut, il utilise la langue par défaut de l'espace de travail

sessionIdstring

Regroupe les questions liées pour l'analyse et les webhooks

mentionedPagesstring[]

Slugs de pages à forcer dans le contexte

Exemple
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?"}'
Réponse
{
  "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?"]
}
Erreurs
Statut Signification
401 Clé API manquante ou invalide
403 Le chat AI n'est pas activé pour cet espace de travail
429 Le budget AI du compte est épuisé

Updated

API — Docsbook