// Interact with the Mintlify REST API to manage deployments, trigger builds, and query documentation site metadata programmatically.
| name | mintlify-api |
| description | Interact with the Mintlify REST API to manage deployments, trigger builds, and query documentation site metadata programmatically. |
| license | MIT |
| compatibility | Any HTTP client. Authentication via API key. |
| metadata | {"author":"mintlify","version":"1.0"} |
Use the Mintlify API to manage documentation sites programmatically. This skill covers deployment management, build triggers, and site metadata queries.
All API requests require an API key passed in the Authorization header:
Authorization: Bearer <your-api-key>
Generate API keys from the Mintlify dashboard under Settings > API Keys.
Programmatically trigger a documentation rebuild when your codebase changes outside of Git push events.
Retrieve information about your documentation site including deployment status, configured domains, and navigation structure.
Create and manage preview deployments for pull requests and branches to review documentation changes before they go live.
Comprehensive reference for building Mintlify documentation sites. Use when creating pages, configuring docs.json, adding components, setting up navigation, or working with API references. Routes to detailed reference files for all components and configuration options.
Read and navigate external documentation efficiently. Invoke when the task requires checking how a specific function, endpoint, or configuration option works; when the user references an API, SDK, library, or third-party tool by name; when any docs URL or documentation site is mentioned; or when implementing something that depends on an external service or package.
Write, edit, and maintain documentation. Use for collaborative drafting, autonomous writing, or improving existing docs. Defaults to collaborative mode where the human makes final decisions. Built by Mintlify.
Add new pages to docs.json navigation structure. Updates navigation groups based on user journey (Customize, Deploy, etc.). Use when the user asks to add a page to navigation, update docs.json, add to nav, or include a new page in the sidebar.