API Reference
Adzen has four partner APIs and a set of tracking URLs.
Base URLs
| Environment | URL |
|---|---|
| Production | https://api.adzen.ai |
| Sandbox | https://sandbox.adzen.ai. It takes its own keys; see Sandbox for its paths. |
Production accepts requests from US IP addresses. Requests from other countries
get 403 with no JSON body. The display tag paths under /dea/url/ accept
requests from any country.
Products
| Product | Path prefix | Auth headers | Key | Reference |
|---|---|---|---|---|
| UGC API | /v1/ugc | X-API-Key | UGC API key | POST /v1/ugc/process |
| AI API | /v1/ai | X-API-Key or Authorization: Bearer <key> | AI API key | POST /v1/ai/process |
| Publisher insights | /v1/publisher/insights | X-API-Key or Authorization: Bearer <key> | AI API key, or reporting key | GET /v1/publisher/insights |
| Ads API | /v1/ad-manager | X-API-Key or Authorization: Bearer <key> | Organization key or advertiser key | Ads API |
| Tracking URLs | /dea | None | None | Tracking URLs and tag traffic |
When a request carries both X-API-Key and Authorization, Adzen uses
X-API-Key. A key works only on the products listed for it. See
Authentication for key types, rotation and auth
errors.
https://api.adzen.ai/v1/ugc/process
https://api.adzen.ai/v1/ai/process
https://api.adzen.ai/v1/publisher/insights
https://api.adzen.ai/v1/ad-manager/campaignsUGC API
Match an ad to a community post with
POST /v1/ugc/process. The response carries an
impression pixel and a click URL that your client fires. See
Tracking URLs.
AI API
Match an ad to an assistant message with
POST /v1/ai/process. Each matched ad carries a click
URL and two impression beacons that your client fires. See
Tracking URLs.
Publisher insights
Read your impressions, clicks and estimated earnings on AI Surfaces, the web
or UGC with GET /v1/publisher/insights. AI
publishers use the same key as the AI API. Web publishers and UGC partners use
a read-only reporting key.
Ads API
Manage ad accounts, campaigns, ad sets, ads and conversions, and read insights,
for every advertiser you represent under /v1/ad-manager. Start at
Ads API.
Health endpoints
| Endpoint | Key | Response |
|---|---|---|
GET https://api.adzen.ai/v1/ugc/health | None | 200, text/plain body ok |
GET https://api.adzen.ai/v1/ai/health | None | 200, text/plain body ok |
If a health check returns 200 and a keyed request returns 401, the key was
rejected.
Response formats
| Endpoint type | Response |
|---|---|
Partner endpoints (/v1/ugc, /v1/ai, /v1/publisher/insights, /v1/ad-manager) | JSON request and response bodies. Error bodies differ by product; see Errors. |
| Impression beacons | 204 with an empty body |
| Click URLs | 302 to the advertiser’s landing page |
Limits and testing
- Rate limits: limits and retry rules for each product.
- Sandbox: test a UGC API integration against fictional ads.
- Tracking URLs and tag traffic: the impression and click URLs your client fires, and the traffic the Adzen tag sends from publisher pages.