> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Mintlify

> How to set up the Mintlify connector, plus the actions that are available.

![Mintlify](https://stackone-logos.com/api/mintlify/filled/svg)

v2.1.4[See changelog](https://docs.stackone.com/connectors/mintlify/changelog.md)

[16 actions](#actions) · 2 auth methods

Knowledge Management
Analytics

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Admin API Key · Connector Profile](https://docs.stackone.com/connectors/mintlify/guides/connector-profile/admin-api-key.md)
>
> Use for managing docs configuration, pages, and settings. Requires dashboard admin access.

> [card] [Assistant API Key · Connector Profile](https://docs.stackone.com/connectors/mintlify/guides/connector-profile/assistant-api-key.md)
>
> Use for AI assistant and search features only. Separate from admin operations.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Admin API Key · Link Account](https://docs.stackone.com/connectors/mintlify/guides/link-account/admin-api-key.md)

> [card] [Assistant API Key · Link Account](https://docs.stackone.com/connectors/mintlify/guides/link-account/assistant-api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Admin API Key

Assistant API Key

No auth methods found

16 actions

ActionDescription

Trigger Deployment`mintlify_trigger_deployment`

Trigger a documentation deployment to publish updates from your configured branch

Trigger Preview Deployment`mintlify_trigger_preview_deployment`

Trigger a preview deployment for a Git branch, creating a new preview or redeploying an existing one (POST /project/prev...

Get Deployment Status`mintlify_get_deployment_status`

Get the status of a deployment update by its status ID

Create Agent Job`mintlify_create_agent_job`

Initiates an AI-powered background job to automatically generate documentation updates and create pull requests with the...

Get Agent Job`mintlify_get_agent_job`

Retrieves the current status, progress, and details of a specific agent job by its unique identifier for monitoring docu...

Send Agent Follow-up Message`mintlify_send_agent_followup`

Sends additional instructions or refinements to an active agent job to iteratively improve documentation output without...

Search Documentation`mintlify_search_documentation`

Search through documentation using semantic and keyword search

Get Page Content`mintlify_get_page_content`

Retrieve the full text content of a documentation page by its path

Create Assistant Message`mintlify_create_assistant_message`

Generate a streaming response from the AI assistant trained on your documentation

Get User Feedback`mintlify_get_user_feedback`

Retrieve user feedback from your documentation including page ratings and code snippet feedback

Get Feedback By Page`mintlify_get_feedback_by_page`

Retrieve user feedback counts aggregated by documentation page

Get Assistant Conversations`mintlify_get_assistant_conversations`

Retrieve AI assistant conversation history including queries, responses, and cited sources

Get Assistant Caller Stats`mintlify_get_assistant_caller_stats`

Retrieve assistant query volume broken down by caller type (web, API, other) for a specified date range, enabling channe...

Get Search Queries`mintlify_get_search_queries`

Retrieve documentation search terms with hit counts, click-through rates, and top clicked pages

Get Page Views`mintlify_get_page_views`

Retrieve per-page and site-wide content view counts split by human and AI traffic

Get Unique Visitors`mintlify_get_unique_visitors`

Retrieve per-page and site-wide approximate unique visitor counts split by human and AI traffic


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.