Skip to content

Commit f04a0fa

Browse files
committed
Rewrite API overview page
1 parent c451053 commit f04a0fa

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

advanced/rest-api/overview.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
---
22
title: Overview
3+
description: 'Trigger updates, embed AI chat, and more'
34
---
45

5-
## Trigger Updates
6+
## Introduction
7+
The Mintlify REST API enables you to programmatically interact with your documentation, trigger updates, and embed AI-powered chat experiences. This guide covers the key features and authentication requirements.
68

7-
You can leverage the REST API to programmatically trigger an update when desired.
9+
## Triggering Updates
810

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>
11+
You can leverage the [Update API](/advanced/rest-api/update/trigger) to programmatically trigger an update when desired.
1412

15-
## Authentication
13+
An update will automatically take the newest version of your documentation on your chosen deployment branch, build it, and deploy it.
1614

17-
You can generate an API key through
18-
[the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is
19-
associated with the entire org and can be used across multiple deployments.
15+
## Embedded AI Chat
2016

21-
<Frame>
22-
<img src="/images/external-api-key.png" />
23-
</Frame>
17+
The Chat API allows you to embed an AI chat experience with full knowledge of your docs into your own webpages.
2418

25-
## Admin API key
19+
Responses include citations so you can point your users to the right places they need to get help.
2620

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).
21+
Successful examples of embedding the chat experience include:
2822

29-
## Chat API key
23+
- [Mintlify's own chat demo](https://chat.mintlify.com)
24+
- The [Lovable help center](https://lovable.dev/support)
3025

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.
26+
Check out our [example](https://github.com/mintlify/discovery-api-example) for how to use the API for AI chat.
3227

33-
Responses include citations so you can point your users to the right places they need to get help.
28+
## Authentication
29+
30+
You can generate API keys through
31+
[the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). API keys are associated with the entire org and can be used across multiple deployments.
32+
33+
<Frame>
34+
<img src="/images/external-api-key.png" alt="API Key Dashboard UI"/>
35+
</Frame>
3436

35-
<Note>
36-
The Chat API token is a public token that can be referenced in your
37-
frontend code whereas the API key is a server-side token that should be kept
38-
secret.
39-
</Note>
37+
### API Key Types
4038

41-
Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
42-
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
39+
| Type | Prefix | Usage | Security |
40+
|------|---------|--------|-----------|
41+
| Admin API Key | `mint_` | [Update endpoints](/advanced/rest-api/update/trigger) | Server-side only, keep secret |
42+
| Chat API Key | `mint_dsc_` | [Chat endpoints](/advanced/rest-api/chat/generate-message) | Public, safe for frontend |

0 commit comments

Comments
 (0)