Upload translation

POST/api/v1/upload_translation

Features

Upload or replace a translation for a workspace document. Creates a draft by default. This is how an EXTERNAL translator returns its work: the translation webhook notifies you, you translate, you call this. Pass back the source_blob_sha the webhook gave you as source_hash and set origin 'external_api', or the freshness surfaces cannot tell which commit your translation belongs to. The language starts being served to readers as soon as the first page is uploaded — there is no separate activation step.

Price — $0.00001 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/upload_translation.

Input6

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.

source_pathstring · body

Source document path (e.g. 'guides/quick-start.md')

languagestring · body

Target language code (e.g. 'es', 'fr')

contentstring · body

Translated content

statusstring · body

Status (default: draft) One of: draft, published, outdated.

source_hashstring · body

Git blob sha (40 hex) of the SOURCE file this was translated FROM — pass the source_blob_sha the translation webhook delivered, verbatim. This is what makes 'is this commit translated?' answerable: without it the row records only a hash of your own output, which no commit can ever match. Omit for a hand-written translation whose freshness is a person's call.

originstring · body

Who produced it: 'external_api' for a machine translator answering the webhook (compared against the repo like any machine translation), 'manual_upload' for a person's own words (never reported as stale). Default 'manual_upload'. One of: manual_upload, external_api.

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 attributes5

statusstring

translationobject

comparableboolean

Whether this row can be matched to a commit — true only when a source_hash was supplied AND origin is external_api. False means the owner's coverage surfaces will read it as 'manual': present, but not attributable to any commit.

replaced_ai_translationboolean

replacedobject

{ origin, status, updatedAt } of the row that was overwritten.

duration_msinteger

Server-side wall time for the call.

Limitations

REQUIRES PRO or higher.

Responses

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

401Missing or invalid API key.

Example input

curl -X POST 'https://docsbook.io/api/v1/upload_translation' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status":"draft","origin":"manual_upload"}'

Example output

{
  "ok": true,
  "result": {
    "status": "<status>",
    "translation": {},
    "comparable": true,
    "replaced_ai_translation": true,
    "replaced": {}
  },
  "duration_ms": 0
}

Atualizado Sep 24, 2026