From 3552b2dbcee6bf62647b1a1b824685f57000c24a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 22:11:09 +0000 Subject: [PATCH 01/11] Update api-reference/agent/create-agent-job.mdx --- api-reference/agent/create-agent-job.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/agent/create-agent-job.mdx b/api-reference/agent/create-agent-job.mdx index b21502eb3..8f7b7a361 100644 --- a/api-reference/agent/create-agent-job.mdx +++ b/api-reference/agent/create-agent-job.mdx @@ -1,5 +1,5 @@ --- -openapi: POST /agent/job/{domain} +openapi: POST /admin/agent/job/{domain} --- 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. From b5428631165f097b52ed1d5dab8af26e1341610d Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 22:11:14 +0000 Subject: [PATCH 02/11] Update api-reference/agent/get-agent-job.mdx --- api-reference/agent/get-agent-job.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/agent/get-agent-job.mdx b/api-reference/agent/get-agent-job.mdx index e24430aae..9987544ef 100644 --- a/api-reference/agent/get-agent-job.mdx +++ b/api-reference/agent/get-agent-job.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /agent/{domain}/job/{id} +openapi: GET /admin/agent/{domain}/job/{id} --- ## Usage From ad821ffc9793a071d2a19a332858bafb2732d538 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 22:11:19 +0000 Subject: [PATCH 03/11] Update api-reference/agent/get-all-jobs.mdx --- api-reference/agent/get-all-jobs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/agent/get-all-jobs.mdx b/api-reference/agent/get-all-jobs.mdx index 51a586573..23cffe0bb 100644 --- a/api-reference/agent/get-all-jobs.mdx +++ b/api-reference/agent/get-all-jobs.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /agent/{domain}/jobs +openapi: GET /admin/agent/{domain}/jobs --- ## Usage From 2e80c5ac5646a30c1e0a80b4d0880a7b4e05584b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 22:11:36 +0000 Subject: [PATCH 04/11] Update api-reference/introduction.mdx --- api-reference/introduction.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 2a446431d..7ade26cbf 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -10,6 +10,9 @@ The Mintlify REST API enables you to programmatically interact with your documen - [Trigger update](/api-reference/update/trigger): Trigger an update of your site when desired. - [Get update status](/api-reference/update/status): Get the status of an update and other details about your docs. +- [Create agent job](/api-reference/agent/create-agent-job): Create an agent job to automatically edit your documentation. +- [Get agent job](/api-reference/agent/get-agent-job): Retrieve the details and status of a specific agent job. +- [Get all agent jobs](/api-reference/agent/get-all-jobs): Retrieve all agent jobs for a domain. - [Generate assistant message](/api-reference/assistant/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing. - [Search documentation](/api-reference/assistant/search): Search through your documentation. From c0c7b43abc3607345283337b223d5be3e9012d86 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 22:11:42 +0000 Subject: [PATCH 05/11] Update api-reference/introduction.mdx --- api-reference/introduction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 7ade26cbf..f51ec9831 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -22,7 +22,7 @@ You can generate an API key through [the dashboard](https://dashboard.mintlify.c ### Admin API key -The admin API key is used for the [Trigger update](/api-reference/update/trigger) and [Get update status](/api-reference/update/status) endpoints. +The admin API key is used for the [Trigger update](/api-reference/update/trigger), [Get update status](/api-reference/update/status), and all agent endpoints. Admin API keys begin with the `mint_` prefix. Keep your admin API keys secret. From 69ab8f5cf2e8fa0492ebe41a30438426eba81838 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 22:51:35 +0000 Subject: [PATCH 06/11] Update discovery-openapi.json --- discovery-openapi.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/discovery-openapi.json b/discovery-openapi.json index 0cbb4ddde..2a220def4 100644 --- a/discovery-openapi.json +++ b/discovery-openapi.json @@ -576,8 +576,7 @@ } } } - }, - "/agent/job/{domain}": { + } "post": { "summary": "Create agent job", "description": "Creates a new agent job that can generate and edit documentation based on provided messages and branch information.", From bc8e6aabbce618c3b5aedcadfe37f7ba816504a7 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 22:53:03 +0000 Subject: [PATCH 07/11] Update discovery-openapi.json --- discovery-openapi.json | 287 +---------------------------------------- 1 file changed, 2 insertions(+), 285 deletions(-) diff --git a/discovery-openapi.json b/discovery-openapi.json index 2a220def4..1dfe87c04 100644 --- a/discovery-openapi.json +++ b/discovery-openapi.json @@ -485,7 +485,7 @@ "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." + "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." } } } @@ -577,289 +577,6 @@ } } } - "post": { - "summary": "Create agent job", - "description": "Creates a new agent job that can generate and edit documentation based on provided messages and branch information.", - "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." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "branch", - "messages", - ], - "properties": { - "branch": { - "type": "string", - "description": "The name of the Git branch that the agent should work on, will be automatically created if it doesn't exist" - }, - "messages": { - "type": "array", - "description": "A list of previous messages to provide to the agent.", - "items": { - "type": "object", - "required": [ - "role", - "content" - ], - "properties": { - "role": { - "type": "string", - "enum": ["system", "user"], - "description": "The role of the message sender." - }, - "content": { - "type": "string", - "description": "The content of the message." - } - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Agent job created successfully (streaming response). X-Session-Id Header is sent back in the response", - "headers": { - "X-Message-Id": { - "schema": { - "type": "string" - }, - "description": "Message identifier for the created job" - } - }, - "content": { - "text/plain": { - "schema": { - "type": "string", - "description": "Streaming response containing the agent job execution details and results." - } - } - } - } - } - } - }, - "/agent/{domain}/job/{id}": { - "get": { - "summary": "Get agent job by ID", - "description": "Retrieves the details and status of a specific agent job by its ID.", - "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." - }, - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the agent job to retrieve." - } - ], - "responses": { - "200": { - "description": "Agent job details retrieved successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "sessionId": { - "type": "string", - "description": "The subdomain this session belongs to." - }, - "subdomain": { - "type": "string", - "description": "The subdomain this session belongs to." - }, - "branch": { - "type": "string", - "description": "Git branch name where changes were made.", - "nullable": true - }, - "haulted": { - "type": "boolean", - "description": "Whether the session execution was halted." - }, - "haultReason": { - "type": "string", - "enum": ["completed", "github_missconfigured", "error"], - "description": "Reason for session halt." - }, - "pullRequestLink": { - "type": "string", - "description": "Link to the created pull request." - }, - "messageToUser": { - "type": "string", - "description": "Message for the user about the session outcome." - }, - "todos": { - "type": "array", - "description": "List of todo items from the session.", - "items": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "Brief description of the task." - }, - "status": { - "type": "string", - "enum": ["pending", "in_progress", "completed", "cancelled"], - "description": "Current status of the task." - }, - "priority": { - "type": "string", - "enum": ["high", "medium", "low"], - "description": "Priority level of the task." - }, - "id": { - "type": "string", - "description": "Unique identifier for the todo item." - } - } - } - }, - "createdAt": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the session was created." - } - } - } - } - } - } - } - } - }, - "/agent/{domain}/jobs": { - "get": { - "summary": "Get all agent jobs", - "description": "Retrieves all agent jobs for the specified domain, including their status and details.", - "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": "All agent jobs retrieved successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "allSessions": { - "type": "array", - "description": "Array of all agent sessions for the domain.", - "items": { - "type": "object", - "properties": { - "sessionId": { - "type": "string", - "description": "The subdomain this session belongs to." - }, - "subdomain": { - "type": "string", - "description": "The subdomain this session belongs to." - }, - "branch": { - "type": "string", - "description": "Git branch name where changes were made.", - "nullable": true - }, - "haulted": { - "type": "boolean", - "description": "Whether the session execution was halted." - }, - "haultReason": { - "type": "string", - "enum": ["completed", "github_missconfigured", "error"], - "description": "Reason for session halt." - }, - "pullRequestLink": { - "type": "string", - "description": "Link to the created pull request." - }, - "messageToUser": { - "type": "string", - "description": "Message for the user about the session outcome." - }, - "todos": { - "type": "array", - "description": "List of todo items from the session.", - "items": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "Brief description of the task." - }, - "status": { - "type": "string", - "enum": ["pending", "in_progress", "completed", "cancelled"], - "description": "Current status of the task." - }, - "priority": { - "type": "string", - "enum": ["high", "medium", "low"], - "description": "Priority level of the task." - }, - "id": { - "type": "string", - "description": "Unique identifier for the todo item." - } - } - } - }, - "createdAt": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the session was created." - } - } - } - } - } - } - } - } - } - } - } - } }, "components": { "securitySchemes": { @@ -870,4 +587,4 @@ } } } -} +} \ No newline at end of file From b47f71e5954432b637ded9748d18518d438b46c8 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 22:53:48 +0000 Subject: [PATCH 08/11] Update admin-openapi.json --- admin-openapi.json | 357 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 357 insertions(+) create mode 100644 admin-openapi.json diff --git a/admin-openapi.json b/admin-openapi.json new file mode 100644 index 000000000..d742e4e8f --- /dev/null +++ b/admin-openapi.json @@ -0,0 +1,357 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Mintlify Admin API", + "description": "An API for administrative operations including documentation updates and agent management.", + "version": "1.0.0" + }, + "servers": [ + { + "url": "https://api.mintlify.com/v1" + } + ], + "security": [ + { + "bearerAuth": [] + } + ], + "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" + } + } + } + }, + "/admin/agent/job/{domain}": { + "post": { + "summary": "Create agent job", + "description": "Creates a new agent job that can generate and edit documentation based on provided messages and branch information.", + "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." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "branch", + "messages" + ], + "properties": { + "branch": { + "type": "string", + "description": "The name of the Git branch that the agent should work on, will be automatically created if it doesn't exist" + }, + "messages": { + "type": "array", + "description": "A list of previous messages to provide to the agent.", + "items": { + "type": "object", + "required": [ + "role", + "content" + ], + "properties": { + "role": { + "type": "string", + "enum": ["system", "user"], + "description": "The role of the message sender." + }, + "content": { + "type": "string", + "description": "The content of the message." + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Agent job created successfully (streaming response). X-Session-Id Header is sent back in the response", + "headers": { + "X-Message-Id": { + "schema": { + "type": "string" + }, + "description": "Message identifier for the created job" + } + }, + "content": { + "text/plain": { + "schema": { + "type": "string", + "description": "Streaming response containing the agent job execution details and results." + } + } + } + } + } + } + }, + "/admin/agent/{domain}/job/{id}": { + "get": { + "summary": "Get agent job by ID", + "description": "Retrieves the details and status of a specific agent job by its ID.", + "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." + }, + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the agent job to retrieve." + } + ], + "responses": { + "200": { + "description": "Agent job details retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sessionId": { + "type": "string", + "description": "The subdomain this session belongs to." + }, + "subdomain": { + "type": "string", + "description": "The subdomain this session belongs to." + }, + "branch": { + "type": "string", + "description": "Git branch name where changes were made.", + "nullable": true + }, + "haulted": { + "type": "boolean", + "description": "Whether the session execution was halted." + }, + "haultReason": { + "type": "string", + "enum": ["completed", "github_missconfigured", "error"], + "description": "Reason for session halt." + }, + "pullRequestLink": { + "type": "string", + "description": "Link to the created pull request." + }, + "messageToUser": { + "type": "string", + "description": "Message for the user about the session outcome." + }, + "todos": { + "type": "array", + "description": "List of todo items from the session.", + "items": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "Brief description of the task." + }, + "status": { + "type": "string", + "enum": ["pending", "in_progress", "completed", "cancelled"], + "description": "Current status of the task." + }, + "priority": { + "type": "string", + "enum": ["high", "medium", "low"], + "description": "Priority level of the task." + }, + "id": { + "type": "string", + "description": "Unique identifier for the todo item." + } + } + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the session was created." + } + } + } + } + } + } + } + } + }, + "/admin/agent/{domain}/jobs": { + "get": { + "summary": "Get all agent jobs", + "description": "Retrieves all agent jobs for the specified domain, including their status and details.", + "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": "All agent jobs retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allSessions": { + "type": "array", + "description": "Array of all agent sessions for the domain.", + "items": { + "type": "object", + "properties": { + "sessionId": { + "type": "string", + "description": "The subdomain this session belongs to." + }, + "subdomain": { + "type": "string", + "description": "The subdomain this session belongs to." + }, + "branch": { + "type": "string", + "description": "Git branch name where changes were made.", + "nullable": true + }, + "haulted": { + "type": "boolean", + "description": "Whether the session execution was halted." + }, + "haultReason": { + "type": "string", + "enum": ["completed", "github_missconfigured", "error"], + "description": "Reason for session halt." + }, + "pullRequestLink": { + "type": "string", + "description": "Link to the created pull request." + }, + "messageToUser": { + "type": "string", + "description": "Message for the user about the session outcome." + }, + "todos": { + "type": "array", + "description": "List of todo items from the session.", + "items": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "Brief description of the task." + }, + "status": { + "type": "string", + "enum": ["pending", "in_progress", "completed", "cancelled"], + "description": "Current status of the task." + }, + "priority": { + "type": "string", + "enum": ["high", "medium", "low"], + "description": "Priority level of the task." + }, + "id": { + "type": "string", + "description": "Unique identifier for the todo item." + } + } + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the session was created." + } + } + } + } + } + } + } + } + } + } + } + } + }, + "components": { + "securitySchemes": { + "bearerAuth": { + "type": "http", + "scheme": "bearer", + "description": "The Authorization header expects a Bearer token. See the [Admin API Key documentation](/docs/api-reference/introduction#admin-api-key) for details on how to get your API key." + } + } + } +} \ No newline at end of file From c547f223c9fbda47892ff4019fbce329b7f8cab6 Mon Sep 17 00:00:00 2001 From: "mintlify-development[bot]" <109878554+mintlify-development[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 23:36:46 +0000 Subject: [PATCH 09/11] Update api-reference/agent/create-agent-job.mdx --- api-reference/agent/create-agent-job.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/api-reference/agent/create-agent-job.mdx b/api-reference/agent/create-agent-job.mdx index 8f7b7a361..a11c55244 100644 --- a/api-reference/agent/create-agent-job.mdx +++ b/api-reference/agent/create-agent-job.mdx @@ -4,6 +4,10 @@ openapi: POST /admin/agent/job/{domain} 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. + +This endpoint uses the admin API (`/admin/agent/job/{domain}`) and requires an admin API key for authentication. + + If a branch doesn't exist, the agent creates one. If files are edited successfully, a draft pull request is automatically created at the end of the job. ## Rate limits From 0e0ed9999872512a10e07febffc499083ed4281c Mon Sep 17 00:00:00 2001 From: cdxker Date: Tue, 30 Sep 2025 17:13:44 -0700 Subject: [PATCH 10/11] feature: fix route, add details api key --- admin-openapi.json | 10 +++++----- api-reference/agent/create-agent-job.mdx | 6 +----- api-reference/agent/get-agent-job.mdx | 2 +- api-reference/agent/get-all-jobs.mdx | 2 +- 4 files changed, 8 insertions(+), 12 deletions(-) diff --git a/admin-openapi.json b/admin-openapi.json index d742e4e8f..bd3813114 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -60,7 +60,7 @@ } } }, - "/admin/agent/job/{domain}": { + "/agent/job/{domain}": { "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 +140,7 @@ } } }, - "/admin/agent/{domain}/job/{id}": { + "/agent/{domain}/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 +242,7 @@ } } }, - "/admin/agent/{domain}/jobs": { + "/agent/{domain}/jobs": { "get": { "summary": "Get all agent jobs", "description": "Retrieves all agent jobs for the specified domain, including their status and details.", @@ -350,8 +350,8 @@ "bearerAuth": { "type": "http", "scheme": "bearer", - "description": "The Authorization header expects a Bearer token. See the [Admin API Key documentation](/docs/api-reference/introduction#admin-api-key) for details on how to get your API key." + "description": "The Authorization header expects a Bearer token. Create an [Admin API Key](https://dashboard.mintlify.com/settings/organization/api-keys) here." } } } -} \ No newline at end of file +} diff --git a/api-reference/agent/create-agent-job.mdx b/api-reference/agent/create-agent-job.mdx index a11c55244..ecb49a3f0 100644 --- a/api-reference/agent/create-agent-job.mdx +++ b/api-reference/agent/create-agent-job.mdx @@ -1,13 +1,9 @@ --- -openapi: POST /admin/agent/job/{domain} +openapi: POST /agent/job/{projectId} --- 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. - -This endpoint uses the admin API (`/admin/agent/job/{domain}`) and requires an admin API key for authentication. - - If a branch doesn't exist, the agent creates one. If files are edited successfully, a draft pull request is automatically created at the end of the job. ## Rate limits diff --git a/api-reference/agent/get-agent-job.mdx b/api-reference/agent/get-agent-job.mdx index 9987544ef..e24430aae 100644 --- a/api-reference/agent/get-agent-job.mdx +++ b/api-reference/agent/get-agent-job.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /admin/agent/{domain}/job/{id} +openapi: GET /agent/{domain}/job/{id} --- ## Usage diff --git a/api-reference/agent/get-all-jobs.mdx b/api-reference/agent/get-all-jobs.mdx index 23cffe0bb..51a586573 100644 --- a/api-reference/agent/get-all-jobs.mdx +++ b/api-reference/agent/get-all-jobs.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /admin/agent/{domain}/jobs +openapi: GET /agent/{domain}/jobs --- ## Usage From 6a8afe4a924426bab04299daf1ea0efb5b93fd71 Mon Sep 17 00:00:00 2001 From: cdxker Date: Tue, 30 Sep 2025 17:25:27 -0700 Subject: [PATCH 11/11] feature: rename domain / projectId plus copy --- admin-openapi.json | 18 +++++++++--------- api-reference/agent/create-agent-job.mdx | 4 +--- api-reference/agent/get-agent-job.mdx | 2 +- api-reference/agent/get-all-jobs.mdx | 2 +- 4 files changed, 12 insertions(+), 14 deletions(-) diff --git a/admin-openapi.json b/admin-openapi.json index bd3813114..8b2d7b4f7 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -60,19 +60,19 @@ } } }, - "/agent/job/{domain}": { + "/agent/job/{projectId}": { "post": { "summary": "Create agent job", "description": "Creates a new agent job that can generate and edit documentation based on provided messages and branch information.", "parameters": [ { - "name": "domain", + "name": "projectId", "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." + "description": "The ID of your project. Can be retrieved from your dashboard." } ], "requestBody": { @@ -140,19 +140,19 @@ } } }, - "/agent/{domain}/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.", "parameters": [ { - "name": "domain", + "name": "projectId", "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." + "description": "The ID of your project. Can be retrieved from your dashboard." }, { "name": "id", @@ -242,19 +242,19 @@ } } }, - "/agent/{domain}/jobs": { + "/agent/{projectId}/jobs": { "get": { "summary": "Get all agent jobs", "description": "Retrieves all agent jobs for the specified domain, including their status and details.", "parameters": [ { - "name": "domain", + "name": "projectId", "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." + "description": "The ID of your project. Can be retrieved from your dashboard." } ], "responses": { diff --git a/api-reference/agent/create-agent-job.mdx b/api-reference/agent/create-agent-job.mdx index ecb49a3f0..7bfa41529 100644 --- a/api-reference/agent/create-agent-job.mdx +++ b/api-reference/agent/create-agent-job.mdx @@ -10,9 +10,7 @@ If a branch doesn't exist, the agent creates one. If files are edited successful The agent 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 +- 100 uses per Mintlify project per hour ## Suggested usage diff --git a/api-reference/agent/get-agent-job.mdx b/api-reference/agent/get-agent-job.mdx index e24430aae..74612aea4 100644 --- a/api-reference/agent/get-agent-job.mdx +++ b/api-reference/agent/get-agent-job.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /agent/{domain}/job/{id} +openapi: GET /agent/{projectId}/job/{id} --- ## Usage diff --git a/api-reference/agent/get-all-jobs.mdx b/api-reference/agent/get-all-jobs.mdx index 51a586573..12bd4ec8c 100644 --- a/api-reference/agent/get-all-jobs.mdx +++ b/api-reference/agent/get-all-jobs.mdx @@ -1,5 +1,5 @@ --- -openapi: GET /agent/{domain}/jobs +openapi: GET /agent/{projectId}/jobs --- ## Usage