Mintlify

Trigger Update

Queue a deployment update for a Mintlify documentation project from its configured deployment branch. Returns a status ID for tracking progress.

Get Update Status

Get the status of a Mintlify deployment update from its status ID, including logs, commit details, and screenshots.

Trigger Preview Deployment

Create or update a Mintlify preview deployment for a Git branch. Redeploys when a preview already exists for the branch.

Trigger Automation

Run a scheduled Mintlify automation immediately instead of waiting for its next scheduled time. Only automations with a custom schedule can be triggered.

Create Agent Job

Create a background Mintlify agent job that edits your documentation from a prompt. Opens a pull request when the agent successfully edits files.

Get Agent Job

Retrieve the current status and details of a Mintlify agent job, including the pull request link once the agent opens one.

Send Agent Message

Send a follow-up instruction to an existing Mintlify agent job. The message is processed asynchronously.

Detect AI-Sounding Prose

Analyze a documentation page for AI-generated prose and return flagged passages with suggested human rewrites. Consumes one AI credit per checked page.

Search Documentation

Run a semantic and keyword search across a Mintlify documentation site, with optional version, language, tag, and group filters.

Get Page Content

Retrieve the full text content of a Mintlify documentation page by its path. Use it after a search to fetch the complete page.

Ask Assistant

Ask the Mintlify assistant, trained on your documentation, a question and get the assembled answer with its cited sources. Consumes the deployment's assistant credits.

Get Feedback

Export paginated user feedback from a Mintlify documentation project, with optional date-range, source, and status filters.

Get Feedback By Page

Export Mintlify feedback counts aggregated by documentation page path, broken down into thumbs up, thumbs down, and code snippet feedback.

Get Assistant Conversations

Export paginated Mintlify AI assistant conversation history, including the query, response, cited sources, and whether the question was answered.

Get Assistant Caller Stats

Get a breakdown of Mintlify assistant query counts by caller type — web, API, and other — for a date range.

Get Search Queries

Export Mintlify documentation search terms for a date range, ordered by hit count, with click-through rate and the most-clicked result path.

Get Page Views

Export Mintlify per-path and site-wide content view counts for a date range, split by human and AI bot traffic.

Get Unique Visitors

Export Mintlify per-path and site-wide approximate distinct visitor counts for a date range, split by human and AI bot traffic.