Base URL
All API requests should be made to:Endpoints
Admin Operations
- Trigger update: Trigger an update of your site when desired.
- Get update status: Get the status of an update and other details about your docs.
Agent Operations
- Create agent job: Create an agent job to automatically edit your documentation.
- Get agent job: Retrieve the details and status of a specific agent job.
Assistant Operations
- Generate assistant message: Embed the assistant, trained on your docs, into any application of your choosing.
- Search documentation: Search through your documentation.
Analytics Export
- Get user feedback: Export user feedback from your documentation.
- Get 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 and Get update status.
- CI/CD integration: Update documentation as part of your deployment pipeline when code changes with Trigger update.
- Custom integrations: Embed the AI assistant into your product, support portal, or internal tools with Generate assistant message and Search documentation.
- Automated editing: Use agent jobs to programmatically update documentation at scale with Create agent job and Get agent job.
- Analytics export: Export feedback and assistant conversations for external analysis with Get user feedback and Get assistant conversations.
Authentication
Generate API keys on the API keys page 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, Get update status, Create agent job, Get agent job, Get user feedback, and Get assistant conversations. Admin API keys begin with themint_ prefix.
The admin API key is a server-side secret. Do not expose it in client-side code.
Usage:
Assistant API key
Use the assistant API key to authenticate requests to Generate assistant message and Search documentation endpoints. Assistant API keys begin with themint_dsc_ prefix.
The assistant API key is a public token that you can reference in frontend code.
Usage:
Calls using the assistant API token can incur costs: either using your assistant credits or incurring overages.