Getting started
Integration paths
Start with the Dashboard package guide for your runtime. All paths connect to the wavebird API, but their setup and lifecycle hooks are not interchangeable.
JavaScript and TypeScript
Install @wavebirdai/api 0.1.0-beta.19. Both languages use the same package. Choose your language in Overview and copy its complete files. The generated route and component target Next.js App Router.
Connect existing server authentication, durable atomic turn storage, model streaming, presentation and cancellation. The browser adapter loads the official renderer. Banner, Native and Clip use the same integration and project-controlled format selection.
Python and FastAPI
Use Python 3.11 or newer with the wavebird-publisher-server 0.1.0b9 wheel and its FastAPI example. Install the exact wheel linked from Dashboard's Python guide. It is a separate distribution, not an npm package.
The generated guide sets responsive_size_selection to true. Direct PublisherConfig construction defaults it to false, gdpr_applies to false and api_base_url to https://api.wavebird.ai. Width and height caps derive from allowed_sizes when omitted. Copy your saved project values instead of assuming JavaScript defaults.
Connect the example's authentication, session-resolution and model-generation hooks. Keep server credentials in ENV. Persist WAVEBIRD_TURN_JOURNAL_PATH on durable local storage shared by workers on one host. Do not place this SQLite store on an ephemeral or multi-host/serverless filesystem.
Serve the package's browser module with its documented FastAPI route and use the official renderer. Connect output presentation and Stop as shown in the example. Verify each selected format and timing separately. Package availability does not establish platform parity or Live approval.
Direct REST for other runtimes
Use direct REST when your backend does not support the package runtime. WordPress JavaScript and Supabase TypeScript can keep their existing app flow, but generated Next.js route files are not Edge Functions.
Keep the key in the backend ad function. Send only permitted context, synchronize actual consent and pass a filled response to the hosted renderer. Your adapter owns the session, turn lifecycle, cancellation and error handling.
Browser-only Script Tag
Choose this path for a browser-managed slot. It uses a Browser Publishable Key, exact origins and browser activation. Follow its own consent and lifecycle contract. It is not a drop-in replacement for the server package.
Existing Advanced SDK
The older wavebird npm SDK is separate from @wavebirdai/api. Keep it only when your integration uses its jobs and decision methods. Existing .4 integrations remain pinned until explicitly upgraded.
Android and iOS
There is no qualified public native mobile package in this guide. Web and Python examples do not establish native-device support.
Need help with your integration?
Share the affected endpoint, request ID, and the behavior you expected. Leave out keys and user content.