# Mintlify

> Mintlify is a platform for building and hosting documentation websites. It provides a set of tools and services for maintaining documentation and making it accessible to AI agents.

- [Documentation (181 pages)](/content/docs/_llms/en/documentation.md): Documentation for Documentation.

## API reference

### API reference

- [Mintlify REST API introduction](/content/docs/api/introduction.md): Use the Mintlify REST API to trigger deployments, embed an AI assistant, export analytics data, and manage documentation programmatically.

### Admin

- [Trigger deployment](/content/docs/api/update/trigger.md): Queue a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. The update is triggered from your configured deployment branch.
- [Get deployment status](/content/docs/api/update/status.md): Get the status of an update from the status ID
- [Trigger preview deployment](/content/docs/api/preview/trigger.md): Create or update a preview deployment for a specific branch. If a preview already exists for the branch, it triggers a redeployment. Returns a status ID to track progress and the preview URL.
- [Trigger automation](/content/docs/api/automations/trigger.md): Trigger a scheduled automation to run immediately, instead of waiting for its next scheduled time. Useful for running automations from CI/CD pipelines, like a GitHub Action that runs on every merge to your default branch. Only scheduled (custom schedule) automations can be triggered. The run picks u…

### Agent

- [Create agent job](/content/docs/api/agent/v2/create-agent-job.md): Creates a new agent job that runs in the background. The job processes the prompt asynchronously — poll the get job endpoint to track progress. If the agent edits files successfully, a pull request is automatically created.
- [Get agent job](/content/docs/api/agent/v2/get-agent-job.md): Retrieves the current status and details of an agent job. Poll this endpoint to track job progress.
- [Send follow-up message](/content/docs/api/agent/v2/send-message.md): Sends a follow-up message to an existing agent job. The message is processed asynchronously — poll the get job endpoint to track progress.

### Assistant

- [Create assistant message](/content/docs/api/assistant/create-assistant-message-v2.md): Generates a response message from the assistant for the specified domain. Compatible with AI SDK v5+.

### Search

- [Search documentation](/content/docs/api/assistant/search.md): Perform semantic and keyword searches across your documentation with configurable filtering and pagination.
- [Get page content](/content/docs/api/assistant/get-page-content.md): Retrieve the full text content of a specific documentation page by its path. Use this after a search to fetch the complete content of a matching page.

### Mintlify Index

- [Mintlify Index REST API](/content/docs/api/search-index/introduction.md): Use the Mintlify Index REST API to search documentation and the web, assemble source-cited context, and retrieve page contents for applications and agents.
- [Build implementation context](/content/docs/api/search-index/context.md): Searches Mintlify Index and returns source-cited content assembled within a token budget. Use this endpoint when an application or agent needs ready-to-use context in one request.
- [Search technical knowledge](/content/docs/api/search-index/search.md): Returns ranked results from publisher-maintained documentation or the web. Use Mintlify result IDs or any result URL with the contents endpoint when you need more content.
- [Get result contents](/content/docs/api/search-index/contents.md): Retrieves content for Mintlify result IDs or result URLs returned by the search endpoint. A request can include up to 20 items across both fields.

### Analytics

- [Get feedback](/content/docs/api/analytics/feedback.md): Returns paginated user feedback with optional filtering
- [Get feedback by page](/content/docs/api/analytics/feedback-by-page.md): Returns feedback counts aggregated by documentation page path (thumbs up/down for contextual feedback, code snippet count, and total per page)
- [Get assistant conversations](/content/docs/api/analytics/assistant-conversations.md): Returns paginated AI assistant conversation history
- [Get assistant conversation thread](/content/docs/api/analytics/assistant-thread.md): Returns the full message transcript for a single assistant conversation thread. The thread ID is available from the assistant conversations endpoint, or as the `threadId` query parameter appended to assistant link-mode deflection support URLs.
- [Get assistant caller stats](/content/docs/api/analytics/assistant-caller-stats.md): Returns a breakdown of assistant query counts by caller type (web, API, and other) for the specified date range.
- [Get search queries](/content/docs/api/analytics/searches.md): Returns paginated documentation search terms for the date range, ordered by hit count descending. Each row includes click-through rate, the most-clicked result path for that query (if any), and the last time the term was searched. `totalSearches` is the total number of search query events in the sam…
- [Get page views](/content/docs/api/analytics/views.md): Returns per-path and site-wide content view event counts, split by human and AI traffic.
- [Get unique visitors](/content/docs/api/analytics/visitors.md): Returns per-path and site-wide approximate distinct visitors by traffic type. The `total` field is deduplicated across human and AI (union of distinct visitor IDs with any qualifying content view).

