From a5e726b068a4d98a12ea9e95afac6f77bf43a705 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 17 Jan 2025 01:02:56 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- .../rest-api/{discovery => chat}/create-topic.mdx | 0 .../{discovery => chat}/generate-message.mdx | 0 advanced/rest-api/overview.mdx | 12 ++++++------ mint.json | 12 ++++++------ 4 files changed, 12 insertions(+), 12 deletions(-) rename advanced/rest-api/{discovery => chat}/create-topic.mdx (100%) rename advanced/rest-api/{discovery => chat}/generate-message.mdx (100%) diff --git a/advanced/rest-api/discovery/create-topic.mdx b/advanced/rest-api/chat/create-topic.mdx similarity index 100% rename from advanced/rest-api/discovery/create-topic.mdx rename to advanced/rest-api/chat/create-topic.mdx diff --git a/advanced/rest-api/discovery/generate-message.mdx b/advanced/rest-api/chat/generate-message.mdx similarity index 100% rename from advanced/rest-api/discovery/generate-message.mdx rename to advanced/rest-api/chat/generate-message.mdx diff --git a/advanced/rest-api/overview.mdx b/advanced/rest-api/overview.mdx index f9d74b067..f6e775e89 100644 --- a/advanced/rest-api/overview.mdx +++ b/advanced/rest-api/overview.mdx @@ -19,27 +19,27 @@ associated with the entire org and can be used across multiple deployments. -## 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): Create a Discovery API key - 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. 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). \ No newline at end of file diff --git a/mint.json b/mint.json index 65c9d33d9..4a7eac089 100644 --- a/mint.json +++ b/mint.json @@ -70,7 +70,9 @@ }, "settings/global", "settings/navigation", - "migration" + "migration", + "advanced/rest-api/chat/generate-message", + "advanced/rest-api/chat/create-topic" ] }, { @@ -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" ] } ]