# Mintlify API

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

- Skill: `nominal-io/mintlify-api` (Agent Skill)
- Install (CLI): `npx skillmds@latest add nominal-io/mintlify-api`
- Raw SKILL.md: https://api.skillmd.com/api/skills/nominal-io/mintlify-api/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- License: MIT
- Author: nominal-io (https://skillmd.com/u/nominal-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/nominal-io/mintlify-api

---


# 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://dashboard.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://dashboard.mintlify.com)
- [Deployment guide](https://mintlify.com/docs/deploy)