### Static export

- [Start static export job](/content/docs/api/static-export/start-job.md): Start a static export job for a deployment. The job pre-renders your documentation into a self-contained set of static HTML, RSC, and asset files, then packages the result as a single downloadable archive.
- [Get static export job status](/content/docs/api/static-export/get-job-status.md): Retrieve the current status of a static export job. Poll this endpoint after starting a job until `status` is `completed` (or `failed`).

## Help center

### Help center

- [Fix "Failed to fetch OpenAPI file for anchor or tab" error](/content/docs/help-center/openapi-url-fetch-fails-during-build.md): Fix Mintlify builds that fail to download a hosted OpenAPI document because of private hosts, authenticated URLs, TLS, DNS, or CI race conditions.
- [Fix "Domain already claimed by another organization" error](/content/docs/help-center/domain-already-claimed-by-another-organization.md): Release a custom domain from another Mintlify deployment or request help when adding it fails because another deployment or organization already holds it.
- [Configure OAuth 2.0 authentication with Auth0](/content/docs/help-center/configure-oauth-with-auth0.md): Set up Auth0 as the OAuth 2.0 identity provider for a private Mintlify docs site: endpoint URLs, callback registration, and group-based access.
- [Private repo missing when creating a second deployment](/content/docs/help-center/private-repo-missing-when-creating-second-deployment.md): Re-authorize Mintlify with private-repo access so an existing private GitHub repository shows up in the onboarding repo picker for a new deployment.
- [Fix a static file that returns 404 on your docs site](/content/docs/help-center/static-file-not-served.md): Diagnose why a file you added to your documentation repository (like a JSON, PDF, or image) does not load at its expected URL on your Mintlify site.
- [Preview deployment not created for a fork branch](/content/docs/help-center/preview-deployment-not-created-for-fork-branch.md): Why fork pull requests and fork branches passed to the preview API do not produce preview deployments, and how maintainers can preview fork changes.
- [Branch missing from the web editor branch list](/content/docs/help-center/branch-missing-from-editor-branch-list.md): Why a branch that exists in your repository does not appear in the web editor branch dropdown, and how to find it with search.
- [Style the icon inside a Card component](/content/docs/help-center/style-card-icons-with-custom-css.md): Add a background color, rounded corners, or padding to Card component icons using custom CSS and the card-icon data attribute selector.
- [Can I rename my deployment or organization?](/content/docs/help-center/can-i-rename-my-deployment-or-organization.md): Change your deployment's name from the dashboard, and learn why subdomains and organization names require deleting and recreating instead of renaming.
- [Tailwind classes not applying in the editor's live preview](/content/docs/help-center/tailwind-classes-not-applying-in-editor-preview.md): The web editor's live preview skips the build step that generates CSS for Tailwind classes. Check styling with mint dev or a preview deployment.
- [Fix agent runs blocked by a git provider IP allow list](/content/docs/help-center/agent-blocked-by-git-provider-ip-allow-list.md): Resolve agent session failures caused by a GitHub or GitLab IP allow list by routing your deployment through the Mintlify static IP.
- [Change your workspace icon](/content/docs/help-center/change-your-workspace-icon.md): Upload, replace, or remove the icon that represents your workspace in the Mintlify dashboard, and learn the supported file formats and size limit.
- [Advertise an externally-hosted MCP server](/content/docs/help-center/register-external-mcp-server-in-discovery.md): Expose a self-hosted MCP server alongside the built-in search MCP server on your docs domain, since Mintlify's discovery endpoints only list servers it hosts.

## Learn

### Guides

#### Overview

- [Guides](/content/docs/guides/index.md): Browse guides on documentation best practices, content strategy, SEO optimization, accessibility, and docs-as-code workflows for your team.

#### AI

- [Tutorial: Build an in-app documentation assistant](/content/docs/guides/assistant-embed.md): Build and embed an in-app documentation assistant that answers user questions with cited information from your Mintlify documentation site.
- [Configure automerge for GitHub Apps](/content/docs/guides/configure-automerge.md): Set up GitHub workflows to automatically merge Mintlify pull requests by adding the Mintlify bot to your repository's ruleset bypass list.
- [Use automations](/content/docs/guides/use-automations.md): Use Mintlify automations to automate recurring docs maintenance: choose the right trigger, write effective instructions, and get consistent agent results.
- [Write documentation with Claude Code](/content/docs/guides/claude-code.md): Configure Claude Code with CLAUDE.md project instructions to write, review, and update your Mintlify documentation following your style guide.
- [Write documentation with Codex](/content/docs/guides/codex.md): Configure OpenAI Codex CLI with project instructions and MCP to write Mintlify documentation that follows your style guide and MDX standards.
- [Write documentation with Cursor](/content/docs/guides/cursor.md): Configure Cursor with project rules to write Mintlify documentation that follows your style guide, component usage, and MDX conventions.
- [Write documentation with Devin Desktop](/content/docs/guides/devin-desktop.md): Configure Devin Desktop's Cascade AI with workspace rules to write Mintlify documentation that follows your style guide and MDX standards.
- [GEO guide: Optimize docs for AI search and answer engines](/content/docs/guides/geo.md): Optimize your documentation for AI-powered answer engines like ChatGPT, Perplexity, and Google AI Overviews with Generative Engine Optimization techniques.

#### API docs

- [Migrating MDX API pages to OpenAPI navigation](/content/docs/guides/migrating-from-mdx.md): Migrate your manually written MDX API pages to automated OpenAPI-generated documentation with flexible navigation and endpoint grouping.

#### Best practices

- [How to create accessible documentation](/content/docs/guides/accessibility.md): Create accessible documentation following WCAG guidelines with semantic HTML, keyboard navigation, alt text, and inclusive content practices.
- [Changelogs](/content/docs/create/changelogs.md): Create product changelogs with date-based entries, RSS feed support, and subscriber notifications to keep users informed about updates.
- [Documentation content types](/content/docs/guides/content-types.md): Choose the right documentation type for each page using the Diátaxis framework: tutorials, how-to guides, reference, and explanation.
- [Documentation content templates](/content/docs/guides/content-templates.md): Copy and modify ready-to-use MDX templates for how-to guides, tutorials, concept explanations, and API reference pages in your documentation.
- [Build custom page layouts](/content/docs/guides/custom-layouts.md): Use page modes and components to build custom landing pages, marketing pages, and other non-standard layouts in your Mintlify documentation.
- [How to measure and improve documentation quality](/content/docs/guides/improving-docs.md): Use analytics, user feedback, and content audits to identify documentation gaps and improve the pages that matter most to your users.
- [How to set up multi-language documentation](/content/docs/guides/internationalization.md): Set up multi-language documentation with locale-based routing, language switcher navigation, and translated content to reach global audiences.
- [How to link documentation pages effectively](/content/docs/guides/linking.md): Create internal links, anchor links, and deep links in your documentation, and maintain link integrity with redirects and broken link checks.
- [How to maintain documentation over time](/content/docs/guides/maintenance.md): Keep documentation accurate and up-to-date with review schedules, ownership models, automated checks, and content lifecycle practices.
- [How to use images, screenshots, and videos in documentation](/content/docs/guides/media.md): Learn when and how to use screenshots, GIFs, and videos in documentation with guidance on format selection, alt text, and long-term maintenance.
- [How to structure documentation navigation](/content/docs/guides/navigation.md): Design documentation navigation that helps users find what they need with clear information architecture, logical grouping, and validated structure.
- [How to improve documentation SEO](/content/docs/guides/seo.md): Improve your documentation's search engine rankings with page titles, keyword research, internal linking, and technical SEO techniques.
- [How to write technical documentation](/content/docs/guides/style-and-tone.md): Write clear, consistent technical documentation with practical guidance on voice, structure, terminology, and tone for developer and product docs.
- [How to understand your documentation audience](/content/docs/guides/understand-your-audience.md): Define your documentation audience, research their goals and knowledge level, and apply those insights to write content that helps them succeed.

#### Git

- [Git concepts for documentation](/content/docs/guides/git-concepts.md): Learn Git version control fundamentals for docs-as-code workflows, including repositories, branches, commits, and pull request collaboration.
- [Work with branches](/content/docs/guides/branches.md): Create and manage documentation branches to preview changes, collaborate with teammates, and merge updates before publishing to production.

#### Use cases

- [Create developer documentation](/content/docs/guides/developer-documentation.md): Build developer documentation that helps engineers integrate with your APIs, SDKs, and tools, including quickstarts, references, and guides.
- [Create a knowledge base](/content/docs/guides/knowledge-base.md): Host your internal knowledge base on Mintlify to consolidate information for your team, improve search, and reduce maintenance burden.
- [Create a help center](/content/docs/guides/help-center.md): Build a self-service help center on Mintlify that helps customers find answers, reduces support ticket volume, and scales with your team.
- [Headless docs with a custom frontend](/content/docs/guides/custom-frontend.md): Build a headless documentation frontend with Astro while using Mintlify for content management, AI-powered search, and assistant features.
- [Static export](/content/docs/api/static-export/overview.md): Generate a self-contained static export of your documentation and download it as a single bundle through the Mintlify REST API for self-hosting.

## OpenAPI Specs

- [openapi](/docs/es/openapi.json)
- [openapi](/docs/fr/openapi.json)
- [openapi](/docs/openapi.json)
- [openapi](/docs/zh/openapi.json)
- [admin-openapi](/docs/admin-openapi.json)
- [admin-openapi](/docs/es/admin-openapi.json)
- [admin-openapi](/docs/fr/admin-openapi.json)
- [admin-openapi](/docs/zh/admin-openapi.json)
- [discovery-openapi](/docs/discovery-openapi.json)
- [discovery-openapi](/docs/es/discovery-openapi.json)
- [discovery-openapi](/docs/fr/discovery-openapi.json)
- [discovery-openapi](/docs/zh/discovery-openapi.json)
- [index-openapi](/docs/es/index-openapi.json)
- [index-openapi](/docs/fr/index-openapi.json)
- [index-openapi](/docs/index-openapi.json)
- [index-openapi](/docs/zh/index-openapi.json)
- [analytics.openapi](/docs/analytics.openapi.json)
- [analytics.openapi](/docs/es/analytics.openapi.json)
- [analytics.openapi](/docs/fr/analytics.openapi.json)
- [analytics.openapi](/docs/zh/analytics.openapi.json)
- [static-export-openapi](/docs/es/static-export-openapi.json)
- [static-export-openapi](/docs/fr/static-export-openapi.json)
- [static-export-openapi](/docs/static-export-openapi.json)
- [static-export-openapi](/docs/zh/static-export-openapi.json)

## AsyncAPI Specs

- [asyncapi](/docs/asyncapi.yaml)
- [asyncapi](/docs/es/asyncapi.yaml)
- [asyncapi](/docs/fr/asyncapi.yaml)
- [asyncapi](/docs/zh/asyncapi.yaml)

## Optional

- [Learn](https://learn.mintlify.com/): Self-paced lessons to get the most from Mintlify.

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English / Documentation (181 pages)](/content/docs/_llms/en/documentation.md): Documentation for English / Documentation.
- [French (250 pages)](/content/docs/_llms/fr.md): Documentation for French.
- [French / Documentation (181 pages)](/content/docs/_llms/fr/documentation.md): Documentation for French / Documentation.
- [Spanish (250 pages)](/content/docs/_llms/es.md): Documentation for Spanish.
- [Spanish / Documentación (181 pages)](/content/docs/_llms/es/documentacion.md): Documentation for Spanish / Documentación.
- [Chinese (250 pages)](/content/docs/_llms/zh.md): Documentation for Chinese.
- [Chinese / 文档 (181 pages)](/content/docs/_llms/zh/tab.md): Documentation for Chinese / 文档.