# 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.

> ## Agent Instructions
> To set up a new Mintlify project for a user, follow the agent setup workflow in https://www.mintlify.com/docs/quickstart.md.
> For plans and pricing, see https://www.mintlify.com/pricing.md.

- [Documentation (187 pages)](https://www.mintlify.com/docs/_llms/en/documentation.txt): Documentation for Documentation.

## API reference

### API reference

- [Mintlify REST API introduction](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/docs/api/update/status.md): Get the status of an update from the status ID
- [Trigger preview deployment](https://www.mintlify.com/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](https://www.mintlify.com/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…
- [Trigger automation webhook](https://www.mintlify.com/docs/api/automations/webhook.md): Queue a run of a custom automation that has a webhook trigger, instead of waiting for the trigger's configured event. Useful for running automations from CI/CD pipelines, release scripts, or any other system that already emits events. Only custom automations with a webhook trigger can be triggered;…

### Agent

- [Get agent job](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/docs/api/assistant/search.md): Perform semantic and keyword searches across your documentation with configurable filtering and pagination.
- [Get page content](https://www.mintlify.com/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.

### Analytics

- [Get feedback](https://www.mintlify.com/docs/api/analytics/feedback.md): Returns paginated user feedback with optional filtering
- [Get feedback by page](https://www.mintlify.com/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](https://www.mintlify.com/docs/api/analytics/assistant-conversations.md): Returns paginated AI assistant conversation history
- [Get assistant conversation thread](https://www.mintlify.com/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](https://www.mintlify.com/docs/api/analytics/assistant-caller-stats.md): Returns a breakdown of assistant conversation counts by caller type (web, API, and other) for conversations started in the specified date range.
- [Get search queries](https://www.mintlify.com/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](https://www.mintlify.com/docs/api/analytics/views.md): Returns per-path and site-wide content view event counts, split by human and AI traffic.
- [Get unique visitors](https://www.mintlify.com/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](https://www.mintlify.com/docs/api/static-export/start-job.md): <Warning>**Static export is not publicly available.** It is only available on Enterprise plans. Contact [sales@mintlify.com](mailto:sales@mintlify.com) to request access.</Warning>
- [Get static export job status](https://www.mintlify.com/docs/api/static-export/get-job-status.md): <Warning>**Static export is not publicly available.** It is only available on Enterprise plans. Contact [sales@mintlify.com](mailto:sales@mintlify.com) to request access.</Warning>

## Help center

### Help center

- [Can I rename my project or organization?](https://www.mintlify.com/docs/help-center/can-i-rename-my-deployment-or-organization.md): Rename your project or organization from the dashboard, and learn why subdomains and organization slugs require deleting and recreating instead.
- [Change your organization icon](https://www.mintlify.com/docs/help-center/change-your-workspace-icon.md): Upload, replace, or remove the icon that represents your organization in the Mintlify dashboard, and learn the supported file formats and size limit.
- [Default mintlify.app subdomain indexed with custom domain](https://www.mintlify.com/docs/help-center/default-subdomain-indexed-alongside-custom-domain.md): Why your default <subdomain>.mintlify.app address stays crawlable after you add a custom domain, and how to remove it from search engine results.
- [Fix "Domain already claimed by another organization" error](https://www.mintlify.com/docs/help-center/domain-already-claimed-by-another-organization.md): Release a custom domain from another Mintlify project or request help when adding it fails because another project or organization already holds it.
- [Private repo missing when creating a second project](https://www.mintlify.com/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 project.
- [Preview deployment not created for a fork branch](https://www.mintlify.com/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.
- [Mintlify static IP for Git provider allowlists](https://www.mintlify.com/docs/help-center/ip-addresses-for-git-provider-allowlists.md): Add Mintlify's static egress IP 54.242.90.151 to the allowlist for GitHub Enterprise Cloud, GitHub Enterprise Server, and self-hosted GitLab instances.
- [Fix agent runs blocked by a git provider IP allow list](https://www.mintlify.com/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 project through the Mintlify static IP.
- [Configure OAuth 2.0 authentication with Auth0](https://www.mintlify.com/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.
- [Fix "Failed to fetch OpenAPI file for anchor or tab" error](https://www.mintlify.com/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 a static file that returns 404 on your docs site](https://www.mintlify.com/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.
- [Branch missing from the web editor branch list](https://www.mintlify.com/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.
- [Web editor shows "Repository unavailable"](https://www.mintlify.com/docs/help-center/editor-shows-repository-unavailable.md): Why the web editor shows a Repository unavailable notice when Mintlify can't reach your docs repository or deployment branch, and how to restore access.
- [Tailwind classes not applying in the editor's live preview](https://www.mintlify.com/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.
- [Style the icon inside a Card component](https://www.mintlify.com/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.
- [Fix site search returning no results](https://www.mintlify.com/docs/help-center/site-search-returns-no-results.md): Diagnose why your documentation site's built-in search returns no results for any query, often caused by hidden: true on a version in docs.json.
- [Fix llms.txt returning 404 while llms-full.txt works](https://www.mintlify.com/docs/help-center/llms-txt-returns-404-but-llms-full-txt-works.md): Diagnose why your documentation site's llms.txt file returns a 404 error while llms-full.txt still loads, usually caused by the Don't index project setting.
- [Advertise an externally hosted MCP server](https://www.mintlify.com/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.
- [Why your visitor count dropped after crawler filtering](https://www.mintlify.com/docs/help-center/visitor-count-dropped-after-crawler-filtering.md): Understand why visitor totals in Mintlify analytics dropped in September 2026 after crawler traffic was excluded from visitor counts.
- [Migrate from Confluence to Mintlify](https://www.mintlify.com/docs/help-center/migrate-from-confluence.md): Use the manual migration workflow to convert exported Confluence content into a Mintlify project.
- [Migrate docs into Mintlify from a ZIP export](https://www.mintlify.com/docs/help-center/migrate-docs-from-a-zip-export.md): Mintlify has no direct ZIP upload. Learn how to convert a ZIP export from Document360, ReadMe, or another platform into a Mintlify project.
- [Agent PRs open against your deploy branch](https://www.mintlify.com/docs/help-center/agent-opens-pull-requests-against-deploy-branch.md): Why the Mintlify agent and automations open pull requests against your deploy branch, and how to send changes to a different branch.
- [Publish button disabled because of invalid MDX](https://www.mintlify.com/docs/help-center/publish-button-disabled-invalid-mdx.md): Why the Publish button in the editor is disabled with the message 'Fix invalid MDX before publishing' and how to find and fix the page with the error.
- [Fix "Must be a valid url" error for logo.href or navbar.primary.href](https://www.mintlify.com/docs/help-center/docs-json-href-must-be-a-valid-url.md): Resolve docs.json validation errors when you use a relative path like /contact in logo.href, navbar.links, or navbar.primary.href.
- [Fix "frontmatter must be a single endpoint string" deploy errors](https://www.mintlify.com/docs/help-center/endpoint-frontmatter-must-be-a-single-string.md): Resolve failed deployments caused by openapi, api, or asyncapi page frontmatter that lists multiple endpoints or uses a non-string value.
- [Docs site refuses to load in an iframe](https://www.mintlify.com/docs/help-center/embed-docs-site-in-iframe.md): Learn why your Mintlify documentation site refuses to load inside an iframe on another domain and how to request that your app's origins be allowed.
- [Custom components flash or are missing from page source](https://www.mintlify.com/docs/help-center/custom-components-flash-or-missing-from-page-source.md): Custom React components in Mintlify render in the browser after the page loads, so they are not in the initial HTML. Use built-in components for content that must render on the server.

## Learn

### Guides

#### Overview

- [Guides](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/docs/guides/accessibility.md): Create accessible documentation following WCAG guidelines with semantic HTML, keyboard navigation, alt text, and inclusive content practices.
- [Changelogs](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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](https://www.mintlify.com/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)
- [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 (187 pages)](https://www.mintlify.com/docs/_llms/en/documentation.txt): Documentation for English / Documentation.
- [French (266 pages)](https://www.mintlify.com/docs/_llms/fr.txt): Documentation for French.
- [French / Documentation (187 pages)](https://www.mintlify.com/docs/_llms/fr/documentation.txt): Documentation for French / Documentation.
- [Spanish (266 pages)](https://www.mintlify.com/docs/_llms/es.txt): Documentation for Spanish.
- [Spanish / Documentación (187 pages)](https://www.mintlify.com/docs/_llms/es/documentacion.txt): Documentation for Spanish / Documentación.
- [Chinese (266 pages)](https://www.mintlify.com/docs/_llms/zh.txt): Documentation for Chinese.
- [Chinese / 文档 (187 pages)](https://www.mintlify.com/docs/_llms/zh/tab.txt): Documentation for Chinese / 文档.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.