> ## Documentation Index
> Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ApiConfig

> Represents the API reference configuration and playground settings for Mintlify.

## Definition

**Assembly:** Mintlify.Core.dll

**Namespace:** Mintlify.Core.Models

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
Mintlify.Core.Models.ApiConfig
```

## Summary

Represents the API reference configuration and playground settings for Mintlify.

## Remarks

This configuration controls how API documentation is displayed and how the API playground
functions, including OpenAPI, AsyncAPI, and MDX-based API specifications.

## Constructors

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor

#### Syntax

```csharp theme={"dark"}
public ApiConfig()
```

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> AsyncApi

Gets or sets the AsyncAPI specification configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.ApiSpecConfig?`

#### Remarks

Can be a string URL, an array of URLs, or an object with source and directory properties
pointing to AsyncAPI specification files.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Examples

Gets or sets the configuration for autogenerated API examples.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.ApiExamplesConfig Examples { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.ApiExamplesConfig?`

#### Remarks

Controls which programming languages are shown in code examples and whether
optional parameters are included in the generated examples.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Mdx

Gets or sets the MDX configuration for API pages generated from MDX files.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.MdxConfig Mdx { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.MdxConfig?`

#### Remarks

Allows manual definition of API endpoints in individual MDX files rather than
using an OpenAPI specification. Useful for small APIs or prototyping.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> OpenApi

Gets or sets the OpenAPI specification configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.ApiSpecConfig?`

#### Remarks

Can be a string URL, an array of URLs, or an object with source and directory properties
pointing to OpenAPI specification files.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Params

Gets or sets the display settings for API parameters.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.ApiParamsConfig Params { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.ApiParamsConfig?`

#### Remarks

Controls how API parameters are displayed in the documentation,
including whether they are expanded by default.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Playground

Gets or sets the API playground settings.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.ApiPlaygroundConfig Playground { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.ApiPlaygroundConfig?`

#### Remarks

Controls the display mode of the API playground and whether requests
are proxied through Mintlify's servers for CORS handling.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Proxy

Gets or sets whether to pass API requests through a proxy server.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<bool> Proxy { get; set; }
```

#### Property Value

Type: `System.Nullable<bool>?`

#### Remarks

When true, API requests from the playground are routed through Mintlify's
proxy servers to handle CORS restrictions. This is a legacy property that
is superseded by Playground.Proxy but kept for backward compatibility.
Defaults to true when not specified.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Url

Gets or sets the base URL display mode for API endpoints.

#### Syntax

```csharp theme={"dark"}
public string Url { get; set; }
```

#### Property Value

Type: `string?`

#### Remarks

Controls how the base URL is displayed in API documentation.

## Methods

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name  | Type      | Description |
| ----- | --------- | ----------- |
| `obj` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetHashCode <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetType <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MemberwiseClone <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ReferenceEquals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ToString <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`