### SDK Installation Examples (npm, yarn, pnpm)

Source: https://context7.com/context7/mintlify/llms.txt

Provides commands to install an SDK using different package managers: npm, yarn, and pnpm. Useful for getting started with the SDK.

```bash
npm install @example/sdk
```

```bash
yarn add @example/sdk
```

```bash
pnpm add @example/sdk
```

--------------------------------

### Install and Run Mintlify CLI

Source: https://context7.com/context7/mintlify/llms.txt

Installs the Mintlify CLI globally, initializes a new documentation project, and starts a local development server with hot-reloading. Ensure Node.js and npm are installed.

```bash
# Install Mintlify CLI globally
npm i -g mintlify

# Initialize a new documentation project
mintlify init

# Start local development server
mintlify dev

# Expected output:
# 🌿 Mintlify dev server running on http://localhost:3000
# Watching for changes...

```

--------------------------------

### CLI Installation and Initialization

Source: https://context7.com/context7/mintlify/llms.txt

Install the Mintlify CLI globally and initialize a new documentation project. Start the local development server with hot-reloading.

```APIDOC
## CLI Installation and Initialization

### Description
Install Mintlify CLI to develop and preview documentation locally with hot-reloading support.

### Method
CLI Commands

### Commands
- `npm i -g mintlify` - Install Mintlify CLI globally.
- `mintlify init` - Initialize a new documentation project.
- `mintlify dev` - Start local development server.

### Expected Output
```
🌿 Mintlify dev server running on http://localhost:3000
Watching for changes...
```
```

--------------------------------

### API Reference Endpoint Example

Source: https://context7.com/context7/mintlify/llms.txt

Demonstrates how to document an API endpoint using MDX, including request examples in cURL and JavaScript SDK, and success/error response examples in JSON. It utilizes Mintlify's components like RequestExample and ResponseExample.

```mdx
<!-- api-reference/endpoint.mdx -->
---
title: 'List Projects'
api: 'GET /projects'
---

<RequestExample>
```bash cURL
curl https://api.example.com/v1/projects?limit=10 \
  -H "Authorization: Bearer sk_test_abc123"
```

```javascript SDK
const projects = await client.projects.list({
  limit: 10,
  status: 'active'
});
```
</RequestExample>

<ResponseExample>
```json Success Response
{
  "data": [
    {
      "id": "proj_123",
      "name": "My Project",
      "status": "active",
      "createdAt": "2025-10-10T10:00:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 10,
    "offset": 0
  }
}
```

```json Error Response
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or expired API key"
  }
}
```
</ResponseExample>
```

--------------------------------

### Custom Domain Setup (Bash)

Source: https://context7.com/context7/mintlify/llms.txt

Commands to configure a custom domain for a documentation site, including DNS setup and updating the configuration file. Verifies deployment with cURL.

--------------------------------

### SDK Usage Example (TypeScript)

Source: https://context7.com/context7/mintlify/llms.txt

Illustrates how to use the SDK client in TypeScript to create a new user. Includes initialization, user creation, and error handling.

--------------------------------

### Authentication Setup

Source: https://context7.com/context7/mintlify/llms.txt

Configure authentication for private documentation with multiple provider support, including JWT and SSO options.

```APIDOC
## Authentication Setup

Configure authentication for private documentation with multiple provider support.

### Method

Configuration object for authentication settings.

### Parameters

#### Request Body

- **auth** (object) - Required - Authentication configuration.
  - **method** (string) - Required - Authentication method (e.g., "jwt").
  - **config** (object) - Required - Authentication configuration details.
    - **jwksUrl** (string) - Required - URL for JSON Web Key Set.
    - **audience** (string) - Required - API audience.
    - **issuer** (string) - Required - Token issuer.
- **sso** (object) - Optional - Single Sign-On configuration.
  - **enabled** (boolean) - Required - Whether SSO is enabled.
  - **providers** (array) - Required - List of SSO providers.
    - **name** (string) - Required - Name of the provider (e.g., "Google", "GitHub").
    - **clientId** (string) - Required - Client ID for the provider.
```

--------------------------------

