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

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/mintlify/filled/svg" alt="Mintlify" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-preview connector-page-stage-tag">Preview</span><span>v2.1.2</span></div>
    <div><a href="/connectors/mintlify/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">16 actions</a> · 2 auth methods</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">Knowledge Management</span>
      <span className="connector-page-category-tag">Analytics</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · Admin API Key" href="/connectors/mintlify/guides/connector-profile/admin-api-key" icon="https://stackone-logos.com/api/mintlify/filled/svg" horizontal>
        Use for managing docs configuration, pages, and settings. Requires dashboard admin access.
      </Card>

      <Card title="Connector Profile · Assistant API Key" href="/connectors/mintlify/guides/connector-profile/assistant-api-key" icon="https://stackone-logos.com/api/mintlify/filled/svg" horizontal>
        Use for AI assistant and search features only. Separate from admin operations.
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

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

    <Columns cols={2}>
      <Card title="Link Account · Admin API Key" href="/connectors/mintlify/guides/link-account/admin-api-key" icon="https://stackone-logos.com/api/mintlify/filled/svg" horizontal />

      <Card title="Link Account · Assistant API Key" href="/connectors/mintlify/guides/link-account/assistant-api-key" icon="https://stackone-logos.com/api/mintlify/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />

      <div className="connector-actions-scopes" data-connector-actions-auth>
        <button type="button" className="connector-actions-scopes__toggle" data-connector-actions-auth-toggle aria-expanded="false">
          <span>Authentication type<span data-connector-actions-auth-count /></span>
        </button>

        <div className="connector-actions-scopes__menu">
          <div className="connector-actions-scopes__header">
            <input type="search" className="connector-actions-scopes__search" data-connector-actions-auth-search placeholder="Search auth methods..." aria-label="Search auth methods" />

            <div className="connector-actions-scopes__actions">
              <button type="button" data-connector-actions-auth-select-all>Select all</button>
              <span>|</span>
              <button type="button" data-connector-actions-auth-clear>Clear</button>
            </div>
          </div>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="Admin API Key" data-connector-actions-auth-filter />

            <span>Admin API Key</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="Assistant API Key" data-connector-actions-auth-filter />

            <span>Assistant API Key</span>
          </label>

          <div className="connector-actions-scopes__empty" data-connector-actions-auth-empty hidden>No auth methods found</div>
        </div>
      </div>
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>16 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_trigger_deployment" data-action-label="Trigger Deployment" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Trigger Deployment</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_trigger_deployment" aria-label="Copy mintlify_trigger_deployment"><code className="connector-page-code">mintlify\_trigger\_deployment</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Trigger a documentation deployment to publish updates from your configured branch</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_trigger_preview_deployment" data-action-label="Trigger Preview Deployment" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Trigger Preview Deployment</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_trigger_preview_deployment" aria-label="Copy mintlify_trigger_preview_deployment"><code className="connector-page-code">mintlify\_trigger\_preview\_deployment</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Trigger a preview deployment for a Git branch, creating a new preview or redeploying an existing one (POST /project/prev...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_deployment_status" data-action-label="Get Deployment Status" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Deployment Status</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_deployment_status" aria-label="Copy mintlify_get_deployment_status"><code className="connector-page-code">mintlify\_get\_deployment\_status</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the status of a deployment update by its status ID</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_create_agent_job" data-action-label="Create Agent Job" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Agent Job</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_create_agent_job" aria-label="Copy mintlify_create_agent_job"><code className="connector-page-code">mintlify\_create\_agent\_job</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Initiates an AI-powered background job to automatically generate documentation updates and create pull requests with the...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_agent_job" data-action-label="Get Agent Job" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Agent Job</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_agent_job" aria-label="Copy mintlify_get_agent_job"><code className="connector-page-code">mintlify\_get\_agent\_job</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the current status, progress, and details of a specific agent job by its unique identifier for monitoring docu...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_send_agent_followup" data-action-label="Send Agent Follow-up Message" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Send Agent Follow-up Message</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_send_agent_followup" aria-label="Copy mintlify_send_agent_followup"><code className="connector-page-code">mintlify\_send\_agent\_followup</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Sends additional instructions or refinements to an active agent job to iteratively improve documentation output without...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_search_documentation" data-action-label="Search Documentation" data-action-scopes="" data-action-auth="Assistant API Key" data-action-auth-scopes="{&#x22;Assistant API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Search Documentation</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_search_documentation" aria-label="Copy mintlify_search_documentation"><code className="connector-page-code">mintlify\_search\_documentation</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search through documentation using semantic and keyword search</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_page_content" data-action-label="Get Page Content" data-action-scopes="" data-action-auth="Assistant API Key" data-action-auth-scopes="{&#x22;Assistant API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Page Content</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_page_content" aria-label="Copy mintlify_get_page_content"><code className="connector-page-code">mintlify\_get\_page\_content</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the full text content of a documentation page by its path</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_create_assistant_message" data-action-label="Create Assistant Message" data-action-scopes="" data-action-auth="Assistant API Key" data-action-auth-scopes="{&#x22;Assistant API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Assistant Message</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_create_assistant_message" aria-label="Copy mintlify_create_assistant_message"><code className="connector-page-code">mintlify\_create\_assistant\_message</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Generate a streaming response from the AI assistant trained on your documentation</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_user_feedback" data-action-label="Get User Feedback" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get User Feedback</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_user_feedback" aria-label="Copy mintlify_get_user_feedback"><code className="connector-page-code">mintlify\_get\_user\_feedback</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve user feedback from your documentation including page ratings and code snippet feedback</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_feedback_by_page" data-action-label="Get Feedback By Page" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Feedback By Page</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_feedback_by_page" aria-label="Copy mintlify_get_feedback_by_page"><code className="connector-page-code">mintlify\_get\_feedback\_by\_page</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve user feedback counts aggregated by documentation page</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_assistant_conversations" data-action-label="Get Assistant Conversations" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Assistant Conversations</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_assistant_conversations" aria-label="Copy mintlify_get_assistant_conversations"><code className="connector-page-code">mintlify\_get\_assistant\_conversations</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve AI assistant conversation history including queries, responses, and cited sources</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_assistant_caller_stats" data-action-label="Get Assistant Caller Stats" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Assistant Caller Stats</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_assistant_caller_stats" aria-label="Copy mintlify_get_assistant_caller_stats"><code className="connector-page-code">mintlify\_get\_assistant\_caller\_stats</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve assistant query volume broken down by caller type (web, API, other) for a specified date range, enabling channe...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_search_queries" data-action-label="Get Search Queries" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Search Queries</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_search_queries" aria-label="Copy mintlify_get_search_queries"><code className="connector-page-code">mintlify\_get\_search\_queries</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve documentation search terms with hit counts, click-through rates, and top clicked pages</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_page_views" data-action-label="Get Page Views" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Page Views</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_page_views" aria-label="Copy mintlify_get_page_views"><code className="connector-page-code">mintlify\_get\_page\_views</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve per-page and site-wide content view counts split by human and AI traffic</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="mintlify_get_unique_visitors" data-action-label="Get Unique Visitors" data-action-scopes="" data-action-auth="Admin API Key" data-action-auth-scopes="{&#x22;Admin API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Unique Visitors</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="mintlify_get_unique_visitors" aria-label="Copy mintlify_get_unique_visitors"><code className="connector-page-code">mintlify\_get\_unique\_visitors</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve per-page and site-wide approximate unique visitor counts split by human and AI traffic</div>
      </div>
    </div>
  </div>
</div>


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