Skip to content
Closed
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
12 changes: 6 additions & 6 deletions advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,27 @@ associated with the entire org and can be used across multiple deployments.
<img src="/images/external-api-key.png" />
</Frame>

## Discovery API
## Chat API

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.
The Chat 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.
Responses include citations so you can point your users to the right places they need to get help.

## Getting Started

To get started, you'll need to generate a Discovery API key in the [dashboard](https://dashboard.mintlify.com/products/chat/widget):
To get started, you'll need to generate a Chat API key in the [dashboard](https://dashboard.mintlify.com/products/chat/widget):

<Frame>
<img
alt="Create a Discovery API key"
alt="Create a Chat API key"
src="/images/generate-discovery-api-key.png"
/>
</Frame>

<Note>
The Discovery API token is a public token that can be referenced in your
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>

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).
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
12 changes: 6 additions & 6 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@
},
"settings/global",
"settings/navigation",
"migration"
"migration",
"advanced/rest-api/chat/generate-message",
"advanced/rest-api/chat/create-topic"
]
},
{
Expand Down Expand Up @@ -191,11 +193,9 @@
},
{
"group": "Discovery API",
"pages": [
"advanced/rest-api/discovery/create-topic",
"advanced/rest-api/discovery/generate-message"
]
}
"pages": []
},
"advanced/rest-api/overview"
]
}
]
Expand Down
Loading