### API Authentication Examples (Bash, Node.js, Python)

Source: https://context7.com/context7/mintlify/llms.txt

Demonstrates how to authenticate API requests using Bearer tokens in multiple programming languages. Includes cURL, Node.js fetch, and Python requests.

```bash
curl https://api.example.com/users \
  -H "Authorization: Bearer YOUR_TOKEN"
```

```javascript
const response = await fetch('https://api.example.com/users', {
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
const data = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.example.com/users',
    headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
data = response.json()
```

--------------------------------

### Automate Documentation Deployment with GitHub Actions

Source: https://context7.com/context7/mintlify/llms.txt

A GitHub Actions workflow to automate the validation and deployment of documentation. It checks out the code, sets up Node.js, installs the Mintlify CLI, validates the documentation, and deploys it to Mintlify using a secret token. Triggered on push and pull requests to the main branch.

```yaml
# .github/workflows/docs.yml
name: Deploy Documentation

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - name: Install Mintlify CLI
        run: npm i -g mintlify

      - name: Validate documentation
        run: mintlify validate

      - name: Deploy to Mintlify
        if: github.ref == 'refs/heads/main'
        run: mintlify deploy
        env:
          MINTLIFY_TOKEN: ${{ secrets.MINTLIFY_TOKEN }}
```

--------------------------------

### API Reference with Snippet Inclusion (MDX)

Source: https://context7.com/context7/mintlify/llms.txt

An example of an API reference page in MDX that includes a reusable 'auth-header.mdx' snippet and defines request body parameters.

--------------------------------

### Mintlify Component Library Usage (MDX)

Source: https://context7.com/context7/mintlify/llms.txt

Demonstrates the usage of Mintlify's built-in MDX components like CardGroup, Card, Steps, and Tabs for structuring and presenting documentation content. These components aid in organizing information, creating interactive elements, and showcasing API examples across different programming languages.

```mdx
<CardGroup cols={2}>
  <Card title="REST API" icon="code" href="/api/rest">
    RESTful API with JSON responses
  </Card>
  <Card title="GraphQL" icon="diagram-project" href="/api/graphql">
    Flexible queries with GraphQL
  </Card>
  <Card title="WebSockets" icon="bolt" href="/api/websockets">
    Real-time bidirectional communication
  </Card>
  <Card title="Webhooks" icon="webhook" href="/api/webhooks">
    Event-driven integrations
  </Card>
</CardGroup>

<Steps>
  <Step title="Install SDK">
    Install the client library for your programming language
    ```bash
    npm install @example/sdk
    ```
  </Step>
  <Step title="Configure Authentication">
    Set up your API credentials in environment variables
    ```bash
    export API_KEY=sk_test_abc123
    ```
  </Step>
  <Step title="Make Your First Request">
    Call the API to verify your setup
    ```javascript
    const result = await client.ping();
    console.log(result); // { status: 'ok' }
    ```
  </Step>
</Steps>

<Tabs>
  <Tab title="JavaScript">
    ```javascript
    const client = new ExampleAPI({ apiKey: process.env.API_KEY });
    const user = await client.users.get('usr_123');
    ```
  </Tab>
  <Tab title="Python">
    ```python
    client = ExampleAPI(api_key=os.environ['API_KEY'])
    user = client.users.get('usr_123')
    ```
  </Tab>
  <Tab title="Go">
    ```go
    client := example.NewClient(os.Getenv("API_KEY"))
    user, err := client.Users.Get("usr_123")
    ```
  </Tab>
</Tabs>
```

--------------------------------

### GET /projects

Source: https://context7.com/context7/mintlify/llms.txt

Retrieves a list of projects, optionally filtered by limit and status.

```APIDOC
## GET /projects

### Description

Retrieves a list of projects.

### Method

GET

### Endpoint

`/projects`

### Query Parameters

- **limit** (number) - Optional - The maximum number of projects to return.
- **status** (string) - Optional - Filter projects by status (e.g., "active").

### Request Example

#### cURL
```bash
curl https://api.example.com/v1/projects?limit=10 \
  -H "Authorization: Bearer sk_test_abc123"
