Skip to main content

​
Definition

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

​
Syntax

Mintlify.Core.Models.ApiPlaygroundConfig

​
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

public ApiPlaygroundConfig()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Display

Gets or sets the display mode of the API playground.

​
Syntax

public string Display { get; set; }

​
Property Value

Type: string?

​
Examples

"playground": {
  "display": "interactive"
}

​
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

public System.Nullable<bool> Proxy { get; set; }

​
Property Value

Type: System.Nullable<bool>?

​
Examples

"playground": {
  "proxy": false
}

​
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 object

​
Syntax

public virtual bool Equals(object obj)

​
Parameters

NameTypeDescription
objobject?-

​
Returns

Type: bool

​
Equals Inherited

Inherited from object

​
Syntax

public static bool Equals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
GetHashCode Inherited Virtual

Inherited from object

​
Syntax

public virtual int GetHashCode()

​
Returns

Type: int

​
GetType Inherited

Inherited from object

​
Syntax

public System.Type GetType()

​
Returns

Type: System.Type

​
MemberwiseClone Inherited

Inherited from object

​
Syntax

protected internal object MemberwiseClone()

​
Returns

Type: object

​
ReferenceEquals Inherited

Inherited from object

​
Syntax

public static bool ReferenceEquals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?