API Reference #

The platform exposes a REST API for managing contacts, sending messages, running campaigns, and every other core surface of the platform.

• Base URL — https://api.youraiconnector.com/v1
• Authentication — provide your API key any of these ways (see Authentication for details):
  • ?apiKey=YOUR_API_KEY query parameter — the simplest form, works on every endpoint
  • X-API-Key: YOUR_API_KEY request header
  • Authorization: Bearer YOUR_API_KEY request header
• Where to get an API key — see API Access. The key lives at Settings → Integrations → API Key (its own section, separate from Webhooks).
• Rate limits — public endpoints: 1,200 requests/minute; authenticated endpoints: 300 requests/minute per API key, plus a 1,200 requests/minute ceiling per account. Burst above the cap returns 429 Too Many Requests.
• Spec file — download the OpenAPI spec (OpenAPI 3.1).

New to the API? Start with the step-by-step guides:

• Getting Started — your first request, the response format, and a map of every resource
• Authentication · Errors & Pagination
• Resource guides: AI Agents · Entry Points · Broadcasts · Campaigns · Contacts · FAQs · Knowledge Base · Tasks · Messages · Appointments · Channels · Templates · Analytics · Webhooks · Team · API Keys
• Build an Integration End-to-End

The interactive explorer below lets you browse every endpoint, inspect schemas, and run requests live against the production API.