Brightcove Live API (2.0.0)

Download OpenAPI specification:Download

API for interacting with the Brightcove Live platform

jobs

List all jobs in an account

Authorizations:

BC_OAuth2

path Parameters

account_id

required

string

Account ID

query Parameters

regions	Array of strings regions to query
modified_at	string modified_at filter - format :
created_at	string created_at filter - format :
processing_state	string filter by processing state
ingest_state	string filter by ingest state
type	string filter by type

Responses

Response samples

200
404
500

Content type

application/json

{"jobs": [{"created_at": "string",
"description": "string",
"id": "string",
"ingest_points": [{"url": "string"
}
],
"labels": ["string"
],
"last_updated": "string",
"name": "string",
"protocol": "string",
"region": "string",
"state": {"ingest_state": "connected",
"processing_state": "configuring"
},
"type": "string"
}
]
}

Configure a new job

Authorizations:

BC_OAuth2

path Parameters

account_id

required

string

Account ID

Request Body schema: application/json
required

Job Config

audio_only	boolean
	object
description	string
required	object (external.Input)
live_to_vod	boolean
long_description	string
	object (external.MaintenancePreferences)
	object (external.ManifestOptions)
name	string
	Array of objects (external.Notification)
required	object (external.OutputVariants)
	object (external.RedundancyOptions)
reference_id	string
region required	string
	object (external.SSAI)
tags	Array of strings
type required	string Enum: "channel" "event"

Responses

Request samples

Payload

Content type

application/json

{"audio_only": true,
"custom_fields": {"property1": "string",
"property2": "string"
},
"description": "string",
"input": {"audio_pids": [{"language_code": "string",
"name": "string",
"pid": 0
}
],
"fixed_ingest_ip": true,
"input_loss_behaviour": {"fill_type": "black_screen"
},
"protocol": "rtp",
"srt_options": {"ingest_port": 0,
"min_latency": 0
},
"whitelist_cidr_blocks": ["string"
]
},
"live_to_vod": true,
"long_description": "string",
"maintenance_preferences": {"day": "string",
"start_time": "string"
},
"manifest": {"dash": { },
"dvr": {"playlist_window_seconds": 0
},
"hls": {"playlist_type": "string"
},
"include_iframe_only_stream": true,
"low_latency": { },
"name": "string",
"playlist_groups": [{"audio_bitrate": {"max": 2147483647,
"min": 0
},
"audio_codec": ["aac"
],
"language_code": ["string"
],
"name": "string",
"video_bitrate": {"max": 2147483647,
"min": 0
},
"video_codec": ["h264"
],
"video_height": {"max": 2160,
"min": 1
}
}
],
"playlist_window_seconds": 0,
"segment_container_format": "cmaf",
"segment_duration_seconds": 1
},
"name": "string",
"notifications": [{"subscription_type": "state_change",
"url": "string"
}
],
"outputs": {"audio": [{"bitrate": 0,
"codec": "aac",
"input_selector_name": "string",
"label": "string",
"language_code": "string",
"sample_rate": 0
}
],
"caption": [{"passthrough": true,
"type": "embedded_closed_caption"
}
],
"rtmp": [{"audio_label": "string",
"label": "string",
"url": "string",
"video_label": "string"
}
],
"video": [{"bitrate": 0,
"codec": "h264",
"codec_options": {"level": "3",
"profile": "baseline"
},
"decoder_buffer_size": 0,
"embed_timecode": true,
"framerate": "string",
"height": 0,
"keyframe_rate": 0,
"keyframe_rate_units": "string",
"label": "string",
"max_bitrate": 0,
"num_b_frames": 0,
"num_reference_frames": 0,
"rate_control_mode": "string",
"sample_aspect_ratio": "string",
"width": 0
}
]
},
"redundancy": {"num_inputs": 0
},
"reference_id": "string",
"region": "string",
"ssai": {"enabled": true
},
"tags": ["string"
],
"type": "channel"
}

Response samples

200
404
500

Content type

application/json

