View all systems 
Mintlifydeveloper tools
14 available actions
What your AI agent can do in 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). This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 14 actions.
Common starting points
- Get Agent JobRetrieve the status and details (status, PR link, model, source repo/ref) of a docs agent job.
- Get Search QueriesExport documentation search terms ordered by hit count (with CTR and top clicked page).
- Create Agent JobStart a background documentation agent job from a natural-language prompt.
- Send Agent MessageSend a follow-up instruction to an existing, in-progress docs agent job (asynchronous).
- Trigger UpdateQueue a production deployment of the docs project from its configured branch.
- Trigger AutomationTrigger a custom-schedule automation (workflow) to run immediately.
Browse all 14 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 9 actions
- Get Agent JobRetrieve the status and details (status, PR link, model, source repo/ref) of a docs agent job.
- Get Assistant Caller StatsGet assistant query counts broken down by caller type (web, api, other, total) for a date range.
- Get Assistant ConversationsExport the AI assistant conversation history (question, answer, cited sources, resolution status) for a Mintlify project, optionally filtered by date.
- Get FeedbackExport a project's user feedback (thumbs / contextual comments / agent feedback), optionally filtered by date, source and status.
- Get Feedback By PageGet feedback counts (thumbs up/down, code, total) aggregated per documentation page path for a date range.
- Get Page ViewsExport per-path and site-wide content view counts split by human vs AI traffic.
- Get Search QueriesExport documentation search terms ordered by hit count (with CTR and top clicked page).
- Get Unique VisitorsExport per-path and site-wide approximate distinct visitor counts split by human vs AI traffic.
- Get Update StatusGet the status and details (queued / in_progress / success / failure, logs, commit, screenshot) of a triggered deployment update by its statusId.
Create & communicateCreate records or send supported messagesView 2 actions
- Create Agent JobStart a background documentation agent job from a natural-language prompt.
- Send Agent MessageSend a follow-up instruction to an existing, in-progress docs agent job (asynchronous).
Other actionsSpecialist and administrative actions.View 3 actions
- Trigger AutomationTrigger a custom-schedule automation (workflow) to run immediately.
- Trigger PreviewCreate or update a preview deployment of the docs project for a Git branch (redeploys if a preview already exists for that branch).
- Trigger UpdateQueue a production deployment of the docs project from its configured branch.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Mintlify
How does the agent connect to Mintlify?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Mintlify?
The page above lists the 14 actions currently available through the Mintlify connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Mintlify included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Mintlify is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Mintlify to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.