Tools

Mintlify

Deploy, edit, search, and measure Mintlify documentation

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.

Tools

`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

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`statusId`	string	Status ID of the queued update. Poll it with Get Update Status.

`mintlify_get_update_status`

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

Input

Parameter	Type	Required	Description
`statusId`	string	Yes	Status ID returned by Trigger Update or Trigger Preview Deployment
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`id`	string	Status ID of the update
`projectId`	string	Documentation project ID
`createdAt`	string	ISO 8601 UTC start time
`endedAt`	string	ISO 8601 UTC end time
`status`	string	Update status: queued, in_progress, success, or failure
`summary`	string	Summary of the update status
`logs`	array	Deployment log lines
`subdomain`	string	Subdomain of the docs being updated
`screenshot`	string	Screenshot of the docs
`screenshotLight`	string	Light-mode screenshot of the docs
`screenshotDark`	string	Dark-mode screenshot of the docs
`author`	object	Author of the update
`commit`	object	Commit that produced the update
`source`	string	Source of the update trigger: internal, github-app-installation, api, github, dashboard, gitlab, or onboarding

`mintlify_trigger_preview`

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

Input

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`branch`	string	Yes	Name of the Git branch to create a preview deployment for
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`statusId`	string	Status ID for tracking the preview deployment
`previewUrl`	string	URL where the preview deployment is hosted

`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

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`automationId`	string	Yes	Automation ID, copied from the automation's settings panel on the Automations page
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`schemaId`	string	ID of the triggered automation
`instanceId`	string	ID of the queued automation run, visible in the run history
`jobId`	string	ID of the background job processing the run

`mintlify_detect_ai_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

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`path`	string	Yes	Repo-relative path of the page, used for reporting only
`content`	string	Yes	Raw MDX or Markdown content of the page to check (max 1,000,000 characters)
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`path`	string	Path from the request
`skipped`	string	Reason the page was skipped ("too_short"), or null when the page was checked
`predictionShort`	string	Overall verdict for the page: AI, AI-Assisted, Human, or Mixed. Null when the page was skipped.
`fractionAi`	number	Fraction of the page detected as AI-generated (0-1). Null when the page was skipped.
`fractionAiAssisted`	number	Fraction of the page detected as AI-assisted (0-1). Null when the page was skipped.
`fractionHuman`	number	Fraction of the page detected as human-written (0-1). Null when the page was skipped.
`windows`	array	Flagged non-human passages with line ranges and suggested rewrites. Empty when the page was skipped.
`creditsCharged`	number	AI credits charged for this request (0 when skipped)

`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

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`prompt`	string	Yes	The instruction for the agent to execute
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`id`	string	Unique identifier for the agent job
`status`	string	Current job status: active, completed, archived, or failed
`source`	object	Source repository information
`model`	string	AI model used for this job
`prLink`	string	GitHub pull request URL created by the agent. Null while the job is active or if no files changed.
`createdAt`	string	Timestamp when the job was created
`archivedAt`	string	Timestamp when the job was archived

`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

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`jobId`	string	Yes	Unique identifier of the agent job
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`id`	string	Unique identifier for the agent job
`status`	string	Current job status: active, completed, archived, or failed
`source`	object	Source repository information
`model`	string	AI model used for this job
`prLink`	string	GitHub pull request URL created by the agent. Null while the job is active or if no files changed.
`createdAt`	string	Timestamp when the job was created
`archivedAt`	string	Timestamp when the job was archived

`mintlify_send_agent_message`

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

Input

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`jobId`	string	Yes	Unique identifier of the agent job to send a message to
`prompt`	string	Yes	The follow-up instruction for the agent
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`id`	string	Unique identifier for the agent job
`status`	string	Current job status: active, completed, archived, or failed
`source`	object	Source repository information
`model`	string	AI model used for this job
`prLink`	string	GitHub pull request URL created by the agent. Null while the job is active or if no files changed.
`createdAt`	string	Timestamp when the job was created
`archivedAt`	string	Timestamp when the job was archived

`mintlify_search`

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

Input

Parameter	Type	Required	Description
`domain`	string	Yes	Domain identifier from your domain.mintlify.site URL, found at the end of your dashboard URL
`query`	string	Yes	Search query to execute against your documentation content
`pageSize`	number	No	Number of search results to return, between 1 and 50 (default 10)
`scoreThreshold`	number	No	Minimum relevance score for results, between 0 and 1
`version`	string	No	Filter results by documentation version
`language`	string	No	Filter results by content language
`tag`	string	No	Filter results by tag
`groups`	json	No	Documentation groups the caller is authorized to access, as a JSON array of strings. Only applies to deployments using auth or userAuth.
`apiKey`	string	Yes	Mintlify assistant API key (starts with mint_dsc_)

Output

Parameter	Type	Description
`results`	array	Matching documentation chunks ordered by relevance
`resultCount`	number	Number of results returned

`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

Parameter	Type	Required	Description
`domain`	string	Yes	Domain identifier from your domain.mintlify.site URL, found at the end of your dashboard URL
`path`	string	Yes	Page slug or path to retrieve, matching the path field returned by Search Documentation
`groups`	json	No	Documentation groups the caller is authorized to access, as a JSON array of strings. Only applies to deployments using auth or userAuth.
`apiKey`	string	Yes	Mintlify assistant API key (starts with mint_dsc_)

Output

Parameter	Type	Description
`path`	string	The page path that was requested
`content`	string	Full text content of the page

