@import url("https://use.typekit.net/zmy3zmk.css");

h1, h2, h3 {
  font-family: "inter-variable", sans-serif;
  font-variation-settings: "slnt" 0, "wght" 600;
}

Mintlify

Components

Integrations

Changelog

Get Started

Community

This operation returns a list of all indexes in a project.

List indexes

The IndexModel describes the configuration and status of a Pinecone index.

The dimensions of the vectors to be inserted in the index.

The URL address where the index is hosted.

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.


Configuration needed to deploy a pod-based index.

The environment where the index is hosted.

Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when `metadata_config` is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.

By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields that should be indexed.

The type of pod to use. One of `s1`, `p1`, or `p2` appended with `.` and one of `x1`, `x2`, `x4`, or `x8`.

The number of pods to be used in the index. This should be equal to `shards` x `replicas`.'

The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.

The number of shards. Shards split your data across multiple pods so you can fit more data into an index.

The name of the collection to be used as the source for the index.

Configuration needed to deploy a serverless index.

The public cloud where you would like your index hosted. Serverless indexes can be hosted only in AWS at this time.

The region where you would like your index to be created.  Serverless indexes can be created only in the us-west-2 region of AWS at this time.

ApiKeyAuth

A list containing one serverless index and one pod-based index.

The list of indexes that exist in the project.

The response shape used for all error responses.

Start building modern documentation in under five minutes

Quickstart

Preview changes locally to update your docs

Local Development

Edit your docs directly from the dashboard with live previews.

Web Editor

Customize your documentation using the mint.json file

Global Settings

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

Navigation

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

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

Troubleshooting

Host the documentation at your website's custom subdomain

Custom Domain

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.

Search Engine Optimization

Redirects and Broken Links

Versioning

Allow more members of your team to update your docs

Editor Permissions

GitHub

GitLab

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

Route 53 and Cloudfront

Host documentation at a /docs subpath using Vercel

Vercel

Chat Widget

Introduction

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

Give your users a personalized docs experience

The types and shape of user data you can send to Mintlify

Sending Data

Customize how your team can login to Mintlify

Single Sign-On (SSO)

Integrate with an analytics platform to track viewer events

Analytics Integrations

Amplitude

Clearbit

Fathom

Google Analytics 4

Google Tag Manager

Heap

HotJar

Koala

LogRocket

Mixpanel

Pirsch

Plausible

PostHog

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

A dropdown component for toggling content

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

Getting Started

Writing Content

API References

Configurations

Advanced

List indexes

Authorizations

Response