{"account_id": "string",
"audio_only": true,
"created_at": "string",
"id": "string",
"ingest_endpoints": [{"url": "string"
}
],
"input": {"audio_pids": [{"language_code": "string",
"name": "string",
"pid": 0
}
],
"fixed_ingest_ip": true,
"input_loss_behaviour": {"fill_type": "black_screen"
},
"protocol": "rtp",
"srt_options": {"ingest_port": 0,
"min_latency": 0
},
"whitelist_cidr_blocks": ["string"
]
},
"last_started_at": "string",
"live_to_vod": true,
"maintenance_preferences": {"day": "string",
"start_time": "string"
},
"manifest": {"dash": { },
"dvr": {"playlist_window_seconds": 0
},
"hls": {"playlist_type": "string"
},
"include_iframe_only_stream": true,
"low_latency": { },
"name": "string",
"playlist_groups": [{"audio_bitrate": {"max": 2147483647,
"min": 0
},
"audio_codec": ["aac"
],
"language_code": ["string"
],
"name": "string",
"video_bitrate": {"max": 2147483647,
"min": 0
},
"video_codec": ["h264"
],
"video_height": {"max": 2160,
"min": 1
}
}
],
"playlist_window_seconds": 0,
"segment_container_format": "cmaf",
"segment_duration_seconds": 1
},
"notifications": [{"subscription_type": "state_change",
"url": "string"
}
],
"outputs": {"audio": [{"bitrate": 0,
"codec": "aac",
"input_selector_name": "string",
"label": "string",
"language_code": "string",
"sample_rate": 0
}
],
"caption": [{"passthrough": true,
"type": "embedded_closed_caption"
}
],
"rtmp": [{"audio_label": "string",
"label": "string",
"url": "string",
"video_label": "string"
}
],
"video": [{"bitrate": 0,
"codec": "h264",
"codec_options": {"level": "3",
"profile": "baseline"
},
"decoder_buffer_size": 0,
"embed_timecode": true,
"framerate": "string",
"height": 0,
"keyframe_rate": 0,
"keyframe_rate_units": "string",
"label": "string",
"max_bitrate": 0,
"num_b_frames": 0,
"num_reference_frames": 0,
"rate_control_mode": "string",
"sample_aspect_ratio": "string",
"width": 0
}
]
},
"redundancy": {"num_inputs": 0
},
"region": "string",
"ssai": {"enabled": true
},
"state": {"ingest_state": "connected",
"processing_state": "configuring"
},
"type": "channel"
}

Finish a job

Authorizations:

BC_OAuth2

path Parameters

id required	string Job ID
account_id required	string Job ID

Responses

Response samples

200
404
500

Content type

application/json

{"id": "string"
}

Get a job

Authorizations:

BC_OAuth2

path Parameters

id required	string Job ID
account_id required	string Account ID

Responses

Response samples

200
404
500

Content type

application/json

{"account_id": "string",
"audio_only": true,
"created_at": "string",
"id": "string",
"ingest_endpoints": [{"url": "string"
}
],
"input": {"audio_pids": [{"language_code": "string",
"name": "string",
"pid": 0
}
],
"fixed_ingest_ip": true,
"input_loss_behaviour": {"fill_type": "black_screen"
},
"protocol": "rtp",
"srt_options": {"ingest_port": 0,
"min_latency": 0
},
"whitelist_cidr_blocks": ["string"
]
},
"last_started_at": "string",
"live_to_vod": true,
"maintenance_preferences": {"day": "string",
"start_time": "string"
},
"manifest": {"dash": { },
"dvr": {"playlist_window_seconds": 0
},
"hls": {"playlist_type": "string"
},
"include_iframe_only_stream": true,
"low_latency": { },
"name": "string",
"playlist_groups": [{"audio_bitrate": {"max": 2147483647,
"min": 0
},
"audio_codec": ["aac"
],
"language_code": ["string"
],
"name": "string",
"video_bitrate": {"max": 2147483647,
"min": 0
},
"video_codec": ["h264"
],
"video_height": {"max": 2160,
"min": 1
}
}
],
"playlist_window_seconds": 0,
"segment_container_format": "cmaf",
"segment_duration_seconds": 1
},
"notifications": [{"subscription_type": "state_change",
"url": "string"
}
],
"outputs": {"audio": [{"bitrate": 0,
"codec": "aac",
"input_selector_name": "string",
"label": "string",
"language_code": "string",
"sample_rate": 0
}
],
"caption": [{"passthrough": true,
"type": "embedded_closed_caption"
}
],
"rtmp": [{"audio_label": "string",
"label": "string",
"url": "string",
"video_label": "string"
}
],
"video": [{"bitrate": 0,
"codec": "h264",
"codec_options": {"level": "3",
"profile": "baseline"
},
"decoder_buffer_size": 0,
"embed_timecode": true,
"framerate": "string",
"height": 0,
"keyframe_rate": 0,
"keyframe_rate_units": "string",
"label": "string",
"max_bitrate": 0,
"num_b_frames": 0,
"num_reference_frames": 0,
"rate_control_mode": "string",
"sample_aspect_ratio": "string",
"width": 0
}
]
},
"redundancy": {"num_inputs": 0
},
"region": "string",
"ssai": {"enabled": true
},
"state": {"ingest_state": "connected",
"processing_state": "configuring"
},
"type": "channel"
}

