1. Resolutions & Events API

This is the company's core product, which allows you to receive information about visitors to your website in the format of real-time resolutions. The available data not only enables user identification but also provides access to raw event data for those users on your website

2. Data API

Data API provides programmatic access to account and contact data

3. Public API

This is our White Label product, which allows you to create our Resolution and Event pixels using APIs hosted on your own domain. Additionally, the API enables you to create and manage projects, invite users to a project, and more. Review the detailed API documentation, and to start using the API, please complete the application form

4. Taxonomy API

The Taxonomy API lets you retrieve lists of categories, subcategories, and intent topics, with the option to filter them by audience segment type. The API also enables you to submit requests to add new topics to the taxonomy and fetch their approval statuses

How to start

Below is the instruction to help you get started with our APIs

Introduction

The onboarding flow consists of three steps:

1. Create User Account
2. Login - obtain a JWT and your organization_id
3. Create API Client - issue one-time api_key and api_secret for data endpoints

After activation, you can call Events & Resolutions endpoints (e.g., /api/v1/events) or Contact API while staying within your contract quotas.

1. Create User Account

Create your user account within the Delivr.ai system

curl --request POST \
  --url 'https://api.delivr.ai/data/core/v1/auth/register' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
  "email": "[email protected]",
  "password": "Password123!",
  "first_name": "John",
  "last_name": "Doe",
  "organization_name": "My Company Inc"
}'

Response example:

{
   "message": "Successfully registered."
}

2. Login

The login endpoint authenticates a user, returning a JWT and key identifiers including organization_id

Request

curl --request POST \
  --url 'https://api.delivr.ai/data/core/v1/auth/login' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "email": "[email protected]",
    "password": "Password123!"
  }'

Successful Response (example)

{
  "user_id": "a2e1f8a8-1b3a-4c1c-9c0f-2b6a1d9f3f11",
  "organization_id": "1d7b5e3c-7a9e-4e31-91a8-0b2d9f2b7a10",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Please note that the JWT token for the Resolutions & Events and Data API is different from the JWT token for Public API

3. Create API Client

Creates an application client and returns API credentials. These credentials are required for business/data endpoints.

Request

curl --request POST \
  --url 'https://api.delivr.ai/data/core/v1/client' \
  --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'content-type: application/json' \
  --data '{
    "name": "My Application"
  }'

Successful Response (example)

{
  "client_id": "2f3e4a8b-3d1b-4a6f-b0ad-8ef0f2a9dc12",
  "api_key": "dvr_p_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "api_secret": "secret_1e7f2c3a4b5d6e7f8c9a0b1c2d3e4f5a",
  "created_at": "2025-01-15 10:30:00"
}

Security Warning

• Store these credentials securely. api_key and api_secret are shown only once and cannot be retrieved again.
• If you lose these credentials, create a new API client.
• Never expose API keys in client-side apps or public repositories.