10000 Rewrite REST API overview page by IHSten · Pull Request #643 · mintlify/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Rewrite REST API overview page #643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Rewrite REST API overview page #643

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 26 additions & 26 deletions advanced/rest-api/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
---
title: Overview
description: 'Trigger updates, embed AI chat, and more'
---

## Trigger Updates
## Introduction
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.

You can leverage the REST API to programmatically trigger an update when desired.
## Triggering Updates

<Info>
While the primary use-case will be to trigger updates, we will be adding more and more
functionality to the API overtime. Let us know what else you want to see in
[our community](https://mintlify.com/community)!
</Info>
You can leverage the [Update API](/advanced/rest-api/update/trigger) to programmatically trigger an update when desired.

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

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

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

Check warning on line 17 in advanced/rest-api/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/rest-api/overview.mdx#L17 

Did you really mean 'webpages'?

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

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

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

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

Responses include citations so you can point your users to the right places they need to get help.
## Authentication

You can generate API keys through
[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.

<Frame>
<img src="/images/external-api-key.png" alt="API Key Dashboard UI"/>
</Frame>

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

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