Skip to content

Commit

Permalink
changed discovery api to chat api
Browse files Browse the repository at this point in the history
  • Loading branch information
tiffany-mintlify committed Jan 17, 2025
1 parent 9f9e9aa commit 22523b9
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,24 @@ 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>
Expand Down
11 changes: 6 additions & 5 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -190,12 +190,13 @@
]
},
{
"group": "Discovery API",
"group": "Chat API",
"pages": [
"advanced/rest-api/discovery/create-topic",
"advanced/rest-api/discovery/generate-message"
]
}
"advanced/rest-api/chat/create-topic",
"advanced/rest-api/chat/generate-message"
]
}

]
}
]
Expand Down

0 comments on commit 22523b9

Please sign in to comment.