You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference/introduction.mdx
+7-16Lines changed: 7 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,18 +3,12 @@ title: Introduction
3
3
icon: "book-open"
4
4
---
5
5
6
-
## Trigger Updates
7
-
8
-
You can leverage the REST API to programmatically trigger an update when desired.
9
-
10
6
## Authentication
11
7
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.
15
9
16
10
<Frame>
17
-
<imgsrc="/images/external-api-key.png" />
11
+
<imgalt="Screenshot of the API keys page in the Mintlify dashboard."src="/images/external-api-key.png" />
18
12
</Frame>
19
13
20
14
## 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
23
17
24
18
## Assistant API key
25
19
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.
27
21
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.
29
23
30
24
<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.
34
28
</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