Skip to main content
A2V2.ai gives you two ways to integrate the platform with your own product: the Open API (a REST API for moving CRM data in and out programmatically) and the Widget JS API (the embeddable chat widget you load on your site). This section is written for developers. If you just want to add the agent to a website without code, start with Embed & Install instead.

Who this is for

Backend / integration developers

Use the Open API to create and update CRM contacts, submit forms, manage contact files, and run AI document extraction from your own backend.

Front-end / web developers

Use the Widget JS API to embed the chat bubble and control it programmatically with A2V2Widget.init() / .destroy().

The two surfaces

SurfaceAuthWhat it’s forReference
Open API (REST)API key + secret (header)Server-to-server: contacts, forms, contact files, document extractionEndpoints
Widget JS APINone (public, per agent)Embed and control the chat widget in the browserWidget JS API

Base URL

All Open API endpoints live under the /v1/open path on the A2V2.ai API host:
https://api.a2v2.ai/v1/open
https://api.a2v2.ai is the production API host. Every example in this section uses it as the base URL, followed by the fixed /v1/open path.
The Widget JS API is served from a separate, public host and does not use the /v1/open path:
https://chat-widget.a2v2.ai/embed.js

Authentication at a glance

Open API requests authenticate with an API key and secret sent as request headers. You create keys in the dashboard under Settings → API Permissions, and each key is scoped to a single agent with explicit permissions.
X-API-Key: your-api-key
X-API-Secret: your-api-secret
Content-Type: application/json
Full details — including how keys are scoped and how to rotate them — are on the Authentication page.

Response format

Every Open API response is JSON with a success flag.
{
  "success": true,
  "message": "Operation completed successfully",
  "data": { }
}
List endpoints return a pagination object alongside data:
{
  "pagination": {
    "currentPage": 1,
    "totalPages": 5,
    "totalItems": 100,
    "itemsPerPage": 20,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Rate limits

Each API key has its own rate limits, set when you create the key. The defaults are 60 requests per minute and 1,000 requests per hour, and you can raise them when configuring the key (up to 1,000/minute and 10,000/hour). Requests over the limit return an error response — back off and retry.

Health check

A lightweight, unauthenticated endpoint confirms the API is reachable:
curl https://api.a2v2.ai/v1/open/health
{ "success": true, "message": "A2V2 Open API is healthy", "version": "1.0.0" }

Authentication

Create an API key and scope its permissions.

Endpoints

Every Open API endpoint, grouped by domain.

Widget JS API

Embed and control the chat widget in the browser.

Embed & Install

The no-code way to add your agent to a site.