Programming — entry 004 of 4

Mintlify

Verified Sep 2026

Mintlify's Admin API lets a documentation project's own backend trigger deployments, kick off AI agent jobs, and pull analytics (page views, search queries, feedback) via bearer-token endpoints prefixed mint_, confirmed live by a real request that returned a clean 401 "Unauthorized" rather than any generic error, with a separate CORS preflight also succeeding. Admin API access itself is gated to Mintlify's paid Pro plan and above — the free Starter tier covers hosting and the docs editor but not the Admin API — per its own current pricing page.

documentationapi-referencedocs-as-codedeveloper-tools
AuthenticationAPI KeySign up with the provider to obtain credentials.
HTTPSSupportedTraffic is encrypted in transit.
CORSEnabledCallable directly from browser JavaScript.
PricingFreemiumA usable free tier exists, with paid plans for more volume.
FormatsJSONResponses can be requested as JSON.

GreatAPIs Score

Score81out of 100
Authentication15/25API key required
Pricing17/20Freemium tier available
Docs20/20Machine-readable spec file bundled
Formats9/15Single response format
Freshness20/20Verified within 6 months

Embed this badge

Scored 81 on greatapis.com
<a href="https://greatapis.com/api/mintlify/"><img src="https://greatapis.com/badge/mintlify.svg" alt="Scored 81 on greatapis.com"></a>

Auth quickstart

  1. Get a key at the provider
  2. Send it on every request as a headerAuthorization: Bearer <key>
Stored keyNo key stored

Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.

Endpoints

Servers
https://api.mintlify.com/v1
Auth
bearerAuth
project3
POST/project/preview/{projectId}Trigger preview deployment
Parameters
NameInRequiredType
projectIdpathyesstring
Request body

application/json (required)

Responses
StatusDescriptionSchema
202Preview deployment queued successfully.
400Invalid request. The `branch` field is required.
403Preview deployments are not available on your current plan.
GET/project/update-status/{statusId}Get update status
Parameters
NameInRequiredType
statusIdpathyesstring
Responses
StatusDescriptionSchema
200A successful response
POST/project/update/{projectId}Trigger update
Parameters
NameInRequiredType
projectIdpathyesstring
Responses
StatusDescriptionSchema
202A successful response
workflow1
POST/workflow/{projectId}/{workflowSchemaId}/triggerTrigger automation
Parameters
NameInRequiredType
projectIdpathyesstring
workflowSchemaIdpathyesstring
Responses
StatusDescriptionSchema
202Automation run queued successfully.
400Invalid request. The automation ID is malformed, the automation is not active, or the automation is not configured with a custom schedule.
404The automation was not found or does not belong to this project.

Try it

Developer reference

Base URLhttps://api.mintlify.com/v1
Rate limit

10 requests/second and 1,000 requests/day per IP on the public Mintlify Index MCP server (429 on excess); separately, up to 10 API keys/hour per organization on the Admin REST API

Key endpoints
  • POST/project/update/{projectId}
  • GET/project/update-status/{statusId}
  • POST/project/preview/{projectId}