/*
 * Adding Inter Variable from Adobe Fonts
 * © 2009-2025 Adobe Systems Incorporated. All Rights Reserved.
 */

@import url('https://p.typekit.net/p.css?s=1&k=zmy3zmk&ht=tk&f=55314&a=164646275&app=typekit&e=css');

@font-face {
  font-family: 'inter-variable';
  src: url('https://use.typekit.net/af/250efc/00000000000000007750957d/31/l?primer=7cdcb44be4a7db8877ffa5c0007b8dd865b3bbc383831fe2ea177f62257a9191&fvd=n4&v=3')
      format('woff2'),
    url('https://use.typekit.net/af/250efc/00000000000000007750957d/31/d?primer=7cdcb44be4a7db8877ffa5c0007b8dd865b3bbc383831fe2ea177f62257a9191&fvd=n4&v=3')
      format('woff'),
    url('https://use.typekit.net/af/250efc/00000000000000007750957d/31/a?primer=7cdcb44be4a7db8877ffa5c0007b8dd865b3bbc383831fe2ea177f62257a9191&fvd=n4&v=3')
      format('opentype');
  font-display: auto;
  font-style: normal;
  font-weight: 100 900;
  font-stretch: normal;
}

body {
  font-family: 'inter-variable', sans-serif;
}

Show a definition when you hover over text

Tooltips

Mintlify

Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers.

Introduction

Quickstart

Install the CLI to preview and develop your docs locally

Installation

Build your documentation using the Mintlify Web Editor

Web Editor

Configure the global settings for your documentation

Settings

Pages are the building blocks of your documentation

Pages

Structure and customize your documentation's navigation hierarchy

Navigation

Customize the appearance of your documentation

Themes

Build interactive and reusable elements with React components

React

Learn how to feed your documentation into LLMs and AI tools

AI Ingestion

Text, title, and styling in standard markdown

Headers and Text

Add image, video, and other HTML elements

Images and Embeds

Lists and Tables

Code

Reusable, custom snippets to keep content in sync

Reusable Snippets

A dropdown component to toggle content visibility

Accordions

Use callouts to add eye-catching context to your content

Callouts

Highlight main points or links with customizable icons

Cards

Columns

The CodeGroup component lets you combine code blocks in a display separated by tabs

Code Groups

Display code blocks at the top-right of the page on desktop devices

Examples

Expandables

Set parameters for your API or SDK references

Fields

Use the Frame component to wrap images or other components in a container.

Frames

Icons

Mermaid

Sequence content using the Steps component

Steps

Tabs

Update

Playground

Troubleshooting

How to migrate documentation from your existing provider

Migrations

Host your documentation at your website's custom domain

Custom Domain

Redirects and Broken Links

GitHub

GitLab

Add broken links, linting, and grammar checks to the updating process

CI Checks

Preview changes to your docs in a live deployment

Preview Deployments

Fully customize your documentation with custom CSS & JS

Custom Scripts

Trigger an update after updating your OpenAPI document by calling this endpoint in a CI check

Trigger an update

Get the status of an update from the status ID

Get the status of an update

Creates a topic to manage message history for a given AI chat conversation

Create a chat topic

Generate a completion in response to a user query

Generate a message completion

Product Updates

Start building modern documentation in under five minutes

Preview changes locally to update your docs

Local Development

Edit your docs directly from the dashboard with live previews.

Configure your documentation using the `docs.json` file

Global Settings

Organize your docs directory to guide your users to the information they need 

Migration

Setting the title and metadata for navigation and SEO

Page Titles and Metadata

Images, Videos, and Embeds

Code Blocks

Interactive Playground

Reference OpenAPI endpoints in your docs pages

OpenAPI Setup

Use OpenAPI features to enhance your Mintlify docs

Writing OpenAPI

Advanced Features

Generate docs pages for your API endpoints using MDX

MDX Setup

You can set authentication parameters to let users use their real API keys.

Authentication

Mintlify automatically generates most meta tags. If you want to customize them, you can set default values in mint.json or change them per page.

Versioning & Localization

Allow more members of your team to update your docs

Editor Permissions

Fully customize your documentation with custom CSS

Custom CSS

Custom JS

Host documentation at a /docs subpath using Cloudflare Workers

Cloudflare

Host documentation at a /docs subdirectory using AWS services

AWS Route 53 and Cloudfront

Host documentation at a /docs subpath using Vercel

Vercel

Guarantee privacy of your docs by authenticating users

Authenticate users to view only certain pages

Partial Authentication

A list of features unlocked with Personalization

Personalization

How to determine which product is best for you

Auth vs Personalization

The shape of user data you can use to personalize your docs

Sending Data

Integrate the Mintlify widget into your products to offer users quick access to AI-powered chat with your docs content as the knowledge base.

Getting Started

Core Concepts

Components

API Pages

Guides

Deep Dive

Tooltips