Skip to content

Commit af47b10

Browse files
authored
💅🏼 Paper cuts (#925)
* add info on breadcrumbs to Navigation * remove extra linebreak * update API introduction
1 parent 055e321 commit af47b10

File tree

2 files changed

+37
-17
lines changed

2 files changed

+37
-17
lines changed

api-reference/introduction.mdx

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,37 @@
11
---
2-
title: Introduction
2+
title: "Introduction"
3+
description: "Trigger updates, embed AI assistant, and more"
34
icon: "book-open"
45
---
56

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+
615
## Authentication
716

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.
922

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.
1324

14-
## Admin API key
25+
### Assistant API key
1526

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.
1728

18-
## Assistant API key
29+
Assistant API keys begin with the `mint_dsc_` prefix.
1930

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.
2132

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.
2334

2435
<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-
2736
Calls using the assistant API token can incur costs: either using your AI chat credits or incurring overages.
2837
</Note>

navigation.mdx

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -398,9 +398,7 @@ We currently support the following languages:
398398

399399
## Nesting
400400

401-
It's important to note that you can use any combination of anchors, tabs, and dropdowns - either one can be nested within each other interchangeably.
402-
403-
This way, you can create a very complex navigation structure that is easy to manage.
401+
You can use any combination of anchors, tabs, and dropdowns. The components can be nested within each other interchangeably to create your desired navigation structure.
404402

405403
<CodeGroup>
406404

@@ -475,7 +473,6 @@ This way, you can create a very complex navigation structure that is easy to man
475473
}
476474
```
477475

478-
479476
```json Tabs with external anchors
480477
{
481478
"navigation": {
@@ -519,4 +516,18 @@ This way, you can create a very complex navigation structure that is easy to man
519516
}
520517
```
521518

522-
</CodeGroup>
519+
</CodeGroup>
520+
521+
---
522+
523+
## Breadcrumbs
524+
525+
Control how breadcrumbs display on individual pages to orient users in your documentation.
526+
527+
```json
528+
{
529+
"styling": {
530+
"eyebrows": "breadcrumbs"
531+
}
532+
}
533+
```

0 commit comments

Comments
 (0)