Skip to Content
API referenceOverview

API Reference

All Adzen endpoints accept and return JSON. Authentication is via the X-API-Key header on every request.

Base URLs

EnvironmentURL
Sandboxhttps://sandbox.adzen.ai
Productionhttps://api.adzen.ai

The sandbox covers UGC and Ad Manager. Its UGC path differs from production; see Sandbox. There is no sandbox for AI Surfaces yet.

Path shape

Every partner API endpoint lives under /v1/<product>/; tag and beacon traffic uses /dea/:

https://api.adzen.ai/v1/ugc/process https://api.adzen.ai/v1/ai/process https://api.adzen.ai/v1/ad-manager/campaigns

The /v1/ prefix is required in production. Paths without it — /ugc/process, /ai/process — return 404.

Production is US-only. API calls and impression and click beacons from outside the US get 403. The sandbox does not apply this rule.

Keys are scoped to one product

A key is issued for one of UGC, AI, or Ad Manager, and is rejected on the others. A missing, invalid, or wrong-product key fails with 401.

Endpoints

Delivery (tag traffic)

  • /dea/* — ad requests, placements and impression beacons, fired by the tag, not your code — except AI impression beacons, which your code fires from the URLs on each matched ad.

UGC (User-Generated Content)

  • POST /v1/ugc/process — Match an ad to a post
  • GET /v1/ugc/health — Liveness check, no key required

Ad suppression is handled by Adzen; there is no endpoint for it.

AI

  • POST /v1/ai/process — Match an ad to a conversation turn
  • GET /v1/ai/health — Liveness check, no key required

Impression beacons are returned on each matched ad as render_impression_url / view_impression_url, served from https://api.adzen.ai/dea/ai/impressions/*.

Ad Manager

Ad Manager endpoints — documentation coming soon.

Keys

API keys are issued and rotated by Adzen.

Last updated on