skills.rest
mpsuesser
mpsuesserCOMMUNITY
Explore all skills by this author →
GitHub

mintlify-api

Trigger Mintlify deployments and retrieve site metadata via authenticated HTTP requests.

Updated Mar 12, 2026
Search Tags:#ci/cd#documentation#api#preview#metadata#deployments#mintlify
One-click install
npx skills add https://github.com/mpsuesser/workspace --skill mintlify-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: mintlify-api
Source: https://github.com/mpsuesser/workspace/tree/main/dotconfig/pi/agent/skills/__techs__/.unused/mintlify-api
Command: npx skills add https://github.com/mpsuesser/workspace --skill mintlify-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you control a Mintlify documentation site from code instead of manually clicking through the dashboard each time you need a rebuild, a preview, or deployment status updates.

Core Features & Use Cases

  • Trigger deployments: Programmatically initiate documentation rebuilds when changes happen outside normal Git push events (for example, after a content pipeline finishes updating docs).
  • Query site metadata: Retrieve deployment information, configured domains, and navigation structure so your systems can react to current site state.
  • Manage preview deployments: Create and manage preview deployments for pull requests and branches to review changes before they go live.

Quick Start

Use the Mintlify REST API by sending your API key in the Authorization header to trigger a deployment or fetch the site’s metadata for a given environment.

Frequently Asked Questions about mintlify-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I trigger a Mintlify deployment programmatically from a CI/CD pipeline?▼

Trigger Mintlify deployments programmatically by sending authenticated HTTP requests with a Bearer API key to the Mintlify REST API, automating documentation rebuilds directly from your CI/CD pipeline after content updates.

Can I create preview deployments for pull requests on Mintlify?▼

Yes, you can create and manage Mintlify preview deployments for pull requests and branches via the API, enabling automated review of documentation changes across environments before they go live.

How do I retrieve Mintlify site metadata like configured domains and navigation?▼

Retrieve Mintlify site metadata by querying the REST API with your Bearer API key, returning configured domains, deployment information, and navigation structure for a given environment to react to current site state.

Do I need an API key to manage Mintlify deployments via the REST API?▼

Yes, managing Mintlify deployments requires an authenticated HTTP request using a Bearer API key in the Authorization header to securely trigger rebuilds, handle preview environments, and fetch site metadata.

When should I automate Mintlify deployments instead of using the dashboard?▼

Automate Mintlify deployments instead of using the dashboard when orchestrating rebuilds programmatically across branches and environments, such as after a content pipeline finishes updating docs outside normal Git push events.

Related Skills

Explore More Software Engineering Skills→
kubiyabotkubiyabot
16

http-skill

Send arbitrary HTTP requests to REST and GraphQL APIs.

Official
Advanced
dnvitidnviti
11

github-pages-updater

Audit repositories and generate GitHub Pages sites with GitHub Actions pipelines.

Community
Intermediate
QventuQventu

mintlify

Creates and maintains Mintlify documentation sites using CLI, MDX frontmatter, and docs.json.

Official
Intermediate
Pieverse-EngPieverse-Eng

aster

Generate signed EIP-712 requests for Aster Futures API endpoints.

Official
Advanced