Update 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 sidebar folders (sidebar_collapse_top_folders: «сверни папки первого уровня»), the copy-page menu and its entries, previous/next links, breadcrumbs, scroll-to-top, page feedback, the 'was this helpful' bar, edit-on-GitHub, the Ask AI buttons (header, outline, on selection), copy-as-markdown, and where the language and theme switchers sit. Also the HOME-PAGE LANDING switches (home_hide_sidebar, home_hide_outline, home_hide_chrome, home_landing_typography), which strip the sidebar, the outline and the article chrome (breadcrumbs, 'Updated', rating bar, prev/next) off the site's FRONT PAGE ONLY and give its sections landing-page scale so it can read as a landing page — use them for 'make the home page a landing page', «сделай главную посадочной», «убери сайдбары на главной». There is no full-width/edge-to-edge switch: the front page always sits in the same reading column as every other page. And the SITE FOOTER (whether it exists, its layout, its copyright text, its call-to-action button, and whether it shows the social icons and a theme picker) — 'add a footer', 'put a copyright line at the bottom', «добавь футер». Pass only the toggles the user mentioned; the rest are untouched. Use it for 'hide the search button', 'remove breadcrumbs', «убери кнопку поиска». NOT header links or folder tabs — and NOT the footer's LINK COLUMNS, which are update_navigation's footer_columns. NOT colours or fonts (update_branding). All toggles available on FREE plan.
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/update_ui_settings.
Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.
The search button in the site header.
The search box at the top of the left sidebar.
First-level sidebar folders become collapsible rows (chevron + name, fold on click, open by themselves around the current page) like second-level folders, instead of always-open uppercase section headings. Their pages stay flush left — no indent and no guide line, which remain the look of the second level. Off by default.
—
Show "Copy Skills.md URL" in the Copy page dropdown
Show "View as Markdown" in the Copy page dropdown
Show "Open in ChatGPT" in the Copy page dropdown
Show "Open in Claude" in the Copy page dropdown
Show "Open in Cursor" in the Copy page dropdown
Show "Open in Windsurf" in the Copy page dropdown
Show "Connect to VSCode" in the Copy page dropdown
Show "Connect MCP" in the Copy page dropdown — copies a prompt that installs this project's MCP server into any agent
—
—
HOME PAGE ONLY: hide the left navigation rail on the site's front page (its top-level README/index), on desktop — the mobile drawer stays. Every other page keeps its sidebar. It also makes the front page a landing rather than the first doc: it leaves the sidebar tree, and the subheader's "Overview" tab opens the next page instead and is not highlighted on the front page (give the front page its own tab with update_navigation subheader_folders kind:"page" if the owner wants one).
HOME PAGE ONLY: hide the right-hand "On this page" outline on the site's front page.
HOME PAGE ONLY: remove the article chrome from the front page — the breadcrumb/copy-page bar, the "Updated" line, the "Was this page helpful?" bar and the previous/next links — so it reads as a landing page, not as page one of a manual.
HOME PAGE ONLY: landing-page scale for the front page's sections — each h2 becomes a large section title with air above it and the paragraph under it reads as that section's lead. Pair it with hero/stats/cards widgets in the README.
—
—
—
—
Show AI chat button (AI must be enabled separately)
—
—
Show floating Ask AI button when user selects text in the docs (AI must be enabled separately)
Floating "Ask Docs" pill pinned to the page's bottom-right corner
—
—
—
—
Base URL for Edit on GitHub links
Show the site footer — the band under every docs page. Off by default. It renders only once it has content: a link column (update_navigation footer_columns), footer_text, a CTA, the logo or the social icons.
How the footer's blocks sit: 'columns' (brand block left, link columns right), 'centered' (everything stacked down the middle) or 'minimal' (one row — text left, links and socials right). Placement only; it never turns a block off. One of: columns, centered, minimal.
Free text under the footer's logo — copyright line, legal entity, postal address. Plain text: line breaks are kept, markup is not. Max 600 chars. Pass an empty string to clear it.
Show the site logo in the footer's brand block.
Show the social icons in the footer. WHICH accounts is not a footer setting — it is the workspace's social_links (update_navigation); this only decides whether the footer draws them.
Show a three-way light / dark / system picker in the footer.
Label for an optional call-to-action button in the footer's brand block (e.g. 'Get started'). Without a label no button is drawn. Pass an empty string to remove it.
Where the footer's call-to-action button goes. Leave unset to reuse the workspace's own cta_url (see get_workspace) rather than repeating it.
curl -X POST 'https://docsbook.io/api/v1/update_ui_settings' \
-H 'Authorization: Bearer dbk_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"footer_layout":"columns"}'Responses#
| Status | Meaning |
|---|---|
200 |
The tool ran. Read ok to see whether it succeeded. |
401 |
Missing or invalid API key. |