Settings
Endpoints21
POSTApprove translation/api/v1/approve_translationApprove a draft translation, moving it to status 'published'.POSTConfigure mentions/api/v1/configure_mentionsChoose what the mention checks watch on one engine: turn the daily check on or off, and set the queries (up to 5) —…POSTDelete translation/api/v1/delete_translationDelete a translation row.GETGet chat system prompt/api/v1/get_chat_system_promptGet the current custom AI chat system prompt for a workspace.GETGet translation/api/v1/get_translationGet the translation for a specific source path and language.GETGet translation status/api/v1/get_translation_statusHow each enabled language stands against the source RIGHT NOW: pages current / behind / missing / manual, the…GETList pending translations/api/v1/list_pending_translationsList draft translations awaiting approval for a workspace.POSTRun translation pass/api/v1/run_translation_passStart a REAL translation catch-up run for one or more languages: the same batch the panel's 'Translate now' starts,…POSTSet chat hooks/api/v1/set_chat_hooksSet pre-, post-, and streaming webhook URLs for the AI chatbot.POSTSet chat system prompt/api/v1/set_chat_system_promptSet a custom system prompt for the AI chatbot.POSTSet translation mode/api/v1/set_translation_modeSet the translation workflow mode for a workspace: 'auto' (Docsbook AI), 'manual' (drafts via API), or 'external'…GETTest chat hook/api/v1/test_chat_hookSend a test ping to one of the configured AI chat hooks and return status.POSTUpdate access/api/v1/update_accessMake a workspace private and configure its unlock method (password and/or bring-your-own SSO/OIDC identity provider —…POSTUpdate ai settings/api/v1/update_ai_settingsConfigure the AI chatbot.POSTUpdate branding/api/v1/update_brandingUpdate visual branding: colors, fonts, logo, theme, the site's call-to-action URL, and the Site source URL the AI…POSTUpdate domain/api/v1/update_domainSet or remove a custom domain (e.g.POSTUpdate languages/api/v1/update_languagesSet the languages the site is served in — the call for 'we need docs in Spanish and German', «нужна документация на…POSTUpdate navigation/api/v1/update_navigationUpdate every curated link on the docs site: header links, social links, FOOTER link columns, folder navigation tabs,…POSTUpdate site address/api/v1/update_site_addressChange the ADDRESS of the site: the in .docsbook.io — its path name / subdomain.POSTUpdate ui settings/api/v1/update_ui_settingsShow or hide one interface element of the docs site — the header search button, sidebar search, collapsible top-level…POSTUpload translation/api/v1/upload_translationUpload or replace a translation for a workspace document.