Demo data

Reference demo

Preview dummy API reference content, request examples, response examples, and generated spec pages.

Use this page to inspect reference-style documentation. It includes hand-authored API fields and links to generated OpenAPI and AsyncAPI stub pages.

Example endpoint

POST POST /v1/demo-pages

Create a sample documentation page in a placeholder project.

Authorizationstring headerheaderRequired

Bearer token for your own API. This is dummy data.

workspaceIdstring pathpathRequired

The example workspace that owns the page.

dryRunboolean queryqueryOptional

Preview the change without saving it.

titlestringRequired

Human-readable page title.

bodystringRequired

Markdown or MDX content for the page.

tagsstring[]Optional

Labels used for filtering or search.

Request example

Create a page

{
  "title": "Install the CLI",
  "body": "Run npm install -g example-cli.",
  "tags": ["setup", "cli"]
}

201HTTP response

The page was created.

400HTTP response

The request body was missing a required field.

Response example

Created page

{
  "id": "page_123",
  "slug": "install-the-cli",
  "title": "Install the CLI",
  "status": "published"
}

The starter also has dummy OpenAPI and AsyncAPI files under examples/. They generate extra pages in the API reference navigation group.

Generated from examples/openapi.json.

Generated from examples/asyncapi.yaml.