Reference

Reference demo

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

Updated May 11, 2026

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

Example endpoint

POSTCreate a demo page

https://api.example.com/v1/demo-pages

Auth: Bearer tokenOpen playground

Create a sample documentation page in a placeholder project.

Parameters

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.

Request body

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"]
}

Responses

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"
}

Generated spec pages

The starter also has dummy OpenAPI and AsyncAPI files under examples/. They generate pages in the API reference navigation group with base URLs, auth notes, parameters, request bodies, responses, schemas, examples, and code samples.

OpenAPI: List demo pages

Generated from examples/openapi.json.

AsyncAPI: Subscribe to page events

Generated from examples/asyncapi.yaml.

Open the API playground to inspect the OpenAPI file with Scalar.

Next step: Deploy to Vercel

Was this page helpful?