Mintlify for AI agents
Agents read Mintlify at once. Changes and sends are held for a person's approval by default.
About Mintlify
Mintlify is a documentation platform. This toolkit exposes the Admin API for managing docs programmatically — trigger deployments and previews, run automations, drive the docs-editing agent, and export analytics (feedback, searches, views, visitors and assistant conversations).
What an agent can do in Mintlify
Every Mintlify action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Mintlify without asking first. 9 actions.
- 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.
- 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.
- 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 t
- 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.
- 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 i
- 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 fet
- Get Search QueriesExport 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
- 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 f
- 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_TRIGG
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 5 actions.
- 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
- 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_agen
- 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)
- 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 pre
- 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
Changes wait in Needs you
Changes and sends in Mintlify are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Related connectors
Mintlify questions
Can an agent change data in Mintlify on its own?
Not by default. Changes and sends in Mintlify are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Mintlify?
This connector lists 9 read actions. Reads run at once, without waiting for approval.
How does Mintlify connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.