1. Configuration

Setting the API metadata

Setting the api field in the page’s metadata will enable the API playground.

title: "Create new user"
api: "POST https://api.mintlify.com/user"


This can be any one of the following REST API methods:

GETRetrieve information about the REST API resource
POSTCreate a REST API resource
PUTUpdate a REST API resource
PATCHUpdate a REST API resource
DELETEDelete a REST API resource or related component


The endpoint should point to the API that the playground should call. For example, it can be something like


If you have baseUrl configured in mint.json, you can use relative paths like /v1/endpoint.


Mintlify also supports OpenAPI and Swagger files.

title: "Get users"
openapi: "GET /users"

Learn more at the OpenAPI guide.