Your AI team, working 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).

Start your company

What your team can do in Mintlify

21 tools to work with, connected with an API key.

Create Agent Job

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.

Create Assistant Message

Generate a Mintlify assistant response for a domain using AI SDK v5+ conversation messages. Requires an Assistant API key, not an Admin API key. Returns the complete buffered SSE stream as text, preserving all events; read threadId from the finish event to continue the conversation.

Get Agent JobReads only

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.

Get Assistant Caller StatsReads only

Get 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 ConversationsReads only

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.

Get Assistant ThreadReads only

Retrieve the full ordered message transcript for one Mintlify assistant conversation thread in a project. Use conversationId from assistant conversations as thread_id, or the threadId query parameter from a link-mode deflection support URL. Requires an Admin API key: an unrestricted Admin key is accepted, or a scoped key with read or write access. Returns the complete thread without pagination.

Get FeedbackReads only

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.

Get Feedback By PageReads only

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.

Get Page ContentReads only

Retrieve the full text content of a Mintlify documentation page by its path. Use after Search Documentation to fetch a matching page's complete content. Requires an Assistant API key, not an Admin API key. Page content requests do not consume credits.

Get Page ViewsReads only

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.

Get Search QueriesReads only

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

Get Static Export JobReads only

Retrieve the current state of one Mintlify static export job. Poll after starting a job until status is completed or failed. Completed jobs return a time-limited bundleUrl, sizeBytes, and expiresAt; call again for a fresh link. Returns the link without downloading the bundle. Static export requires an Enterprise plan and sales-enabled access; contact sales@mintlify.com to enable it. Requires an Admin API key: an unrestricted Admin key is valid, or a scoped Admin key with read or write access.

Get Unique VisitorsReads only

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.

Get Update StatusReads only

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.

Search DocumentationReads only

Search a Mintlify documentation site using semantic and keyword search, optionally filtered by version, language, tag, or documentation groups. Requires an Assistant API key, not an Admin API key. Search requests do not consume credits. Returns matching content, source paths, and metadata.

Send Agent Message

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.

Start Static Export Job

Start an asynchronous static export of a deployment's documentation into a self-contained archive of HTML, RSC, and assets. Returns the accepted job (HTTP 202), not a finished export; poll its jobId with the job status endpoint. Static export is not publicly available: it requires an Enterprise plan and access enabled by sales@mintlify.com. Authenticate with an Admin API key with write access; unrestricted Admin keys are also valid. Only one job may be queued or running per deployment (otherwise 409). Limited to 10 job starts per organization per hour.

Trigger Automation

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

Trigger Automation Webhook

Queue a run of an active custom automation with a webhook trigger, for example from a CI/CD pipeline or release script. Returns success and runId when queued (HTTP 202), not when the automation finishes. Other trigger types return 404. Requires an organization Admin API key with write access and a plan that includes API access and automations. Unrestricted Admin API keys are also valid. Consumes AI credits; exhausted credits return 402.

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

Trigger Update

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

More in Developer tools

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or