This operation specifies the pod type and number of replicas for an index. It applies to pod-based indexes only. Serverless indexes scale automatically based on usage.

Configure an index

Mintlify

Start building modern documentation in under five minutes

Quickstart

Configure your documentation using the `docs.json` file

Global Settings

Customize the appearance of your documentation

Themes

How to migrate documentation from your existing provider

Migration

Setting the title and metadata for navigation and SEO

Page Titles and Metadata

Text, title, and styling in standard markdown

Headers and Text

Add image, video, and other HTML elements

Images, Videos, and Embeds

Lists and Tables

Code Blocks

Reusable, custom snippets to keep content in sync

Reusable Snippets

Playground

Troubleshooting

Host your documentation at your website's custom domain

Custom Domain

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

LLM Ingestion

Fully customize your documentation with custom CSS & JS

Custom CSS & JS

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

Accordions

Group multiple accordions into a single display.

Accordion Groups

Use callouts to add eye-catching context to your content

Callout Boxes

Highlight main points or links with customizable icons

Cards

Card Groups

Display code with optional syntax highlighting

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

Code Groups

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

Frames

Use [Font Awesome](https://fontawesome.com/icons) or [Lucide](https://lucide.dev/icons) icons anywhere in the doc

Icons

Mermaid Diagrams

Sequence content using the Steps component

Steps

Tabs

Show a definition when you hover over text.

Tooltips

Update

Parameter Fields

Response Fields

Expandables

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

Sidebar Code Examples

Integrate with an analytics platform to track events

Analytics Integrations

Amplitude

Clearbit

Fathom

Google Analytics 4

Google Tag Manager

Heap

HotJar

Koala

LogRocket

Mixpanel

Pirsch

Plausible

PostHog

Segment

Automate your SDK usage snippets in the API playground

Speakeasy

Automate your SDK example snippets in the API playground

Stainless

Support Integrations

Intercom

Front

Privacy Integrations

Osano

Product Updates

Preview changes locally to update your docs

Local Development

Edit your docs directly from the dashboard with live previews.

Web Editor

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

Navigation

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.

Chat Widget

Overview

Use [Font Awesome](https://fontawesome.com/icons) icons anywhere in the doc

Getting Started

Writing Content

API References

Configurations

Advanced

Configure an index