Mintlify

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

Untrusted display-only summary

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

Untrusted display-only summary

Get assistant query counts broken down by caller type (web, api, other, total) for a date range. Returns a single aggregate object; no pagination.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

Export documentation search terms ordered by hit count (with CTR and top clicked page). Returns one page plus a cursor to fetch the next; there is no more-flag, so stop paging once next_cursor is null.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

Trigger 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 rout…

Untrusted display-only summary

Create 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).

Untrusted display-only summary

Queue 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.').

Untrusted display-only summary