Skip to main content
Mintlify
Previewv1.0.0
16 actions · 2 auth methods

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · Admin API Key

Use for managing docs configuration, pages, and settings. Requires dashboard admin access.

Connector Profile · Assistant API Key

Use for AI assistant and search features only. Separate from admin operations.
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · Admin API Key

Link Account · Assistant API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
16 actions
Action
Description
Trigger Deployment
Trigger a documentation deployment to publish updates from your configured branch
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
Get the status of a deployment update by its status ID
Create Agent Job
Initiates an AI-powered background job to automatically generate documentation updates and create pull requests with the…
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
Sends additional instructions or refinements to an active agent job to iteratively improve documentation output without…
Search Documentation
Search through documentation using semantic and keyword search
Get Page Content
Retrieve the full text content of a documentation page by its path
Create Assistant Message
Generate a streaming response from the AI assistant trained on your documentation
Get User Feedback
Retrieve user feedback from your documentation including page ratings and code snippet feedback
Get Feedback By Page
Retrieve user feedback counts aggregated by documentation page
Get Assistant Conversations
Retrieve AI assistant conversation history including queries, responses, and cited sources
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
Retrieve documentation search terms with hit counts, click-through rates, and top clicked pages
Get Page Views
Retrieve per-page and site-wide content view counts split by human and AI traffic
Get Unique Visitors
Retrieve per-page and site-wide approximate unique visitor counts split by human and AI traffic