Skip to content

Commit 94da33c

Browse files
committed
move discovery api
1 parent 9db4661 commit 94da33c

File tree

8 files changed

+42
-44
lines changed

8 files changed

+42
-44
lines changed

advanced/discovery-api/overview.mdx

Lines changed: 0 additions & 25 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.

advanced/rest-api/overview.mdx

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
---
2-
title: Introduction
2+
title: Overview
33
---
44

5-
<Check>
6-
The Mintlify REST API is only available on the [Pro plan and
7-
above](https://mintlify.com/pricing).
8-
</Check>
5+
## Trigger Updates
96

10-
Leverage the external API to programmatically trigger an update when desired.
7+
Leverage the REST API to programmatically trigger an update when desired.
118
The primary use-case will be to trigger updates. We will be adding more and more
129
functionality to the API overtime. Let us know what else you want to see in
1310
[our community](https://mintlify.com/community)!
@@ -21,3 +18,28 @@ associated with the entire org and can be used across multiple deployments.
2118
<Frame>
2219
<img src="/images/external-api-key.png" />
2320
</Frame>
21+
22+
## Discovery API
23+
24+
The Discovery 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.
26+
27+
## Getting Started
28+
29+
To get started, you'll need to generate a Discovery API key in the [dashboard](https://dashboard.mintlify.com/products/chat/widget):
30+
31+
<Frame>
32+
<img
33+
alt="Create a Discovery API key"
34+
src="/images/generate-discovery-api-key.png"
35+
/>
36+
</Frame>
37+
38+
<Note>
39+
The Discovery API token is a public token that can be referenced in your
40+
frontend code whereas the API key is a server-side token that should be kept
41+
secret.
42+
</Note>
43+
44+
Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
45+
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
---
22
openapi: "GET /project/update-status/{statusId}"
3-
hideApiMarker: true
43
---
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
---
22
openapi: "POST /project/update/{projectId}"
3-
hideApiMarker: true
43
---
174 KB
Loading

mint.json

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -182,17 +182,20 @@
182182
"group": "REST API",
183183
"pages": [
184184
"advanced/rest-api/overview",
185-
"advanced/rest-api/trigger-update",
186-
"advanced/rest-api/update-status"
187-
]
188-
},
189-
{
190-
"icon": "magnifying-glass",
191-
"group": "Discovery API",
192-
"pages": [
193-
"advanced/discovery-api/overview",
194-
"advanced/discovery-api/create-topic",
195-
"advanced/discovery-api/generate-message"
185+
{
186+
"group": "Updates",
187+
"pages": [
188+
"advanced/rest-api/update/trigger",
189+
"advanced/rest-api/update/status"
190+
]
191+
},
192+
{
193+
"group": "Discovery API",
194+
"pages": [
195+
"advanced/rest-api/discovery/create-topic",
196+
"advanced/rest-api/discovery/generate-message"
197+
]
198+
}
196199
]
197200
}
198201
]

0 commit comments

Comments
 (0)