Skip to main content
Mintlify logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: MINTLIFY
  • Version: 20261101_00

Tools

Slug: MINTLIFY_CREATE_AGENT_JOBStart a background documentation agent job from a natural-language prompt. The agent edits the connected docs repo and OPENS A PULL REQUEST if it changes files (DESTRUCTIVE; consumes credits). Returns an AgentJob; poll its id with MINTLIFY_GET_AGENT_JOB for progress. Rate limit: 100 jobs per project per hour.

Input Parameters

string
required
Instruction for the docs agent (must be non-empty). The agent edits the connected docs repo and OPENS A PULL REQUEST if it changes files. This is DESTRUCTIVE and consumes credits.
string
required
Mintlify project ID (from the API keys page).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_AGENT_JOBRetrieve the status and details (status, PR link, model, source repo/ref) of a docs agent job. Poll this until status is completed, archived or failed. No pagination.

Input Parameters

string
required
Agent job ID returned by create_agent_job. An unknown id returns 404 (the API calls these ‘sessions’ internally, so the message reads ‘Session not found’).
string
required
Mintlify project ID (from the API keys page).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_ASSISTANT_CALLER_STATSGet assistant query counts broken down by caller type (web, api, other, total) for a date range. Returns a single aggregate object; no pagination.

Input Parameters

string
Exclusive upper bound for the date range, ISO 8601 or YYYY-MM-DD.
string
Inclusive lower bound for the date range, ISO 8601 or YYYY-MM-DD.
string
required
Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 ‘Invalid project id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_ASSISTANT_CONVERSATIONSExport the AI assistant conversation history (question, answer, cited sources, resolution status) for a Mintlify project, optionally filtered by date. Returns one page of conversations plus a cursor to fetch the next page.

Input Parameters

integer
Items per page, 1-1000 (default 100). Values above 1000 are rejected client-side; the API 400s on an over-max limit.
string
Pagination cursor (ULID). Pass the next_cursor from a previous page verbatim; omit for the first page. Do not synthesize cursors.
string
Exclusive upper bound for the conversation timestamp, ISO 8601 or YYYY-MM-DD.
string
Inclusive lower bound for the conversation timestamp, ISO 8601 or YYYY-MM-DD (e.g. 2026-01-01).
string
required
Mintlify project ID (from the API keys page). Routed into the {projectId} path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_FEEDBACKExport a project’s user feedback (thumbs / contextual comments / agent feedback), optionally filtered by date, source and status. Returns one page plus a cursor to fetch the next.

Input Parameters

integer
Items per page, 1-100 (default 50). Values above 100 are clamped to 100 client-side (the API 400s on an over-max value).
string
Pagination cursor: pass the next_cursor from a previous page. Must be a valid Mongo ObjectId string (echo it back verbatim; do not synthesize).
string ("code_snippet" | "contextual" | "agent" | "thumbs_only")
Filter by feedback source: code_snippet | contextual | agent | thumbs_only.
string
Comma-separated statuses to include: pending,in_progress,resolved,dismissed.
string
Exclusive upper bound, ISO 8601 or YYYY-MM-DD.
string
Inclusive lower bound, ISO 8601 or YYYY-MM-DD.
string
required
Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 ‘Invalid project id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_FEEDBACK_BY_PAGEGet feedback counts (thumbs up/down, code, total) aggregated per documentation page path for a date range. Single page of results — this endpoint exposes no pagination cursor, so only the first page is available.

Input Parameters

integer
Number of page rows to return, 1-100 (default 10). Values above 100 are clamped to 100 client-side (the API returns 400 on an over-max limit).
string ("code_snippet" | "contextual" | "agent" | "thumbs_only")
Filter by feedback source: code_snippet | contextual | agent | thumbs_only.
string
Comma-separated statuses to include: pending,in_progress,resolved,dismissed.
string
Exclusive upper bound for the date range, ISO 8601 or YYYY-MM-DD.
string
Inclusive lower bound for the date range, ISO 8601 or YYYY-MM-DD.
string
required
Mintlify project ID (from the API keys page).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_PAGE_VIEWSExport per-path and site-wide content view counts split by human vs AI traffic. Offset-paginated: returns one page of rows plus site-wide totals, the hasMore flag as has_more, and a next_offset to fetch the following page.

