Skip to main content

TypeScript SDK Quickstart

This guide walks you through creating a stream with all parameters configured upfront.

Prerequisites

Create a Stream

Create a stream with your model, prompt, ControlNets, and IP Adapter all configured:
The response includes:
  • id - Unique stream identifier
  • whipUrl - URL to send video via WebRTC WHIP
  • outputPlaybackId - ID to watch the processed output

Start Broadcasting

Use the whipUrl with the Browser SDK to send video.

Update Prompt

Change the prompt in real-time without reloading the pipeline:
Hot-swappable parameters (no reload): prompt, negativePrompt, guidanceScale, seed, delta, controlnets[].conditioningScale, ipAdapter.scale

Get Stream Status

List All Streams

Delete a Stream

Available ControlNets

SDXL (stabilityai/sdxl-turbo):
  • xinsir/controlnet-depth-sdxl-1.0 - Depth guidance
  • xinsir/controlnet-canny-sdxl-1.0 - Edge detection
  • xinsir/controlnet-tile-sdxl-1.0 - Texture preservation
SD1.5 (Lykon/dreamshaper-8, prompthero/openjourney-v4):
  • lllyasviel/control_v11f1p_sd15_depth - Depth
  • lllyasviel/control_v11p_sd15_canny - Canny edges
  • lllyasviel/control_v11f1e_sd15_tile - Tile

Next Steps