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.

Creating the credential itself is dashboard-only. Once you hold an organization API key + secret, everything else in this guide is available via API.

What you needHow to create it
OrganizationCreated by your Delivr contact. They invite you via email.
Organization API key + secret (the credential for everything below)Dashboard: https://app.delivr.ai/{org_id}/settings/api-keys
ProjectAPI (POST /api/v1/project/create) or dashboard
PixelAPI (POST /api/v2/pixel/create) or dashboard

Most integrations only need an organization API key + secret pair. That covers querying events, audiences, taxonomy, and identity lookup across every project in the org, plus full management of your organization, projects, pixels, and members. To give a client or integration access to one project only, create a project-scoped key instead.

Managing your organization, projects, pixels, and members works with the organization API key (X-Api-Key + X-Api-Secret) directly: read, update, or delete your own organization (https://api.delivr.ai/api/v1/organization), full project and pixel CRUD (https://api.delivr.ai/api/v1/project* and https://api.delivr.ai/api/v1/pixel*), and organization- and project-member management (.../api/v1/organization/user* and .../api/v1/project/user*). On the org-key path a project-scoped call names its target project in the request: a project_id field for writes, or a ?project_id= query parameter for reads.

Base URL: https://api.delivr.ai for everything: management, events, audiences, taxonomy, and lookup.


Concepts

flowchart TD
    A["Organization<br/>(your account)"] --> G["API key + secret<br/>(manages and queries)"]
    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)"]
    G -->|"X-Api-Key + X-Api-Secret<br/>creates, manages, queries"| C

    style A fill:#3b82f6,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. Manages your projects, pixels, and members, and queries the data APIs. Created in the dashboard.
ProjectA container for your pixels and audience data. Lives under your organization.

Step 1: Create an Organization API Key

The organization API key + secret pair is the credential for everything in this guide: creating projects and pixels, and querying events, audiences, taxonomy, and identity lookup. Create it in the dashboard:

  1. Sign in at app.delivr.ai.
  2. Open https://app.delivr.ai/{org_id}/settings/api-keys and click Create API key.
  3. Copy the key and secret. The secret is shown once.

The pair goes in two headers on every request:

X-Api-Key: dlvr_xxxxxxxx
X-Api-Secret: xxxxxxxx

There is no separate token exchange. The key authenticates directly, and every call is scoped to the key's own organization, so you never pass an organization_id.


Step 2: Create a Project

Projects are containers for your pixels and audience data. Create one with your organization API key:

curl -X POST https://api.delivr.ai/api/v1/project/create \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "X-Api-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "project": {
      "name": "My Project"
    }
  }'

The project is created in the organization the key belongs to. There is no organization_id header on this path.

Response

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

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

Provisioning a project per tenant? This endpoint is the one to automate against. It needs no dashboard session and no token refresh, so a server-side job can call it with a stored key pair.

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

List Your Projects

curl https://api.delivr.ai/api/v1/project/get \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "X-Api-Secret: YOUR_API_SECRET"

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/api/v2/pixel/create \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "X-Api-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "YOUR_PROJECT_ID",
    "title": "My Website Pixel",
    "allowed_origins": ["example.com"]
  }'

The target project is named in the body and must belong to your key's organization. allowed_origins lists the sites the pixel runs on. If one pixel runs on many sites, such as an agency's client sites, send "allow_any_origin": true instead. See Declare Where Your Pixel Runs.

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",
    "allowed_origins": ["example.com"],
    "allow_any_origin": false,
    "origins_status": "declared"
  }
}

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>

Verify your first event

Before you build anything on top of the pixel, confirm an event actually arrives. Load a page on your site so the pixel fires, then check either way:

  • In the dashboard: open the pixel (or source) detail page. It shows a live "waiting for your first event... received" indicator that flips once data lands.
  • From the API (once you have the key from Step 1): query the base event tier and confirm rows come back.
curl -s "https://api.delivr.ai/api/v3/events/web_event?project_id=YOUR_PROJECT_ID&limit=10" \
  -H "X-Api-Key: dlvr_xxxxxxxx" \
  -H "X-Api-Secret: YOUR_SECRET"

If rows come back, your pixel is wired up correctly.


Summary: What You Have Now

ItemWhere You Got ItWhere To Use It
api_key / api_secretStep 1, dashboardX-Api-Key / X-Api-Secret headers on every call in this guide and on all data API calls
Project IDStep 2project_id parameter on events and audience calls
Pixel IDStep 3pixel_id parameter on events calls

Full credential walkthrough: Authentication.


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. New integrations should use the per-tier Events API v3, where the route you call fixes the price.

On-Domain Events API · Events API v3

Path 2: Intent Audiences

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

Intent Audiences API


Did this page help you?