HomePricingHow it worksSkills
Log in

mintlify-api

All-time installs
1,605

Interact with the Mintlify REST API to manage deployments, trigger builds, and query documentation site metadata programmatically.

Install

Other options

Summary

Interact with the Mintlify REST API to manage deployments, trigger builds, and query documentation site metadata programmatically.

Raw SKILL.md

1,320 bytes
---
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](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)

Security audits