API Reference

The Docsalot API powers the official CLI and the documentation-management workflows exposed through the dashboard.

​

Base URL

https://docsalot.dev/api/cli/v1

​

Authentication

Most endpoints require a bearer token:

curl -H "Authorization: Bearer $DOCSALOT_API_TOKEN" \
  https://docsalot.dev/api/cli/v1/documentations

For interactive sign-in, use the device-flow endpoints under /auth/device/*.

​

What Is Documented Here

• Auth covers token validation and the device login flow.
• Documentations covers listing docs, fetching manifest metadata, pulling content, pushing changes, publishing versions, and managing custom domains.

​

Lightweight Editing Flow

1. Fetch a documentation manifest to get paths and file metadata.
2. Pull only the file paths you want to edit.
3. Push only the changed files back as a new version.

See the Document APIs playground guide for a full example.

​

Custom Domains

Custom domains are available through the same bearer-token API used by the CLI. Use these endpoints when you want to automate customer-owned domains such as docs.yourdomain.com:

• GET /documentations/{documentationId}/custom-domains
• POST /documentations/{documentationId}/custom-domains
• PATCH /documentations/{documentationId}/custom-domains
• DELETE /documentations/{documentationId}/custom-domains

​

OpenAPI Spec

Download the OpenAPI spec