All integrations

Mintlify

DEVELOPER · DEVELOPER

Documentation deployments, previews, static exports, automations, and agent jobs on their own key.

Connecting Mintlify in practice

Mintlify issues three API keys with three prefixes and three blast radii — mint_ for deployments and analytics, mint_dsc_ for assistant and search, mint_us_ for the Index API — and the assistant key spends credits on every message, so leaking that one costs money rather than data. Keys default to a 90-day expiry, and an organization can create at most 10 API keys per hour.

Scopes that draw scrutiny

  • mint_ (Admin API key) Server-side only. Triggers deployments, runs agent jobs and exports analytics, and is the key that can change published documentation.
  • mint_dsc_ (Assistant API key) Handles assistant messages and documentation search. Every message consumes credits and may trigger overages, so abuse is billed to the owner.
  • mint_us_ (Index API key) Server-side only, authenticating the Index REST API.

Rate limits

  • Up to 10 API keys per hour per organization.

Worth knowing

  • Keys default to a 90-day expiry — the alternatives are 7, 30, 60, 90 days or no expiry — so an integration left alone stops working roughly a quarter after it shipped.
  • Admin and assistant keys can be pinned to IP addresses or CIDR ranges at creation time, which is the only network control, and it cannot be added afterwards.
  • Admin keys support a read or write scope restriction; the assistant and index keys do not, so least privilege is only available on one of the three.
  • The assistant key can be proxied in production but must not be embedded client-side, because a visitor who extracts it spends the account’s credits.

Checked against Mintlify REST API introduction (2026-09-29), Trigger deployment endpoint (2026-09-29)

Acts as the person, not as itself

Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.

Credentials never touch the agent

Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.

Every call on the record

Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.

What an agent can do

Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.

mintlify_get_project_update_status_by_statusidREAD

Get a deployment update status via GET https://api.mintlify.com/v1/project/update-status/{statusId}. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_static_export_by_projectid_jobs_by_jobidREAD

Get a static export job via GET https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v1_analytics_by_projectid_assistantREAD

List assistant conversations via GET https://api.mintlify.com/v1/analytics/{projectId}/assistant. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v1_analytics_by_projectid_assistant_caller_statsREAD

Get assistant caller statistics via GET https://api.mintlify.com/v1/analytics/{projectId}/assistant/caller-stats. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v1_analytics_by_projectid_assistant_threads_by_threadidREAD

Get an assistant conversation thread via GET https://api.mintlify.com/v1/analytics/{projectId}/assistant/threads/{threadId}. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v1_analytics_by_projectid_feedbackREAD

List feedback entries via GET https://api.mintlify.com/v1/analytics/{projectId}/feedback. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v1_analytics_by_projectid_feedback_by_pageREAD

Get feedback totals by page via GET https://api.mintlify.com/v1/analytics/{projectId}/feedback/by-page. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v1_analytics_by_projectid_searchesREAD

List search queries via GET https://api.mintlify.com/v1/analytics/{projectId}/searches. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v1_analytics_by_projectid_viewsREAD

Get page view counts via GET https://api.mintlify.com/v1/analytics/{projectId}/views. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v1_analytics_by_projectid_visitorsREAD

Get visitor counts via GET https://api.mintlify.com/v1/analytics/{projectId}/visitors. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_get_v2_agent_by_projectid_job_by_idREAD

Get an agent job via GET https://api.mintlify.com/v2/agent/{projectId}/job/{id}. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_post_project_preview_by_projectidWRITE

Create a preview deployment via POST https://api.mintlify.com/v1/project/preview/{projectId}. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys). Deploys the named Git branch to a preview URL. Answers 202 with a previewUrl and a statusId; poll the statusId with the update-status tool.

api
mintlify_post_project_update_by_projectidWRITE

Trigger a documentation update via POST https://api.mintlify.com/v1/project/update/{projectId}. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys). PUBLISHES: this triggers a real documentation update for the project, which changes what visitors see. It answers 202 with a statusId; poll it with the update-status tool.

api
mintlify_post_static_export_by_projectid_jobsWRITE

Start a static export job via POST https://api.mintlify.com/v1/static-export/{projectId}/jobs. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys). Answers 409 when an export for this project is already running and 429 when the export rate limit is reached -- both are provider limits, not call errors.

api
mintlify_post_v1_contentsWRITE

Get Mintlify Index result contents via POST https://leaves.mintlify.com/api/universal-search/v1/contents. Needs the MINTLIFY INDEX API KEY (https://app.mintlify.com/settings/organization/api-keys). Supply at least one of `ids` or `urls` in the body, up to 20 items in total; the schema states the rule as an anyOf and Mintlify answers 400 when neither is present. `ids` are values returned by the Index search tool.

api
mintlify_post_v1_contextWRITE

Build Mintlify Index context via POST https://leaves.mintlify.com/api/universal-search/v1/context. Needs the MINTLIFY INDEX API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_post_v1_page_by_domainWRITE

Get documentation page content via POST https://api.mintlify.com/discovery/v1/page/{domain}. Needs the Mintlify ASSISTANT API KEY (https://app.mintlify.com/settings/organization/api-keys). `path` is the value the search tool returns for a result, not a URL. On a deployment using `auth` or `userAuth`, pass the caller's authorized `groups` or only public pages are returned.

api
mintlify_post_v1_searchWRITE

Search the Mintlify Index via POST https://leaves.mintlify.com/api/universal-search/v1/search. Needs the MINTLIFY INDEX API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_post_v1_search_by_domainWRITE

Search documentation via POST https://api.mintlify.com/discovery/v1/search/{domain}. Needs the Mintlify ASSISTANT API KEY (https://app.mintlify.com/settings/organization/api-keys). Searches ONE documentation deployment, named by the `domain` path argument. For search across the whole Mintlify Index use the Index search tool, which needs the Index API key instead.

api
mintlify_post_v2_agent_by_projectid_jobWRITE

Create an agent job via POST https://api.mintlify.com/v2/agent/{projectId}/job. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys). Starts an agent job that acts on the project's documentation. Answers 201 with a job id; read it back with the get-agent-job tool. Mintlify answers 429 when the project's agent concurrency is exhausted.

api
mintlify_post_v2_agent_by_projectid_job_by_id_messageWRITE

Send a follow-up message to an agent job via POST https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_post_v2_assistant_by_domain_messageWRITE

Send an assistant message via POST https://api.mintlify.com/discovery/v2/assistant/{domain}/message. Needs the Mintlify ASSISTANT API KEY (https://app.mintlify.com/settings/organization/api-keys).

api
mintlify_post_v2_workflow_by_projectid_by_workflowschemaid_webhookWRITE

Trigger an automation webhook via POST https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys). Answers 402 when the organization's plan does not include automations and 503 when the automation runner is unavailable -- both are provider conditions rather than a bad request.

api
mintlify_post_workflow_by_projectid_by_workflowschemaid_triggerWRITE

Trigger an automation via POST https://api.mintlify.com/v1/workflow/{projectId}/{workflowSchemaId}/trigger. Needs the Mintlify ADMIN API KEY (https://app.mintlify.com/settings/organization/api-keys).

api

Put Mintlify behind one governed endpoint.

Same permissions, same audit trail, whatever else you connect next.