Update a given job

Authorizations:

BC_OAuth2

path Parameters

id required	string Job ID
account_id required	string Account ID

Request Body schema: application/json
required

Job Config

audio_only	boolean
required	object (external.Input)
live_to_vod	boolean
	object (external.MaintenancePreferences)
	object (external.ManifestOptions)
	Array of objects (external.Notification)
required	object (external.OutputVariants)
	object (external.RedundancyOptions)
region required	string
	object (external.SSAI)
type required	string Enum: "channel" "event"

Responses

Request samples

Payload

Content type

application/json

{"audio_only": true,
"input": {"audio_pids": [{"language_code": "string",
"name": "string",
"pid": 0
}
],
"fixed_ingest_ip": true,
"input_loss_behaviour": {"fill_type": "black_screen"
},
"protocol": "rtp",
"srt_options": {"ingest_port": 0,
"min_latency": 0
},
"whitelist_cidr_blocks": ["string"
]
},
"live_to_vod": true,
"maintenance_preferences": {"day": "string",
"start_time": "string"
},
"manifest": {"dash": { },
"dvr": {"playlist_window_seconds": 0
},
"hls": {"playlist_type": "string"
},
"include_iframe_only_stream": true,
"low_latency": { },
"name": "string",
"playlist_groups": [{"audio_bitrate": {"max": 2147483647,
"min": 0
},
"audio_codec": ["aac"
],
"language_code": ["string"
],
"name": "string",
"video_bitrate": {"max": 2147483647,
"min": 0
},
"video_codec": ["h264"
],
"video_height": {"max": 2160,
"min": 1
}
}
],
"playlist_window_seconds": 0,
"segment_container_format": "cmaf",
"segment_duration_seconds": 1
},
"notifications": [{"subscription_type": "state_change",
"url": "string"
}
],
"outputs": {"audio": [{"bitrate": 0,
"codec": "aac",
"input_selector_name": "string",
"label": "string",
"language_code": "string",
"sample_rate": 0
}
],
"caption": [{"passthrough": true,
"type": "embedded_closed_caption"
}
],
"rtmp": [{"audio_label": "string",
"label": "string",
"url": "string",
"video_label": "string"
}
],
"video": [{"bitrate": 0,
"codec": "h264",
"codec_options": {"level": "3",
"profile": "baseline"
},
"decoder_buffer_size": 0,
"embed_timecode": true,
"framerate": "string",
"height": 0,
"keyframe_rate": 0,
"keyframe_rate_units": "string",
"label": "string",
"max_bitrate": 0,
"num_b_frames": 0,
"num_reference_frames": 0,
"rate_control_mode": "string",
"sample_aspect_ratio": "string",
"width": 0
}
]
},
"redundancy": {"num_inputs": 0
},
"region": "string",
"ssai": {"enabled": true
},
"type": "channel"
}

Response samples

200
404
500

Content type

application/json

