What you can do
| Area | Endpoints |
|---|---|
| Deployments | Trigger updates, check deployment status, create preview deployments |
| Agent | Create and monitor agent jobs that automatically edit your docs |
| Assistant | Embed the AI assistant into any application; search and retrieve page content |
| Analytics | Export feedback, assistant conversations, search terms, page views, and visitor counts |
Authentication
Generate API keys on the API keys page in your dashboard. Keys belong to an organization and work across all projects in that organization. You can create up to 10 API keys per hour per organization.Admin API key
Admin keys begin withmint_. Use them to authenticate requests to the Deployments, Agent, and Analytics endpoints.
Admin keys are server-side secrets. Do not expose them in client-side code.
Assistant API key
Assistant keys begin withmint_dsc_. Use them to authenticate requests to the Assistant endpoints.
Assistant keys are public tokens safe for use in frontend code.
Assistant API calls consume assistant credits or incur overages on your plan.
Common use cases
- Automated deployments — Trigger site updates on a schedule or when events occur. Use Trigger update and poll Get update status to confirm completion.
- CI/CD integration — Update documentation as part of your deployment pipeline. Integrate Trigger update into your existing workflows.
- Preview deployments — Create branch previews automatically when pull requests are opened. Use Trigger preview deployment in CI.
- Embed the assistant — Add an AI assistant trained on your docs to your product, support portal, or internal tools. See Assistant message (AI SDK v5+) and Assistant message (AI SDK v4).
- Programmatic editing — Use agent jobs to update documentation at scale. See Create agent job and Get agent job.
- Analytics export — Pull feedback, conversation history, and traffic data into external dashboards or data warehouses.