API DOCS

API reference

Build with the wavebird Server API first. Script Tag and SDK remain available for specific setups.

BASE URL

https://api.wavebird.ai

VERSION

v1

STATUS

Stable

Quickstart Get API keys Markdown for LLMs ↓

RELATEDAPI stability Script Tag SDK Migration guide

Core endpoints

These routes cover activation, placements, advanced job creation, decisions, hosted rendering, beacons, consent, and project configuration.

METHODENDPOINTDESCRIPTION

POST/v1/browser/activateExchanges a publishable key and origin for a short-lived browser activation token.POST/v1/placementsCreates one job, waits for the first slot decision, and returns the canonical placement response.POST/v1/jobsAdvanced compatibility route that creates a sponsorship job and returns one or more slot IDs.GET/v1/decisions/{slot_id}Polls a slot for the selected sponsored asset and render metadata.GET/v1/render.jsReturns the browser renderer that mounts hosted placement frames and manages turn lifecycle.GET/v1/render/{asset_token}Returns isolated creative HTML for a single asset token.POST/v1/beaconsRecords render, visible, click, completion, or heartbeat events for billing and proof integrity.POST/v1/consentStores publisher consent state for Script Tag and custom consent flows.GET/v1/projects/{client_id}/configReturns non-secret runtime configuration for a project.

Choose an integration path

Server APIRECOMMENDEDRecommended path for production apps that already own request flow.Script TagBrowser path for teams that want automatic rendering and beacon wiring.Advanced SDKCompatibility wrapper for TypeScript teams that explicitly need a package.

Public package and source

Build against the public wavebird package and repository.

NPMwavebird GITHUBwavebird-ai/wavebird

Need rollout review?

Start with the Server API. Use contact only when you need rollout review, enterprise coordination, or non-standard integration help.

Contact the team

Next

Quickstart