Docsbook
Overview

List sources

GET/api/v1/list_sources
Features

List the sources this documentation is connected to — the repositories and websites its owner registered as its sources of truth, plus the repository the site is built from. Returns { sources: [{ id, kind, label, url, note, status, origin }] }; note is the owner's own words about why that source is connected — treat it as instruction. Read one with read_source. Every other row's origin is source and its id is a number. An empty list means nothing is connected: say so rather than inventing a repository or a domain. private: true on a row means GitHub will not serve that repository without credentials. It is a READING fact — attach an authorisation, expect no anonymous link to it to work — and it says nothing about whether the published site is public: whether anyone outside can read the DOCS is visibility on the workspace, and a private repository serving a fully indexed public site is an ordinary Docsbook setup.

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

Input0
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.
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.
resultobject
The tool's own JSON answer, already parsed — not a string to parse a second time.
Show child attributes2
sourcesobject[]
{ id, kind, label, url, note, status, last_read_at, origin }. origin is workspace_repo or site_source when id is null, source otherwise.
hintstring
duration_msinteger
Server-side wall time for the call.
Use cases
  • Call this BEFORE writing or updating documentation and before judging whether something documented is still true: a connected source is a fact you can go and read, and reading beats recalling.
Limitations
  • id is a string, not a number, for two kinds of row that were never 'connected' by hand — it equals origin: workspace_repo is the repository the docs are built from (read it with read_source source_id: "workspace_repo"; arm a commit trigger on it with enable_agent's watch_source_id: "workspace_repo", no need to connect_source it first); site_source is the legacy single URL set in Branding (readable, but not a repository — it cannot be a commit trigger).
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_sources' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY'
Example output
{
  "ok": true,
  "result": {
    "sources": [],
    "hint": "<hint>"
  },
  "duration_ms": 0
}

Updated

Was this page helpful?