> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

![Mintlify logo](https://mintcdn.com/composio-preview/9YPuzjEU4UlMnwGq/images/toolkits/mintlify.svg?fit=max\&auto=format\&n=9YPuzjEU4UlMnwGq\&q=85\&s=154af97741946ea926723ed0ad7a9b77)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `MINTLIFY`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Agent Job
>
> **Slug:** `MINTLIFY_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.
>
> #### Input Parameters
>
> **prompt** `string` *required*
>
> Instruction for the docs agent (must be non-empty). The agent edits the connected docs repo and OPENS A PULL REQUEST if it changes files. This is DESTRUCTIVE and consumes credits.
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Agent Job
>
> **Slug:** `MINTLIFY_GET_AGENT_JOB`
>
> 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.
>
> #### Input Parameters
>
> **job\_id** `string` *required*
>
> Agent job ID returned by create\_agent\_job. An unknown id returns 404 (the API calls these 'sessions' internally, so the message reads 'Session not found').
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Assistant Caller Stats
>
> **Slug:** `MINTLIFY_GET_ASSISTANT_CALLER_STATS`
>
> Get assistant query counts broken down by caller type (web, api, other, total) for a date range. Returns a single aggregate object; no pagination.
>
> #### Input Parameters
>
> **date\_to** `string`
>
> Exclusive upper bound for the date range, ISO 8601 or YYYY-MM-DD.
>
> **date\_from** `string`
>
> Inclusive lower bound for the date range, ISO 8601 or YYYY-MM-DD.
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Assistant Conversations
>
> **Slug:** `MINTLIFY_GET_ASSISTANT_CONVERSATIONS`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Items per page, 1-1000 (default 100). Values above 1000 are rejected client-side; the API 400s on an over-max limit.
>
> **cursor** `string`
>
> Pagination cursor (ULID). Pass the `next_cursor` from a previous page verbatim; omit for the first page. Do not synthesize cursors.
>
> **date\_to** `string`
>
> Exclusive upper bound for the conversation timestamp, ISO 8601 or YYYY-MM-DD.
>
> **date\_from** `string`
>
> Inclusive lower bound for the conversation timestamp, ISO 8601 or YYYY-MM-DD (e.g. 2026-01-01).
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). Routed into the \{projectId} path segment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feedback
>
> **Slug:** `MINTLIFY_GET_FEEDBACK`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Items per page, 1-100 (default 50). Values above 100 are clamped to 100 client-side (the API 400s on an over-max value).
>
> **cursor** `string`
>
> Pagination cursor: pass the next\_cursor from a previous page. Must be a valid Mongo ObjectId string (echo it back verbatim; do not synthesize).
>
> **source** `string ("code_snippet" | "contextual" | "agent" | "thumbs_only")`
>
> Filter by feedback source: code\_snippet | contextual | agent | thumbs\_only.
>
> **status** `string`
>
> Comma-separated statuses to include: pending,in\_progress,resolved,dismissed.
>
> **date\_to** `string`
>
> Exclusive upper bound, ISO 8601 or YYYY-MM-DD.
>
> **date\_from** `string`
>
> Inclusive lower bound, ISO 8601 or YYYY-MM-DD.
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feedback By Page
>
> **Slug:** `MINTLIFY_GET_FEEDBACK_BY_PAGE`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of page rows to return, 1-100 (default 10). Values above 100 are clamped to 100 client-side (the API returns 400 on an over-max limit).
>
> **source** `string ("code_snippet" | "contextual" | "agent" | "thumbs_only")`
>
> Filter by feedback source: code\_snippet | contextual | agent | thumbs\_only.
>
> **status** `string`
>
> Comma-separated statuses to include: pending,in\_progress,resolved,dismissed.
>
> **date\_to** `string`
>
> Exclusive upper bound for the date range, ISO 8601 or YYYY-MM-DD.
>
> **date\_from** `string`
>
> Inclusive lower bound for the date range, ISO 8601 or YYYY-MM-DD.
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Page Views
>
> **Slug:** `MINTLIFY_GET_PAGE_VIEWS`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Rows per page, 1-250 (default 50). Values above 250 are clamped to 250 client-side (the API 400s on an over-max value).
>
> **offset** `integer`
>
> Zero-based row offset (>=0, default 0). To page, pass back the next\_offset returned by the previous call while has\_more is true.
>
> **date\_to** `string`
>
> Exclusive upper bound, ISO 8601 or YYYY-MM-DD.
>
> **date\_from** `string`
>
> Inclusive lower bound, ISO 8601 or YYYY-MM-DD.
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 'Invalid project id'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Search Queries
>
> **Slug:** `MINTLIFY_GET_SEARCH_QUERIES`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Items per page, 1-100 (default 50). Values above 100 are clamped to 100 client-side (the API 400s on an over-max value).
>
> **cursor** `string`
>
> Opaque pagination cursor: pass the next\_cursor from a previous page verbatim to fetch the next page. Omit for the first page.
>
> **date\_to** `string`
>
> Exclusive upper bound, ISO 8601 or YYYY-MM-DD.
>
> **date\_from** `string`
>
> Inclusive lower bound, ISO 8601 or YYYY-MM-DD.
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 'Invalid project id'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Unique Visitors
>
> **Slug:** `MINTLIFY_GET_UNIQUE_VISITORS`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Rows per page, 1-250 (default 50). Values above 250 are clamped to 250 client-side (the API 400s on an over-max value).
>
> **offset** `integer`
>
> Zero-based row offset (>=0, default 0). Pass the prior response's `next_offset` to fetch the next page.
>
> **date\_to** `string`
>
> Exclusive upper bound, ISO 8601 or YYYY-MM-DD.
>
> **date\_from** `string`
>
> Inclusive lower bound, ISO 8601 or YYYY-MM-DD.
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 'Invalid project id'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Update Status
>
> **Slug:** `MINTLIFY_GET_UPDATE_STATUS`
>
> 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.
>
> #### Input Parameters
>
> **status\_id** `string` *required*
>
> Status ID returned by MINTLIFY\_TRIGGER\_UPDATE. Identifies the deployment update to inspect. Note: this endpoint keys on the statusId, not the project id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Agent Message
>
> **Slug:** `MINTLIFY_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.
>
> #### Input Parameters
>
> **job\_id** `string` *required*
>
> Agent job ID returned by create\_agent\_job. An unknown id returns 404 (the API calls these 'sessions' internally, so the message often reads 'Session not found').
>
> **prompt** `string` *required*
>
> Follow-up instruction for the running agent job (non-empty). Refines or continues the work started by create\_agent\_job.
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Trigger Automation
>
> **Slug:** `MINTLIFY_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.').
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'.
>
> **workflow\_schema\_id** `string` *required*
>
> Automation/workflow ID from the Automations settings panel. Only custom-schedule automations are triggerable; other automation types return 400.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Trigger Preview
>
> **Slug:** `MINTLIFY_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).
>
> #### Input Parameters
>
> **branch** `string` *required*
>
> Git branch to build a preview deployment for (non-empty).
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Trigger Update
>
> **Slug:** `MINTLIFY_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.').
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
