Skip to main content
POST
/
v1
/
jobs
/
{id}
/
start
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",
"status": "processing",
"created_at": "2023-11-07T05:31:56Z",
"creditsUsed": 123,
"video_length_seconds": 123,
"background": {
"type": "color",
"color": "#FF0000",
"transparent_format": "webm_vp9",
"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
}
}
}

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.
Available options:
videobgremover-original,
videobgremover-light
background
object
webhook_url
string<uri>

Webhook URL to notify when job completes or fails

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