From 629e06a1913b675c4074b0d17e8c1e573d29f14a Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 21 Oct 2025 16:44:27 -0700 Subject: [PATCH 01/11] remove deprecated endpoint pages --- api/assistant/create-topic.mdx | 3 --- api/assistant/generate-message.mdx | 3 --- 2 files changed, 6 deletions(-) delete mode 100644 api/assistant/create-topic.mdx delete mode 100644 api/assistant/generate-message.mdx diff --git a/api/assistant/create-topic.mdx b/api/assistant/create-topic.mdx deleted file mode 100644 index dc00663e3..000000000 --- a/api/assistant/create-topic.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: POST /chat/topic ---- diff --git a/api/assistant/generate-message.mdx b/api/assistant/generate-message.mdx deleted file mode 100644 index b1cdbbb37..000000000 --- a/api/assistant/generate-message.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: POST /chat/message ---- From 3f15ff5f8bac440c708757735ee4759fedf29e7e Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 21 Oct 2025 16:49:57 -0700 Subject: [PATCH 02/11] sentence case group title --- docs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.json b/docs.json index 8688ba60e..58094eb0f 100644 --- a/docs.json +++ b/docs.json @@ -276,7 +276,7 @@ "tab": "API Reference", "groups": [ { - "group": "API Reference", + "group": "API reference", "icon": "file-json", "pages": [ "api/introduction" From 56678bb8f055fd60aff186d055ba6a45cca62ac2 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 21 Oct 2025 16:55:24 -0700 Subject: [PATCH 03/11] consistent capitalization of ID --- api/update/status.mdx | 2 +- api/update/trigger.mdx | 2 +- openapi.json | 14 +++++++------- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/api/update/status.mdx b/api/update/status.mdx index 9e2e93b66..3b303c7eb 100644 --- a/api/update/status.mdx +++ b/api/update/status.mdx @@ -1,3 +1,3 @@ --- -openapi: "GET /project/update-status/{statusId}" +openapi: "GET /project/update-status/{statusID}" --- diff --git a/api/update/trigger.mdx b/api/update/trigger.mdx index 26b0968f3..06ee53b60 100644 --- a/api/update/trigger.mdx +++ b/api/update/trigger.mdx @@ -1,3 +1,3 @@ --- -openapi: "POST /project/update/{projectId}" +openapi: "POST /project/update/{projectID}" --- diff --git a/openapi.json b/openapi.json index 463bdb225..45ccd2139 100644 --- a/openapi.json +++ b/openapi.json @@ -19,15 +19,15 @@ "enabled": true }, "paths": { - "/project/update/{projectId}": { + "/project/update/{projectID}": { "post": { "summary": "Trigger update", "description": "Queue a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. By default, the update is triggered from your configured deployment branch.", "parameters": [ { - "name": "projectId", + "name": "projectID", "in": "path", - "description": "The ID of the project to trigger an update on. Can be retrieved from your dashboard.", + "description": "The ID of the project to trigger an update on. Can be retrieved from the top of the sidebar navigation in your dashboard.", "required": true, "schema": { "type": "string" @@ -44,7 +44,7 @@ "properties": { "statusId": { "type": "string", - "description": "The status id of the triggered updated." + "description": "The status ID of the triggered updated." } } } @@ -54,13 +54,13 @@ } } }, - "/project/update-status/{statusId}": { + "/project/update-status/{statusID}": { "get": { "summary": "Get update status", "description": "Get the status of an update from the status ID", "parameters": [ { - "name": "statusId", + "name": "statusID", "in": "path", "description": "The status ID of a triggered update.", "required": true, @@ -79,7 +79,7 @@ "properties": { "_id": { "type": "string", - "description": "The status id of the triggered updated." + "description": "The status ID of the triggered updated." }, "projectId": { "type": "string", From 8dcd712fa9a09acaa47ba6e70a6e46b50b240d56 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 22 Oct 2025 13:23:13 -0700 Subject: [PATCH 04/11] update placeholders --- api/agent/create-agent-job.mdx | 2 +- api/agent/get-agent-job.mdx | 2 +- api/agent/get-all-jobs.mdx | 2 +- api/assistant/create-assistant-message.mdx | 2 +- api/assistant/search.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/api/agent/create-agent-job.mdx b/api/agent/create-agent-job.mdx index 08458f47d..f22b6a08b 100644 --- a/api/agent/create-agent-job.mdx +++ b/api/agent/create-agent-job.mdx @@ -1,5 +1,5 @@ --- -openapi: POST /agent/{projectId}/job +openapi: POST /agent/{projectID}/job --- This endpoint creates an agent job based on provided messages and branch information. The job executes asynchronously and returns a streaming response with the execution details and results. diff --git a/api/agent/get-agent-job.mdx b/api/agent/get-agent-job.mdx index 74612aea4..046e483de 100644 --- a/api/agent/get-agent-job.mdx +++ b/api/agent/get-agent-job.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /agent/{projectId}/job/{id} +openapi: GET /agent/{projectID}/job/{id} --- ## Usage diff --git a/api/agent/get-all-jobs.mdx b/api/agent/get-all-jobs.mdx index 12bd4ec8c..15e16ad13 100644 --- a/api/agent/get-all-jobs.mdx +++ b/api/agent/get-all-jobs.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /agent/{projectId}/jobs +openapi: GET /agent/{projectID}/jobs --- ## Usage diff --git a/api/assistant/create-assistant-message.mdx b/api/assistant/create-assistant-message.mdx index b2dd38479..5acc1b63a 100644 --- a/api/assistant/create-assistant-message.mdx +++ b/api/assistant/create-assistant-message.mdx @@ -1,5 +1,5 @@ --- -openapi: POST /assistant/{domain}/message +openapi: POST /assistant/{projectID}/message --- ## Rate limits diff --git a/api/assistant/search.mdx b/api/assistant/search.mdx index aad5f0e85..56c227710 100644 --- a/api/assistant/search.mdx +++ b/api/assistant/search.mdx @@ -1,3 +1,3 @@ --- -openapi: "POST /search/{domain}" +openapi: "POST /search/{projectID}" --- From 6a1ffe7a6dfdd7c791429a5ae25ff651624514d4 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 22 Oct 2025 14:34:24 -0700 Subject: [PATCH 05/11] remove unused endpoints from admin-openapi.json --- admin-openapi.json | 50 +++------------------------------------------- 1 file changed, 3 insertions(+), 47 deletions(-) diff --git a/admin-openapi.json b/admin-openapi.json index bd6b8922b..54a181571 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -16,51 +16,7 @@ } ], "paths": { - "/admin/update/{domain}": { - "post": { - "summary": "Trigger update", - "description": "Triggers an update of your documentation site.", - "parameters": [ - { - "name": "domain", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard." - } - ], - "responses": { - "200": { - "description": "Update triggered successfully" - } - } - } - }, - "/admin/update/{domain}/status": { - "get": { - "summary": "Get update status", - "description": "Retrieves the status of documentation updates and other details about your docs.", - "parameters": [ - { - "name": "domain", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard." - } - ], - "responses": { - "200": { - "description": "Update status retrieved successfully" - } - } - } - }, - "/agent/{projectId}/job": { + "/agent/{projectID}/job": { "post": { "summary": "Create agent job", "description": "Creates a new agent job that can generate and edit documentation based on provided messages and branch information.", @@ -140,7 +96,7 @@ } } }, - "/agent/{projectId}/job/{id}": { + "/agent/{projectID}/job/{ID}": { "get": { "summary": "Get agent job by ID", "description": "Retrieves the details and status of a specific agent job by its ID.", @@ -242,7 +198,7 @@ } } }, - "/agent/{projectId}/jobs": { + "/agent/{projectID}/jobs": { "get": { "summary": "Get all agent jobs", "description": "Retrieves all agent jobs for the specified domain, including their status and details.", From a92a22b4cd9bb1ac0b2c502f059345514dc11369 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 22 Oct 2025 15:41:07 -0700 Subject: [PATCH 06/11] capitalization match paths --- admin-openapi.json | 12 ++++++------ openapi.json | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/admin-openapi.json b/admin-openapi.json index 54a181571..2214e34d5 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -16,7 +16,7 @@ } ], "paths": { - "/agent/{projectID}/job": { + "/agent/{projectId}/job": { "post": { "summary": "Create agent job", "description": "Creates a new agent job that can generate and edit documentation based on provided messages and branch information.", @@ -28,7 +28,7 @@ "schema": { "type": "string" }, - "description": "The ID of your project. Can be retrieved from your dashboard." + "description": "The identifier of your project. Can be retrieved from the top of the navigation sidebar in your dashboard." } ], "requestBody": { @@ -96,7 +96,7 @@ } } }, - "/agent/{projectID}/job/{ID}": { + "/agent/{projectId}/job/{id}": { "get": { "summary": "Get agent job by ID", "description": "Retrieves the details and status of a specific agent job by its ID.", @@ -108,7 +108,7 @@ "schema": { "type": "string" }, - "description": "The ID of your project. Can be retrieved from your dashboard." + "description": "The identifier of your project. Can be retrieved from the top of the navigation sidebar in your dashboard." }, { "name": "id", @@ -198,7 +198,7 @@ } } }, - "/agent/{projectID}/jobs": { + "/agent/{projectId}/jobs": { "get": { "summary": "Get all agent jobs", "description": "Retrieves all agent jobs for the specified domain, including their status and details.", @@ -210,7 +210,7 @@ "schema": { "type": "string" }, - "description": "The ID of your project. Can be retrieved from your dashboard." + "description": "The identifier of your project. Can be retrieved from the top of the navigation sidebar in your dashboard." } ], "responses": { diff --git a/openapi.json b/openapi.json index 45ccd2139..a88364e81 100644 --- a/openapi.json +++ b/openapi.json @@ -19,15 +19,15 @@ "enabled": true }, "paths": { - "/project/update/{projectID}": { + "/project/update/{projectId}": { "post": { "summary": "Trigger update", "description": "Queue a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. By default, the update is triggered from your configured deployment branch.", "parameters": [ { - "name": "projectID", + "name": "projectId", "in": "path", - "description": "The ID of the project to trigger an update on. Can be retrieved from the top of the sidebar navigation in your dashboard.", + "description": "The identifier of the project to trigger an update on. Can be retrieved from the top of the navigation sidebar in your dashboard.", "required": true, "schema": { "type": "string" @@ -54,13 +54,13 @@ } } }, - "/project/update-status/{statusID}": { + "/project/update-status/{statusId}": { "get": { "summary": "Get update status", "description": "Get the status of an update from the status ID", "parameters": [ { - "name": "statusID", + "name": "statusId", "in": "path", "description": "The status ID of a triggered update.", "required": true, From 345051b11a797f824763b99a4b7ae8a31dac3870 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 22 Oct 2025 15:53:03 -0700 Subject: [PATCH 07/11] update how to find `{domain}` --- discovery-openapi.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/discovery-openapi.json b/discovery-openapi.json index 1dfe87c04..45c5326bd 100644 --- a/discovery-openapi.json +++ b/discovery-openapi.json @@ -31,7 +31,7 @@ "schema": { "type": "string" }, - "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard." + "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found at the end of your dashboard URL. For example, `dashboard.mintlify.com/organization/domain` has a domain identifier of `domain`." } ], "requestBody": { @@ -505,7 +505,7 @@ "schema": { "type": "string" }, - "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard." + "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found at the end of your dashboard URL. For example, `dashboard.mintlify.com/organization/domain` has a domain identifier of `domain`." } ], "requestBody": { From cbb65daf1d4987423519870980e7785773b3a6f1 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 22 Oct 2025 15:55:31 -0700 Subject: [PATCH 08/11] update how to find `{projectId}` --- admin-openapi.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/admin-openapi.json b/admin-openapi.json index 2214e34d5..29415b346 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -28,7 +28,7 @@ "schema": { "type": "string" }, - "description": "The identifier of your project. Can be retrieved from the top of the navigation sidebar in your dashboard." + "description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard." } ], "requestBody": { @@ -108,7 +108,7 @@ "schema": { "type": "string" }, - "description": "The identifier of your project. Can be retrieved from the top of the navigation sidebar in your dashboard." + "description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard." }, { "name": "id", @@ -210,7 +210,7 @@ "schema": { "type": "string" }, - "description": "The identifier of your project. Can be retrieved from the top of the navigation sidebar in your dashboard." + "description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard." } ], "responses": { From 1f707dc6e189cd2d096ca72c39f9c3ccbfa7c1bb Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 22 Oct 2025 15:56:50 -0700 Subject: [PATCH 09/11] how to find `{projectId}` --- openapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.json b/openapi.json index a88364e81..33bc4d8a6 100644 --- a/openapi.json +++ b/openapi.json @@ -27,7 +27,7 @@ { "name": "projectId", "in": "path", - "description": "The identifier of the project to trigger an update on. Can be retrieved from the top of the navigation sidebar in your dashboard.", + "description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard.", "required": true, "schema": { "type": "string" From 971e39416f53a45b3eb45483caa5be0cda46e00f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 22 Oct 2025 15:57:38 -0700 Subject: [PATCH 10/11] remove deprecated endpoints --- discovery-openapi.json | 75 ------------------------------------------ 1 file changed, 75 deletions(-) diff --git a/discovery-openapi.json b/discovery-openapi.json index 45c5326bd..4bb9e8d3a 100644 --- a/discovery-openapi.json +++ b/discovery-openapi.json @@ -418,81 +418,6 @@ } } }, - "/chat/topic": { - "post": { - "summary": "Create Assistant Chat Topic", - "description": "Creates a topic to manage message history for a given AI assistant conversation", - "responses": { - "200": { - "description": "Topic created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "topicId": { - "type": "string", - "description": "The id of the created topic." - } - } - } - } - } - } - } - } - }, - "/chat/message": { - "post": { - "summary": "Create Assistant Chat Message", - "description": "Generate a completion in response to a user query", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "topicId", - "message" - ], - "properties": { - "topicId": { - "type": "string", - "description": "The topic ID to associate this message with" - }, - "message": { - "type": "string", - "description": "The user message to generate a completion for" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Topic created successfully", - "headers": { - "X-Mintlify-Base-Url": { - "schema": { - "type": "string" - }, - "description": "The base URL for the Mintlify documentation" - } - }, - "content": { - "text/plain": { - "schema": { - "type": "string", - "description": "A text stream in the form `||[chunks]`. The chunks are parts of your docs that most closely matched the user query. Each has the following format: \\n ```\\n { \\n \\tid: string;\\n \\tlink: string;\\n \\tchunk_html: string;\\n \\tmetadata: {\\n \\t\\ttitle?: string\\n \\t}\\n} \\n``` \\n The links are relative links with your docs URL intended as the host. To get an absolute link to your docs, you can use the `X-Mintlify-Base-Url` header as the host and construct a fully-qualified URL." - } - } - } - } - } - } - }, "/search/{domain}": { "post": { "summary": "Search documentation", From 55f3da8c76f613d1e25cae731dab69b846df83df Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 22 Oct 2025 16:03:03 -0700 Subject: [PATCH 11/11] match path capitalization --- api/agent/create-agent-job.mdx | 2 +- api/agent/get-agent-job.mdx | 2 +- api/agent/get-all-jobs.mdx | 2 +- api/assistant/create-assistant-message.mdx | 2 +- api/assistant/search.mdx | 2 +- api/update/status.mdx | 2 +- api/update/trigger.mdx | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/api/agent/create-agent-job.mdx b/api/agent/create-agent-job.mdx index f22b6a08b..08458f47d 100644 --- a/api/agent/create-agent-job.mdx +++ b/api/agent/create-agent-job.mdx @@ -1,5 +1,5 @@ --- -openapi: POST /agent/{projectID}/job +openapi: POST /agent/{projectId}/job --- This endpoint creates an agent job based on provided messages and branch information. The job executes asynchronously and returns a streaming response with the execution details and results. diff --git a/api/agent/get-agent-job.mdx b/api/agent/get-agent-job.mdx index 046e483de..74612aea4 100644 --- a/api/agent/get-agent-job.mdx +++ b/api/agent/get-agent-job.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /agent/{projectID}/job/{id} +openapi: GET /agent/{projectId}/job/{id} --- ## Usage diff --git a/api/agent/get-all-jobs.mdx b/api/agent/get-all-jobs.mdx index 15e16ad13..12bd4ec8c 100644 --- a/api/agent/get-all-jobs.mdx +++ b/api/agent/get-all-jobs.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /agent/{projectID}/jobs +openapi: GET /agent/{projectId}/jobs --- ## Usage diff --git a/api/assistant/create-assistant-message.mdx b/api/assistant/create-assistant-message.mdx index 5acc1b63a..b2dd38479 100644 --- a/api/assistant/create-assistant-message.mdx +++ b/api/assistant/create-assistant-message.mdx @@ -1,5 +1,5 @@ --- -openapi: POST /assistant/{projectID}/message +openapi: POST /assistant/{domain}/message --- ## Rate limits diff --git a/api/assistant/search.mdx b/api/assistant/search.mdx index 56c227710..aad5f0e85 100644 --- a/api/assistant/search.mdx +++ b/api/assistant/search.mdx @@ -1,3 +1,3 @@ --- -openapi: "POST /search/{projectID}" +openapi: "POST /search/{domain}" --- diff --git a/api/update/status.mdx b/api/update/status.mdx index 3b303c7eb..9e2e93b66 100644 --- a/api/update/status.mdx +++ b/api/update/status.mdx @@ -1,3 +1,3 @@ --- -openapi: "GET /project/update-status/{statusID}" +openapi: "GET /project/update-status/{statusId}" --- diff --git a/api/update/trigger.mdx b/api/update/trigger.mdx index 06ee53b60..26b0968f3 100644 --- a/api/update/trigger.mdx +++ b/api/update/trigger.mdx @@ -1,3 +1,3 @@ --- -openapi: "POST /project/update/{projectID}" +openapi: "POST /project/update/{projectId}" ---