{"old_config": {"audio_only": true,
"input": {"audio_pids": [{"language_code": "string",
"name": "string",
"pid": 0
}
],
"fixed_ingest_ip": true,
"input_loss_behaviour": {"fill_type": "black_screen"
},
"protocol": "rtp",
"srt_options": {"ingest_port": 0,
"min_latency": 0
},
"whitelist_cidr_blocks": ["string"
]
},
"live_to_vod": true,
"maintenance_preferences": {"day": "string",
"start_time": "string"
},
"manifest": {"dash": { },
"dvr": {"playlist_window_seconds": 0
},
"hls": {"playlist_type": "string"
},
"include_iframe_only_stream": true,
"low_latency": { },
"name": "string",
"playlist_groups": [{"audio_bitrate": {"max": 2147483647,
"min": 0
},
"audio_codec": ["aac"
],
"language_code": ["string"
],
"name": "string",
"video_bitrate": {"max": 2147483647,
"min": 0
},
"video_codec": ["h264"
],
"video_height": {"max": 2160,
"min": 1
}
}
],
"playlist_window_seconds": 0,
"segment_container_format": "cmaf",
"segment_duration_seconds": 1
},
"notifications": [{"subscription_type": "state_change",
"url": "string"
}
],
"outputs": {"audio": [{"bitrate": 0,
"codec": "aac",
"input_selector_name": "string",
"label": "string",
"language_code": "string",
"sample_rate": 0
}
],
"caption": [{"passthrough": true,
"type": "embedded_closed_caption"
}
],
"rtmp": [{"audio_label": "string",
"label": "string",
"url": "string",
"video_label": "string"
}
],
"video": [{"bitrate": 0,
"codec": "h264",
"codec_options": {"level": "3",
"profile": "baseline"
},
"decoder_buffer_size": 0,
"embed_timecode": true,
"framerate": "string",
"height": 0,
"keyframe_rate": 0,
"keyframe_rate_units": "string",
"label": "string",
"max_bitrate": 0,
"num_b_frames": 0,
"num_reference_frames": 0,
"rate_control_mode": "string",
"sample_aspect_ratio": "string",
"width": 0
}
]
},
"redundancy": {"num_inputs": 0
},
"region": "string",
"ssai": {"enabled": true
},
"type": "channel"
},
"updated_job": {"account_id": "string",
"audio_only": true,
"created_at": "string",
"custom_fields": {"property1": "string",
"property2": "string"
},
"description": "string",
"id": "string",
"ingest_endpoints": [{"url": "string"
}
],
"input": {"audio_pids": [{"language_code": "string",
"name": "string",
"pid": 0
}
],
"fixed_ingest_ip": true,
"input_loss_behaviour": {"fill_type": "black_screen"
},
"protocol": "rtp",
"srt_options": {"ingest_port": 0,
"min_latency": 0
},
"whitelist_cidr_blocks": ["string"
]
},
"labels": ["string"
],
"last_started_at": "string",
"live_to_vod": true,
"long_description": "string",
"maintenance_preferences": {"day": "string",
"start_time": "string"
},
"manifest": {"dash": { },
"dvr": {"playlist_window_seconds": 0
},
"hls": {"playlist_type": "string"
},
"include_iframe_only_stream": true,
"low_latency": { },
"name": "string",
"playlist_groups": [{"audio_bitrate": {"max": 2147483647,
"min": 0
},
"audio_codec": ["aac"
],
"language_code": ["string"
],
"name": "string",
"video_bitrate": {"max": 2147483647,
"min": 0
},
"video_codec": ["h264"
],
"video_height": {"max": 2160,
"min": 1
}
}
],
"playlist_window_seconds": 0,
"segment_container_format": "cmaf",
"segment_duration_seconds": 1
},
"name": "string",
"notifications": [{"subscription_type": "state_change",
"url": "string"
}
],
"outputs": {"audio": [{"bitrate": 0,
"codec": "aac",
"input_selector_name": "string",
"label": "string",
"language_code": "string",
"sample_rate": 0
}
],
"caption": [{"passthrough": true,
"type": "embedded_closed_caption"
}
],
"rtmp": [{"audio_label": "string",
"label": "string",
"url": "string",
"video_label": "string"
}
],
"video": [{"bitrate": 0,
"codec": "h264",
"codec_options": {"level": "3",
"profile": "baseline"
},
"decoder_buffer_size": 0,
"embed_timecode": true,
"framerate": "string",
"height": 0,
"keyframe_rate": 0,
"keyframe_rate_units": "string",
"label": "string",
"max_bitrate": 0,
"num_b_frames": 0,
"num_reference_frames": 0,
"rate_control_mode": "string",
"sample_aspect_ratio": "string",
"width": 0
}
]
},
"playback_rights_id": "string",
"redundancy": {"num_inputs": 0
},
"reference_id": "string",
"region": "string",
"ssai": {"enabled": true
},
"state": {"ingest_state": "connected",
"processing_state": "configuring"
},
"tags": ["string"
],
"type": "channel"
}
}

Clip a given job

Authorizations:

BC_OAuth2

path Parameters

id required	string Job ID
account_id required	string Account ID

Request Body schema: application/json
required

Clip Config

description	string
end	string
name	string
reference_id	string
remove_ads	boolean
start	string
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"end": "string",
"name": "string",
"reference_id": "string",
"remove_ads": true,
"start": "string",
"tags": ["string"
]
}

Response samples

200
404
500

Content type

application/json

{"id": "string"
}

Start a given job

Authorizations:

BC_OAuth2

path Parameters

id required	string Job ID
account_id required	string Account ID

Responses

Response samples

200
404
500

Content type

application/json

{"id": "string"
}

Stop a job

Authorizations:

BC_OAuth2

path Parameters

id required	string Job ID
account_id required	string Account ID

Responses

Response samples

200
404
500

Content type

application/json

{"id": "string"
}

Get thumnail images from a processing job

Authorizations:

BC_OAuth2

path Parameters

id required	string Job ID
account_id required	string Account ID

Responses

Response samples

200
404
500

Content type

application/json

{"thumbnail_detail": {"pipeline_id": "string",
"thumbnails": [{"body": "string",
"content_type": "string",
"thumbnail_type": "string",
"timestamp": "string"
}
]
}
}

