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
You will need:
- A published bot
- A Mintlify account with a Pro or Custom plan
Install the integration in Botpress
First, install the integration to your bot:
- In Botpress Studio, select Explore Hub in the upper-right corner.
- 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:
- Log in to your Mintlify dashboard.
- In the left sidebar, go to Settings > API Keys.
- Copy and store your Project ID.
- Select + Create Admin API Key, then copy the generated API key.
Your integration is ready. You can use the integration’s Cards to interact with your Mintlify agent jobs.
Cards
Create Agent job
Creates a new agent job that can generate and edit documentation in a branch based on a prompt.
inputobjectoutputobjectGet Agent Job by ID
Retrieve the details and status of a specific agent job by its ID.
inputobjectoutputobjectGet All Agent Jobs
Retrieve all agent jobs, including their status and details.
outputobject