Mintlify

Mintlify is a documentation platform for building, deploying, and maintaining developer docs. Docs live as MDX in your Git repository, deploy on every merge, and ship with a built-in AI assistant trained on your content.

With Mintlify, you can:

• Deploy documentation from Git: Trigger production updates and per-branch preview deployments, then poll deployment status for logs, commit details, and screenshots
• Run automations on demand: Kick off a scheduled automation immediately from CI/CD instead of waiting for its next run
• Edit docs with an agent: Launch background agent jobs from a prompt, send follow-up instructions, and get a pull request when the agent changes files
• Check writing quality: Analyze a page for AI-sounding prose and get flagged passages with suggested human rewrites
• Search and retrieve content: Run semantic and keyword search across your docs, then fetch the full text of any matching page
• Ask the docs assistant: Get a grounded answer with its cited source pages, and continue the conversation across turns with a thread ID
• Export analytics: Pull user feedback, assistant conversations, caller stats, search queries, page views, and unique visitors

In Sim, the Mintlify integration lets your agents ship docs, drive documentation agent jobs, answer questions from your published content, and measure how that content performs — all from a single block.

Authentication. Mintlify issues two key types for these endpoints, and the API Key field takes whichever the selected operation needs:

• Admin API key (mint_ prefix) — Trigger Update, Get Update Status, Trigger Preview Deployment, Trigger Automation, Create/Get Agent Job, Send Agent Message, Detect AI-Sounding Prose, and every analytics export
• Assistant API key (mint_dsc_ prefix) — Search Documentation, Get Page Content, and Ask Assistant

Generate both on the API keys page in your Mintlify dashboard. The Project ID used by the admin operations is on the same page; the Domain used by the assistant operations is the identifier at the end of your dashboard URL (app.mintlify.com/organization/domain). The REST API requires a Mintlify Pro or Enterprise plan.

Usage Instructions

Integrate Mintlify into your workflow. Trigger production and preview deployments, run scheduled automations, launch documentation agent jobs, detect AI-sounding prose, search your docs and read page content, ask the docs assistant, and export feedback, conversation, search, view, and visitor analytics.

Actions

Mintlify Trigger Update

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

Input

Output

Mintlify Get Update Status

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

Input

Output

Mintlify Trigger Preview Deployment

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

Input

Output

Mintlify 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.

Input

Output

Mintlify 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.

Input

Output

Mintlify 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.

Input

Output

Mintlify Get Agent Job

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

Input

Output

Mintlify Send Agent Message

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

Input

Output

Mintlify Search Documentation

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

Input

Output

Mintlify 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.

Input

Output

Mintlify Create Assistant Message

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.

Input

Output

Mintlify Get Feedback

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

Input

Output

Mintlify Get Feedback By Page

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

Input

Output

Mintlify Get Assistant Conversations

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

Input

Output

Mintlify Get Assistant Caller Stats

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

Input

Output

Mintlify 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.

Input

Output

Mintlify Get Page Views

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

Input

Output

Mintlify 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.

Input

Output