Aperçu

List docsbook docs

GET/api/v1/list_docsbook_docs
Features

List EVERY page of Docsbook's own official documentation — the product's full table of contents.

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

Also reachable without a token on this workspace's public MCP endpoint.

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

Input1
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.
path_prefixstring · query
Optional: only pages under this prefix, e.g. 'guides/' or 'ai/'.
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
  • The one call that answers 'what can Docsbook do?' without having to guess a search query first: the page list is the feature list.
  • Use it to orient yourself before advising a user what to do, to check whether a capability is documented at all, or when a search_docsbook_docs query came back empty and you need to know whether the topic is missing or just worded differently.
Limitations
  • 🔴 This is Docsbook the platform's own manual, not the user's documentation — that is the project's own outline tool (get_project_doc_outline on the signed-in server, or the branded one a public endpoint names).
Responses
200The tool ran. Read ok to see whether it succeeded.
401Missing or invalid API key.
Example input
curl 'https://docsbook.io/api/v1/list_docsbook_docs' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY'
Example output
{
  "ok": true,
  "result": "<result>",
  "duration_ms": 0
}

Mis à jour

Cette page vous a-t-elle été utile ?