GET
/
v1
/
jobs
/
{id}
/
status
Check job processing status
curl --request GET \
  --url https://api.videobgremover.com/v1/jobs/{id}/status \
  --header 'X-Api-Key: <api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "created",
  "filename": "my-video.mp4",
  "created_at": "2023-12-01T10:00:00Z",
  "length_seconds": null,
  "thumbnail_url": null,
  "transparent_thumbnail_url": null,
  "processed_video_url": null,
  "processed_mask_url": null,
  "message": null,
  "background": null,
  "output_format": null,
  "export_id": null
}

Authorizations

​
X-Api-Key
string
header
required

API key with format vbr_ followed by 32 characters

Path Parameters

​
id
string<uuid>
required

Job ID to check status for

Response

Job status retrieved successfully

​
id
string<uuid>
required

Job identifier

​
status
enum<string>
required

Current job status

Available options:
created,
uploaded,
processing,
completed,
failed
​
filename
string
required

Original filename

​
created_at
string<date-time>
required

Job creation time

​
export_id
string<uuid> | null

Export identifier (only present for API calls with background)

​
length_seconds
number | null

Video duration in seconds

​
thumbnail_url
string<uri> | null

Signed URL for video thumbnail

​
transparent_thumbnail_url
string<uri> | null

Signed URL for transparent thumbnail

​
processed_video_url
string<uri> | null

Signed URL for processed video (when completed)

​
processed_mask_url
string<uri> | null

Signed URL for video mask (when completed)

​
message
string | null

Status message

​
background
object

Background options (only present for API calls with background)

​
output_format
string | null

Output file format (only present for API calls with background)