Skip to main content
POST

Authorizations

X-Api-Key
string
header
required

API key with format vbr_ followed by 32 characters

Path Parameters

id
string<uuid>
required

Job ID returned from job creation

Body

application/json
format
enum<string>
default:mp4

Output video format

Available options:
mp4
model
enum<string>
default:videobgremover-original

AI model for background removal:

  • videobgremover-original: High-quality background removal. Best for detailed segmentation and complex scenes.
  • videobgremover-light: Fast and efficient background removal. Optimized for speed while maintaining good quality.
  • videobgremover-pro: Advanced background removal for complex objects. Enables text prompting for precise segmentation.
  • videobgremover-human: Fast matting algorithm optimized for portraits and facing people.
Available options:
videobgremover-original,
videobgremover-light,
videobgremover-pro,
videobgremover-human
prompt
object
background
object
webhook_url
string<uri>

Webhook URL to notify when job completes or fails. Must use HTTPS in production.

Response

Processing started successfully

id
string<uuid>

Job identifier

export_id
string<uuid>

Export identifier (when background is specified)

status
enum<string>

Processing status

Available options:
processing
created_at
string<date-time>

Processing start time

creditsUsed
number

Credits deducted for this job

video_length_seconds
number

Video duration in seconds

background
object