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

# Mintlify

> Add a bot to Mintlify using the official integration.

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KMZAPEVTD6HZ9BPRHVK09DC5)
*v1.0.1*

The official Mintlify integration allows your bot to create and manage [Mintlify agent](https://www.mintlify.com/docs/ai/agent) jobs.

## Setup

> [!NOTE]
>
> You will need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * A [Mintlify account](https://dashboard.mintlify.com/signup) with a [Pro or Custom plan](https://www.mintlify.com/pricing)

**1. Install the integration in Botpress**

First, install the integration to your bot:

1. In Botpress Studio, select **Explore Hub** in the upper-right corner.
2. Search for the **Mintlify** integration, then select **Install Integration**.

In the **Configuration** menu, you should see two fields:

* **API key**
* **Project ID**

Leave these empty for now—you'll come back to them after getting your Mintlify credentials.

**2. Get your Mintlify credentials**

Next, get your Mintlify API key and project ID:

1. [Log in to your Mintlify dashboard](https://dashboard.mintlify.com/login).
2. In the left sidebar, go to **Settings** > **API Keys**.
3. Copy and store your **Project ID**.
4. Select **+ Create Admin API Key**, then copy the generated API key.

**3. Configure the integration in Botpress**

Now, you can finish setting up the integration in Botpress:

1. In the integration's **API Key** field, paste your Mintlify API key.
2. In the integration's **Project ID** field, paste your Mintlify project ID.
3. Select **Save Configuration**.

> [!TIP]
>
> Your integration is ready. You can use the integration's [Cards](#cards) to interact with your Mintlify agent jobs.

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Create Agent job

Creates a new agent job that can generate and edit documentation in a branch based on a prompt.

**input** `object`

**prompt** `string` *required*

The prompt to send the Mintlify agent

**branchName** `string` *required*

The name of the branch the Mintlify agent will make changes on. If the branch doesn't exist, it'll automatically be created.

**output** `object`

**response** `string` *required*

Streaming response containing the agent job execution details and results.

### Get Agent Job by ID

Retrieve the details and status of a specific agent job by its ID.

**input** `object`

**jobId** `string` *required*

The unique identifier of the agent job to retrieve

**output** `object`

**sessionId** `string` *required*

The ID of the session.

**subdomain** `string` *required*

The subdomain this session belongs to

**branch** `string | null` *required*

**haulted** `boolean` *required*

Whether the session execution was halted.

**haultReason** `string` *required*

Reason for session halt.

**pullRequestLink** `string` *required*

Link to the created pull request.

**messageToUser** `string` *required*

Message for the user about the session outcome.

**todos** `array` *required*

List of todo items from the session.

**array item properties**

**content** `string` *required*

Brief description of the task.

**status** `string` *required*

Current status of the task.

**priority** `string` *required*

Priority level of the task

**id** `string` *required*

Unique identifier for the todo item.

**createdAt** `string` *required*

Timestamp when the session was created.

### Get All Agent Jobs

Retrieve all agent jobs, including their status and details.

**input** `object`

This Card has no input fields.

**output** `object`

**allSessions** `array` *required*

Array of all agent sessions for the domain

**array item properties**

**sessionId** `string` *required*

The ID of the session.

**subdomain** `string` *required*

The subdomain this session belongs to

**branch** `string | null` *required*

**haulted** `boolean` *required*

Whether the session execution was halted.

**haultReason** `string` *required*

Reason for session halt.

**pullRequestLink** `string` *required*

Link to the created pull request.

**messageToUser** `string` *required*

Message for the user about the session outcome.

**todos** `array` *required*

List of todo items from the session.

**array item properties**

**content** `string` *required*

Brief description of the task.

**status** `string` *required*

Current status of the task.

**priority** `string` *required*

Priority level of the task

**id** `string` *required*

Unique identifier for the todo item.

**createdAt** `string` *required*

Timestamp when the session was created.


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