mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
1424cf40df
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
102 lines
7.1 KiB
Plaintext
102 lines
7.1 KiB
Plaintext
---
|
|
title: "Mintlify REST API introduction"
|
|
description: "Use the Mintlify REST API to trigger deployments, embed an AI assistant, export analytics data, and manage documentation programmatically."
|
|
keywords: ["REST API", "endpoints", "API keys"]
|
|
boost: 3
|
|
---
|
|
|
|
<Info>
|
|
The REST API requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=api).
|
|
</Info>
|
|
|
|
The Mintlify REST (Representational State Transfer) API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data.
|
|
|
|
## Endpoints
|
|
|
|
- [Trigger update](/api/update/trigger): Trigger an update of your site when desired.
|
|
- [Get update status](/api/update/status): Get the status of an update and other details about your docs.
|
|
- [Trigger preview deployment](/api/preview/trigger): Create or update a preview deployment for a specific branch.
|
|
- [Trigger automation](/api/automations/trigger): Run a scheduled automation on demand.
|
|
- [Detect AI-sounding prose](/api/admin/deslop): Analyze a page for AI-generated prose and get suggested human rewrites.
|
|
- [Create agent job](/api/agent/v2/create-agent-job): Create an agent job to automatically edit your documentation.
|
|
- [Get agent job](/api/agent/v2/get-agent-job): Retrieve the details and status of a specific agent job.
|
|
- [Send follow-up message](/api/agent/v2/send-message): Send a follow-up message to an existing agent job.
|
|
- [Create assistant message](/api/assistant/create-assistant-message-v2): Embed the assistant, trained on your docs, into any application of your choosing.
|
|
- [Search documentation](/api/assistant/search): Search through your documentation.
|
|
- [Get page content](/api/assistant/get-page-content): Retrieve the full text content of a documentation page.
|
|
- [Get user feedback](/api/analytics/feedback): Export user feedback from your documentation.
|
|
- [Get feedback by page](/api/analytics/feedback-by-page): Export feedback counts aggregated by page.
|
|
- [Get assistant conversations](/api/analytics/assistant-conversations): Export AI assistant conversation history.
|
|
- [Get assistant caller stats](/api/analytics/assistant-caller-stats): Retrieve a breakdown of assistant query counts by caller type.
|
|
- [Get search queries](/api/analytics/searches): Export documentation search terms and analytics.
|
|
- [Get page views](/api/analytics/views): Export per-page and site-wide content view counts.
|
|
- [Get unique visitors](/api/analytics/visitors): Export per-page and site-wide unique visitor counts.
|
|
|
|
### Common use cases
|
|
|
|
- **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api/update/trigger) and [Get update status](/api/update/status).
|
|
- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/update/trigger).
|
|
- **Preview deployments**: Create or update preview deployments programmatically in your CI/CD pipeline with [Trigger preview deployment](/api/preview/trigger).
|
|
- **On-demand automations**: Run scheduled automations from your CI/CD pipeline or release tooling with [Trigger automation](/api/automations/trigger).
|
|
- **Assistant integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Create assistant message](/api/assistant/create-assistant-message-v2).
|
|
- **Documentation retrieval**: Find and retrieve documentation for custom search experiences with [Search documentation](/api/assistant/search) and [Get page content](/api/assistant/get-page-content).
|
|
- **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api/agent/v2/create-agent-job), [Get agent job](/api/agent/v2/get-agent-job), and [Send follow-up message](/api/agent/v2/send-message).
|
|
- **Analytics export**: Export feedback, assistant conversations, search analytics, page views, and visitor data for external analysis with [Get user feedback](/api/analytics/feedback), [Get feedback by page](/api/analytics/feedback-by-page), [Get assistant conversations](/api/analytics/assistant-conversations), [Get assistant caller stats](/api/analytics/assistant-caller-stats), [Get search queries](/api/analytics/searches), [Get page views](/api/analytics/views), and [Get unique visitors](/api/analytics/visitors).
|
|
|
|
## Authentication
|
|
|
|
Generate API keys on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Each API key belongs to an organization—you can use keys across multiple deployments within the same organization.
|
|
|
|
You can create up to 10 API keys per hour per organization.
|
|
|
|
Mintlify uses two types of API keys, each scoped to a different set of endpoints:
|
|
|
|
| Key type | Prefix | Use for |
|
|
| ----------------- | ----------- | --------------------------------------------------------------------------------------- |
|
|
| Admin API key | `mint_` | Updates, agent jobs, and analytics exports. Server-side only. |
|
|
| Assistant API key | `mint_dsc_` | Assistant messages, documentation search, and page content. Proxy in production. |
|
|
|
|
### Admin API key
|
|
|
|
Use the admin API key for deployment, triggering the agent, and analytics endpoints.
|
|
|
|
- [Trigger update](/api/update/trigger)
|
|
- [Get update status](/api/update/status)
|
|
- [Trigger preview deployment](/api/preview/trigger)
|
|
- [Trigger automation](/api/automations/trigger)
|
|
- [Detect AI-sounding prose](/api/admin/deslop)
|
|
- [Create agent job](/api/agent/v2/create-agent-job)
|
|
- [Get agent job](/api/agent/v2/get-agent-job)
|
|
- [Send follow-up message](/api/agent/v2/send-message)
|
|
- [Get user feedback](/api/analytics/feedback)
|
|
- [Get feedback by page](/api/analytics/feedback-by-page)
|
|
- [Get assistant conversations](/api/analytics/assistant-conversations)
|
|
- [Get assistant caller stats](/api/analytics/assistant-caller-stats)
|
|
- [Get search queries](/api/analytics/searches)
|
|
- [Get page views](/api/analytics/views)
|
|
- [Get unique visitors](/api/analytics/visitors)
|
|
|
|
Admin API keys begin with the `mint_` prefix.
|
|
|
|
The admin API key is a server-side secret. Do not expose it in client-side code.
|
|
|
|
### Assistant API key
|
|
|
|
<Warning>
|
|
Do not directly embed the assistant API key in client-side code. Any visitor who extracts the key can call the assistant message endpoint on your behalf, consuming credits and potentially triggering overage charges.
|
|
|
|
For production deployments, proxy requests that use an assistant API key through your own backend and store the key as a server-side environment variable. Routing requests through a proxy also lets you add rate limiting, authentication, and bot protection to prevent abuse.
|
|
</Warning>
|
|
|
|
Use the assistant API key to authenticate requests to the assistant, search, and page content endpoints.
|
|
|
|
- [Create assistant message](/api/assistant/create-assistant-message-v2)
|
|
- [Search documentation](/api/assistant/search)
|
|
- [Get page content](/api/assistant/get-page-content)
|
|
|
|
Assistant API keys begin with the `mint_dsc_` prefix.
|
|
|
|
<Note>
|
|
Search documentation and page content requests do not consume credits. Assistant message requests use credits and can incur overages.
|
|
</Note>
|