`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

Parameter	Type	Required	Description
`domain`	string	Yes	Domain identifier from your domain.mintlify.site URL, found at the end of your dashboard URL
`message`	string	No	The question to ask the assistant. Ignored when a full Messages array is supplied.
`messages`	json	No	Full AI SDK message array for multi-turn conversations, each entry with id, role, and parts. Overrides Message when provided.
`fp`	string	No	Fingerprint identifier for tracking conversation sessions (default "anonymous")
`threadId`	string	No	Thread ID from a previous response, to continue the same conversation
`retrievalPageSize`	number	No	Number of documentation search results used to generate the response
`currentPath`	string	No	Path of the page the user is currently viewing, for more relevant answers (max 200 characters)
`version`	string	No	Filter retrieval by documentation version
`language`	string	No	Filter retrieval by content language
`groups`	json	No	Group identifiers to filter retrieval by, as a JSON array of strings
`assistantContext`	json	No	Contextual snippets for the assistant, as a JSON array of objects with type ("code" or "textSelection"), value, and optional path and elementId
`apiKey`	string	Yes	Mintlify assistant API key (starts with mint_dsc_)

Output

Parameter	Type	Description
`text`	string	Assembled assistant answer
`threadId`	string	Thread ID for continuing this conversation in a follow-up call
`sources`	array	Documentation sources the assistant cited

`mintlify_get_feedback`

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

Input

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`dateFrom`	string	No	Inclusive start date in ISO 8601 or YYYY-MM-DD format
`dateTo`	string	No	Exclusive end date in ISO 8601 or YYYY-MM-DD format
`source`	string	No	Filter by feedback source: code_snippet, contextual, agent, or thumbs_only
`status`	string	No	Comma-separated statuses to filter by: pending, in_progress, resolved, dismissed
`limit`	number	No	Max results per page, between 1 and 100 (default 50)
`cursor`	string	No	Pagination cursor returned as nextCursor by a previous call
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`feedback`	array	Feedback entries for the requested window
`nextCursor`	string	Cursor for the next page, or null when there are no more results
`hasMore`	boolean	Whether additional results are available

`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

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`dateFrom`	string	No	Inclusive start date in ISO 8601 or YYYY-MM-DD format
`dateTo`	string	No	Exclusive end date in ISO 8601 or YYYY-MM-DD format
`limit`	number	No	Max results per page, between 1 and 100 (default 10)
`source`	string	No	Filter by feedback source: code_snippet, contextual, agent, or thumbs_only
`status`	string	No	Comma-separated statuses to filter by: pending, in_progress, resolved, dismissed
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`feedback`	array	Feedback counts aggregated by documentation page path
`hasMore`	boolean	Whether additional results are available

`mintlify_get_assistant_conversations`

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

Input

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`dateFrom`	string	No	Inclusive start date in ISO 8601 or YYYY-MM-DD format
`dateTo`	string	No	Exclusive end date in ISO 8601 or YYYY-MM-DD format
`limit`	number	No	Max results per page, between 1 and 1000 (default 100)
`cursor`	string	No	ULID pagination cursor returned as nextCursor by a previous call
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`conversations`	array	Assistant conversations for the requested window
`nextCursor`	string	Cursor for the next page, or null when there are no more results
`hasMore`	boolean	Whether additional results are available

`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

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`dateFrom`	string	No	Inclusive start date in ISO 8601 or YYYY-MM-DD format
`dateTo`	string	No	Exclusive end date in ISO 8601 or YYYY-MM-DD format
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`web`	number	Assistant queries originating from the documentation site
`api`	number	Assistant queries originating from API calls
`other`	number	Assistant queries from other sources such as integrations and SDKs
`total`	number	Total assistant queries across all caller types

`mintlify_get_searches`

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

Input

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`dateFrom`	string	No	Inclusive start date in ISO 8601 or YYYY-MM-DD format
`dateTo`	string	No	Exclusive end date in ISO 8601 or YYYY-MM-DD format
`limit`	number	No	Max search terms per page, between 1 and 100 (default 50)
`cursor`	string	No	Opaque pagination cursor returned as nextCursor by a previous call
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`searches`	array	Search terms ordered by hit count descending
`totalSearches`	number	Total search events in the date range, summing all hits rather than distinct queries
`nextCursor`	string	Cursor for the next page, or null when there are no more results

`mintlify_get_views`

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

Input

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`dateFrom`	string	No	Inclusive start date in ISO 8601 or YYYY-MM-DD format
`dateTo`	string	No	Exclusive end date in ISO 8601 or YYYY-MM-DD format
`limit`	number	No	Max results per page, between 1 and 250 (default 50)
`offset`	number	No	Number of rows to skip for offset-based pagination (default 0)
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`totals`	object	Site-wide content view event counts for the date range
`views`	array	Per-page content view event counts
`hasMore`	boolean	Whether additional results are available

`mintlify_get_visitors`

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

Input

Parameter	Type	Required	Description
`projectId`	string	Yes	Mintlify project ID, copied from the API keys page in your dashboard
`dateFrom`	string	No	Inclusive start date in ISO 8601 or YYYY-MM-DD format
`dateTo`	string	No	Exclusive end date in ISO 8601 or YYYY-MM-DD format
`limit`	number	No	Max results per page, between 1 and 250 (default 50)
`offset`	number	No	Number of rows to skip for offset-based pagination (default 0)
`apiKey`	string	Yes	Mintlify admin API key (starts with mint_)

Output

Parameter	Type	Description
`totals`	object	Site-wide unique visitor totals for the date range, deduplicated across human and AI
`visitors`	array	Per-page unique visitor counts
`hasMore`	boolean	Whether additional results are available

Notes

Category: tools
Type: mintlify

MillionVerifier Mistral Parser

Mintlify