curl --request POST \
--url https://api.videobgremover.com/v1/jobs/{id}/start \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"format": "mp4"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"export_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_exports": 123,
"exports": [
{
"export_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"format": "<string>",
"status": "queued",
"transform": {
"crop": {
"x": 1,
"y": 1,
"width": 2,
"height": 2
},
"max_width": 480,
"fps": 15,
"reverse": false
}
}
],
"status": "processing",
"created_at": "2023-11-07T05:31:56Z",
"creditsUsed": 123,
"video_length_seconds": 123,
"background": {
"type": "color",
"color": "#FF0000",
"transparent_format": "webm_vp9",
"transform": {
"crop": {
"x": 1,
"y": 1,
"width": 2,
"height": 2
},
"max_width": 480,
"fps": 15,
"reverse": false
},
"options": {
"preset": "mobile",
"smart_sampling": true,
"threshold": 1.05
},
"lottie_options": {
"preset": "mobile",
"smart_sampling": true,
"threshold": 1.05
},
"composition": {
"template": "ai_ugc_ad",
"background_url": "https://example.com/background.mp4",
"background_type": "image",
"background_audio_enabled": false,
"background_audio_volume": 1,
"export_format": "h264",
"export_crf": 23
},
"blur_mode": "background",
"blur_intensity": 100,
"blur_type": "gaussian"
}
}Start processing a video job
Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.
curl --request POST \
--url https://api.videobgremover.com/v1/jobs/{id}/start \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"format": "mp4"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"export_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_exports": 123,
"exports": [
{
"export_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"format": "<string>",
"status": "queued",
"transform": {
"crop": {
"x": 1,
"y": 1,
"width": 2,
"height": 2
},
"max_width": 480,
"fps": 15,
"reverse": false
}
}
],
"status": "processing",
"created_at": "2023-11-07T05:31:56Z",
"creditsUsed": 123,
"video_length_seconds": 123,
"background": {
"type": "color",
"color": "#FF0000",
"transparent_format": "webm_vp9",
"transform": {
"crop": {
"x": 1,
"y": 1,
"width": 2,
"height": 2
},
"max_width": 480,
"fps": 15,
"reverse": false
},
"options": {
"preset": "mobile",
"smart_sampling": true,
"threshold": 1.05
},
"lottie_options": {
"preset": "mobile",
"smart_sampling": true,
"threshold": 1.05
},
"composition": {
"template": "ai_ugc_ad",
"background_url": "https://example.com/background.mp4",
"background_type": "image",
"background_audio_enabled": false,
"background_audio_volume": 1,
"export_format": "h264",
"export_crf": 23
},
"blur_mode": "background",
"blur_intensity": 100,
"blur_type": "gaussian"
}
}Authorizations
API key with format vbr_ followed by 32 characters
Path Parameters
Job ID returned from job creation
Body
Output video format
mp4 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.
videobgremover-original, videobgremover-light, videobgremover-pro, videobgremover-human Show child attributes
Show child attributes
Show child attributes
Show child attributes
Additional outputs rendered after the primary background output in the
same processing worker invocation. Each sizes value creates one output;
native preserves the source dimensions. Primary and additional outputs
that are identical are deduplicated. At most 50 unique outputs are allowed.
The primary background property is required when exports is provided.
Numeric sizes are not currently supported for pro_bundle,
stacked_video_mask_inverted, mask_video, mask_video_inverted, or
webp; use native for those formats.
1Show child attributes
Show child attributes
Webhook URL to notify when job completes or fails. Must use HTTPS in production.
Response
Processing started successfully
Job identifier
Export identifier (when background is specified)
Batch identifier when additional exports were requested
Number of unique primary and additional outputs in the batch
Queued outputs when additional exports were requested
Show child attributes
Show child attributes
Processing status
processing Processing start time
Credits deducted for this job
Video duration in seconds
Show child attributes
Show child attributes
