API Reference
Introduction
Trigger updates, embed AI assistant, and more
The Mintlify REST API enables you to programmatically interact with your documentation, trigger updates, and embed AI-powered chat experiences.
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.
- Generate assistant message: Embed the assistant, trained on your docs, into any application of your choosing.
- Search documentation: Search through your documentation.
Authentication
You can generate an API key through the dashboard. API keys are associated with an entire organization and can be used across multiple deployments.Admin API key
The admin API key is used for the Trigger update and Get update status endpoints. Admin API keys begin with themint_ prefix. Keep your admin API keys secret.
Assistant API key
The assistant API key is used for the Generate assistant message and Search documentation endpoints. Assistant API keys begin with themint_dsc_ prefix.
The assistant API key is a server-side token that should be kept secret.
The assistant API token is a public token that can be referenced in your frontend code.
Calls using the assistant API token can incur costs: either using your AI assistant credits or incurring overages.