Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Represents the API playground settings for interactive documentation.Remarks
Controls how the API playground is displayed and whether API requests are proxied through Mintlify’s servers for CORS handling.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Display
Gets or sets the display mode of the API playground.Syntax
Property Value
Type:string?
Examples
Remarks
Valid values are:- “interactive”: Full interactive playground with request/response testing
- “simple”: Copyable endpoint with no interactive features
- “none”: Hide the playground completely Defaults to “interactive” when not specified.
Proxy
Gets or sets whether to pass API requests through a proxy server.Syntax
Property Value
Type:System.Nullable<bool>?
Examples
Remarks
When true, API requests from the playground are routed through Mintlify’s proxy servers to handle CORS restrictions. This allows the playground to make requests to APIs that don’t have CORS configured. Defaults to true when not specified.Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?