> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/mintlify/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Trigger updates, embed AI assistant, export analytics, and more

The Mintlify REST 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.
* [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.
* [Get all agent jobs](/api/agent/get-all-jobs): Retrieve all agent jobs for a domain.
* [Generate 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 user feedback](/api/analytics/feedback): Export user feedback from your documentation.
* [Get assistant conversations](/api/analytics/assistant-conversations): Export AI assistant conversation history.

### 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).
* **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Generate assistant message](/api/assistant/create-assistant-message-v2) and [Search documentation](/api/assistant/search).
* **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 [Get all agent jobs](/api/agent/get-all-jobs).
* **Analytics export**: Export feedback and assistant conversations for external analysis with [Get user feedback](/api/analytics/feedback) and [Get assistant conversations](/api/analytics/assistant-conversations).

## 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), [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), [Get all agent jobs](/api/agent/get-all-jobs), [Get user feedback](/api/analytics/feedback), and [Get assistant conversations](/api/analytics/assistant-conversations).

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 [Generate assistant message](/api/assistant/create-assistant-message-v2) and [Search documentation](/api/assistant/search) 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>