Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 21 additions & 12 deletions api-reference/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,28 +1,37 @@
---
title: Introduction
title: "Introduction"
description: "Trigger updates, embed AI assistant, and more"
icon: "book-open"
---

The Mintlify REST API enables you to programmatically interact with your documentation, trigger updates, and embed AI-powered chat experiences.

## Endpoints

- [Trigger Update](/api-reference/update/trigger): Trigger an update of your site when desired.
- [Get Update Status](/api-reference/update/status): Get the status of an update and other details about your docs.
- [Generate Assistant Message](/api-reference/chat/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing.

## Authentication

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

### Admin API key

The admin API key is used for the majority of the API. It is used to trigger updates and get update status.

<Frame>
<img alt="Screenshot of the API keys page in the Mintlify dashboard." src="/images/external-api-key.png" />
</Frame>
Admin API keys begin with the `mint_` prefix. Keep your admin API keys secret.

## Admin API key
### Assistant API key

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

## Assistant API key
Assistant API keys begin with the `mint_dsc_` prefix.

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.
The assistant API **key** is a server-side token that should be kept secret.

Responses include citations so you can point your users to the right destinations for more information.
The assistant API **token** is a public token that can be referenced in your frontend code.

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

Calls using the assistant API token can incur costs: either using your AI chat credits or incurring overages.
</Note>
21 changes: 16 additions & 5 deletions navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -398,9 +398,7 @@ We currently support the following languages:

## Nesting

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.

This way, you can create a very complex navigation structure that is easy to manage.
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.

<CodeGroup>

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


```json Tabs with external anchors
{
"navigation": {
Expand Down Expand Up @@ -519,4 +516,18 @@ This way, you can create a very complex navigation structure that is easy to man
}
```

</CodeGroup>
</CodeGroup>

---

## Breadcrumbs

Control how breadcrumbs display on individual pages to orient users in your documentation.

```json
{
"styling": {
"eyebrows": "breadcrumbs"
}
}
```