概览

Read docsbook doc

GET/api/v1/read_docsbook_doc
Features

Read ONE page of DOCSBOOK'S OWN official documentation in full, verbatim, by the path from a search_docsbook_docs hit (e.g. 'guides/advanced/custom-domain.md'). Reading the page before you answer is the difference between telling a user which switch to flip and inventing one.

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/read_docsbook_doc.

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.
pathstring · queryrequired
Path in the official docs, from a search_docsbook_docs hit, e.g. 'ai/chat.md'.
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 the search snippet is not enough to act on: step-by-step setup, the exact list of options a setting takes, what a limit actually is, what a plan actually includes.
Limitations
  • 🔴 This is Docsbook the PLATFORM's own manual, not the user's documentation — that is the project's own read-page tool (read_project_doc 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/read_docsbook_doc?path=<path>' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY'
Example output
{
  "ok": true,
  "result": "<result>",
  "duration_ms": 0
}

更新于

此页面对您有帮助吗?