Mintlify

Add a bot to Mintlify using the official integration.

The official Mintlify integration allows your bot to create and manage Mintlify agent jobs.

Setup

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.

Get your Mintlify credentials

Next, get your Mintlify API key and project ID:

  1. Log in to your Mintlify dashboard.
  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.

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.

Cards

Create Agent job

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

inputobject
outputobject

Get Agent Job by ID

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

inputobject
outputobject

Get All Agent Jobs

Retrieve all agent jobs, including their status and details.

outputobject

Triggers