mintlify-api
mintlify.com
Programmatically manage Mintlify documentation deployments, builds, and site metadata via REST API.
What is mintlify-api?
The Mintlify API skill enables you to interact with Mintlify's REST API to automate documentation site management. Use it to trigger deployments, manage preview builds, and query site metadata without manual dashboard access.
- Trigger documentation rebuilds programmatically when codebase changes occur
- Query site metadata including deployment status, domains, and navigation structure
- Create and manage preview deployments for pull requests and branches
- Authenticate via API key for secure programmatic access
How to install mintlify-api
npx skills add null --skill mintlify-api- Mintlify account with documentation site set up
- API key generated from Mintlify dashboard (Settings > API Keys)
- HTTP client or SDK for making REST requests
How to use mintlify-api
- 1.Generate an API key from your Mintlify dashboard under Settings > API Keys
- 2.Include the API key in the Authorization header as `Bearer <your-api-key>` for all requests
- 3.Call the appropriate API endpoint to trigger deployments, query metadata, or manage previews
- 4.Consult the API reference documentation for endpoint-specific parameters and response formats
Use cases
- Automate documentation builds as part of CI/CD pipelines when code is merged
- Generate preview deployments automatically for pull requests to review doc changes before publishing
- Retrieve deployment status and site configuration data for monitoring or reporting
- Trigger rebuilds on external events outside of Git push workflows
- DevOps engineers automating documentation workflows
- Backend developers integrating docs into CI/CD systems
- Documentation maintainers managing multiple preview environments
- Teams using Mintlify for API or product documentation
mintlify-api FAQ
Generate API keys from the Mintlify dashboard at app.mintlify.com under Settings > API Keys.
Yes, you can create and manage preview deployments for pull requests and branches to review changes before they go live.
The API uses bearer token authentication via the Authorization header with your API key.
Yes, you can retrieve site metadata including deployment status, configured domains, and navigation structure.
Full instructions (SKILL.md)
Source of truth, from mintlify.com.
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"
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 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
Related skills
More from mintlify.com and the wider catalog.
mintlify
Guidance for writing and organizing Mintlify documentation sites correctly the first time.
antislop
System rules for AI agents to generate crafted UI, copy, and code—not generic AI slop.
antislop-code
Remove generic AI-slop comments from code while preserving valuable ones—never touch the code itself.
antislop-copywriting
Rules and patterns for writing human-sounding copy: avoid AI tells in headlines, tone, CTAs, and prose.
antislop-human
Accessibility rules for UI: contrast, keyboard, focus, and mobile usability for real people.
antislop-layoutmobile
Mobile layout rules for responsive design: grids, breakpoints, sizing, and tap targets that reflow across screen sizes.