Beacon

Get one documentation page

GEThttps://example.com/api/v1/docs/{slug}.json

Returns the same fields as a list entry, plus a markdown field that contains the page body. The API converts components such as Callout and Steps to standard Markdown and makes site links absolute.

Path parameters

  • slugstringRequired

    The page's file name in content/docs/ without the .mdx extension. The home page's slug is introduction.

Responses

200

The page's metadata and Markdown body

Content type: application/json

  • slugstringRequired
  • titlestringRequired
  • descriptionstringRequired
  • urlstring (uri)Required
  • markdownUrlstring (uri)Required
  • apiUrlstring (uri)Required
  • markdownstringRequired
{
  "slug": "quickstart",
  "title": "Quickstart",
  "description": "Create a site and deploy it.",
  "url": "https://example.com/quickstart",
  "markdownUrl": "https://example.com/quickstart.md",
  "apiUrl": "https://example.com/api/v1/docs/quickstart.json",
  "markdown": "# Quickstart"
}

404

No page has this slug

Code samples

curl --request GET \
  --url 'https://example.com/api/v1/docs/quickstart.json'