Skip to content

Commit be72beb

Browse files
authored
Document assistant API limits (#914)
* update intro * add limits * remove example using old API * reviewer feedback
1 parent d13bfd9 commit be72beb

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
---
22
openapi: POST /assistant/{domain}/message
33
---
4+
5+
## Rate limits
6+
7+
The assistant API has the following limits:
8+
9+
- 10,000 uses per key per month
10+
- 10,000 requests per Mintlify organization per hour
11+
- 10,000 requests per IP per day

api-reference/introduction.mdx

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,12 @@ title: Introduction
33
icon: "book-open"
44
---
55

6-
## Trigger Updates
7-
8-
You can leverage the REST API to programmatically trigger an update when desired.
9-
106
## Authentication
117

12-
You can generate an API key through
13-
[the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is
14-
associated with the entire org and can be used across multiple deployments.
8+
You can generate an API key through [the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is associated with an entire organization and can be used across multiple deployments.
159

1610
<Frame>
17-
<img src="/images/external-api-key.png" />
11+
<img alt="Screenshot of the API keys page in the Mintlify dashboard." src="/images/external-api-key.png" />
1812
</Frame>
1913

2014
## Admin API key
@@ -23,15 +17,12 @@ The Admin API key is used for the majority of the API. It is used to trigger upd
2317

2418
## Assistant API key
2519

26-
The Assistant API allows you to embed the AI assistant experience grounded in your docs and continually kept up to date into any application of your choosing.
20+
The assistant API allows you to embed the AI assistant, trained on your docs and continually kept up to date, into any application of your choosing.
2721

28-
Responses include citations so you can point your users to the right places they need to get help.
22+
Responses include citations so you can point your users to the right destinations for more information.
2923

3024
<Note>
31-
The Assistant API token is a public token that can be referenced in your
32-
frontend code whereas the API key is a server-side token that should be kept
33-
secret.
25+
The assistant API **token** is a public token that can be referenced in your frontend code. The API **key** is a server-side token that should be kept secret.
26+
27+
Calls using the assistant API token can incur costs: either using your AI chat credits or incurring overages.
3428
</Note>
35-
36-
Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
37-
the API for AI assistant. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).

0 commit comments

Comments
 (0)