Introduction

The Doxbrix REST API lets you manage documentation programmatically — create and publish pages, manage spaces and structure, run searches and quality scans, query the assistant, and more. Anything you can do in the app or CLI, you can do over the API. This section is the complete endpoint reference.

Base URL

All API requests are made to:

https://api.doxbrix.io

Every endpoint path in this reference is relative to that base URL and prefixed with the API version.

Versioning

The API is versioned in the URL path. The current version is v1:

https://api.doxbrix.io/v1/pages

We add functionality in backward-compatible ways within a version (new endpoints, new optional fields). Breaking changes ship in a new version. We announce deprecations in the Changelog with a migration window.

Authentication

All requests require an API key passed as a bearer token:

Authorization: Bearer dxb_YOUR_TOKEN

See Authentication for creating tokens and scopes.

Requests

• Request and response bodies are JSON. Send Content-Type: application/json.
• Use standard HTTP verbs: GET (read), POST (create), PATCH (update), DELETE (remove).
• Timestamps are ISO 8601 in UTC (e.g. 2024-11-15T09:30:00Z).
• IDs are prefixed by resource type (e.g. pg_… for pages, sp_… for spaces).

curl https://api.doxbrix.io/v1/pages/pg_01abc \
  -H "Authorization: Bearer dxb_YOUR_TOKEN"

Responses

Successful responses return the relevant resource as JSON with an appropriate status code (200, 201). Errors return a structured error object — see Errors & rate limits.

{
  "id": "pg_01abc",
  "title": "Quickstart",
  "status": "published",
  "slug": "quickstart",
  "createdAt": "2024-11-15T09:30:00Z",
  "updatedAt": "2024-11-15T10:00:00Z"
}

Pagination

List endpoints are cursor-paginated. Pass limit and cursor:

curl "https://api.doxbrix.io/v1/pages?limit=50&cursor=eyJpZCI6..." \
  -H "Authorization: Bearer dxb_YOUR_TOKEN"

The response includes a pagination object:

{
  "data": [ /* … */ ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "eyJpZCI6..."
  }
}

Follow nextCursor until hasMore is false.

Idempotency

For POST requests, send an Idempotency-Key header to safely retry without creating duplicates:

Idempotency-Key: a1b2c3d4-e5f6-7890

Doxbrix returns the original result for repeated requests with the same key.

SDKs

Official SDKs wrap the API with typed clients:

The official TypeScript/JavaScript SDK wraps the API with a typed client:

import { Doxbrix } from '@doxbrix/sdk'

const dx = new Doxbrix({ token: process.env.DOXBRIX_TOKEN })
const page = await dx.pages.create({
  title: 'Webhooks',
  spaceId: 'sp_01xyz',
})

API vs. CLI

Both hit the same backend. Use the CLI for file-based authoring and publishing workflows; use the API for programmatic integration into your own apps and services.

Resources in this reference