---
canonical_url: "https://docs.composio.dev/toolkits/mintlify"
markdown_url: "https://docs.composio.dev/toolkits/mintlify.md"
product: "platform"
version: null
last_updated: null
---

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

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

## Tools

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prompt` | string | Yes | 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 | Yes | Mintlify project ID (from the API keys page). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | 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 | Yes | Mintlify project ID (from the API keys page). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_to` | string | No | Exclusive upper bound for the date range, ISO 8601 or YYYY-MM-DD. |
| `date_from` | string | No | Inclusive lower bound for the date range, ISO 8601 or YYYY-MM-DD. |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Items per page, 1-1000 (default 100). Values above 1000 are rejected client-side; the API 400s on an over-max limit. |
| `cursor` | string | No | Pagination cursor (ULID). Pass the `next_cursor` from a previous page verbatim; omit for the first page. Do not synthesize cursors. |
| `date_to` | string | No | Exclusive upper bound for the conversation timestamp, ISO 8601 or YYYY-MM-DD. |
| `date_from` | string | No | Inclusive lower bound for the conversation timestamp, ISO 8601 or YYYY-MM-DD (e.g. 2026-01-01). |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). Routed into the {projectId} path segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 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 | No | 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") | No | Filter by feedback source: code_snippet | contextual | agent | thumbs_only. |
| `status` | string | No | Comma-separated statuses to include: pending,in_progress,resolved,dismissed. |
| `date_to` | string | No | Exclusive upper bound, ISO 8601 or YYYY-MM-DD. |
| `date_from` | string | No | Inclusive lower bound, ISO 8601 or YYYY-MM-DD. |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 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") | No | Filter by feedback source: code_snippet | contextual | agent | thumbs_only. |
| `status` | string | No | Comma-separated statuses to include: pending,in_progress,resolved,dismissed. |
| `date_to` | string | No | Exclusive upper bound for the date range, ISO 8601 or YYYY-MM-DD. |
| `date_from` | string | No | Inclusive lower bound for the date range, ISO 8601 or YYYY-MM-DD. |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 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 | No | 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 | No | Exclusive upper bound, ISO 8601 or YYYY-MM-DD. |
| `date_from` | string | No | Inclusive lower bound, ISO 8601 or YYYY-MM-DD. |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 'Invalid project id'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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 plus a cursor to fetch the next; there is no more-flag, so stop paging once next_cursor is null.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 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 | No | 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 | No | Exclusive upper bound, ISO 8601 or YYYY-MM-DD. |
| `date_from` | string | No | Inclusive lower bound, ISO 8601 or YYYY-MM-DD. |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 'Invalid project id'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 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 | No | Zero-based row offset (>=0, default 0). Pass the prior response's `next_offset` to fetch the next page. |
| `date_to` | string | No | Exclusive upper bound, ISO 8601 or YYYY-MM-DD. |
| `date_from` | string | No | Inclusive lower bound, ISO 8601 or YYYY-MM-DD. |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). An id of the wrong shape returns 400 'Invalid project id'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | 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 | Yes | Follow-up instruction for the running agent job (non-empty). Refines or continues the work started by create_agent_job. |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | 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 | Yes | Automation/workflow ID from the Automations settings panel. Only custom-schedule automations are triggerable; other automation types return 400. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | Yes | Git branch to build a preview deployment for (non-empty). |
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Mintlify project ID (from the API keys page). Must be an ObjectId-shaped id or the API returns 400 'Invalid project id'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |