API overview
Aimdoc API & Webhooks are available on the Convert plan only.
Aimdoc's External API gives you programmatic access to Aimdoc data. Use it when your system needs to retrieve records on demand; use webhooks when your system needs to react as events happen.
Authentication
Base URL:
https://api.aimdoc.ai/api/v1
Send your API key as a Bearer token:
Authorization: Bearer ak_your_api_key_here
Create an API key in the dashboard:
- Go to Integrations
- Open API Keys
- Click Create new key
- Copy and store the key securely
You can only view your API key at the time of creation. Make sure to save it securely — you won't be able to view it again.
Make your first request
Request a page of conversations:
curl "https://api.aimdoc.ai/api/v1/conversations?page=1&per_page=50" \
-H "Authorization: Bearer ak_your_api_key_here"
Use the API Reference for the complete endpoint list, supported filters, request parameters, response schemas, and errors.
Choose an integration method
- Use the API to retrieve conversations, messages, contacts, visitor
profiles, and accounts when your application needs them.
Conversations, contacts, and visitor profiles accept an
account_idfilter. - Use Webhooks to receive event-driven updates without polling.
- Use the MCP Server to let supported AI assistants query Aimdoc data and, with a user-authorized connection, configure and publish agents.
References
- API Reference for endpoints, parameters, schemas, and errors
- Webhooks Guide for setup, delivery, and security
- Webhooks Reference for event names and canonical payload schemas