Skip to content

Commit a8d3017

Browse files
committed
Merge branch 'main' into hb/add-dropdowns
2 parents 1906ecf + 274f37b commit a8d3017

File tree

7 files changed

+659
-744
lines changed

7 files changed

+659
-744
lines changed

advanced/rest-api/overview.mdx

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,33 @@ title: Overview
44

55
## Trigger Updates
66

7-
Leverage the REST API to programmatically trigger an update when desired.
8-
The primary use-case will be to trigger updates. We will be adding more and more
9-
functionality to the API overtime. Let us know what else you want to see in
10-
[our community](https://mintlify.com/community)!
7+
You can leverage the REST API to programmatically trigger an update when desired.
8+
9+
<Info>
10+
While the primary use-case will be to trigger updates, we will be adding more and more
11+
functionality to the API overtime. Let us know what else you want to see in
12+
[our community](https://mintlify.com/community)!
13+
</Info>
1114

1215
## Authentication
1316

1417
You can generate an API key through
15-
[the dashboard](https://dashboard.mintlify.com/settings/integrations). The API key is
18+
[the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is
1619
associated with the entire org and can be used across multiple deployments.
1720

1821
<Frame>
1922
<img src="/images/external-api-key.png" />
2023
</Frame>
2124

22-
## Chat API
25+
## Admin API key
2326

24-
The Chat API allows you to embed an AI chat experience grounded in your docs and continually kept up to date into any application of your choosing.
25-
Responses include citations so you can point your users to the right places they need to get help.
27+
The Admin API key is used for the majority of the API. It is used to trigger updates via the [Update endpoint](/advanced/rest-api/update/trigger).
2628

27-
## Getting Started
29+
## Chat API key
2830

29-
To get started, you'll need to generate a Chat API key in the [dashboard](https://dashboard.mintlify.com/products/chat/widget):
31+
The Chat API allows you to embed the AI chat experience grounded in your docs and continually kept up to date into any application of your choosing.
3032

31-
<Frame>
32-
<img
33-
alt="Create a Chat API key"
34-
src="/images/generate-discovery-api-key.png"
35-
/>
36-
</Frame>
33+
Responses include citations so you can point your users to the right places they need to get help.
3734

3835
<Note>
3936
The Chat API token is a public token that can be referenced in your

advanced/widget/chat.mdx

Lines changed: 0 additions & 122 deletions
This file was deleted.

0 commit comments

Comments
 (0)