API settings
Configure OpenAPI and AsyncAPI specs, the interactive API playground, SDK code examples, and authentication settings in your docs.json file.
Use the api field in docs.json to configure what API specifications generate API pages, the interactive API playground for testing endpoints, and how to generate and display code examples.
Settings
Section titled “Settings”Type: object
Define all API-related settings under the api key.
api.openapi(string or array or object) — OpenAPI specification files for generating API reference pages. Accepts a single path or URL, an array of paths, URLs, and objects, or an object specifying a source, directory, and overlays.
api.openapi object
source(string) — URL or path to your OpenAPI specification file. Minimum length: 1.directory(string) — Directory to search for OpenAPI files. Do not include a leading slash.overlays(array of string) — Paths or URLs of OpenAPI Overlay documents to apply to the specification, in order. An empty array disables all overlays for the specification, including auto-discovered ones.
"openapi": "openapi.json""openapi": [
"openapi/v1.json",
"openapi/v2.json",
"https://api.example.com/openapi.yaml"
]"openapi": {
"source": "openapi.json",
"directory": "api-reference"
}"openapi": {
"source": "openapi.json",
"overlays": ["overlays/docs-adjustments.yaml"]
}api.asyncapi(string or array or object) — AsyncAPI specification files for generating event-driven API reference pages. Accepts a single path or URL, an array of paths and URLs, or an object specifying a source and directory.
api.asyncapi object
source(string) — URL or path to your AsyncAPI specification file. Minimum length: 1.directory(string) — Directory to search for AsyncAPI files. Do not include a leading slash.
"asyncapi": "asyncapi.json""asyncapi": [
"asyncapi/events.yaml",
"asyncapi/webhooks.yaml"
]"asyncapi": {
"source": "asyncapi.json",
"directory": "websockets"
}api.playground(object) — Interactive API playground settings.
api.playground
display("interactive" | "simple" | "none" | "auth") — The display mode for the playground. Defaults tointeractive.
interactive: Full interactive playground with request buildersimple: Simplified view without the request buildernone: Hide the playground entirelyauth: Show the playground only to authenticated usersproxy(boolean) — Whether to route API requests through a proxy server. Defaults totrue.credentials(boolean) — Whether to include cookies and authentication headers for cross-origin requests whenproxyisfalse. Defaults tofalse. Has no effect whenproxyistrue.
api.params(object) — Display settings for API parameters.
api.params
expanded("all" | "closed") — Whether to expand all parameters by default. Defaults toclosed.post(array of string) — OpenAPI spec field keys to surface as post pills next to every parameter name in API reference pages and the playground. For each key you list, Mintlify reads the value from the schema and renders it as a pill:
- String values render as the verbatim string.
truerenders the key name as the pill label.false,null, and empty strings render nothing.- Number values render the stringified number.
- Arrays of strings or numbers render one pill per element.
- Objects and other values are skipped.
Use this to expose custom OpenAPI fields—such as
x-internal,nullable, or vendor extensions—as visual annotations on each parameter without per-property configuration.
-
api.url("full") — Display mode for the base URL in the endpoint header. Set tofullto always show the complete base URL on every endpoint page. By default, the base URL is only shown when there are multiple base URLs to select from. -
api.examples(object) — Settings for autogenerated API code examples.
api.examples
languages(array of string) — Languages for autogenerated code snippets. See supported languages for the full list of available languages and aliases.defaults("required" | "all") — Whether to include optional parameters in generated examples. Defaults toall.prefill(boolean) — Whether to prefill the playground with example values from your OpenAPI specification. Defaults tofalse.autogenerate(boolean) — Whether to generate code samples for endpoints from your API specification. Defaults totrue. When set tofalse, only manually written code samples (fromx-codeSamplesin OpenAPI or<RequestExample>components in MDX) appear in the playground.
api.mdx(object) — Settings for API pages built from MDX files rather than OpenAPI specs.
api.mdx
auth(object) — Authentication configuration for MDX-based API requests.
auth
method("bearer" | "basic" | "key" | "cobo") — Authentication method for API requests.name(string) — Authentication parameter name for API requests.
server(string or array) — Base URL prepended to relative paths in page-levelapifrontmatter fields. Not used when the frontmatter contains a full URL.
Example
Section titled “Example”{
"api": {
"openapi": ["openapi/v1.json", "openapi/v2.json"],
"playground": {
"display": "interactive"
},
"params": {
"expanded": "all",
"post": ["nullable", "x-internal"]
},
"url": "full",
"examples": {
"languages": ["curl", "python", "javascript", "go"],
"defaults": "required",
"prefill": true,
"autogenerate": true
}
}
}