Mintlify API

Name: Mintlify API API
Brand: Mintlify API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsProject Managementbearer9 EndpointsREST

For Agents

Trigger documentation deployments, run agent-driven doc edit jobs, query the AI assistant, and pull feedback analytics from a Mintlify project.

Quickstart

Get started with Mintlify API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"trigger a documentation deployment"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Mintlify API API.

Trigger a fresh documentation deployment with POST /v1/project/update/{projectId} and poll status via GET /v1/project/update-status/{statusId}

Create a Mintlify agent job to edit docs programmatically with POST /v2/agent/{projectId}/job

Send a follow-up message into an existing agent job using POST /v2/agent/{projectId}/job/{id}/message

Ask the docs AI assistant a question through POST /discovery/v2/assistant/{domain}/message

GET STARTED

Start building with Mintlify API API

Explore with Jentic

View OpenAPI Document

Use for: Trigger a fresh deployment of the docs site for project abc, Check whether the latest doc build has finished, Create an agent job to add a section about webhooks to the docs, Send a follow-up message refining the agent's draft

Not supported: Does not handle source code hosting, CI pipelines, or end-user authentication — use for documentation deployments, agent edits, and docs assistant queries only.

Jentic publishes the only available OpenAPI document for Mintlify API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Mintlify API, keeping it validated and agent-ready. Mintlify is a documentation platform that publishes developer docs sites and ships an AI assistant for end users. The REST API exposes deployment triggers, agent-driven documentation editing jobs, an assistant message endpoint, search over published docs, and analytics over feedback and assistant conversations. Useful for keeping docs deployed, programmatically editable, and queryable from automation.

Use Cases

Patterns agents use Mintlify API API for, with concrete tasks.

★ CI-Triggered Docs Deployment

Kick off a Mintlify deployment from a CI pipeline by calling POST /v1/project/update/{projectId} after a docs commit lands. The status id returned can be polled until the build finishes, gating the release on a clean docs publish. Removes the need for a UI click on every release.

POST /v1/project/update/{projectId} after merge, then poll GET /v1/project/update-status/{statusId} every 10 seconds until status is success

Agent-Authored Documentation Edits

Create a Mintlify agent job to draft new pages or fix existing ones with natural-language instructions via POST /v2/agent/{projectId}/job. Reviewers refine the output by sending follow-up messages into the same job, producing a doc PR without hand-editing markdown.

POST /v2/agent/{projectId}/job with instructions to add a webhooks page, then send refinement messages with POST /v2/agent/{projectId}/job/{id}/message

Embedded Docs Q&A

Power an in-product help widget by calling the assistant message endpoint at POST /discovery/v2/assistant/{domain}/message with the user's question and the published docs domain. The response is a grounded answer over your documentation. Reduces support load by letting users self-serve common questions inside your app.

POST /discovery/v2/assistant/{domain}/message with the user's question and surface the answer in the in-product help drawer

Docs Search Integration

Surface Mintlify-hosted docs results inside another tool with POST /discovery/v1/search/{domain}. The endpoint returns matching pages and snippets so the calling app can render its own search UI without forcing users to leave for the docs site.

POST /discovery/v1/search/{domain} with the query string and render the top 5 results inline in the developer dashboard

Agent-Driven Docs Operations

An AI agent uses Jentic to keep docs healthy: deploy after every release, edit pages on demand from PR descriptions, and report on feedback. The Mintlify admin and assistant tokens stay in the Jentic vault so the agent never holds them directly.

Search Jentic for 'trigger a docs deployment', load the Mintlify update schema, and deploy projectId after the release tag is pushed

Key Endpoints

9 endpoints — jentic publishes the only available openapi specification for mintlify api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v1/project/update/{projectId}

Trigger a docs deployment

GET

/v1/project/update-status/{statusId}

Get deployment status

POST

/v2/agent/{projectId}/job

Create an agent docs job

POST

/v2/agent/{projectId}/job/{id}/message

Send a follow-up message

POST

/discovery/v2/assistant/{domain}/message

Ask the docs assistant

POST

/discovery/v1/search/{domain}

Search published docs

GET

/v1/analytics/{projectId}/feedback

Get user feedback

POST

/v1/project/update/{projectId}

Trigger a docs deployment

GET

/v1/project/update-status/{statusId}

Get deployment status

POST

/v2/agent/{projectId}/job

Create an agent docs job

POST

/v2/agent/{projectId}/job/{id}/message

Send a follow-up message

POST

/discovery/v2/assistant/{domain}/message

Ask the docs assistant

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Mintlify uses two bearer tokens — admin and assistant. Jentic stores both in the vault and picks the correct one for each operation, so agents call deploy, agent-job, and assistant endpoints without juggling secrets.

Intent-based discovery

Agents search Jentic for intents like 'trigger a docs deployment' or 'ask the docs assistant' and Jentic returns the right Mintlify operation with its input schema and the matching token already wired.

Time to first call

Direct Mintlify integration: roughly a day to handle two bearer tokens, two URL roots, and async deployment polling. Through Jentic: under an hour.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Stoplight

Stoplight focuses on API design and reference docs derived from OpenAPI

Choose Stoplight when API reference quality is the priority and you do not need an embedded docs assistant

Complementary

Notion

Notion stores internal source content that can feed into Mintlify pages

Use Notion upstream for collaborative drafting and Mintlify downstream for the public, branded docs site

Complementary

Linear

Linear tracks the engineering work that lands in each docs deployment

Use Linear to capture docs tasks and let an agent close them when the corresponding Mintlify deployment succeeds

FAQs

Specific to using Mintlify API API through Jentic.

Why is there no official OpenAPI spec for Mintlify API?

Mintlify does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Mintlify API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Mintlify API use?

Mintlify uses two HTTP bearer tokens — an admin bearer for project and agent endpoints, and an assistant bearer for the discovery assistant and search endpoints. Both go in the Authorization header. Jentic stores both in the vault and selects the correct one per operation.

Can I deploy my docs from CI with the Mintlify API?

Yes. Call POST /v1/project/update/{projectId} after the docs commit lands; the response returns a status id. Poll GET /v1/project/update-status/{statusId} until it reports a successful build.

How do agent jobs differ from a normal deployment?

Agent jobs at POST /v2/agent/{projectId}/job ask Mintlify's documentation agent to draft or edit pages from natural-language instructions. The agent produces a draft you can refine via follow-up messages on /v2/agent/{projectId}/job/{id}/message. Deployments simply rebuild and publish the current source.

How do I query the docs assistant through Jentic?

Run `pip install jentic`, search Jentic for 'ask the docs assistant', and Jentic returns POST /discovery/v2/assistant/{domain}/message. Provide the published docs domain and the user question; the answer comes back grounded on the docs content.

How do I monitor docs feedback and assistant conversations?

GET /v1/analytics/{projectId}/feedback returns thumbs-up and thumbs-down ratings on docs pages, while GET /v1/analytics/{projectId}/assistant returns conversation history. Schedule the agent to pull both endpoints daily and report on quality trends.