​
Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

​
Syntax

Mintlify.Core.Models.MdxConfig

​
Summary

Represents the MDX configuration for API pages generated from MDX files.

​
Remarks

This configuration allows manual definition of API endpoints in individual MDX files rather than using an OpenAPI specification. It provides flexibility for custom content and is useful for documenting small APIs or prototyping.

​
Constructors

​
.ctor

​
Syntax

public MdxConfig()

​
Properties

​
Auth

Gets or sets the authentication configuration for MDX-based API requests.

​
Syntax

public Mintlify.Core.Models.MdxAuthConfig Auth { get; set; }

​
Property Value

Type: Mintlify.Core.Models.MdxAuthConfig?

​
Remarks

Defines the authentication method and parameters required for API calls made from the documentation playground.

​
Server

Gets or sets the base server URL(s) for API requests.

​
Syntax

public object Server { get; set; }

​
Property Value

Type: object?

​
Examples

// Single server
"server": "https://api.example.com"

// Multiple servers
"server": ["https://api1.example.com", "https://api2.example.com"]

​
Remarks

Can be a single string URL or an array of URLs for multiple base endpoints. Used as the base URL for all API requests made from the playground.