From a7e7a99942d4de126735632e574f3e02d9dd63af Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 15 Jul 2025 10:14:34 -0700 Subject: [PATCH 1/4] update intro --- api-reference/introduction.mdx | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 06ea36885..7910a8a32 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -3,18 +3,12 @@ title: Introduction icon: "book-open" --- -## Trigger Updates - -You can leverage the REST API to programmatically trigger an update when desired. - ## Authentication -You can generate an API key through -[the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is -associated with the entire org and can be used across multiple deployments. +You can generate an API key through [the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is associated with an entire organization and can be used across multiple deployments. - + Screenshot of the API keys page in the Mintlify dashboard. ## Admin API key @@ -23,15 +17,12 @@ The Admin API key is used for the majority of the API. It is used to trigger upd ## Assistant API key -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. +The assistant API allows you to embed the AI assistant, trained on 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. +Responses include citations so you can point your users to the right destinations for more information. - 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. + The assistant API **token** is a public token that can be referenced in your frontend code. The API **key** is a server-side token that should be kept secret. Calls using the API key can incur costs: either using your AI chat credits or incurring overages. -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 assistant. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com). +Check out our [example](https://github.com/mintlify/discovery-api-example) for how to use the assistant API. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com). From 94a987093b470dc9797eb27df4fe0c60e68b7964 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 15 Jul 2025 10:27:26 -0700 Subject: [PATCH 2/4] add limits --- api-reference/chat/create-assistant-message.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/api-reference/chat/create-assistant-message.mdx b/api-reference/chat/create-assistant-message.mdx index 0161d03f5..3b510f830 100644 --- a/api-reference/chat/create-assistant-message.mdx +++ b/api-reference/chat/create-assistant-message.mdx @@ -1,3 +1,11 @@ --- openapi: POST /assistant/{domain}/message --- + +## Rate limits + +The assistant API has the following limits: + +- 10,000 uses per key per month +- 10,000 requests per Mintlify organization per hour +- 10,000 requests per IP per day From bc6d40b0dbd16ce72515f24b1c18d59c3649a178 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 15 Jul 2025 11:20:25 -0700 Subject: [PATCH 3/4] remove example using old API --- api-reference/introduction.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 7910a8a32..1f555bd52 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -24,5 +24,3 @@ Responses include citations so you can point your users to the right destination The assistant API **token** is a public token that can be referenced in your frontend code. The API **key** is a server-side token that should be kept secret. Calls using the API key can incur costs: either using your AI chat credits or incurring overages. - -Check out our [example](https://github.com/mintlify/discovery-api-example) for how to use the assistant API. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com). From 05ab4e84ddcdc481011c425cba6800fc56b4bb22 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 15 Jul 2025 11:21:44 -0700 Subject: [PATCH 4/4] reviewer feedback --- api-reference/introduction.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 1f555bd52..ab48090b2 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -22,5 +22,7 @@ The assistant API allows you to embed the AI assistant, trained on your docs and Responses include citations so you can point your users to the right destinations for more information. - The assistant API **token** is a public token that can be referenced in your frontend code. The API **key** is a server-side token that should be kept secret. Calls using the API key can incur costs: either using your AI chat credits or incurring overages. + The assistant API **token** is a public token that can be referenced in your frontend code. The API **key** is a server-side token that should be kept secret. + + Calls using the assistant API token can incur costs: either using your AI chat credits or incurring overages.