mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
b4c08f5597
- Updated discovery-openapi.json - Updated es/admin-openapi.json - Updated es/discovery-openapi.json - Updated fr/admin-openapi.json - Updated fr/discovery-openapi.json - Updated zh/admin-openapi.json - Updated zh/discovery-openapi.json - Updated api/introduction.mdx - Updated admin-openapi.json - Updated openapi.json - Updated es/api/introduction.mdx - Updated fr/api/introduction.mdx - Updated zh/api/introduction.mdx - Deleted api/agent/create-agent-job.mdx - Deleted api/agent/get-agent-job.mdx - Deleted api/agent/get-all-jobs.mdx - Deleted api/agent/v2/create-agent-job.mdx - Deleted api/agent/v2/get-agent-job.mdx - Deleted api/agent/v2/send-message.mdx - Deleted api/analytics/assistant-caller-stats.mdx - Deleted api/analytics/assistant-conversations.mdx - Deleted api/analytics/feedback-by-page.mdx - Deleted api/analytics/feedback.mdx - Deleted api/analytics/searches.mdx - Deleted api/analytics/views.mdx - Deleted api/analytics/visitors.mdx - Deleted api/assistant/create-assistant-message-v2.mdx - Deleted api/assistant/create-assistant-message.mdx - Deleted api/assistant/get-page-content.mdx - Deleted api/assistant/search.mdx - Deleted api/preview/trigger.mdx - Deleted api/update/status.mdx - Deleted api/update/trigger.mdx - Deleted es/api/agent/create-agent-job.mdx - Deleted es/api/agent/get-agent-job.mdx - Deleted es/api/agent/get-all-jobs.mdx - Deleted es/api/agent/v2/create-agent-job.mdx - Deleted es/api/agent/v2/get-agent-job.mdx - Deleted es/api/agent/v2/send-message.mdx - Deleted es/api/analytics/assistant-caller-stats.mdx - Deleted es/api/analytics/assistant-conversations.mdx - Deleted es/api/analytics/feedback-by-page.mdx - Deleted es/api/analytics/feedback.mdx - Deleted es/api/analytics/searches.mdx - Deleted es/api/analytics/views.mdx - Deleted es/api/analytics/visitors.mdx - Deleted es/api/assistant/create-assistant-message-v2.mdx - Deleted es/api/assistant/create-assistant-message.mdx - Deleted es/api/assistant/get-page-content.mdx - Deleted es/api/assistant/search.mdx - Deleted es/api/preview/trigger.mdx - Deleted es/api/update/status.mdx - Deleted es/api/update/trigger.mdx - Deleted fr/api/agent/create-agent-job.mdx - Deleted fr/api/agent/get-agent-job.mdx - Deleted fr/api/agent/get-all-jobs.mdx - Deleted fr/api/agent/v2/create-agent-job.mdx - Deleted fr/api/agent/v2/get-agent-job.mdx - Deleted fr/api/agent/v2/send-message.mdx - Deleted fr/api/analytics/assistant-caller-stats.mdx - Deleted fr/api/analytics/assistant-conversations.mdx - Deleted fr/api/analytics/feedback-by-page.mdx - Deleted fr/api/analytics/feedback.mdx - Deleted fr/api/analytics/searches.mdx - Deleted fr/api/analytics/views.mdx - Deleted fr/api/analytics/visitors.mdx - Deleted fr/api/assistant/create-assistant-message-v2.mdx - Deleted fr/api/assistant/create-assistant-message.mdx - Deleted fr/api/assistant/get-page-content.mdx - Deleted fr/api/assistant/search.mdx - Deleted fr/api/preview/trigger.mdx - Deleted fr/api/update/status.mdx - Deleted fr/api/update/trigger.mdx - Deleted zh/api/agent/create-agent-job.mdx - Deleted zh/api/agent/get-agent-job.mdx - Deleted zh/api/agent/get-all-jobs.mdx - Deleted zh/api/agent/v2/create-agent-job.mdx - Deleted zh/api/agent/v2/get-agent-job.mdx - Deleted zh/api/agent/v2/send-message.mdx - Deleted zh/api/analytics/assistant-caller-stats.mdx - Deleted zh/api/analytics/assistant-conversations.mdx - Deleted zh/api/analytics/feedback-by-page.mdx - Deleted zh/api/analytics/feedback.mdx - Deleted zh/api/analytics/searches.mdx - Deleted zh/api/analytics/views.mdx - Deleted zh/api/analytics/visitors.mdx - Deleted zh/api/assistant/create-assistant-message-v2.mdx - Deleted zh/api/assistant/create-assistant-message.mdx - Deleted zh/api/assistant/get-page-content.mdx - Deleted zh/api/assistant/search.mdx - Deleted zh/api/preview/trigger.mdx - Deleted zh/api/update/status.mdx - Deleted zh/api/update/trigger.mdx - Updated docs.json - Updated es.json - Updated fr.json - Updated zh.json Mintlify-Source: dashboard-editor
62 lines
5.6 KiB
Plaintext
62 lines
5.6 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
|
|
---
|
|
|
|
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/admin/trigger-update): Trigger an update of your site when desired.
|
|
- [Get update status](/api/admin/get-update-status): Get the status of an update and other details about your docs.
|
|
- [Trigger preview deployment](/api/admin/trigger-preview-deployment): Create or update a preview deployment for a specific branch.
|
|
- [Create agent job](/api/agent/create-agent-job): Create an agent job to automatically edit your documentation.
|
|
- [Get agent job](/api/agent/get-agent-job): Retrieve the details and status of a specific agent job.
|
|
- [Send follow-up message](/api/agent/send-follow-up-message): Send a follow-up message to an existing agent job.
|
|
- [Create assistant message](/api/assistant/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing.
|
|
- [Search documentation](/api/assistant/search-documentation): 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/get-feedback): Export user feedback from your documentation.
|
|
- [Get feedback by page](/api/analytics/get-feedback-by-page): Export feedback counts aggregated by page.
|
|
- [Get assistant conversations](/api/analytics/get-assistant-conversations): Export AI assistant conversation history.
|
|
- [Get assistant caller stats](/api/analytics/get-assistant-caller-stats): Retrieve a breakdown of assistant query counts by caller type.
|
|
- [Get search queries](/api/analytics/get-search-queries): Export documentation search terms and analytics.
|
|
- [Get page views](/api/analytics/get-page-views): Export per-page and site-wide content view counts.
|
|
- [Get unique visitors](/api/analytics/get-unique-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/admin/trigger-update) and [Get update status](/api/admin/get-update-status).
|
|
- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/admin/trigger-update).
|
|
- **Preview deployments**: Create or update preview deployments programmatically in your CI/CD pipeline with [Trigger preview deployment](/api/admin/trigger-preview-deployment).
|
|
- **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Create assistant message](/api/assistant/create-assistant-message), [Search documentation](/api/assistant/search-documentation), 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/create-agent-job), [Get agent job](/api/agent/get-agent-job), and [Send follow-up message](/api/agent/send-follow-up-message).
|
|
- **Analytics export**: Export feedback, assistant conversations, search analytics, page views, and visitor data for external analysis with [Get user feedback](/api/analytics/get-feedback), [Get feedback by page](/api/analytics/get-feedback-by-page), [Get assistant conversations](/api/analytics/get-assistant-conversations), [Get assistant caller stats](/api/analytics/get-assistant-caller-stats), [Get search queries](/api/analytics/get-search-queries), [Get page views](/api/analytics/get-page-views), and [Get unique visitors](/api/analytics/get-unique-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.
|
|
|
|
### Admin API key
|
|
|
|
Use the admin API key to authenticate requests to [Trigger update](/api/admin/trigger-update), [Get update status](/api/admin/get-update-status), [Trigger preview deployment](/api/admin/trigger-preview-deployment), [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), [Send follow-up message](/api/agent/send-follow-up-message), [Get user feedback](/api/analytics/get-feedback), [Get feedback by page](/api/analytics/get-feedback-by-page), [Get assistant conversations](/api/analytics/get-assistant-conversations), [Get assistant caller stats](/api/analytics/get-assistant-caller-stats), [Get search queries](/api/analytics/get-search-queries), [Get page views](/api/analytics/get-page-views), and [Get unique visitors](/api/analytics/get-unique-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
|
|
|
|
Use the assistant API key to authenticate requests to [Create assistant message](/api/assistant/create-assistant-message), [Search documentation](/api/assistant/search-documentation), and [Get page content](/api/assistant/get-page-content) endpoints.
|
|
|
|
Assistant API keys begin with the `mint_dsc_` prefix.
|
|
|
|
The assistant API key is a public token that you can reference in frontend code.
|
|
|
|
<Note>
|
|
Calls using the assistant API token can incur costs: either using your assistant credits or incurring overages.
|
|
</Note> |