Skip to content

Commit 4e61c64

Browse files
committed
Update to assistant
1 parent 2b8729c commit 4e61c64

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

api-reference/introduction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The Admin API key is used for the majority of the API. It is used to trigger upd
2323

2424
## Chat API key
2525

26-
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.
26+
The Chat 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.
2727

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

@@ -34,4 +34,4 @@ Responses include citations so you can point your users to the right places they
3434
</Note>
3535

3636
Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
37-
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
37+
the API for AI assistant. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).

discovery-openapi.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
"x-mcp": {
2222
"enabled": true
2323
},
24-
"summary": "Create a chat topic",
25-
"description": "Creates a topic to manage message history for a given AI chat conversation",
24+
"summary": "Create Assistant Chat Topic",
25+
"description": "Creates a topic to manage message history for a given AI assistant conversation",
2626
"responses": {
2727
"200": {
2828
"description": "Topic created successfully",
@@ -48,7 +48,7 @@
4848
"x-mcp": {
4949
"enabled": true
5050
},
51-
"summary": "Generate a message completion",
51+
"summary": "Create Assistant Chat Message",
5252
"description": "Generate a completion in response to a user query",
5353
"requestBody": {
5454
"required": true,

docs.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,14 +234,14 @@
234234
]
235235
},
236236
{
237-
"group": "Updates",
237+
"group": "Admin",
238238
"pages": [
239239
"api-reference/update/trigger",
240240
"api-reference/update/status"
241241
]
242242
},
243243
{
244-
"group": "Chat",
244+
"group": "Assistant",
245245
"pages": [
246246
"api-reference/chat/create-topic",
247247
"api-reference/chat/generate-message"

openapi.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"paths": {
2222
"/project/update/{projectId}": {
2323
"post": {
24-
"summary": "Trigger an update",
24+
"summary": "Trigger Update",
2525
"description": "Trigger an update after updating your OpenAPI document by calling this endpoint in a CI check",
2626
"parameters": [
2727
{
@@ -56,7 +56,7 @@
5656
},
5757
"/project/update-status/{statusId}": {
5858
"get": {
59-
"summary": "Get the status of an update",
59+
"summary": "Get Update Status",
6060
"description": "Get the status of an update from the status ID",
6161
"parameters": [
6262
{

settings/authentication-personalization/authentication-vs-personalization.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ be aware of, from most important to least:
1111
### Security Guarantees
1212

1313
Authentication is a fully-fledged private documentation solution. Every aspect of your docs,
14-
including page content, images, search results, and AI chat features, are completely inaccessible to
14+
including page content, images, search results, and AI assistant features, are completely inaccessible to
1515
unauthenticated users.
1616

1717
Personalization, on the other hand, offers no security guarantees for your documentation content.
18-
All page content, images, search results, and AI chat features can be accessed by the public. Even
18+
All page content, images, search results, and AI assistant features can be accessed by the public. Even
1919
if you are using the hidden pages feature of Personalization, a motivated attacker would still
2020
be able to access the content of a hidden page.
2121

settings/authentication-personalization/authentication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ documentation content by requiring users to authenticate before viewing any cont
1515
- Documentation page content
1616
- Images used in documentation pages
1717
- Search results
18-
- AI chat interactions
18+
- AI assistant interactions
1919

2020
You can authenticate users through handshake methods such as:
2121

support.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export function openSearch(e) {
1111

1212
<div onClick={openSearch} style={{ cursor: 'pointer' }}>
1313
<Card title="Ask our docs" icon="message-circle-question" href="https://mintlify.com/docs" arrow={true}>
14-
Ask our AI chat assistant that's been trained on our documentation.
14+
Ask our AI assistant that's been trained on our documentation.
1515
</Card>
1616
</div>
1717

0 commit comments

Comments
 (0)