Aimdoc

API & Webhooks

Aimdoc API & Webhooks are available on the Convert plan only.

Aimdoc's External API gives you programmatic access to conversation, message, contact, and visitor profile data, and webhooks let you receive real-time updates when 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.

Common endpoints

  • GET /conversations — list conversations
  • GET /messages — list message records
  • GET /contacts — list contact records
  • GET /visitor-profiles — list visitor profiles
  • GET /visitor-profiles/{visitor_id} — fetch one visitor profile
  • GET /leads — deprecated alias maintained for backward compatibility

Pagination and filters

List endpoints support:

  • page and per_page for pagination
  • start_date and end_date (YYYY-MM-DD) for date ranges
  • search, lead_id, and last_seen_after on visitor profile exports

Example request:

curl "https://api.aimdoc.ai/api/v1/conversations?start_date=2026-02-01&end_date=2026-02-29&page=1&per_page=50" \
  -H "Authorization: Bearer ak_your_api_key_here"

References

Was this page helpful?