Mintlify REST API introduction

The Mintlify REST (Representational State Transfer) API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data.

​

Endpoints

• Trigger update: Trigger an update of your site when desired.
• Get update status: Get the status of an update and other details about your docs.
• Trigger preview deployment: Create or update a preview deployment for a specific branch.
• Trigger automation: Run a scheduled automation on demand.
• Detect AI-sounding prose: Analyze a page for AI-generated prose and get suggested human rewrites.
• Create agent job: Create an agent job to automatically edit your documentation.
• Get agent job: Retrieve the details and status of a specific agent job.
• Send follow-up message: Send a follow-up message to an existing agent job.
• Create assistant message: Embed the assistant, trained on your docs, into any application of your choosing.
• Search documentation: Search through your documentation.
• Get page content: Retrieve the full text content of a documentation page.
• Get user feedback: Export user feedback from your documentation.
• Get feedback by page: Export feedback counts aggregated by page.
• Get assistant conversations: Export AI assistant conversation history.
• Get assistant caller stats: Retrieve a breakdown of assistant query counts by caller type.
• Get search queries: Export documentation search terms and analytics.
• Get page views: Export per-page and site-wide content view counts.
• Get unique visitors: Export per-page and site-wide unique visitor counts.

​

Common use cases

• Automated deployments: Trigger site updates at set intervals or when events occur with Trigger update and Get update status.
• CI/CD integration: Update documentation as part of your deployment pipeline when code changes with Trigger update.
• Preview deployments: Create or update preview deployments programmatically in your CI/CD pipeline with Trigger preview deployment.
• On-demand automations: Run scheduled automations from your CI/CD pipeline or release tooling with Trigger automation.
• Assistant integrations: Embed the AI assistant into your product, support portal, or internal tools with Create assistant message.
• Documentation retrieval: Find and retrieve documentation for custom search experiences with Search documentation and Get page content.
• Automated editing: Use agent jobs to programmatically update documentation at scale with Create agent job, Get agent job, and Send follow-up message.
• Analytics export: Export feedback, assistant conversations, search analytics, page views, and visitor data for external analysis with Get user feedback, Get feedback by page, Get assistant conversations, Get assistant caller stats, Get search queries, Get page views, and Get unique visitors.

​

Authentication

Generate API keys on the API keys page in your dashboard. Each API key belongs to an organization—you can use keys across multiple deployments within the same organization. You can create up to 10 API keys per hour per organization. Mintlify uses two types of API keys, each scoped to a different set of endpoints:

​

Admin API key

Use the admin API key for deployment, triggering the agent, and analytics endpoints.

• Trigger update
• Get update status
• Trigger preview deployment
• Trigger automation
• Detect AI-sounding prose
• Create agent job
• Get agent job
• Send follow-up message
• Get user feedback
• Get feedback by page
• Get assistant conversations
• Get assistant caller stats
• Get search queries
• Get page views
• Get unique visitors

Admin API keys begin with the mint_ prefix. The admin API key is a server-side secret. Do not expose it in client-side code.

​

Assistant API key

Use the assistant API key to authenticate requests to the assistant, search, and page content endpoints.

• Create assistant message
• Search documentation
• Get page content

Assistant API keys begin with the mint_dsc_ prefix.