Account Setup

Overview

Before you start: your Delivr contact (sales or support) creates the organization for you and invites the first user. Watch for an invitation email, accept it, and sign in at app.delivr.ai. From there, everything is self-serve, including inviting teammates from Settings > Members.

Once you're in the dashboard, you need a project and at least one pixel before you can query events or build audiences.

Credential generation is dashboard-only. Everything else is available via API.

What you needHow to create it
OrganizationCreated by your Delivr contact. They invite you via email.
Organization API key + secret (org-level data access, most common)Dashboard: https://app.delivr.ai/{org_id}/settings/api-keys
App credentials (client_id + client_secret for the Partner API, user-level auth)Dashboard: https://app.delivr.ai/account/apps
ProjectAPI or dashboard
PixelAPI or dashboard

Most integrations only need an organization API key + secret pair. That is enough to query events, audiences, taxonomy, and identity lookup for all projects in the org. Apps are for user-scoped access patterns (per-user credentials inside a customer-facing product, for example) and provide the Partner API credentials used by the project/pixel-management endpoints below.

Base URL: https://api.delivr.ai (Partner API for project and pixel management)

The Partner API uses api.delivr.ai. The data APIs (events, audiences, taxonomy, lookup) use apiv3.delivr.ai.


Concepts

flowchart TD
    A["Organization<br/>(your account)"] --> G["API key + secret<br/>(org-level data access)"]
    A --> B["App<br/>(Partner API credentials)"]
    A --> C["Project<br/>(pixels + audiences)"]
    C --> D["Pixel 1<br/>(website tracking)"]
    C --> E["Pixel 2<br/>(another site)"]
    C --> F["Audiences<br/>(intent lists)"]
    B -.->|"client_id + client_secret<br/>manages"| C
    G -.->|"queries"| C

    style A fill:#3b82f6,color:#fff
    style B fill:#6366f1,color:#fff
    style C fill:#8b5cf6,color:#fff
    style G fill:#22c55e,color:#fff
ConceptWhat It Is
OrganizationYour account. Created by Delivr support or sales as part of onboarding; you receive an invite to join it.
API key + secretOrg-level credential pair used to query data APIs. Created in the dashboard.
AppA Partner API credential pair (client_id + client_secret) used to manage projects and pixels via the Partner API. Created in the dashboard.
ProjectA container for your pixels and audience data. Lives under your organization.

Step 1: Create an App (for Partner API access)

App credentials are required to call the Partner API endpoints below (project create, pixel create, etc.). Create the app in the dashboard:

  1. Sign in at app.delivr.ai.
  2. Open https://app.delivr.ai/account/apps and click Create app.
  3. Name the app and copy client_id and client_secret. These are shown once.

Skipping this step? If all you need is to query events or audiences (no programmatic project/pixel creation), you can stop here and create an organization API key + secret instead. Apps are only needed for Partner API calls.

The app credentials go in two headers on every Partner API request:

X-Delivr-Client-ID: client_...
X-Delivr-Client-Secret: secret_...

You'll also need a platform JWT for the Authorization: Bearer header on Partner API calls. Get it from POST https://api.delivr.ai/public/core/auth/issue (see the Partner API reference for details).


Step 2: Create a Project

Projects are containers for your pixels and audience data. Create one via the Partner API:

curl -X POST https://api.delivr.ai/public/core/api/project/create \
  -H "Authorization: Bearer YOUR_PLATFORM_JWT" \
  -H "X-Delivr-Client-ID: YOUR_CLIENT_ID" \
  -H "X-Delivr-Client-Secret: YOUR_CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -H "organization_id: YOUR_ORGANIZATION_ID" \
  -d '{
    "project": {
      "name": "My Project"
    }
  }'

Response

{
  "response": {
    "project_id": "5b6f6b47-5ba7-..."
  }
}

Save the project_id. You'll pass it to the Events and Audiences APIs.

Prefer the UI? Create projects from Settings > Projects in the dashboard.

List Your Projects

curl https://api.delivr.ai/public/core/api/project/get \
  -H "Authorization: Bearer YOUR_PLATFORM_JWT" \
  -H "X-Delivr-Client-ID: YOUR_CLIENT_ID" \
  -H "X-Delivr-Client-Secret: YOUR_CLIENT_SECRET" \
  -H "organization_id: YOUR_ORGANIZATION_ID"

Response

{
  "response": {
    "projects": [
      {
        "project_id": "5b6f6b47-5ba7-...",
        "name": "My Project",
        "status": "active",
        "created_at": "2026-01-01 10:00:00"
      }
    ]
  }
}

Step 3: Create a Pixel

Create a pixel for your project. Either via API:

curl -X POST https://api.delivr.ai/public/core/api/pixel/create \
  -H "Authorization: Bearer YOUR_PLATFORM_JWT" \
  -H "X-Delivr-Client-ID: YOUR_CLIENT_ID" \
  -H "X-Delivr-Client-Secret: YOUR_CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -H "project_id: YOUR_PROJECT_ID" \
  -d '{
    "title": "My Website Pixel"
  }'

Or from the dashboard: open your project, go to Settings > Pixels, and click Create pixel.

Response

{
  "response": {
    "pixel_id": "8a755c42-b2b1-...",
    "installation_url": "https://cdn.delivr.ai/pixels/8a755c42-b2b1-.../p.js"
  }
}

Add the install snippet to your site's <head>:

<script id="delivr-ai" src="https://cdn.delivr.ai/pixels/YOUR_PIXEL_ID/p.js" async></script>

Step 4: Create an Organization API Key (for data queries)

When you're ready to query events, audiences, taxonomy, or identity lookup:

  1. Open Settings > API keys in your organization: https://app.delivr.ai/{org_id}/settings/api-keys.
  2. Click Create key, name it, and copy the api_key (dlvr_...) and api_secret shown in the dialog. The secret is displayed once.

Full walkthrough: Authentication.


Summary: What You Have Now

ItemWhere You Got ItWhere To Use It
App client_id/client_secretStep 1, dashboardX-Delivr-Client-ID / X-Delivr-Client-Secret headers on Partner API calls
Project IDStep 2project_id parameter on events and audience calls
Pixel IDStep 3pixel_id parameter on events calls
api_key / api_secretStep 4, dashboardX-Api-Key / X-Api-Secret headers on all data API calls

Next Steps

You now have a project, a pixel, and an API key + secret pair. Choose your path:

Path 1: On-Domain Events (Pixel)

Query visitor events from your installed pixel.

On-Domain Events API

Path 2: Intent Audiences

Create intent-based audiences on your project and download the results.

Intent Audiences API