Advanced SDK

The older wavebird SDK exposes jobs, decisions and rendering helpers. It is separate from the @wavebirdai/api publisher package.

For a new app, start with the package quickstart. Keep this SDK path when an existing integration relies on its job and decision methods.

Publisher package quickstart →Upgrade checklist →

SDK example

SDK client

sdk.ts

typescript

TypeScript
import { WavebirdClient } from "wavebird";const client = new WavebirdClient({  baseUrl: "https://api.wavebird.ai",  getApiKey: () => process.env.WAVEBIRD_SECRET_KEY ?? "",});const job = await client.createJob({  client_id: process.env.WAVEBIRD_CLIENT_ID,  job_type: "chat",  slots_requested: 1,});

When the SDK still makes sense

Typed client ergonomics

Helpful when your team wants a typed client wrapper around jobs, decisions, and beacons.

React rendering helpers

Useful if you specifically want component-level rendering helpers on top of the public API flow.

Compatibility path

Useful when you are migrating an existing SDK-based integration but want the docs and contracts to stay API-first.

Install the older SDK

For the older wavebird SDK described in this section, use npm install wavebird. The separate publisher @wavebirdai/api package has its versioned npm and legacy GitHub install commands in the API Quickstart.

Open full SDK docs →Open publisher package Quickstart →

Need help with your integration?

Share the affected endpoint, request ID, and the behavior you expected. Leave out keys and user content.

Contact the team