v50

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-2810050281.4 KB

Videos

Get Status of Ingest Jobs

Get the status of all ingest jobs associated with a video (including the original ingestion, replacing and retranscoding the video). NOTE: this operation only works for videos that were ingested using Dynamic Delivery profiles.

Possible states of jobs are:

processing processing is underway, but no playable renditions have been created yet
publishing at least one playable rendition has been created and is being published
published at least one rendition is available for playback
finished processing is complete
failed processing failed - if you cannot figure what went wrong, contact Support

get/v1/accounts/{{account_id}}/videos/{{video_id}}/ingest_jobs

Path parameters

account_idstring required

Video Cloud account ID.

video_idstring required

Video ID.

For example:

https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/9827342837937

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Response

200

account_idstring

the Video Cloud account id

error_codestring

the error code if the job failed

error_messagestring

the error message if the job failed

idstring

the ingest job id returned when you submit the Dynamic Ingest API request

prioritystring

priority of the job (normal or low)

started_atstring

when processing started

state'processing' | 'publishing' | 'published' | 'finished' | 'failed'

the current state of the ingest job - status:

processing - video processing in progress - the video is not currently playable
publishing - video processing in progress - publishing a playable rendition
published - that at least one playable rendition is available for the video
finished - that all processing is complete
failed - video processing failed to complete

submitted_atstring

when the job was submitted

updated_atstring

when the status was last updated

video_idstring

the video id

Example response

[
  {
    "error_code": "UnableToResolveHostError",
    "error_message": "There was a problem resolving the host at https://some.site.comm/videos/mp4/IMG_0544.MOV. Please check that it is correct.",
    "id": "879a3301-5c1a-4b1b-a368-58e200a6e64b",
    "priority": "normal",
    "started_at": "2018-11-14T19:30:36.265Z",
    "state": "failed",
    "submitted_at": "2018-11-14T19:30:36.196Z",
    "updated_at": "2018-11-14T19:43:08.641Z"
  }
]