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

# ApiExamplesConfig

> Represents the configuration for autogenerated API examples in the documentation.

## Definition

**Assembly:** Mintlify.Core.dll

**Namespace:** Mintlify.Core.Models

**Inheritance:** System.Object

## Syntax

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

## Summary

Represents the configuration for autogenerated API examples in the documentation.

## Remarks

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

## Constructors

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

#### Syntax

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

### <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" /> Autogenerate

Gets or sets whether to automatically generate code samples for API endpoints.

#### Syntax

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

#### Property Value

Type: `System.Nullable<bool>?`

#### Remarks

When set to true (default), code samples are automatically generated for endpoints
from API specifications. When set to false, only manually-written code samples
(from x-codeSamples in OpenAPI specifications or RequestExample components in MDX)
appear in the API playground.

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

Gets or sets whether to show optional parameters in API examples.

#### Syntax

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

#### Property Value

Type: `string?`

#### Examples

```csharp theme={"dark"}
"examples": {
  "defaults": "required"
}
```

#### Remarks

Valid values are:

* "all": Show all parameters including optional ones
* "required": Show only required parameters
  Defaults to "all" when not specified.

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

Gets or sets the programming languages for autogenerated API snippets.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.List<string> Languages { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.List<string>?`

#### Examples

```csharp theme={"dark"}
"examples": {
  "languages": ["javascript", "python", "curl"]
}
```

#### Remarks

Specifies which programming languages should be included in the
automatically generated code examples. Common values include:
"javascript", "python", "curl", "go", "java", "php", "ruby", etc.

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

Gets or sets whether to prefill the API playground with data from schema examples.

#### Syntax

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

#### Property Value

Type: `System.Nullable<bool>?`

#### Examples

```csharp theme={"dark"}
"examples": {
  "prefill": true
}
```

#### Remarks

When enabled, the playground automatically populates request fields with example
values from your OpenAPI specification. This provides users with pre-populated
data to help them understand the API structure and test endpoints more easily.
Defaults to false when not specified.

## 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?`
