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

Method

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

MethodDescription
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

Endpoint

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

https://api.example.com/v1/endpoint

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

OpenAPI

Mintlify also supports OpenAPI and Swagger files.

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

Learn more at the OpenAPI guide.