Quick Start Guide | Remove Video Background in 5 Minutes

npm install @videobgremover/sdk

yarn add @videobgremover/sdk

pnpm add @videobgremover/sdk

pip install videobgremover

poetry add videobgremover

pipenv install videobgremover

brew install ffmpeg

sudo apt install ffmpeg

# Download from https://ffmpeg.org/download.html
# Add to PATH environment variable

// Perfect for: Node.js apps, TypeScript projects

import { VideoBGRemoverClient, Video } from '@videobgremover/sdk'

const client = new VideoBGRemoverClient('vbr_your_api_key')
const video = Video.open('https://example.com/video.mp4')

// Remove background (handles everything automatically)
const transparent = await video.removeBackground(client)

console.log('Background removed! Format:', transparent.getFormat())

# Perfect for: Python apps, data science, automation

from videobgremover import VideoBGRemoverClient, Video

client = VideoBGRemoverClient('vbr_your_api_key')
video = Video.open('https://example.com/video.mp4')

# Remove background (handles everything automatically)
transparent = video.remove_background(client)

print(f'Background removed! Format: {transparent.format}')

# Perfect for: Simple scripts, webhooks, any language

# 1. Create job from URL
JOB_RESPONSE=$(curl -s -X POST https://api.videobgremover.com/v1/jobs \
  -H "X-Api-Key: vbr_your_api_key" \
  -d '{"video_url": "https://example.com/video.mp4"}')

JOB_ID=$(echo $JOB_RESPONSE | jq -r '.id')

# 2. Start processing
curl -X POST https://api.videobgremover.com/v1/jobs/$JOB_ID/start \
  -H "X-Api-Key: vbr_your_api_key" \
  -d '{"background": {"type": "transparent", "transparent_format": "webm_vp9"}}'

# 3. Check status
curl -X GET https://api.videobgremover.com/v1/jobs/$JOB_ID/status \
  -H "X-Api-Key: vbr_your_api_key"

import {
  Background,
  Composition,
  EncoderProfile,
  Anchor,
  SizeMode
} from '@videobgremover/sdk'

// 1. Create custom background
const background = Background.fromColor('#FF0000', 1920, 1080, 30)

// 2. Create composition
const composition = new Composition(background)

// 3. Add your transparent video
composition.add(transparent, 'main_video')
  .at(Anchor.CENTER)
  .size(SizeMode.CONTAIN)

// 4. Export final video (local FFmpeg processing)
await composition.toFile('final.mp4', EncoderProfile.h264())

console.log('✅ Composition created: final.mp4')

from videobgremover import (
    Background,
    Composition,
    EncoderProfile,
    Anchor,
    SizeMode
)

# 1. Create custom background
background = Background.from_color('#FF0000', 1920, 1080, 30)

# 2. Create composition
composition = Composition(background)

# 3. Add your transparent video
composition.add(transparent, 'main_video') \
    .at(Anchor.CENTER) \
    .size(SizeMode.CONTAIN)

# 4. Export final video (local FFmpeg processing)
composition.to_file('final.mp4', EncoderProfile.h264())

print('✅ Composition created: final.mp4')

import {
  VideoBGRemoverClient,
  Video,
  Background,
  Composition,
  EncoderProfile,
  Anchor,
  SizeMode
} from '@videobgremover/sdk'

async function completeWorkflow() {
  // 1. Remove background (API call - uses credits)
  const client = new VideoBGRemoverClient('vbr_your_api_key')
  const video = Video.open('https://example.com/person.mp4')
  const transparent = await video.removeBackground(client)

  // 2. Create composition (local FFmpeg - no credits)
  const background = Background.fromImage('office.jpg', 30)
  const comp = new Composition(background)

  // 3. Position and layer
  comp.add(transparent, 'person')
    .at(Anchor.CENTER)
    .size(SizeMode.CONTAIN)
    .opacity(0.95)

  // 4. Export final video
  await comp.toFile('person_in_office.mp4', EncoderProfile.h264())

  console.log('✅ Complete! Person now appears in office background.')
}

completeWorkflow()

from videobgremover import (
    VideoBGRemoverClient, Video, Background, Composition,
    EncoderProfile, Anchor, SizeMode
)

def complete_workflow():
    # 1. Remove background (API call - uses credits)
    client = VideoBGRemoverClient('vbr_your_api_key')
    video = Video.open('https://example.com/person.mp4')
    transparent = video.remove_background(client)

    # 2. Create composition (local FFmpeg - no credits)
    background = Background.from_image('office.jpg', fps=30)
    comp = Composition(background)

    # 3. Position and layer
    comp.add(transparent, 'person') \
        .at(Anchor.CENTER) \
        .size(SizeMode.CONTAIN) \
        .opacity(0.95)

    # 4. Export final video
    comp.to_file('person_in_office.mp4', EncoderProfile.h264())

    print('✅ Complete! Person now appears in office background.')

complete_workflow()