--- title: Mintlify API Integration on Truto slug: mintlify category: Knowledge Management canonical: "https://truto.one/integrations/detail/mintlify/" --- # Mintlify API Integration on Truto **Category:** Knowledge Management **Status:** Beta ## MCP-ready AI tools Truto exposes 16 tools for Mintlify that AI agents can call directly. - **create_a_mintlify_project_update** — Queue a deployment update for a Mintlify documentation project from its configured deployment branch. Returns statusId that can be used to track update progress. - **get_single_mintlify_project_update_status_by_id** — Get the status of a triggered project update in mintlify by its status ID. Returns: status (queued, in_progress, success, failure), projectId, summary, and logs. Required: id. - **create_a_mintlify_project_preview** — Create or update a preview deployment for a specific branch in mintlify. Returns: statusId (for tracking progress) and previewUrl. Required: branch. - **create_a_mintlify_agent_job** — Create an agent job in mintlify for a specific project. - **get_single_mintlify_agent_job_by_id** — Get a mintlify agent job by id within a specific project. Required: id. - **create_a_mintlify_agent_job_message** — Create a message for a Mintlify agent job. Required: job_id. - **list_all_mintlify_feedback** — List feedback entries from Mintlify analytics for a given project. Returns an array of feedback records from the analytics data. - **list_all_mintlify_feedback_by_page** — List feedback aggregated by page for a Mintlify project. Returns feedback data grouped per page from the analytics dataset. - **list_all_mintlify_assistant_conversations** — List assistant conversations for a Mintlify project. Returns conversation data from the analytics assistant endpoint. - **list_all_mintlify_assistant_caller_stats** — List assistant caller statistics for a Mintlify project. Returns analytics data about assistant callers associated with the specified project. - **list_all_mintlify_search_queries** — List search queries recorded in mintlify analytics for a given project. Returns search query data from the analytics dataset. - **list_all_mintlify_page_views** — List page view analytics for a mintlify project. Returns an array of page view records from the analytics data. - **list_all_mintlify_unique_visitors** — List unique visitors analytics for a Mintlify project. Returns visitor data from the analytics endpoint. - **create_a_mintlify_assistant_message** — Send a message to the Mintlify assistant for a specific domain. Required: `domain`. - **list_all_mintlify_documentation_searches** — Search Mintlify documentation for a given domain. Returns matching documentation results for the specified domain. Required: domain. - **get_single_mintlify_page_content_by_id** — Get page content from Mintlify via the discovery API for a given domain. Required: domain. ## How it works 1. **Link your customer's Mintlify account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Mintlify.** The Proxy API is a 1-to-1 mapping of the Mintlify API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Attach AI chat transcripts to support tickets** — Helpdesk and ticketing platforms can pull Mintlify Assistant conversations into new tickets so human agents inherit full context of what the user already asked the AI, eliminating repetition and cutting time-to-resolution. - **Post live doc previews on pull requests** — CI/CD and developer workflow platforms can trigger Mintlify preview builds against feature branches and surface rendered preview URLs inside the PR review experience, so reviewers approve code and docs together. - **Turn doc telemetry into product insights** — Product analytics and PM platforms can join Mintlify page views, search queries, and per-page feedback with in-app usage data to surface knowledge gaps, failed searches, and friction points worth prioritizing on the roadmap. - **Ground in-app copilots in customer docs** — AI-first SaaS products can query a customer's Mintlify index and fetch structured page content at runtime to inject up-to-date documentation into their own copilot's prompt context, reducing hallucinations on technical questions. - **Automate docs maintenance with agent jobs** — Engineering productivity and DevRel tools can dispatch Mintlify agent jobs to draft updates, then publish via project updates — letting customers wire doc maintenance directly into their existing workflows. ## What you can build - **AI conversation handoff to tickets** — Sync Mintlify Assistant conversations and caller stats into a support ticket so agents see the full AI transcript on the first reply. - **PR-triggered documentation previews** — Create a Mintlify project preview per branch, poll its status, and post the preview URL back as a PR comment for inline review. - **Docs analytics dashboards** — Ingest page views, unique visitors, search queries, and per-page feedback into your analytics product to visualize documentation engagement and ROI. - **Zero-result search alerting** — Stream Mintlify search queries into your platform and alert PMs or writers when high-volume terms return no results, exposing real content gaps. - **Doc-grounded in-app AI copilot** — Run documentation searches and pull structured page content on demand to augment your own AI assistant with the customer's latest Mintlify docs. - **One-click production publishing** — Let users trigger a Mintlify project update from inside your product and track build status through completion without leaving the workflow. ## FAQs ### How do end users authenticate their Mintlify account? End users connect their Mintlify workspace through Truto's hosted connect flow, which handles credential exchange and token storage. Your product calls Truto with the connection ID — you never store or refresh Mintlify credentials yourself. ### Which Mintlify capabilities are available through Truto today? Truto exposes tools across four domains: Assistant and agent workflows (messages, agent jobs, conversation history, caller stats), deployments (project updates and previews with status polling), knowledge discovery (documentation search and structured page content retrieval), and analytics (page views, unique visitors, search queries, and per-page feedback). ### Is there a Unified API for Mintlify? Mintlify is currently available as a native integration via Truto's tool catalog rather than behind a Unified API. If you need it normalized into a Knowledge Management Unified API alongside other providers, Truto builds those on request. ### How do I handle long-running deployments like preview builds? Calls like create_a_mintlify_project_preview and create_a_mintlify_project_update return a status ID. Poll get_single_mintlify_project_update_status_by_id until the build completes, then read the resulting preview URL or deployment metadata from the response. ### Can I paginate through large analytics or feedback datasets? Yes. Endpoints like list_all_mintlify_feedback_by_page, list_all_mintlify_page_views, list_all_mintlify_search_queries, and list_all_mintlify_assistant_conversations support pagination through Truto's standard cursor parameters, so you can backfill history and then incrementally sync. ### How fresh is the data returned from Mintlify? Reads are performed against Mintlify's live API at request time, so analytics, search queries, feedback, and assistant conversations reflect the latest state available from Mintlify's ClickHouse-backed telemetry. Truto does not cache responses by default.