Skip to main content

WHIP

WHIP publishes WebRTC media into a room (OBS, ffmpeg, a browser). whip.create builds a publish URL and token locally, with no network call. POST your SDP offer to the URL with Authorization: <token>; the server returns the SDP answer.

const ingress = client.whip.create(roomId, { name: "Studio Camera" });
ingress.url;
ingress.token;

await client.whip.delete(ingress);

Options: participantId, name, expiresIn (default 1h), useExistingPeer.

note

The token is API-scoped and sensitive. Keep the expiry short and don't log it.

Got a Question? Ask us on discord