> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt.

# AI-generated examples

> Automatically create realistic API examples with Fern's AI feature. Customize example styles or disable AI generation as needed.

Fern uses AI to automatically generate realistic request and response examples for your [API Reference](/learn/docs/api-references/overview) documentation. This feature is enabled by default for all API Reference pages. Instead of placeholder values like `username: "string"`, you get believable data that reflects your endpoint properties and descriptions. Examples update automatically as your spec changes.

AI examples work alongside manual examples defined in [`x-fern-examples`](/learn/api-definitions/openapi/extensions/request-response-examples), with manual examples taking priority.

Generation sends endpoint metadata, the relevant part of your API definition, and existing examples to the model. Fern doesn't use your API definition to train AI models.

#### Before

![API Reference with placeholder string values](/learn/_fern-img/58a62c8ab09b5b2ecb168e458fe5f5b9ec2d0bbf049ac8eb51b6275005e735da.webp)

#### After

![API Reference with AI-generated realistic example values](/learn/_fern-img/ce0a22df25ed3bb69c69cb4f273134541aa38f807462d9d83df364be2cc8241f.webp)

## Configuration

Customize the style of generated examples:

**`docs.yml`**

```yaml docs.yml
ai-examples:
  style: "Use names and emails that are inspired by plants."
```

AI-generated examples are written to `ai_examples_override.yml`. Edit this file to customize specific examples. To regenerate examples on each build instead, add the file to `.gitignore`:

**`.gitignore`**

```txt .gitignore
**/ai_examples_override.yml
```

To make AI-generated examples portable to non-Fern OpenAPI tools, use [`fern api enrich`](/learn/cli-api-reference/cli-reference/general-commands#fern-api-enrich) to merge them into native OpenAPI example fields.

## Disable AI-generated examples

To turn the feature off entirely, set `enabled` to `false`:

**`docs.yml`**

```yaml docs.yml
ai-examples:
  enabled: false
```

> Automatically create realistic API examples with Fern's AI feature. Customize example styles or disable AI generation as needed.