Skip to content

Update API reference to rename chat to assistant terminology #742

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

Closed
wants to merge 3 commits into from
Closed

Update API reference to rename chat to assistant terminology #742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
455c419
Documentation edits made through Mintlify web editor
mintlify[bot] May 25, 2025
c9b76ad
Documentation edits made through Mintlify web editor
mintlify[bot] May 25, 2025
420a408
Documentation edits made through Mintlify web editor
mintlify[bot] May 25, 2025
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
0 api-reference/chat/create-topic.mdx → api-reference/assistant/create-topic.mdx
View file
Open in desktop
File renamed without changes.
0 api-reference/chat/generate-message.mdx → api-reference/assistant/generate-message.mdx
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions api-reference/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ associated with the entire org and can be used across multiple deployments.

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

## Chat API key
## Assistant API key

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.
The Assistant API allows you to embed the AI assistant 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.

<Note>
The Chat API token is a public token that can be referenced in your
The Assistant 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 assistant. You can also see a deployed version of this example at [assistant.mintlify.com](https://assistant.mintlify.com).
10 changes: 3 additions & 7 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
"api-playground/troubleshooting"
]
},
{
{
"group": "Authentication and Personalization",
"pages": [
"settings/authentication-personalization/authentication",
Expand Down Expand Up @@ -155,7 +155,6 @@
"advanced/dashboard/sso",
"advanced/dashboard/permissions",
"advanced/dashboard/roles"

]
}
]
Expand Down Expand Up @@ -214,7 +213,7 @@
{
"group": "Version Control and CI/CD",
"pages": [
"settings/github",
"settings/github",
"settings/gitlab",
"settings/ci",
"settings/preview-deployments"
Expand Down Expand Up @@ -242,10 +241,7 @@
},
{
"group": "Chat",
"pages": [
"api-reference/chat/create-topic",
"api-reference/chat/generate-message"
]
"pages": []
}
]
},
Expand Down