rocketkind
DevTools

Mintlify

Mintlify hosts documentation sites built from a Git repository.

Authentication

  • API key

Actions

Generic API request. Call any Mintlify admin API endpoint on this connection, for the case where no shipped action covers it yet (for example the analytics exports for feedback by page, unique visitors or assistant caller stats). The connection supplies the base URL, the admin API key and the egress route, so only the path, query and…

  • Create agent job (v1)Ask the Mintlify agent to edit the connection's documentation from a natural-language instruction, e.g. "document the new rate-limit headers on every endpoint page".
  • Get agent job (v1)Check on a Mintlify agent job started by Create agent job.
  • Get deployment status (v1)Check how a Mintlify deployment went, by the statusId that Trigger deployment or Trigger preview deployment returned.
  • Get page content (v1)Fetch the full text of one page of a published Mintlify documentation site, typically after Search documentation (mintlify:searchdocsv1) found it - search returns passages, this returns the whole page as body.content.
  • Get page views (v1)Report how often each documentation page was viewed in a date range, split into human and AI bot traffic, plus site-wide totals under body.totals - for finding the most-read pages or measuring AI crawler traffic.
  • List assistant conversations (v1)Export what readers asked the documentation's AI assistant and what it answered - for finding gaps in the docs (turns with resolutionStatus unanswered) or reviewing answer quality.
  • List search queries (v1)Export the terms readers typed into the documentation's search box, most-searched first, with each term's hit count, click-through rate and most-clicked result - for spotting what people look for and fail to find.
  • List user feedback (v1)Export the feedback readers left on the connection's documentation - page ratings, comments on code snippets and feedback from AI agents - for triaging doc problems or reporting on them.
  • Search documentation (v1)Run a semantic and keyword search over a published Mintlify documentation site and get the matching passages back - for grounding an answer in the docs or building a custom search box.
  • Send agent follow-up message (v1)Give an existing Mintlify agent job a follow-up instruction - to correct or extend the change it made - instead of starting a new job.
  • Trigger automation (v1)DestructiveRun one of the project's scheduled Mintlify automations now instead of waiting for its next scheduled time - for example from a release pipeline once a merge lands.
  • Trigger deployment (v1)DestructiveQueue a deployment of the connection's Mintlify project from its configured deployment branch - the same rebuild a push to that branch starts - for example after a CI job has regenerated reference pages.
  • Trigger preview deployment (v1)DestructiveCreate a preview deployment of one Git branch of the connection's Mintlify project, or redeploy it if a preview for that branch already exists - for reviewing a docs change before it is merged.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.