mintlify-reference.md

Mintlify component reference

Full mintlify reference docs can be found at https://www.mintlify.com/docs/llms.txt

docs.json

• Refer to the docs.json schema when building the docs.json file and site navigation
• If any documents have been removed from the /docs folder, ensure that a redirect is implemented

Callout components

Use these sparingly, only when it's important to highlight information which might otherwise be missed by someone scanning the page.

Note - Additional helpful information

Supplementary information that supports the main content without interrupting flow

Tip - Best practices and pro tips

Expert advice, shortcuts, or best practices that enhance user success

Warning - Important cautions

Critical information about potential issues, breaking changes, or destructive actions

Info - Neutral contextual information

Background information, context, or neutral announcements

Check - Success confirmations

Positive confirmations, successful completions, or achievement indicators

Code components

Code group with multiple languages

Example of a code group:

```javascript Node.js const response = await fetch('/api/endpoint', { headers: { Authorization: `Bearer ${apiKey}` } }); ```

import requests
response = requests.get('/api/endpoint', 
  headers={'Authorization': f'Bearer {api_key}'})

curl -X GET '/api/endpoint' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Structural components

Steps for procedures

Example of step-by-step instructions:

Run `npm install` to install required packages. Create a `.env` file with your API credentials.

Tabs for alternative content

Example of tabbed content:

```bash brew install node npm install -g package-name ```

Accordions for collapsible content

Example of accordion groups:

- **Firewall blocking**: Ensure ports 80 and 443 are open - **Proxy configuration**: Set HTTP_PROXY environment variable - **DNS resolution**: Try using 8.8.8.8 as DNS server ```javascript const config = { performance: { cache: true, timeout: 30000 }, security: { encryption: 'AES-256' } }; ```

Cards and columns for emphasizing information

Example of cards and card groups:

Complete walkthrough from installation to your first API call in under 10 minutes. Learn how to authenticate requests using API keys or JWT tokens. Understand rate limits and best practices for high-volume usage.

API documentation components

Parameter fields

Example of parameter documentation:

Unique identifier for the user. Must be a valid UUID v4 format. User's email address. Must be valid and unique within the system. Maximum number of results to return. Range: 1-100. Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Response fields

Example of response field documentation:

Unique identifier assigned to the newly created user. ISO 8601 formatted timestamp of when the user was created. List of permission strings assigned to this user.

Expandable nested fields

Example of nested field documentation:

Complete user object with all associated data. User profile information including personal details. User's first name as entered during registration.

<ResponseField name="avatar_url" type="string | null">
URL to user's profile picture. Returns null if no avatar is set.
</ResponseField>

Media and advanced components

Frames for images

Wrap all images in frames:

Videos

Use the HTML video element for self-hosted video content:

<video controls className="w-full aspect-video rounded-xl" src="link-to-your-video.com"

Embed YouTube videos using iframe elements:

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/4KzFe50RQkQ" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen ></iframe>

Tooltips

Example of tooltip usage:

API

Updates

Use updates for changelogs:

## New features - Added bulk user import functionality - Improved error messages with actionable suggestions

Bug fixes

• Fixed pagination issue with large datasets
• Resolved authentication timeout problems