Docsbook
Übersicht

Set translation mode

POST/api/v1/set_translation_mode
Features

Set the translation workflow mode for a workspace: 'auto' (Docsbook AI), 'manual' (drafts via API), or 'external' (forward to webhook).

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

Input2
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.
modestring · body
Translation workflow mode One of: auto, manual, external.
external_webhook_urlstring · body
Webhook URL (required for 'external' mode, empty string clears)
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 attributes4
statusstring
workspace_idnumber
translation_modestring
external_translation_webhook_urlstring
null
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/set_translation_mode' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"mode":"auto"}'
Example output
{
  "ok": true,
  "result": {
    "status": "<status>",
    "workspace_id": 0,
    "translation_mode": "<translation_mode>",
    "external_translation_webhook_url": "<external_translation_webhook_url>"
  },
  "duration_ms": 0
}

Aktualisiert

War diese Seite hilfreich?