Use Mintlify to trigger production or branch-preview deployments, poll deployment status, run scheduled automations, and manage background documentation-agent jobs. Search and retrieve pages, ask the docs assistant, detect AI-sounding passages, or export feedback, conversations, caller statistics, searches, page views, and visitor analytics.
The API Key field takes the key required by the selected operation:
Admin API key (mint_): Trigger Update, Get Update Status, Trigger Preview Deployment, Trigger Automation, Create/Get Agent Job, Send Agent Message, Detect AI-Sounding Prose, and analytics exports.
Assistant API key (mint_dsc_): Search Documentation, Get Page Content, and Ask Assistant.
Generate keys on Mintlify's API keys page . Admin operations use Project ID from that page. Assistant operations use Domain , the identifier in app.mintlify.com/organization/domain. API availability depends on your Mintlify plan; check your account's API access before scheduling a 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.
Queue a deployment update for a Mintlify documentation project from its configured deployment branch. Returns a status ID for tracking progress.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description statusIdstring Status ID of the queued update. Poll it with Get Update Status.
Get the status of a Mintlify deployment update from its status ID, including logs, commit details, and screenshots.
Inputs and outputsParameter Type Required Description statusIdstring Yes Status ID returned by Trigger Update or Trigger Preview Deployment apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description idstring Status ID of the update projectIdstring Documentation project ID createdAtstring ISO 8601 UTC start time endedAtstring ISO 8601 UTC end time statusstring Update status: queued, in_progress, success, or failure summarystring Summary of the update status logsarray Deployment log lines subdomainstring Subdomain of the docs being updated screenshotstring Screenshot of the docs screenshotLightstring Light-mode screenshot of the docs screenshotDarkstring Dark-mode screenshot of the docs authorobject Author of the update ↳ name string Author name ↳ avatarUrl string Author avatar image URL ↳ githubUserId number Author GitHub user ID commitobject Commit that produced the update ↳ sha string Commit SHA ↳ ref string Git ref of the commit ↳ message string Commit message ↳ filesChanged object Files added, modified, and removed by the commit ↳ added array New files added ↳ modified array Existing files that were modified ↳ removed array Files that were removed sourcestring Source of the update trigger: internal, github-app-installation, api, github, dashboard, gitlab, or onboarding
Create or update a Mintlify preview deployment for a Git branch. Redeploys when a preview already exists for the branch.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard branchstring Yes Name of the Git branch to create a preview deployment for apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description statusIdstring Status ID for tracking the preview deployment previewUrlstring URL where the preview deployment is hosted
Run a scheduled Mintlify automation immediately instead of waiting for its next scheduled time. Only automations with a custom schedule can be triggered.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard automationIdstring Yes Automation ID, copied from the automation's settings panel on the Automations page apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description schemaIdstring ID of the triggered automation instanceIdstring ID of the queued automation run, visible in the run history jobIdstring ID of the background job processing the run
Analyze a documentation page for AI-generated prose and return flagged passages with suggested human rewrites. Consumes one AI credit per checked page.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard pathstring Yes Repo-relative path of the page, used for reporting only contentstring Yes Raw MDX or Markdown content of the page to check (max 1,000,000 characters) apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description pathstring Path from the request skippedstring Reason the page was skipped ("too_short"), or null when the page was checked predictionShortstring Overall verdict for the page: AI, AI-Assisted, Human, or Mixed. Null when the page was skipped. fractionAinumber Fraction of the page detected as AI-generated (0-1). Null when the page was skipped. fractionAiAssistednumber Fraction of the page detected as AI-assisted (0-1). Null when the page was skipped. fractionHumannumber Fraction of the page detected as human-written (0-1). Null when the page was skipped. windowsarray Flagged non-human passages with line ranges and suggested rewrites. Empty when the page was skipped. ↳ text string The flagged passage text ↳ label string Detection label, for example AI-Generated ↳ aiAssistanceScore number AI-assistance score for the passage (0-1) ↳ confidence json Detection confidence, either a label such as High or a numeric score ↳ startLine number 1-based start line of the passage ↳ endLine number 1-based end line of the passage ↳ rewrites array Suggested human rewrites of the passage ↳ text string The rewritten passage ↳ rationale string Why the rewrite reads more human creditsChargednumber AI credits charged for this request (0 when skipped)
Create a background Mintlify agent job that edits your documentation from a prompt. Opens a pull request when the agent successfully edits files.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard promptstring Yes The instruction for the agent to execute apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description statusIdstring Status ID of a queued deployment previewUrlstring URL where the preview deployment is hosted idstring Deployment status ID or agent job ID projectIdstring Documentation project ID createdAtstring Creation timestamp endedAtstring Deployment end timestamp archivedAtstring Agent job archive timestamp statusstring Deployment status or agent job status summarystring Summary of the deployment status logsarray Deployment log lines subdomainstring Subdomain of the docs being updated screenshotstring Screenshot of the docs screenshotLightstring Light-mode screenshot of the docs screenshotDarkstring Dark-mode screenshot of the docs authorjson Author of the deployment update commitjson Commit that produced the deployment sourcejson Deployment trigger source (string) or agent job source repository details (object) schemaIdstring ID of the triggered automation instanceIdstring ID of the queued automation run jobIdstring ID of the background job processing an automation run modelstring AI model used for the agent job prLinkstring Pull request URL created by the agent pathstring Documentation page path contentstring Full text content of the page skippedstring Reason a prose check was skipped predictionShortstring Prose verdict: AI, AI-Assisted, Human, Mixed fractionAinumber Fraction of the page detected as AI-generated fractionAiAssistednumber Fraction detected as AI-assisted fractionHumannumber Fraction detected as human-written windowsarray Flagged passages with suggested rewrites creditsChargednumber AI credits charged for the prose check resultsarray Documentation search results resultCountnumber Number of search results returned textstring Assembled assistant answer threadIdstring Assistant thread ID for follow-up messages sourcesarray Documentation sources the assistant cited feedbackarray Feedback entries or per-page feedback aggregates conversationsarray Assistant conversation history searchesarray Documentation search terms with hit counts totalSearchesnumber Total search events in the date range viewsarray Per-page content view event counts visitorsarray Per-page unique visitor counts totalsjson Site-wide human, AI, and total traffic counts webnumber Assistant queries from the documentation site apinumber Assistant queries from API calls othernumber Assistant queries from other sources totalnumber Total assistant queries across all caller types nextCursorstring Cursor for the next page of results hasMoreboolean Whether additional results are available
Retrieve the current status and details of a Mintlify agent job, including the pull request link once the agent opens one.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard jobIdstring Yes Unique identifier of the agent job apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description statusIdstring Status ID of a queued deployment previewUrlstring URL where the preview deployment is hosted idstring Deployment status ID or agent job ID projectIdstring Documentation project ID createdAtstring Creation timestamp endedAtstring Deployment end timestamp archivedAtstring Agent job archive timestamp statusstring Deployment status or agent job status summarystring Summary of the deployment status logsarray Deployment log lines subdomainstring Subdomain of the docs being updated screenshotstring Screenshot of the docs screenshotLightstring Light-mode screenshot of the docs screenshotDarkstring Dark-mode screenshot of the docs authorjson Author of the deployment update commitjson Commit that produced the deployment sourcejson Deployment trigger source (string) or agent job source repository details (object) schemaIdstring ID of the triggered automation instanceIdstring ID of the queued automation run jobIdstring ID of the background job processing an automation run modelstring AI model used for the agent job prLinkstring Pull request URL created by the agent pathstring Documentation page path contentstring Full text content of the page skippedstring Reason a prose check was skipped predictionShortstring Prose verdict: AI, AI-Assisted, Human, Mixed fractionAinumber Fraction of the page detected as AI-generated fractionAiAssistednumber Fraction detected as AI-assisted fractionHumannumber Fraction detected as human-written windowsarray Flagged passages with suggested rewrites creditsChargednumber AI credits charged for the prose check resultsarray Documentation search results resultCountnumber Number of search results returned textstring Assembled assistant answer threadIdstring Assistant thread ID for follow-up messages sourcesarray Documentation sources the assistant cited feedbackarray Feedback entries or per-page feedback aggregates conversationsarray Assistant conversation history searchesarray Documentation search terms with hit counts totalSearchesnumber Total search events in the date range viewsarray Per-page content view event counts visitorsarray Per-page unique visitor counts totalsjson Site-wide human, AI, and total traffic counts webnumber Assistant queries from the documentation site apinumber Assistant queries from API calls othernumber Assistant queries from other sources totalnumber Total assistant queries across all caller types nextCursorstring Cursor for the next page of results hasMoreboolean Whether additional results are available
Send a follow-up instruction to an existing Mintlify agent job. The message is processed asynchronously.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard jobIdstring Yes Unique identifier of the agent job to send a message to promptstring Yes The follow-up instruction for the agent apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description statusIdstring Status ID of a queued deployment previewUrlstring URL where the preview deployment is hosted idstring Deployment status ID or agent job ID projectIdstring Documentation project ID createdAtstring Creation timestamp endedAtstring Deployment end timestamp archivedAtstring Agent job archive timestamp statusstring Deployment status or agent job status summarystring Summary of the deployment status logsarray Deployment log lines subdomainstring Subdomain of the docs being updated screenshotstring Screenshot of the docs screenshotLightstring Light-mode screenshot of the docs screenshotDarkstring Dark-mode screenshot of the docs authorjson Author of the deployment update commitjson Commit that produced the deployment sourcejson Deployment trigger source (string) or agent job source repository details (object) schemaIdstring ID of the triggered automation instanceIdstring ID of the queued automation run jobIdstring ID of the background job processing an automation run modelstring AI model used for the agent job prLinkstring Pull request URL created by the agent pathstring Documentation page path contentstring Full text content of the page skippedstring Reason a prose check was skipped predictionShortstring Prose verdict: AI, AI-Assisted, Human, Mixed fractionAinumber Fraction of the page detected as AI-generated fractionAiAssistednumber Fraction detected as AI-assisted fractionHumannumber Fraction detected as human-written windowsarray Flagged passages with suggested rewrites creditsChargednumber AI credits charged for the prose check resultsarray Documentation search results resultCountnumber Number of search results returned textstring Assembled assistant answer threadIdstring Assistant thread ID for follow-up messages sourcesarray Documentation sources the assistant cited feedbackarray Feedback entries or per-page feedback aggregates conversationsarray Assistant conversation history searchesarray Documentation search terms with hit counts totalSearchesnumber Total search events in the date range viewsarray Per-page content view event counts visitorsarray Per-page unique visitor counts totalsjson Site-wide human, AI, and total traffic counts webnumber Assistant queries from the documentation site apinumber Assistant queries from API calls othernumber Assistant queries from other sources totalnumber Total assistant queries across all caller types nextCursorstring Cursor for the next page of results hasMoreboolean Whether additional results are available
Run a semantic and keyword search across a Mintlify documentation site, with optional version, language, tag, and group filters.
Inputs and outputsParameter Type Required Description domainstring Yes Domain identifier from your domain.mintlify.site URL, found at the end of your dashboard URL querystring Yes Search query to execute against your documentation content pageSizenumber No Number of search results to return, between 1 and 50 (default 10) scoreThresholdnumber No Minimum relevance score for results, between 0 and 1 versionstring No Filter results by documentation version languagestring No Filter results by content language tagstring No Filter results by tag groupsjson No Documentation groups the caller is authorized to access, as a JSON array of strings. Only applies to deployments using auth or userAuth. apiKeystring Yes Mintlify assistant API key (starts with mint_dsc_)
Parameter Type Description resultsarray Matching documentation chunks ordered by relevance ↳ content string The matching content from your documentation ↳ path string Path or URL to the source document ↳ metadata json Additional metadata about the search result resultCountnumber Number of results returned
Retrieve the full text content of a Mintlify documentation page by its path. Use it after a search to fetch the complete page.
Inputs and outputsParameter Type Required Description domainstring Yes Domain identifier from your domain.mintlify.site URL, found at the end of your dashboard URL pathstring Yes Page slug or path to retrieve, matching the path field returned by Search Documentation groupsjson No Documentation groups the caller is authorized to access, as a JSON array of strings. Only applies to deployments using auth or userAuth. apiKeystring Yes Mintlify assistant API key (starts with mint_dsc_)
Parameter Type Description pathstring The page path that was requested contentstring Full text content of the page
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.
Inputs and outputsParameter Type Required Description domainstring Yes Domain identifier from your domain.mintlify.site URL, found at the end of your dashboard URL messagestring No The question to ask the assistant. Ignored when a full Messages array is supplied. messagesjson No Full AI SDK message array for multi-turn conversations, each entry with id, role, and parts. Overrides Message when provided. fpstring No Fingerprint identifier for tracking conversation sessions (default "anonymous") threadIdstring No Thread ID from a previous response, to continue the same conversation retrievalPageSizenumber No Number of documentation search results used to generate the response currentPathstring No Path of the page the user is currently viewing, for more relevant answers (max 200 characters) versionstring No Filter retrieval by documentation version languagestring No Filter retrieval by content language groupsjson No Group identifiers to filter retrieval by, as a JSON array of strings assistantContextjson No Contextual snippets for the assistant, as a JSON array of objects with type ("code" or "textSelection"), value, and optional path and elementId apiKeystring Yes Mintlify assistant API key (starts with mint_dsc_)
Parameter Type Description textstring Assembled assistant answer threadIdstring Thread ID for continuing this conversation in a follow-up call sourcesarray Documentation sources the assistant cited ↳ sourceId string Source identifier ↳ url string URL of the cited page ↳ title string Title of the cited page
Export paginated user feedback from a Mintlify documentation project, with optional date-range, source, and status filters.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard dateFromstring No Inclusive start date in ISO 8601 or YYYY-MM-DD format dateTostring No Exclusive end date in ISO 8601 or YYYY-MM-DD format sourcestring No Filter by feedback source: code_snippet, contextual, agent, or thumbs_only statusstring No Comma-separated statuses to filter by: pending, in_progress, resolved, dismissed limitnumber No Max results per page, between 1 and 100 (default 50) cursorstring No Pagination cursor returned as nextCursor by a previous call apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description feedbackarray Feedback entries for the requested window ↳ id string Unique feedback identifier ↳ path string Path or URL of the page ↳ comment string Text of the feedback comment ↳ createdAt string Submission timestamp ↳ source string Origin: code_snippet, contextual, agent, or thumbs_only ↳ status string Review status: pending, in_progress, resolved, or dismissed ↳ helpful boolean Whether the user found the content helpful (contextual feedback only) ↳ contact string Email the user provided for follow-up (contextual feedback only) ↳ code string Code snippet the feedback relates to (code_snippet feedback only) ↳ filename string Filename of the code snippet (code_snippet feedback only) ↳ lang string Language of the code snippet (code_snippet feedback only) nextCursorstring Cursor for the next page, or null when there are no more results hasMoreboolean Whether additional results are available
Export Mintlify feedback counts aggregated by documentation page path, broken down into thumbs up, thumbs down, and code snippet feedback.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard dateFromstring No Inclusive start date in ISO 8601 or YYYY-MM-DD format dateTostring No Exclusive end date in ISO 8601 or YYYY-MM-DD format limitnumber No Max results per page, between 1 and 100 (default 10) sourcestring No Filter by feedback source: code_snippet, contextual, agent, or thumbs_only statusstring No Comma-separated statuses to filter by: pending, in_progress, resolved, dismissed apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description feedbackarray Feedback counts aggregated by documentation page path ↳ path string The documentation page path ↳ thumbsUp number Positive contextual feedback entries ↳ thumbsDown number Negative contextual feedback entries ↳ code number Code snippet feedback entries ↳ total number Total feedback entries hasMoreboolean Whether additional results are available
Export paginated Mintlify AI assistant conversation history, including the query, response, cited sources, and whether the question was answered.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard dateFromstring No Inclusive start date in ISO 8601 or YYYY-MM-DD format dateTostring No Exclusive end date in ISO 8601 or YYYY-MM-DD format limitnumber No Max results per page, between 1 and 1000 (default 100) cursorstring No ULID pagination cursor returned as nextCursor by a previous call apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description conversationsarray Assistant conversations for the requested window ↳ id string Unique conversation identifier ↳ timestamp string When the conversation occurred ↳ query string The user's question ↳ response string The assistant's response ↳ sources array Documentation pages referenced in the response ↳ title string Title of the page ↳ url string URL of the page ↳ resolutionStatus string Whether the assistant answered the question: answered or unanswered ↳ queryCategory string Auto-assigned category grouping for the conversation ↳ pageUrl string Full URL of the page where the conversation started nextCursorstring Cursor for the next page, or null when there are no more results hasMoreboolean Whether additional results are available
Get a breakdown of Mintlify assistant query counts by caller type — web, API, and other — for a date range.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard dateFromstring No Inclusive start date in ISO 8601 or YYYY-MM-DD format dateTostring No Exclusive end date in ISO 8601 or YYYY-MM-DD format apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description webnumber Assistant queries originating from the documentation site apinumber Assistant queries originating from API calls othernumber Assistant queries from other sources such as integrations and SDKs totalnumber Total assistant queries across all caller types
Export Mintlify documentation search terms for a date range, ordered by hit count, with click-through rate and the most-clicked result path.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard dateFromstring No Inclusive start date in ISO 8601 or YYYY-MM-DD format dateTostring No Exclusive end date in ISO 8601 or YYYY-MM-DD format limitnumber No Max search terms per page, between 1 and 100 (default 50) cursorstring No Opaque pagination cursor returned as nextCursor by a previous call apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description searchesarray Search terms ordered by hit count descending ↳ searchQuery string The search term entered by users ↳ hits number Number of times this term was searched ↳ ctr number Click-through rate for this search term ↳ topClickedPage string Most-clicked result path for this query ↳ lastSearchedAt string Timestamp of the last time this term was searched totalSearchesnumber Total search events in the date range, summing all hits rather than distinct queries nextCursorstring Cursor for the next page, or null when there are no more results
Export Mintlify per-path and site-wide content view counts for a date range, split by human and AI bot traffic.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard dateFromstring No Inclusive start date in ISO 8601 or YYYY-MM-DD format dateTostring No Exclusive end date in ISO 8601 or YYYY-MM-DD format limitnumber No Max results per page, between 1 and 250 (default 50) offsetnumber No Number of rows to skip for offset-based pagination (default 0) apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description totalsobject Site-wide totals for the date range ↳ human number Site-wide human traffic ↳ ai number Site-wide AI bot traffic ↳ total number Site-wide total viewsarray Per-page content view event counts ↳ path string The documentation page path ↳ human number Content view events from human traffic ↳ ai number Content view events from AI bot traffic ↳ total number Total content view events hasMoreboolean Whether additional results are available
Export Mintlify per-path and site-wide approximate distinct visitor counts for a date range, split by human and AI bot traffic.
Inputs and outputsParameter Type Required Description projectIdstring Yes Mintlify project ID, copied from the API keys page in your dashboard dateFromstring No Inclusive start date in ISO 8601 or YYYY-MM-DD format dateTostring No Exclusive end date in ISO 8601 or YYYY-MM-DD format limitnumber No Max results per page, between 1 and 250 (default 50) offsetnumber No Number of rows to skip for offset-based pagination (default 0) apiKeystring Yes Mintlify admin API key (starts with mint_)
Parameter Type Description totalsobject Site-wide totals for the date range ↳ human number Site-wide human traffic ↳ ai number Site-wide AI bot traffic ↳ total number Site-wide total visitorsarray Per-page unique visitor counts ↳ path string The documentation page path ↳ human number Unique human visitors ↳ ai number Unique AI bot visitors ↳ total number Approximate distinct visitors, deduplicated across human and AI hasMoreboolean Whether additional results are available