Ask project docs

GET/api/v1/ask_project_docs

Features

Ask a question about THIS project's own documentation and get back a synthesized, cited answer — the SAME retrieval and model call the project's public 'Ask AI' widget runs for a real reader on its docs site, run here instead for the ADMIN of this documentation. Comes back with refs, the pages the answer actually drew on — quotable and checkable, not a guess. Use those when you already know, or want to find, the page; use this when you want the finished answer a reader would get. NOT docsbook_assistant — that tool answers CRAFT questions ('how should a comparison page be structured') from Docsbook's OWN published corpus about documentation practice. This one answers from THIS project's OWN published pages, about what THIS project's documentation actually says. Booked to this project's own AI usage the way the admin's other questions here are (see get_ai_usage) — works on every plan, including Free, and does not require the visitor-facing AI Chat capability to be turned on. session_id is optional: reuse the same one across calls to keep them grouped as one conversation; omit it and each call reads as a separate one. Any language — the answer comes back in whichever language the question was asked in.

Price — $0.00003 per call (twice what serving it costs us), charged to the workspace balance, the same as over MCP.

Also reachable by name at POST /api/v1/tools/ask_project_docs.

Input3

Authorizationheaderrequired

Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent from your browser straight to the API — never to Docsbook, never stored.

questionstring · queryrequired

The question, in plain language, any language — the whole question, not a keyword: this is what the corpus is searched by.

contextstring · query

Optional: what sharpens the answer — which section or audience you mean, why you're asking. Read as the asker's situation and never cited back as a documented fact; keep it out of question, which is what retrieval embeds.

session_idstring · query

Optional: reuse the same id across calls to group them as one conversation.

Output3

okboolean

Whether the tool itself succeeded. A tool that ran and refused — an exhausted balance, a plan restriction, a bad argument — answers 200 with ok: false: the call was made and billed, and that refusal is its answer.

resultstring

The tool's own JSON answer, already parsed — not a string to parse a second time.

duration_msinteger

Server-side wall time for the call.

Use cases

Use it when you want the ANSWER, not a page to go read yourself: 'what does our docs say the rate limit is', 'would a reader asking about refunds be told the right thing right now', «что у нас написано про...».

Limitations

NOT for browsing the content yourself — that is search_project_docs (by meaning), search_docs (literal string), read_project_doc (one page in full) or get_project_doc_outline (what exists).

Responses

200The tool ran. Read ok to see whether it succeeded.

401Missing or invalid API key.

Example input

curl 'https://docsbook.io/api/v1/ask_project_docs?question=<question>' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY'

Example output

{
  "ok": true,
  "result": "<result>",
  "duration_ms": 0
}

更新日 Sep 24, 2026