Using the playground
Send real requests from the endpoint pages.
Using the playground
Every generated endpoint page includes a playground: fill in parameters, set a bearer token if the API needs one, and send — the request is proxied server-side so CORS never gets in your way, and the live response renders beside the documented schemas.
Two details worth knowing:
- The server URL shown on each endpoint comes from the spec and is editable in place — point it at a sandbox to demo safely.
- The first response status's schema is open by default, so readers see the shape of a success without a click. Deep links work down to individual schema nodes — share exactly the field you mean.
This page itself demonstrates something too: it's a hand-written MDX page
living inside a generated API reference, placed under a "Getting Started"
sidebar heading by this folder's meta.json —
the mechanism your own references can use.