Reference OpenAPI pour le CLI Docsalot et la gestion de documentation.

Reference API

Authoring MCP

Community

Docsalot

API Reference

Home

Get Started

Launch polished docs, publish quickly, and make them easier for AI agents to use.

Quickstart Guide

Learn how AI enhances reading, writing, and discovering your documentation

AI-native documentation

Design information architecture that aligns with user needs.

Navigation

Add top-level documentation tabs for major sections like guides, API reference, SDKs, or CLI docs.

Tabs

Add sidebar dropdown selectors for related documentation sections that should not always be visible.

Dropdowns

Add a language selector and organize translated documentation in layout.json.

Languages

Create persistent navigation items that appear at the top of your sidebar for quick access to important sections.

Anchors

Docsalot gives you complete control over the look and feel of your documentation using the layout.json file

Global Settings (layout.json)

Setting the title and metadata for navigation and SEO

Page Titles and Metadata

Choose the right Docsalot page shell for each page.

Page Modes

Default Mode Example

A wider content canvas with no right-side headings panel.

Wide Mode Example

A focused standalone page with the standard header and footer.

Center Mode Example

A splash-style page that keeps only the top navbar.

Custom Mode Example

A more open canvas that still keeps the sidebar navigation.

Frame Mode Example

Docsalot automatically generates most meta tags. If you want to customize them, you can set default values in layout.json or change them per page.

Search Engine Optimization

Optionally, you can have separate versions for your docs. Docsalot lets you toggle content based on your docs version.

Versioning

Host your documentation at your own custom domain

Custom Domain

Configure Docsalot custom domains when your DNS is managed in Cloudflare

Cloudflare Custom Domains

Host documentation at a /docs subdirectory

Subdirectory

Customize typography with Google Fonts or self-hosted fonts

Fonts

Add a root custom.css file to style custom pages and scoped layouts.

Custom CSS

Customize how your documentation handles missing pages with layout.json.

Custom 404 Page

Build interactive and reusable elements with React components

Custom Components

create-edit-pages

navigation

configuration

publish

Manage your documentation site lifecycle including removal, self-hosting options, and account actions

Documentation Lifecycle Management

Add interactive API requests and live responses to your Docsalot documentation

Playground

Configure auth for the playground globally or per page

Authentication

Generate Docsalot API docs from an OpenAPI specification

OpenAPI setup

Document polymorphic bodies and composed schemas clearly

Complex data types

Show SDK and CLI usage next to raw HTTP requests

Add SDK examples

Decide which generated API pages appear in navigation

Manage page visibility

Document success and failure variants with concrete examples

Multiple responses

Build hand-authored API pages with full control over layout and narrative

Create manual API pages

Document WebSocket and event-driven APIs with AsyncAPI files

AsyncAPI setup

Diagnose blank API pages, missing endpoints, and playground request failures

Troubleshooting

Introduction on how to add and edit content

Writing Content

Text, title, and styling in standard markdown

Rich Text

Images

Lists

Code

Add images, videos, and iframes to your documentation

Images & Embeds

Display an arrangement of data in rows and columns

Tables

Reusable, custom snippets to keep content in sync

Reusable Snippets

Install the Docsalot CLI and skill, then let Claude, Codex, or another coding agent handle documentation workflows.

Agent-first onboarding

Agent-First Onboarding

Install the Docsalot CLI and authenticate manually when you are not using the agent-first flow.

Manual install & auth

Manual Install and Auth

Manual flow for creating a new Docsalot documentation project and local scaffold.

Create docs manually

Create Documentation

Manual flow for pulling, editing, and previewing Docsalot documentation locally.

Maintain docs manually

Maintain Documentation

Manual flow for pushing Docsalot updates and publishing the correct version.

Update & publish manually

Update and Publish

Automatically create and publish a new docs version when docs files change.

GitHub Auto-Publish

Full Docsalot CLI command reference for manual operation, scripting, and troubleshooting.

Manual commands

Manual CLI Commands

Resolve common Docsalot CLI issues for auth, IDs, sync, and publish workflows.

CLI Troubleshooting

Connect your AI assistant to Docsalot to read and edit documentation, publish updates, and learn what readers ask.

Overview

Find out what readers ask, investigate confusing topics, and use the evidence to improve your documentation.

Reader Questions

OpenAPI-backed reference for the Docsalot CLI and documentation management API

Bearer token auth and the device login flow for the Docsalot API

Download the public Docsalot auth and documentations OpenAPI contract

OpenAPI Spec

Get Current User

Start Device Auth

Exchange Device Auth Token

Approve Device Auth

List Documentations

Get Documentation Manifest

Pull Documentation Paths

Pull Documentation Docs

Push Documentation Paths

Push Documentation Docs

Publish Documentation Version

List Custom Domains

Add Custom Domain

Verify Custom Domain

Remove Custom Domain

Create and manage an AI-powered knowledge base from your documentation

Knowledge Base

Add AI-powered chat to your docs that answers questions, cites sources, and generates code examples

AI Assistant

Install and use the Docsalot CLI to authenticate, sync docs, publish versions, and preview locally.

Docsalot CLI

Add a bot to your Discord server that answers questions based on your documentation.

Discord Bot

Add a bot to your Slack workspace that answers questions based on your documentation.

Slack Bot

Optimize SEO with meta tag configuration for better search visibility.

Add one-click AI integrations to your docs.

Contextual menu

Quickly get Markdown versions of pages for AI tools and integrations.

Markdown export

Export your documentation as a single PDF file.

PDF exports

Connect your documentation and API endpoints to AI tools with a hosted MCP server.

Model Context Protocol

Optimize your docs for LLMs to read and index.

llms.txt

Automatically generated AI agent skill files that teach agents how to use your documentation effectively

Skill Files

skill.md Files

Docsalot integrates with a variety of analytics platforms.

Supported Integrations

Amplitude

Fathom

Google Analytics 4

Google Tag Manager

HotJar

Koala

Logrocket

Mixpanel

Pirsch

Plausible

PostHog

Segment

Programs and offers for founders, startups, and affiliates who want AI-readable docs.

Partners

Special Docsalot offer for Alchemist founders and portfolio companies.

Alchemist Companies

Special Docsalot offer for Canadian founders who want done-for-you AI-readable documentation.

Canadian Founders

Affiliate program for partners who want to send qualified companies to Docsalot and earn recurring revenue.

Affiliates

Learn how we collect, use, and protect your information when you use our documentation service

Privacy Policy

A dropdown component for toggling content

Accordions

Group multiple accordions into a single display.

Accordion Group

Highlight main points or links with customizable icons

Cards

Card Group

Use callouts to create add eye-catching context to your content

Callout Boxes

Display code with optional syntax highlighting

Code Blocks

The CodeGroup component lets you combine code blocks in a display separated by tabs

Code Groups

Use the Frame component to wrap images or other components in a container.

Reference API

Reference API

URL de base

Authentification

Sections

On this page

​Reference API

​URL de base

​Authentification

​Sections

On this page

Reference API

URL de base

Authentification

Sections