mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
9200586a3a
* docs: boost search ranking for single-word title pages Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first. * docs: drop boost on websocket-playground stub to keep canonical Playground ranking `api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
63 lines
5.3 KiB
Plaintext
63 lines
5.3 KiB
Plaintext
---
|
|
title: "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/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.
|
|
- [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).
|
|
- **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Create assistant message](/api/assistant/create-assistant-message-v2), [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://dashboard.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/update/trigger), [Get update status](/api/update/status), [Trigger preview deployment](/api/preview/trigger), [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), and [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
|
|
|
|
Use the assistant API key to authenticate requests to [Create assistant message](/api/assistant/create-assistant-message-v2), [Search documentation](/api/assistant/search), 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>
|