Input Parameters

integer
Rows per page, 1-250 (default 50). Values above 250 are clamped to 250 client-side (the API 400s on an over-max value).
integer
Zero-based row offset (>=0, default 0). To page, pass back the next_offset returned by the previous call while has_more is true.
string
Exclusive upper bound, ISO 8601 or YYYY-MM-DD.
string
Inclusive lower bound, ISO 8601 or YYYY-MM-DD.
string
required
Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 ‘Invalid project id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_SEARCH_QUERIESExport documentation search terms ordered by hit count, with CTR and top clicked page. Returns one page with a continuation cursor and a derived has_more flag.

Input Parameters

integer
Items per page, 1-100 (default 50). Values above 100 are clamped to 100 client-side (the API 400s on an over-max value).
string
Opaque pagination cursor: pass the next_cursor from a previous page verbatim to fetch the next page. Omit for the first page.
string
Exclusive upper bound, ISO 8601 or YYYY-MM-DD.
string
Inclusive lower bound, ISO 8601 or YYYY-MM-DD.
string
required
Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 ‘Invalid project id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_UNIQUE_VISITORSExport per-path and site-wide approximate distinct visitor counts split by human vs AI traffic. Offset-paginated: returns one page plus a has_more flag and the effective next_offset to fetch the following page.

Input Parameters

integer
Rows per page, 1-250 (default 50). Values above 250 are clamped to 250 client-side (the API 400s on an over-max value).
integer
Zero-based row offset (>=0, default 0). Pass the prior response’s next_offset to fetch the next page.
string
Exclusive upper bound, ISO 8601 or YYYY-MM-DD.
string
Inclusive lower bound, ISO 8601 or YYYY-MM-DD.
string
required
Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 ‘Invalid project id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_GET_UPDATE_STATUSGet the status and details (queued / in_progress / success / failure, logs, commit, screenshot) of a triggered deployment update by its statusId. Poll this with the statusId returned by MINTLIFY_TRIGGER_UPDATE.

Input Parameters

string
required
Status ID returned by MINTLIFY_TRIGGER_UPDATE. Identifies the deployment update to inspect. Note: this endpoint keys on the statusId, not the project id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_SEND_AGENT_MESSAGESend a follow-up instruction to an existing, in-progress docs agent job (asynchronous). Use to refine or continue work on a job created by create_agent_job. Returns the updated AgentJob; poll get_agent_job for progress. No pagination.

Input Parameters

string
required
Agent job ID returned by create_agent_job. An unknown id returns 404 (the API calls these ‘sessions’ internally, so the message often reads ‘Session not found’).
string
required
Follow-up instruction for the running agent job (non-empty). Refines or continues the work started by create_agent_job.
string
required
Mintlify project ID (from the API keys page).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_TRIGGER_AUTOMATIONTrigger a custom-schedule automation (workflow) to run immediately. Returns the schemaId, instanceId and jobId of the launched run. Only custom-schedule automations are triggerable (others return 400). Requires a Mintlify plan that includes automations (otherwise the API returns 401 ‘Please upgrade to access this route.’).

Input Parameters

string
required
Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 ‘Invalid project id’.
string
required
Automation/workflow ID from the Automations settings panel. Only custom-schedule automations are triggerable; other automation types return 400.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_TRIGGER_PREVIEWCreate or update a preview deployment of the docs project for a Git branch (redeploys if a preview already exists for that branch). Returns a statusId to poll with MINTLIFY_GET_UPDATE_STATUS and a previewUrl. Requires a Mintlify plan that includes preview deployments (plan gating may return 401 or 403).

Input Parameters

string
required
Git branch to build a preview deployment for (non-empty).
string
required
Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 ‘Invalid project id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MINTLIFY_TRIGGER_UPDATEQueue a production deployment of the docs project from its configured branch. Returns a statusId to poll with MINTLIFY_GET_UPDATE_STATUS. Requires a Mintlify plan that includes deployments (otherwise the API returns 401 ‘Please upgrade to access this route.’).

Input Parameters

string
required
Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 ‘Invalid project id’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not