API Reference
Endpoint reference
These are the canonical public API v1 routes. Script Tag and the advanced SDK are wrappers around this surface.
| Endpoint | Authentication | Purpose |
|---|---|---|
| POST /v1/browser/activate | No Authorization header; publishable key in JSON body with allowed Origin | Exchanges a publishable key and origin for a short-lived browser activation token. |
| POST /v1/placements | Secret key or browser activation token | Creates one job, waits for the first slot decision, and returns the canonical placement response. |
| POST /v1/jobs | Secret key, or activation token for browser flows | Advanced compatibility route that creates a sponsorship job and returns one or more slot IDs. |
| GET /v1/decisions/{slot_id} | Secret key or browser activation token | Polls a slot for the selected sponsored asset and render metadata. |
| GET /v1/render.js | No authorization header | Returns the browser renderer that mounts hosted placement frames and manages turn lifecycle. |
| GET /v1/render/{asset_token} | Asset token in the path | Returns isolated creative HTML for a single asset token. |
| POST /v1/beacons | Secret key or browser activation token plus the issued asset_token | Records render, visible, click, completion, or heartbeat events for billing and proof integrity. |
| POST /v1/consent | Secret key, or activation token for browser flows | Stores publisher consent state for Script Tag and custom consent flows. |
| GET /v1/projects/{client_id}/config | Secret key or browser activation token | Returns non-secret runtime configuration for a project. |
Open an endpoint for its request fields, response examples, errors, and integration notes.
Need help with your integration?
Share the affected endpoint, request ID, and the behavior you expected. Leave out keys and user content.