Skip to content

Commit ca2915b

Browse files
Add documentation about AI assistant credits
1 parent 56e6e3b commit ca2915b

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

ai/assistant-credits.mdx

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# AI Assistant Credits
2+
3+
AI assistant credits are the billing units used to measure usage of Mintlify's AI-powered features. This page explains how credits work, where they're used, and how to track your usage.
4+
5+
## What is a Credit?
6+
7+
**1 credit = 1 AI message**
8+
9+
Credits are consumed each time the AI assistant generates a response to a user query. The billing is straightforward:
10+
11+
- Ask 1 question → Use 1 credit
12+
- Ask 2 questions → Use 2 credits
13+
- Ask 10 questions → Use 10 credits
14+
15+
Each interaction with the AI assistant, regardless of the complexity or length of the response, counts as one credit.
16+
17+
## Where Credits Are Used
18+
19+
AI assistant credits are consumed across three main areas of the Mintlify platform:
20+
21+
### Docs Side Panel
22+
The most common usage of credits occurs through the AI assistant in your documentation's side panel. When users interact with the AI assistant while browsing your docs, each question they ask consumes one credit from your account.
23+
24+
### Slack Bot
25+
If you've integrated Mintlify's AI assistant with your Slack workspace, each message sent to the bot will use one credit. This includes questions asked in direct messages or mentions in channels.
26+
27+
### Assistant API
28+
When using Mintlify's Assistant API to integrate AI functionality into your own applications, each API call that generates an AI response will consume one credit.
29+
30+
## Tracking Credit Usage
31+
32+
You can monitor your credit consumption and remaining balance through your Mintlify dashboard. This helps you:
33+
34+
- Track usage patterns across different features
35+
- Monitor credit consumption over time
36+
- Plan for future billing cycles
37+
- Identify which features are driving the most usage
38+
39+
## Credit Limits and Billing
40+
41+
Credit limits and billing details depend on your Mintlify plan. For specific information about:
42+
43+
- Monthly credit allowances
44+
- Overage pricing
45+
- Plan upgrades
46+
- Billing cycles
47+
48+
Please refer to your account dashboard or contact the Mintlify team for detailed pricing information specific to your plan.
49+
50+
<Note>
51+
Credits are consumed in real-time as users interact with the AI assistant. Make sure to monitor your usage regularly to avoid unexpected overages.
52+
</Note>

0 commit comments

Comments
 (0)