/mintlify-api
Interact with the Mintlify REST API to manage deployments, trigger builds, and query documentation site metadata programmatically.
$ npx -y skills add mintlify/docs --skill mintlify-api --agent claude-codeHow it fires
How this skill gets triggered: by you, by Claude, or both.
- Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.Auto-invocation is when the right skill fires by itself at the right moment, driven by a FLOW.md router and a hook, instead of you invoking it by name. It is the difference between a skill being installed and a skill actually getting used.Read the full definition →
- You can call itInvoke it directly when you want it.
- Slash command
/mintlify-api
Context preview
The summary Claude sees to decide when to auto-load this skill.
Interact with the Mintlify REST API to manage deployments, trigger builds, and query documentation site metadata programmatically.
SKILL.md
mintlify-api.SKILL.mdname: 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"
Mintlify API
Use the Mintlify API to manage documentation sites programmatically. This skill covers deployment management, build triggers, and site metadata queries.
Authentication
All API requests require an API key passed in the `Authorization` header:
Authorization: Bearer <your-api-key>
Generate API keys from the [Mintlify dashboard](https://app.mintlify.com) under Settings > API Keys.
Core capabilities
Trigger deployments
Programmatically trigger a documentation rebuild when your codebase changes outside of Git push events.
Query site metadata
Retrieve information about your documentation site including deployment status, configured domains, and navigation structure.
Manage preview deployments
Create and manage preview deployments for pull requests and branches to review documentation changes before they go live.
Resources
- [API reference](https://mintlify.com/docs/api)
- [Dashboard](https://app.mintlify.com)
- [Deployment guide](https://mintlify.com/docs/deploy)
Install the Mint CLI to preview the documentation changes locally. To install, use the following command Run the following command at the root of your documentation (where docs.json is)
Repo: mintlify/docs
Other skills on docs.
- /doc-author
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.
Open skill - /doc-reader
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
Open skill - /mintlify
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.
Open skill - /mintlify
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.
Open skill - /mintlify-docs
Build and maintain documentation sites with Mintlify. Use when creating docs pages, configuring navigation, adding components, or setting up API references.
Open skill