Reference

Create Agent Job

Start a background documentation agent job from a natural-language prompt.

Get Agent Job

Retrieve the status and details (status, PR link, model, source repo/ref) of a docs agent job.

Get Assistant Caller Stats

Get assistant query counts broken down by caller type (web, api, other, total) for a date range.

Get Assistant Conversations

Export the AI assistant conversation history (question, answer, cited sources, resolution status) for a Mintlify project, optionally filtered by date.

Get Feedback

Export a project's user feedback (thumbs / contextual comments / agent feedback), optionally filtered by date, source and status.

Get Feedback By Page

Retrieves aggregated feedback counts (thumbs up/down, code, total) for each documentation page path within a specified date range, helping you quickly assess which content resonates or frustrates your users.

Get Page Views

Export per-path and site-wide content view counts split by human vs AI traffic.

Get Search Queries

Export documentation search terms ordered by hit count (with CTR and top clicked page).

Get Unique Visitors

Export per-path and site-wide approximate distinct visitor counts split by human vs AI traffic.

Get Update Status

Get the status and details (queued / inprogress / success / failure, logs, commit, screenshot) of a triggered deployment update by its statusId.

Send Agent Message

Send a follow-up instruction to an existing, in-progress docs agent job (asynchronous).

Trigger Automation

Triggers a custom-schedule automation to run immediately, enabling you to execute on-demand tasks like sending notifications or updating content without waiting for the scheduled time.

Trigger Preview

Create or update a preview deployment of the docs project for a Git branch (redeploys if a preview already exists for that branch).

Trigger Update

Queue a production deployment of the docs project from its configured branch.