List notifications for a job

Authorizations:

BC_OAuth2

path Parameters

account_id required	string Account ID
job_id required	string Job ID

Responses

Response samples

200
404
500

Content type

application/json

{"last_key": "string",
"notifications": [{"code": "string",
"message": "string",
"resource_id": "string",
"resource_type": "string",
"timestamp": 0,
"type": "string"
}
]
}

List notifications for an account

Authorizations:

BC_OAuth2

path Parameters

account_id

required

string

Account ID

Responses

Response samples

200
404
500

Content type

application/json

{"last_key": "string",
"notifications": [{"code": "string",
"message": "string",
"resource_id": "string",
"resource_type": "string",
"timestamp": 0,
"type": "string"
}
]
}

metricsapi

Get Job metrics

Authorizations:

BC_OAuth2

path Parameters

account_id required	string Account ID
job_id required	string Job ID

query Parameters

name required	string comma separated metric names to query
period	string period filter in seconds (ex: 30s, 60s)
range	string range filter in hours (ex: 1h, 3h)

Responses

Response samples

200
404
500

Content type

application/json

{"data": {"result": [{"dimension": {"inputSource": "string"
},
"metric": {"category": "string",
"label": "string",
"name": "string",
"statistic": "string",
"unit": "string"
},
"values": [[null
]
]
}
]
},
"endTime": 0,
"isPartial": true,
"startTime": 0,
"status": "string"
}

Get all supported metrics

Authorizations:

BC_OAuth2

path Parameters

account_id required	string Account ID
job_id required	string Job ID

Responses

Response samples

200
404
500

Content type

application/json

{"metrics": [{"category": "string",
"label": "string",
"name": "string",
"statistics": ["string"
],
"unit": "string"
}
]
}

playback

Create a playback token for a job

Authorizations:

BC_OAuth2

path Parameters

account_id required	string Account ID
id required	string Job ID

Request Body schema: application/json
required

Token Config

dvr	boolean
end_time	string
low_latency	boolean
manifest_format	string
playlist_name	string
start_time	string

Responses

Request samples

Payload

Content type

application/json

{"dvr": true,
"end_time": "string",
"low_latency": true,
"manifest_format": "string",
"playlist_name": "string",
"start_time": "string"
}

Response samples

200
404
500

Content type

application/json

{"token": "string"
}

Generate sources for a job

path Parameters

account_id required	string Account ID
job_id required	string Job ID

Responses

Response samples

200
404
500

Content type

application/json

[{"property1": null,
"property2": null
}
]

Generate a playback url for a job

path Parameters

account_id required	string Account ID
id required	string Job ID

query Parameters

pt

required

string

Playback Token

Responses

Response samples

200
404
500

Content type

application/json

{"url": "string"
}

session

Get a session from a session id

Authorizations:

BC_OAuth2

path Parameters

account_id required	string Account ID
id required	string Session ID

Responses

Response samples

200
404
500

Content type

application/json

{"account_id": "string",
"end_time": 0,
"id": "string",
"resource_id": "string",
"start_time": 0
}

Get events from a session

Authorizations:

BC_OAuth2

path Parameters

account_id required	string Account ID
id required	string Session ID

Responses

Response samples

200
404
500

Content type

application/json

[{"event_type": "string",
"id": "string",
"session_id": "string",
"timestamp": 0
}
]

Get sessions for a resource

Authorizations:

BC_OAuth2

path Parameters

account_id required	string Account ID
id required	string Resource ID

Responses

Response samples

200
404
500

Content type

application/json

{"sessions": [{"account_id": "string",
"end_time": 0,
"id": "string",
"resource_id": "string",
"start_time": 0
}
]
}

misc

Healthcheck

Responses

Response samples

200

Content type

application/json

{"build_version": "string",
"git_sha": "string"
}

Brightcove Live API (2.0.0)

jobs

List all jobs in an account

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Configure a new job

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Finish a job

Authorizations:

path Parameters

Responses

Response samples

Get a job

Authorizations:

path Parameters

Responses

Response samples

Update a given job

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Clip a given job

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Start a given job

Authorizations:

path Parameters

Responses

Response samples

Stop a job

Authorizations:

path Parameters

Responses

Response samples

Get thumnail images from a processing job

Authorizations:

path Parameters

Responses

Response samples

List notifications for a job

Authorizations:

path Parameters

Responses

Response samples

List notifications for an account

Authorizations:

path Parameters

Responses

Response samples

metricsapi

Get Job metrics

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get all supported metrics

Authorizations:

path Parameters

Responses

Response samples

playback

Create a playback token for a job

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required