API

Jeder Arbeitsbereich hat einen öffentlichen API-Schlüssel, der verwendet wird, um Aufrufe an die REST-API von Docsbook aus Ihrem eigenen Backend zu authentifizieren. Heute bietet die API eine Funktion: den Export des AI-Dokumenten-Chat Ihres Arbeitsbereichs als einfachen REST-Endpunkt – die gleiche Antwort-Engine, die das AI-Chat-Widget auf Ihrer veröffentlichten Dokumenten-Website antreibt, sodass Sie Ihren eigenen Support-Bot, Slack-Integration oder CLI darauf aufbauen können.

API-Schlüssel abrufen#

Öffnen Sie Integrationen — erreichbar über das Dropdown-Menü Ihres Avatars im /chat Eingabefeld, oder über das Dropdown-Menü Ihres Profils im Administrationsbereich. Von dort aus können Sie Ihren Schlüssel anzeigen (maskiert oder offen), kopieren oder zurücksetzen.

Es gibt einen aktiven Schlüssel pro Arbeitsbereich. Das Zurücksetzen widerruft sofort den alten Schlüssel — es gibt keine Schlüsselhistorie, also aktualisieren Sie alle Aufrufer, bevor Sie zurücksetzen.

Authentifizierung#

Jede Anfrage wird mit einem Bearer-Token authentifiziert – dem API-Schlüssel Ihres Arbeitsbereichs.

Authorization: Bearer dbk_<your_api_key>

Halten Sie Ihren Schlüssel geheim – er gewährt vollen Zugriff auf den AI-Chat Ihres Arbeitsbereichs, der gegen das AI-Budget Ihres Kontos abgerechnet wird (das gleiche Budget, das das docs-chat-Widget verwendet; es gibt kein separates API-Quotum).

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?"]
}