|
1 | 1 | --- |
2 | | -title: Introduction |
| 2 | +title: "Introduction" |
| 3 | +description: "Trigger updates, embed AI assistant, and more" |
3 | 4 | icon: "book-open" |
4 | 5 | --- |
5 | 6 |
|
| 7 | +The Mintlify REST API enables you to programmatically interact with your documentation, trigger updates, and embed AI-powered chat experiences. |
| 8 | + |
| 9 | +## Endpoints |
| 10 | + |
| 11 | +- [Trigger Update](/api-reference/update/trigger): Trigger an update of your site when desired. |
| 12 | +- [Get Update Status](/api-reference/update/status): Get the status of an update and other details about your docs. |
| 13 | +- [Generate Assistant Message](/api-reference/chat/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing. |
| 14 | + |
6 | 15 | ## Authentication |
7 | 16 |
|
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. |
| 17 | +You can generate an API key through [the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). API keys are associated with an entire organization and can be used across multiple deployments. |
| 18 | + |
| 19 | +### Admin API key |
| 20 | + |
| 21 | +The admin API key is used for the majority of the API. It is used to trigger updates and get update status. |
9 | 22 |
|
10 | | -<Frame> |
11 | | - <img alt="Screenshot of the API keys page in the Mintlify dashboard." src="/images/external-api-key.png" /> |
12 | | -</Frame> |
| 23 | +Admin API keys begin with the `mint_` prefix. Keep your admin API keys secret. |
13 | 24 |
|
14 | | -## Admin API key |
| 25 | +### Assistant API key |
15 | 26 |
|
16 | | -The Admin API key is used for the majority of the API. It is used to trigger updates via the [Update endpoint](/api-reference/update/trigger). |
| 27 | +The assistant API key is used for generating assistant chat messages through the API. Responses include citations so you can point your users to the right destinations for more information. |
17 | 28 |
|
18 | | -## Assistant API key |
| 29 | +Assistant API keys begin with the `mint_dsc_` prefix. |
19 | 30 |
|
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. |
| 31 | +The assistant API **key** is a server-side token that should be kept secret. |
21 | 32 |
|
22 | | -Responses include citations so you can point your users to the right destinations for more information. |
| 33 | +The assistant API **token** is a public token that can be referenced in your frontend code. |
23 | 34 |
|
24 | 35 | <Note> |
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 | 36 | Calls using the assistant API token can incur costs: either using your AI chat credits or incurring overages. |
28 | 37 | </Note> |
0 commit comments