curl --request POST \
--url https://api.videobgremover.com/v1/jobs \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"filename": "my-video.mp4",
"content_type": "video/mp4"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "created",
"filename": "<string>",
"content_type": "<string>",
"upload_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"instructions": {
"method": "PUT",
"headers": {
"Content-Type": "<string>"
},
"note": "<string>"
}
}Create a new video processing job
Create a VideoBGRemover API job by uploading a video or providing a public video URL. Get a job ID and prepare the video for background removal.
POST
/
v1
/
jobs
curl --request POST \
--url https://api.videobgremover.com/v1/jobs \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"filename": "my-video.mp4",
"content_type": "video/mp4"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "created",
"filename": "<string>",
"content_type": "<string>",
"upload_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"instructions": {
"method": "PUT",
"headers": {
"Content-Type": "<string>"
},
"note": "<string>"
}
}Authorizations
API key with format vbr_ followed by 32 characters
Body
application/json
Response
Job created successfully
- Option 1
- Option 2
Unique job identifier
Job status
Available options:
created Original filename
File content type
Signed URL for uploading the video file
Upload URL expiration time
Job creation timestamp
Show child attributes
Show child attributes
