The API playground is enabled for reference pages that include api: frontmatter. For OpenAPI-generated pages, playground is enabled from docs.json.

How to use

  1. Open one of these pages:
  2. Fill request parameters in the playground panel.
  3. Click Run to send request.

Authentication input

The playground is configured with API key authentication and display: auth. Use this format in auth input:
YOUR_API_KEY
display: auth requires docs authentication setup in Mintlify dashboard. Until auth is configured, interactive playground may be hidden for visitors.
If your reverse proxy blocks playground requests, allow POST requests to /_mintlify/api/request.