```

#### JavaScript SDK
```javascript
const projects = await client.projects.list({
  limit: 10,
  status: 'active'
});
```

### Response

#### Success Response (200)

- **data** (array) - List of project objects.
  - **id** (string) - The project's unique identifier.
  - **name** (string) - The project's name.
  - **status** (string) - The project's current status.
  - **createdAt** (string) - The timestamp when the project was created.
- **pagination** (object) - Pagination details.
  - **total** (number) - The total number of projects available.
  - **limit** (number) - The limit applied to this request.
  - **offset** (number) - The offset applied to this request.

#### Response Example

```json
{
  "data": [
    {
      "id": "proj_123",
      "name": "My Project",
      "status": "active",
      "createdAt": "2025-10-10T10:00:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 10,
    "offset": 0
  }
}
```

#### Error Response

- **error** (object) - Error details.
  - **code** (string) - The error code (e.g., "unauthorized").
  - **message** (string) - A description of the error.
```

--------------------------------

### User Authentication API

Source: https://context7.com/context7/mintlify/llms.txt

This section details how to authenticate API requests using Bearer tokens and provides examples in various languages.

```APIDOC
## API Authentication

Secure your API requests with OAuth 2.0. All API requests require authentication using Bearer tokens.

### Method
GET

### Endpoint
`/users`

### Parameters
#### Request Headers
- **Authorization** (string) - Required - Bearer token for authentication. Format: `Bearer YOUR_API_KEY`
- **Content-Type** (string) - Optional - The content type of the request body, defaults to `application/json`.

### Request Example (cURL)
```bash
curl https://api.example.com/users \
  -H "Authorization: Bearer YOUR_TOKEN"
```

### Request Example (Node.js)
```javascript
const response = await fetch('https://api.example.com/users', {
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
const data = await response.json();
```

### Request Example (Python)
```python
import requests

response = requests.get(
    'https://api.example.com/users',
    headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
data = response.json()
```

### Warning
Never expose your API token in client-side code or public repositories.
```

--------------------------------

### Update TypeScript Code for Breaking Changes

Source: https://context7.com/context7/mintlify/llms.txt

Provides a before-and-after code example in TypeScript demonstrating how to adapt to a breaking API change, specifically related to endpoint scope requirements. This helps users update their integrations.

```typescript
// Before
const users = await client.users.list();

// After
const users = await client.users.list({
  scope: ['read:users']
});

```

--------------------------------

### Advanced Styling Overrides (CSS)

Source: https://context7.com/context7/mintlify/llms.txt

Custom CSS to override default styles and apply advanced styling to documentation elements. Includes examples for gradients and code block styling.

--------------------------------

### GitHub Deployment Integration

Source: https://context7.com/context7/mintlify/llms.txt

Automate documentation deployment with GitHub Actions integration for seamless CI/CD.

```APIDOC
## GitHub Deployment Integration

Automate documentation deployment with GitHub Actions integration.

### Method

YAML configuration file for GitHub Actions workflow.

### Endpoint

`.github/workflows/docs.yml`

### Description

This workflow file automates the process of checking out code, setting up Node.js, installing the Mintlify CLI, validating documentation, and deploying to Mintlify when changes are pushed to the `main` branch.

### Parameters

#### Environment Variables (in GitHub Secrets)

- **MINTLIFY_TOKEN** (string) - Required - Your Mintlify API token.
```

--------------------------------

### Project Configuration (mint.json)

Source: https://context7.com/context7/mintlify/llms.txt

Configure global settings for your documentation site using the `mint.json` configuration file. This includes site name, logo, colors, navigation, and API settings.

```APIDOC
## Project Configuration

### Description
Configure global settings for your documentation site using `mint.json`.

### Method
JSON Configuration File (`mint.json`)

### Parameters
- **name** (string) - Required - The name of the product or documentation site.
- **logo** (object) - Optional - Defines logos for dark and light modes.
  - **dark** (string) - Path to the dark mode logo.
  - **light** (string) - Path to the light mode logo.
- **favicon** (string) - Optional - Path to the favicon.
- **colors** (object) - Optional - Defines primary, light, and dark theme colors.
  - **primary** (string) - Primary theme color.
  - **light** (string) - Light theme color.
  - **dark** (string) - Dark theme color.
- **topbarLinks** (array) - Optional - Links to display in the top bar.
  - **name** (string) - Name of the link.
  - **url** (string) - URL for the link.
- **navigation** (array) - Optional - Defines the site's navigation structure.
  - **group** (string) - Name of the navigation group.
  - **pages** (array) - Array of page slugs or nested group objects.
- **api** (object) - Optional - API configuration for OpenAPI integration.
  - **baseUrl** (string) - Base URL for API requests.
  - **auth** (object) - Authentication method for the API.
    - **method** (string) - Authentication method (e.g., 'bearer').

### Example Request Body
```json
{
  "name": "My Product",
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg"
  },
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#0D9373",
    "light": "#07C983",
    "dark": "#0D9373"
  },
  "topbarLinks": [
    {
      "name": "Support",
      "url": "mailto:support@example.com"
    }
  ],
  "navigation": [
    {
      "group": "Get Started",
      "pages": ["introduction", "quickstart", "cli-installation"]
    },
    {
      "group": "API Reference",
      "pages": ["api-reference/authentication", "api-reference/endpoints"]
    }
  ],
  "api": {
    "baseUrl": "https://api.example.com",
    "auth": {
      "method": "bearer"
    }
  }
}
```
```

--------------------------------

### Mintlify Project Configuration (mint.json)

Source: https://context7.com/context7/mintlify/llms.txt

Configures global settings for a Mintlify documentation site, including the site name, logo, favicon, color scheme, top bar links, and navigation structure. This JSON file defines the site's appearance and organization.

```json
{
  "name": "My Product",
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg"
  },
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#0D9373",
    "light": "#07C983",
    "dark": "#0D9373"
  },
  "topbarLinks": [
    {
      "name": "Support",
      "url": "mailto:support@example.com"
    }
  ],
  "navigation": [
    {
      "group": "Get Started",
      "pages": ["introduction", "quickstart", "cli-installation"]
    },
    {
      "group": "API Reference",
      "pages": ["api-reference/authentication", "api-reference/endpoints"]
    }
  ],
  "api": {
    "baseUrl": "https://api.example.com",
    "auth": {
      "method": "bearer"
    }
  }
}

```

--------------------------------

### OpenAPI Integration

Source: https://context7.com/context7/mintlify/llms.txt

Automatically generate API documentation from OpenAPI specifications. Mintlify supports linking to OpenAPI files in `mint.json` and provides an interactive playground.

```APIDOC
## OpenAPI Integration

### Description
Automatically generate API documentation from OpenAPI specifications with interactive playground.

### Method
YAML/JSON Specification File and `mint.json` Configuration

### Parameters (OpenAPI Spec)
- **openapi** (string) - Required - OpenAPI version (e.g., '3.0.0').
- **info** (object) - Required - Metadata about the API.
  - **title** (string) - Required - The title of the API.
  - **version** (string) - Required - The version of the API.
- **servers** (array) - Optional - List of servers for the API.
  - **url** (string) - The URL of the server.
- **paths** (object) - Required - Relative paths to the endpoints and their operations.
  - **{path}** (object) - Path item object.
    - **get**, **post**, **put**, **delete**, etc. (object) - Operation object.
      - **summary** (string) - A short summary of what the operation does.
      - **parameters** (array) - A list of parameters for the operation.
        - **name** (string) - Required - The name of the parameter.
        - **in** (string) - Required - The location of the parameter ('path', 'query', 'header', 'cookie').
        - **required** (boolean) - Determines if the parameter is required.
        - **schema** (object) - The data type of the parameter.
      - **responses** (object) - Required - The container for the different response objects returned by an operation.
        - **{statusCode}** (object) - A mapping of HTTP status codes to response objects.
          - **description** (string) - A brief description of the response.
          - **content** (object) - A map of possible content types.
            - **{contentType}** (object) - A map of content types to objects.
              - **schema** (object) - A JSON schema describing the response body.

### Parameters (`mint.json` for linking OpenAPI)
- **openapi** (array) - Required - Array of paths to OpenAPI specification files (YAML or JSON).
- **api.baseUrl** (string) - Optional - Base URL for the API (can be overridden by server object in OpenAPI).
- **api.playground.mode** (string) - Optional - Mode for the interactive API playground (e.g., 'simple').

### Example OpenAPI Specification (`openapi.yaml`)
```yaml
openapi: 3.0.0
info:
  title: User API
  version: 1.0.0
servers:
  - url: https://api.example.com/v1
paths:
  /users/{userId}:
    get:
      summary: Get user by ID
      parameters:
        - name: userId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  email:
                    type: string
```

### Example `mint.json` Configuration
```json
{
  "openapi": ["openapi.yaml", "v2/openapi.yaml"],
  "api": {
    "baseUrl": "https://api.example.com",
    "playground": {
      "mode": "simple"
    }
  }
}
```
```

--------------------------------

### Navigation Structure Configuration

Source: https://context7.com/context7/mintlify/llms.txt

Organize documentation pages with a hierarchical navigation structure. Supports groups, nested pages, and external anchors with icons.

```APIDOC
## Navigation Structure

### Description
Organize documentation pages with hierarchical navigation supporting groups and nested pages.

### Method
JSON Configuration File (`mint.json`)

### Parameters
- **navigation** (array) - Defines the site's navigation structure.
  - **group** (string) - Name of the navigation group.
  - **pages** (array) - Array of page slugs or nested group objects.
    - **group** (string) - Name of a nested navigation group.
    - **pages** (array) - Array of page slugs within the nested group.
- **anchors** (array) - Optional - External links to display, often in the footer or sidebar.
  - **name** (string) - Name of the anchor link.
  - **icon** (string) - Icon to display for the anchor (e.g., 'discord').
  - **url** (string) - URL for the anchor link.

### Example Request Body
```json
{
  "navigation": [
    {
      "group": "Getting Started",
      "pages": [
        "introduction",
        "quickstart",
        {
          "group": "Installation",
          "pages": [
            "installation/cli",
            "installation/cloud",
            "installation/docker"
          ]
        }
      ]
    },
    {
      "group": "API Documentation",
      "pages": [
        "api/overview",
        "api/authentication",
        "api/rate-limits"
      ]
    }
  ],
  "anchors": [
    {
      "name": "Community",
      "icon": "discord",
      "url": "https://discord.gg/example"
    }
  ]
}
```
```

--------------------------------

### API Playground Configuration

Source: https://context7.com/context7/mintlify/llms.txt

Enable interactive API testing with authentication and request customization options.

```APIDOC
## API Playground Configuration

Enable interactive API testing with authentication and request customization.

### Method

Configuration object for API playground settings.

### Parameters

#### Request Body

- **api** (object) - Required - API configuration.
  - **baseUrl** (string) - Required - Base URL for the API.
  - **playground** (object) - Optional - Playground settings.
    - **mode** (string) - Optional - Playground display mode (e.g., "show").
    - **requestOptions** (object) - Optional - Request options for the playground.
      - **timeout** (number) - Optional - Request timeout in milliseconds.
      - **retries** (number) - Optional - Number of retries for requests.
```

--------------------------------

### Create User API

Source: https://context7.com/context7/mintlify/llms.txt

This endpoint allows you to create a new user with specified details.

```APIDOC
## POST /users

### Description
Creates a new user with the provided name and email.

### Method
POST

### Endpoint
`/users`

### Parameters
#### Request Body
- **name** (string) - Required - Full name of the user.
- **email** (string) - Required - Valid email address.

### Request Example
```json
{
  "name": "Jane Doe",
  "email": "jane@example.com"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the created user.
- **name** (string) - The full name of the user.
- **email** (string) - The email address of the user.
- **createdAt** (string) - The timestamp when the user was created.

### Response Example
```json
{
  "id": "usr_1234567890",
  "name": "Jane Doe",
  "email": "jane@example.com",
  "createdAt": "2025-10-10T12:00:00Z"
}
```
```

--------------------------------

### Mintlify CI/CD Validation Configuration (YAML)

Source: https://context7.com/context7/mintlify/llms.txt

Configuration file for Mintlify's CI/CD pipeline, enabling automated documentation validation checks. It specifies enabled validation rules, preview settings for specific branches, and Slack notification configurations.

```yaml
# .mintlify/ci.yml
validation:
  enabled: true
  checks:
    - broken-links
    - invalid-openapi
    - missing-metadata
    - duplicate-pages

preview:
  enabled: true
  branches:
    - main
    - staging
    - 'feature/*'

notifications:
  slack:
    webhook: https://hooks.slack.com/services/YOUR/WEBHOOK/URL
    channel: '#docs-updates'
```

--------------------------------

### Theme Customization (JSON)

Source: https://context7.com/context7/mintlify/llms.txt

Configuration object for customizing the theme of a documentation site, including layout, colors, fonts, and mode toggle settings.

--------------------------------

### Configure Authentication with JWT and SSO

Source: https://context7.com/context7/mintlify/llms.txt

Sets up authentication for private documentation, supporting both JSON Web Tokens (JWT) and Single Sign-On (SSO) with providers like Google and GitHub. Requires valid JWKS URL, audience, issuer, and client IDs for SSO providers.

```json
{
  "auth": {
    "method": "jwt",
    "config": {
      "jwksUrl": "https://auth.example.com/.well-known/jwks.json",
      "audience": "https://docs.example.com",
      "issuer": "https://auth.example.com/"
    }
  },
  "sso": {
    "enabled": true,
    "providers": [
      {
        "name": "Google",
        "clientId": "YOUR_GOOGLE_CLIENT_ID"
      },
      {
        "name": "GitHub",
        "clientId": "YOUR_GITHUB_CLIENT_ID"
      }
    ]
  }
}
```

--------------------------------

### Mintlify Local Validation Command (Bash)

Source: https://context7.com/context7/mintlify/llms.txt

Command-line instruction to run Mintlify's documentation validation checks locally. This helps ensure documentation quality by checking for broken links, invalid OpenAPI specs, missing metadata, and duplicate pages before deployment.

```bash
# Run validation locally
mintlify validate

# Expected output:
# ✓ All links valid (127 checked)
# ✓ OpenAPI spec valid
# ✓ No duplicate pages found
# ✓ All pages have metadata
#
# Validation passed!
```

--------------------------------

### GraphQL API Endpoint

Source: https://context7.com/context7/mintlify/llms.txt

Details on accessing the GraphQL API, which allows for flexible queries.

```APIDOC
## POST /api/graphql

### Description
Allows flexible querying of data using GraphQL.

### Method
POST

### Endpoint
/api/graphql

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string.
- **variables** (object) - Optional - Variables for the GraphQL query.

### Request Example
```json
{
  "query": "{ users { id name } }",
  "variables": {}
}
```

### Response
#### Success Response (200)
- **data** (object) - The result of the GraphQL query.

#### Response Example
```json
{
  "data": {
    "users": [
      {
        "id": "1",
        "name": "Alice"
      }
    ]
  }
}
```
```

--------------------------------

### Webhooks API Endpoint

Source: https://context7.com/context7/mintlify/llms.txt

Details on configuring and using Webhooks for event-driven integrations.

```APIDOC
## POST /api/webhooks

### Description
Set up endpoints to receive event-driven notifications.

### Method
POST

### Endpoint
/api/webhooks

### Parameters
#### Request Body
- **url** (string) - Required - The URL to send webhook events to.
- **events** (array) - Optional - A list of event types to subscribe to.

### Request Example
```json
{
  "url": "https://example.com/webhook-receiver",
  "events": ["user.created", "order.placed"]
}
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the created webhook subscription.
- **url** (string) - The configured webhook URL.

#### Response Example
```json
{
  "id": "whk_abc123",
  "url": "https://example.com/webhook-receiver"
}
```
```

--------------------------------

### Configure API Playground for Interactive Testing

Source: https://context7.com/context7/mintlify/llms.txt

Enables an interactive API playground for testing API endpoints. It configures the base URL, timeout, retries for requests, and authentication method (Bearer token). Useful for developers to quickly test API functionality.

```json
{
  "api": {
    "baseUrl": "https://api.example.com/v1",
    "playground": {
      "mode": "show",
      "requestOptions": {
        "timeout": 30000,
        "retries": 3
      }
    },
    "auth": {
      "method": "bearer",
      "name": "Authorization",
      "inputPrefix": "Bearer "
    }
  }
}
```

--------------------------------

### Changelogs

Source: https://context7.com/context7/mintlify/llms.txt

Maintain version history and product updates with structured changelog entries.

```APIDOC
## Changelogs

Maintain version history and product updates with structured changelog entries.

### Method

Markdown file with frontmatter and changelog entries.

### Parameters (Frontmatter)

- **title** (string) - Required - The title of the changelog entry (e.g., "October 2025").
- **description** (string) - Optional - A brief description of the changelog entry.

### Content Structure

- **Date Header** (e.g., `## October 10, 2025`)
- **Notes** (e.g., `<Note>...</Note>` for version information)
- **Sections** (e.g., `### 🚀 New Features`, `### 🐛 Bug Fixes`, `### 📝 Documentation`, `### Breaking Changes`)
- **Code Examples** (using fenced code blocks with language specifiers)
- **Warnings** (e.g., `<Warning>...</Warning>` for breaking changes)
```

--------------------------------

### Structure Changelog Entries with MDX

Source: https://context7.com/context7/mintlify/llms.txt

Organizes version history and product updates using MDX. It includes sections for new features, bug fixes, documentation updates, and breaking changes, allowing for clear communication of changes to users. Supports custom components like Note and Warning.

```mdx
---
title: 'October 2025'
description: 'New features and improvements'
---

## October 10, 2025

<Note>
**Version 2.5.0** - Major feature release
</Note>

### 🚀 New Features

- Added support for webhook retries with exponential backoff
- Introduced batch operations for user management
- New analytics dashboard with real-time metrics

### 🐛 Bug Fixes

- Fixed race condition in concurrent requests
- Resolved memory leak in long-running processes
- Corrected timestamp formatting in audit logs

### 📝 Documentation

- Added TypeScript examples for all endpoints
- Updated authentication flow diagrams
- New troubleshooting guide for common errors

### Breaking Changes

<Warning>
The `/v1/users` endpoint now requires the `read:users` scope.
Update your OAuth configuration before October 31, 2025.
</Warning>

```

--------------------------------

### OpenAPI Specification for API Documentation

Source: https://context7.com/context7/mintlify/llms.txt

An OpenAPI 3.0 specification defining an API's structure, including endpoints, parameters, and responses. This YAML file is used by Mintlify to generate interactive API documentation.

```yaml
# openapi.yaml
openapi: 3.0.0
info:
  title: User API
  version: 1.0.0
servers:
  - url: https://api.example.com/v1
paths:
  /users/{userId}:
    get:
      summary: Get user by ID
      parameters:
        - name: userId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  email:
                    type: string

```

--------------------------------

### Mintlify Navigation Structure

Source: https://context7.com/context7/mintlify/llms.txt

Defines the hierarchical organization of documentation pages, supporting nested groups and external links. This JSON structure dictates how users navigate through the documentation site.

```json
{
  "navigation": [
    {
      "group": "Getting Started",
      "pages": [
        "introduction",
        "quickstart",
        {
          "group": "Installation",
          "pages": [
            "installation/cli",
            "installation/cloud",
            "installation/docker"
          ]
        }
      ]
    },
    {
      "group": "API Documentation",
      "pages": [
        "api/overview",
        "api/authentication",
        "api/rate-limits"
      ]
    }
  ],
  "anchors": [
    {
      "name": "Community",
      "icon": "discord",
      "url": "https://discord.gg/example"
    }
  ]
}

```

--------------------------------

### SEO Optimization

Source: https://context7.com/context7/mintlify/llms.txt

Configure SEO metadata and analytics for improved search engine visibility and tracking.

```APIDOC
## SEO Optimization

Configure SEO metadata for improved search engine visibility.

### Method

Configuration object for SEO and metadata settings.

### Parameters

#### Request Body

- **seo** (object) - Optional - SEO specific settings.
  - **indexHiddenPages** (boolean) - Optional - Whether to index hidden pages.
- **metadata** (object) - Optional - Metadata for social sharing and other purposes.
  - **og:image** (string) - Optional - Open Graph image URL.
  - **twitter:site** (string) - Optional - Twitter site handle.
- **analytics** (object) - Optional - Analytics configuration.
  - **gtm** (object) - Optional - Google Tag Manager configuration.
    - **tagId** (string) - Required - The Google Tag Manager Tag ID.
  - **plausible** (object) - Optional - Plausible Analytics configuration.
    - **domain** (string) - Required - The domain for Plausible Analytics.
```

--------------------------------

### Link OpenAPI Spec in Mintlify Config

Source: https://context7.com/context7/mintlify/llms.txt

Links OpenAPI specification files to the Mintlify project configuration (mint.json). It specifies the path to the OpenAPI file(s) and configures API base URL and playground mode.

```json
// mint.json - Link OpenAPI spec
{
  "openapi": ["openapi.yaml", "v2/openapi.yaml"],
  "api": {
    "baseUrl": "https://api.example.com",
    "playground": {
      "mode": "simple"
    }
  }
}

```

--------------------------------

### Configure SEO Metadata and Analytics

Source: https://context7.com/context7/mintlify/llms.txt

Configures Search Engine Optimization (SEO) settings, including whether to index hidden pages, and defines metadata for social media sharing (Open Graph, Twitter). Also includes settings for analytics platforms like Google Tag Manager (GTM) and Plausible.

```json
{
  "seo": {
    "indexHiddenPages": false
  },
  "metadata": {
    "og:image": "https://example.com/og-image.png",
    "twitter:site": "@example"
  },
  "analytics": {
    "gtm": {
      "tagId": "GTM-XXXXXXX"
    },
    "plausible": {
      "domain": "docs.example.com"
    }
  }
}
```

--------------------------------

### WebSockets API Endpoint

Source: https://context7.com/context7/mintlify/llms.txt

Information regarding the WebSockets API for real-time, bidirectional communication.

```APIDOC
## Upgrade /api/websockets

### Description
Enables real-time bidirectional communication via WebSockets.

### Method
GET (Upgrade)

### Endpoint
/api/websockets

### Parameters
None for the initial handshake.

### Request Example
(WebSocket connection initiation)

### Response
#### Success Response (101)
- **Connection** (string) - Indicates a switching protocols response.

#### Response Example
(WebSocket connection established)
```

--------------------------------

### MDX Frontmatter for SEO and Page Metadata

Source: https://context7.com/context7/mintlify/llms.txt

Uses MDX frontmatter to define page-specific SEO titles and descriptions, and other metadata. This allows for granular control over how each page appears in search results and social media.

```mdx
---
title: 'Getting Started Guide'
description: 'Learn how to integrate Example API in under 5 minutes'
seo:
  title: 'Example API Integration Guide - Quick Start'
  description: 'Complete guide to integrating Example API with code examples in JavaScript, Python, and Go'
---

```

--------------------------------

### REST API Endpoint

Source: https://context7.com/context7/mintlify/llms.txt

Provides information about the RESTful API endpoint, which uses JSON for responses.

```APIDOC
## GET /api/rest

### Description
Retrieves data via the RESTful API with JSON responses.

### Method
GET

### Endpoint
/api/rest

### Parameters
#### Query Parameters
- **param** (string) - Optional - Example query parameter

### Request Example
```json
{
  "query": "example"
}
```

### Response
#### Success Response (200)
- **data** (object) - The response data from the API.

#### Response Example
```json
{
  "data": {
    "message": "Success"
  }
}
```
```

--------------------------------

### Reusable Snippet Definition (MDX)

Source: https://context7.com/context7/mintlify/llms.txt

Defines a reusable MDX snippet for authentication headers, including 'Authorization' and 'Content-Type' parameters. This snippet can be included in other MDX files.

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.