Get translation status
GET
/api/v1/get_translation_statusFeatures
How each enabled language stands against the source RIGHT NOW: pages current / behind / missing / manual, the percentage, whether a run is in flight and how far along, and what the last run did — including which agent run started it. Coverage is null (never 0) when the source repository could not be read.
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/get_translation_status.
Input1
Your API key, sent as
Authorization: Bearer dbk_YOUR_API_KEY.Sent from your browser straight to the API — never to Docsbook, never stored.ISO codes to report on (default: every language switched on for this project)
Output3
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.The tool's own JSON answer, already parsed — not a string to parse a second time.
Show child attributes1
Per enabled language: pages current / behind / missing / manual, percentage, whether a run is in flight, and what the last run did.
Server-side wall time for the call.
Use cases
- Call this BEFORE run_translation_pass: a language already level with the source costs money to re-translate and changes nothing.
Limitations
- REQUIRES PRO or higher.
Responses
200The tool ran. Read
ok to see whether it succeeded.401Missing or invalid API key.
Example input
curl 'https://docsbook.io/api/v1/get_translation_status' \
-H 'Authorization: Bearer dbk_YOUR_API_KEY'Example output
{
"ok": true,
"result": {
"…": "<…>"
},
"duration_ms": 0
}