API
API documentation
Keep your own model and application. Start with the package for your runtime, connect the app hooks and let wavebird handle ad delivery.
BASE URL
https://api.wavebird.ai
VERSION
v1
Choose your integration
JavaScript / TypeScriptUse @wavebirdai/api 0.1.0-beta.19 with the project-specific Dashboard files. Both languages share the same package.Python / FastAPIUse the separate 0.1.0b9 wheel, FastAPI hooks and official browser renderer.Other server runtimesUse REST from your backend when the package runtime does not fit. Keep secret keys on the server.Browser-only Script TagUse the publishable-key path for a browser-managed slot. Follow its separate origin and consent setup.
Existing integrations
Keep the installed package pinned until you choose an upgrade. Package availability, supported formats and Live approval are separate.
Verify and enable Live
Confirm real consent, visible ads, cancellation and No-Fill. Complete the project's separate legal, payout and Live requirements in Dashboard.
REST reference
The public base URL is https://api.wavebird.ai. REST v1 is the shared protocol behind the integration paths.
MethodEndpointPurpose
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.Need help with your integration?
Share the affected endpoint, request ID, and the behavior you expected. Leave out keys and user content.