Brightcove
App · 25 actions
Connect Brightcove to automate video and audio workflows.
Actions
| Action | What it does |
|---|---|
| Create Playlist | Create Playlist. |
| Create Video | Create Video. |
| Delete Playlist | Delete Playlist. |
| Delete Video | Delete Video. |
| Get a Custom Field | Get a Custom Field. |
| Get All Video Variants | Get All Video Variants. |
| Get Custom Fields | Get Custom Fields. |
| Get Digital Master Info | Get Digital Master Info. |
| Get Playlist Count | Get Playlist Count. |
| Get Playlists | Get Playlists. |
| Get Playlists by ID | Get Playlists by ID. |
| Get Playlists for Video | Get Playlists for Video. |
| Get Status of Ingest Job | Get Status of Ingest Job. |
| Get Status of Ingest Jobs | Get Status of Ingest Jobs. |
| Get Video Audio Tracks | Get Video Audio Tracks. |
| Get Video Count | Get Video Count. |
| Get Video Count in Playlist | Get Video Count in Playlist. |
| Get Video Fields | Get Video Fields. |
| Get Video Images | Get Video Images. |
| Get Video Sources | Get Video Sources. |
| Get Videos | Get Videos. |
| Get Videos by ID/Reference ID | Get Videos by ID/Reference ID. |
| Get Videos in Playlist | Get Videos in Playlist. |
| Update Playlist | Update Playlist. |
| Update Video | Update Video. |
Create Playlist
Create Playlist.
Inputs
- Description
descriptiontext - playlist description
- Favorite
favoritetrue/false - whether playlist is in favorites list
- Name
nametextRequired - the playlist name
- Reference id
reference_idtext - the playlist reference id (must be unique within the account)
- Search
searchtext - search string to retrieve the videos (smart playlists only)
- Search syntax
search_syntaxtext - the search syntax used for the search string; see [Managing Playlists](/cms/managing-videos/managing-playlists-using-cms-api.html)One of:
v1,v2. - Type
typetextRequired - the playlist type: EXPLICIT or smart playlist typeOne of:
EXPLICIT,ACTIVATED_OLDEST_TO_NEWEST(Activated oldest to newest),ACTIVATED_NEWEST_TO_OLDEST(Activated newest to oldest),ALPHABETICAL,PLAYS_TOTAL(Plays total),PLAYS_TRAILING_WEEK(Plays trailing week),START_DATE_OLDEST_TO_NEWEST(Start date oldest to newest),START_DATE_NEWEST_TO_OLDEST(Start date newest to oldest). - Video ids
video_idstext - array of video ids (EXPLICIT playlists only) - maximum length: 1000
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"account_id": "example",
"created_at": "2026-10-25T12:00:00Z",
"description": "example",
"favorite": false,
"id": "example-id",
"name": "Example",
"reference_id": "example",
"search": "example",
"state": "READY",
"type": "EXPLICIT",
"updated_at": "2026-10-25T12:00:00Z",
"video_ids": []
}
}Create Video
Create Video.
Inputs
- Cue points
cue_pointslist - Array of cuepoint objects
- Custom fields
custom_fieldsobject - map of `fieldname: value` pairs; values have a maximum length of 1024 single-byte characters Note: be sure to use the **internal** name for the field, not the display name
- Description
descriptiontext - Video short description
- Drm disabled
drm_disabledtrue/false - Use to disable DRM packaging for this video - applies only to DRM-enabled accounts
- Economics
economicstext - whether the video supports adsOne of:
AD_SUPPORTED(Ad supported),FREE. - Geo
geoobject - map of geo-filtering properties
- Long description
long_descriptiontext - A longer description of the video
- Name
nametextRequired - Title of the video video
- Offline enabled
offline_enabledtrue/false - whether video is enabled for offline viewing
- Reference id
reference_idtext - Reference id for the clip - must be unique within the account
- State
statetext - Whether the video should be active or inactiveOne of:
ACTIVE,INACTIVE. - Tags
tagslist - Array of tags for the video - note that tags are string that may not contain a comma or more than 128 characters
- Schedule start
schedule_startdate and time - The date and time the video becomes available.
- Schedule end
schedule_enddate and time - The date and time the video stops being available.
Outputs
Result returned by the service.
responseobject- Object containing metadata for a video
Example output
{
"response": {
"ad_keys": "example",
"clip_source_video_id": "example",
"complete": false,
"created_at": "example",
"created_by": {
"email": "example",
"id": "example-id",
"type": "example"
},
"cue_points": [],
"custom_fields": {},
"delivery_type": "remote",
"description": "example",
"digital_master_id": "example",
"drm_disabled": false,
"duration": 0,
"economics": "AD_SUPPORTED",
"folder_id": "example",
"forensic_watermarking": "ACTIVE",
"geo": {
"countries": [],
"exclude_countries": false,
"restricted": false
},
"has_digital_master": false,
"id": "example-id",
"images": {},
"labels": [],
"link": {
"text": "example",
"url": "example"
},
"long_description": "example",
"name": "Example",
"offline_enabled": false,
"original_filename": "example",
"playback_rights_id": "example",
"projection": "equirectangular",
"published_at": "example",
"reference_id": "example",
"schedule": {
"ends_at": "example",
"starts_at": "example"
},
"sharing": {
"by_external_acct": false,
"by_id": "example",
"by_reference": false,
"source_id": "example",
"to_external_acct": false
},
"state": "ACTIVE",
"tags": [],
"text_tracks": [],
"transcripts": [],
"updated_at": "example",
"updated_by": {
"email": "example",
"id": "example-id",
"type": "example"
},
"variants": [],
"video_preview": {
"sources": [],
"start": 0
}
}
}Delete Playlist
Delete Playlist.
Inputs
- Playlist
playlist_idtextRequired - Playlist ID.
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {}
}Delete Video
Delete Video.
Inputs
- Video ids
video_idstextRequired - One or more video ids or one reference id. If reference ids, the syntax is `ref:my_ref_id`. Note that you may include multiple video ids, but only one reference id. For example: - https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/9827342837937 - https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/9827342837937,47584736360 - https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/ref:my_ref_id
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {}
}Get a Custom Field
Get a Custom Field.
Inputs
- Custom field id
custom_field_idtextRequired - Custom Field ID.
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"description": "example",
"display_name": "example",
"enum_values": [],
"id": "example-id",
"required": false,
"type": "example"
}
}Get All Video Variants
Get All Video Variants.
Inputs
- Video id
video_idtextRequired - Video ID (specified as `{video_id}}`).
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"data": []
}
}Get Custom Fields
Get Custom Fields.
Inputs
None.
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"data": []
}
}Get Digital Master Info
Get Digital Master Info.
Inputs
- Video id
video_idtextRequired - Video ID (specified as `{video_id}}`).
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"created_at": "example",
"duration": 0,
"encoding_rate": 0,
"height": 0,
"id": "example-id",
"size": 0,
"updated_at": "example",
"width": 0
}
}Get Playlist Count
Get Playlist Count.
Inputs
- Q
qtext - Search string - see [search guide](/cms/searching/cmsplayback-api-videos-search.html) for details
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"count": 0
}
}Get Playlists
Get Playlists.
Inputs
- Limit
limitnumber - Number of items to return - see [Paging Search Results](/cms/searching/using-cms-api-page-search-results.html) for more informationFrom 1 to 100.
- Offset
offsetnumber - Number of items to skip - see [Paging Search Results](/cms/searching/using-cms-api-page-search-results.html) for more information
- Q
qtext - Search string - see [playlist search guide](/cms/searching/cms-api-playlists-search.html) for details
- Sort
sorttext - Field to sort results by - if absent and there is a search string, results are sorted by relevance or if there is no search string, results are sorted by `-updated_at` - note: to sort in descending order, preface the field name with a minus(`-`) sign. If the `q=` param is missing, the sort param will be ignored. Also if sort is set to an unsupported field, the quest will fail with an errorOne of:
name,-name,updated_at(Updated at),-updated_at(-updated at).
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"data": []
}
}Get Playlists by ID
Get Playlists by ID.
Inputs
- Playlist
playlist_idtextRequired - Video Cloud playlist ID, or multiple playlist ids separated by commas.
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"account_id": "example",
"created_at": "2026-10-25T12:00:00Z",
"description": "example",
"favorite": false,
"id": "example-id",
"name": "Example",
"reference_id": "example",
"search": "example",
"state": "READY",
"type": "EXPLICIT",
"updated_at": "2026-10-25T12:00:00Z",
"video_ids": []
}
}Get Playlists for Video
Get Playlists for Video.
Inputs
- Video id
video_idtextRequired - Video ID (specified as `{video_id}}`).
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"playlists": []
}
}Get Status of Ingest Job
Get Status of Ingest Job.
Inputs
- Video id
video_idtextRequired - Video ID (specified as `{video_id}}`).
- Job id
job_idtextRequired - The Job ID for the ingest job (returned in the response to an ingest request)
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"account_id": "example",
"error_code": "example",
"error_message": "example",
"id": "example-id",
"priority": "example",
"started_at": "example",
"state": "processing",
"submitted_at": "example",
"updated_at": "example",
"video_id": "example"
}
}Get Status of Ingest Jobs
Get Status of Ingest Jobs.
Inputs
- Video id
video_idtextRequired - Video ID. For example: - https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/9827342837937
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"data": []
}
}Get Video Audio Tracks
Get Video Audio Tracks.
Inputs
- Video id
video_idtextRequired - Video ID (specified as `{video_id}}`).
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"data": []
}
}Get Video Count
Get Video Count.
Inputs
- Q
qtext - Search string - see [search guide](/cms/searching/cmsplayback-api-videos-search.html) for details
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"count": 0
}
}Get Video Count in Playlist
Get Video Count in Playlist.
Inputs
- Playlist
playlist_idtextRequired - Playlist ID.
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"count": 0
}
}Get Video Fields
Get Video Fields.
Inputs
None.
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"custom_fields": [],
"max_custom_fields": "example",
"standard_fields": []
}
}Get Video Images
Get Video Images.
Inputs
- Video id
video_idtextRequired - Video ID (specified as `{video_id}}`).
Outputs
Result returned by the service.
responseobject- map of image maps - the map name is in the form `label.language` where the label is one of `poster`, `thumbnail`, `portrait`, `square`, `wide` or `ultra-wide`, and the `language` is a language identifier such as 'en', 'de', or `ko`
Example output
{
"response": {}
}Get Video Sources
Get Video Sources.
Inputs
- Video id
video_idtextRequired - Video ID (specified as `{video_id}}`).
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"app_name": "example",
"asset_id": "example",
"codec": "example",
"container": "example",
"duration": 0,
"encoding_rate": 0,
"height": 0,
"remote": false,
"size": 0,
"src": "example",
"stream_name": "example",
"type": "example",
"uploaded_at": "example",
"width": 0
}
}Get Videos
Get Videos.
Inputs
- Limit
limitnumber - Number of items to return - see [Paging Search Results](/cms/searching/using-cms-api-page-search-results.html) for more informationFrom 1 to 100.
- Offset
offsetnumber - Number of items to skip - see [Paging Search Results](/cms/searching/using-cms-api-page-search-results.html) for more information
- Sort
sorttext - Field to sort results by - if absent and there is a search string, results are sorted by relevance or if there is no search string, results are sorted by `-updated_at`. Notes: - to sort in descending order, preface the field name with a minus (`-`) sign - this parameter can be used to sort results both for a get videos request and for a get videos in folder requestOne of:
name,-name,reference_id(Reference id),-reference_id(-reference id),created_at(Created at),-created_at(-created at),published_at(Published at),-published_at(-published at),updated_at(Updated at),-updated_at(-updated at), and 8 more. - Q
qtext - Search string - see [search guide](/cms/searching/cmsplayback-api-videos-search.html) for details
- Query
querytext - Search string - see [search guide](/cms/searching/cms-and-playback-apis-video-search-v2.html) for details
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"data": []
}
}Get Videos by ID/Reference ID
Get Videos by ID/Reference ID.
Inputs
- Video ids
video_idstextRequired - One or more video ids or one reference id. If reference ids, the syntax is `ref:my_ref_id`. Note that you may include multiple video ids, but only one reference id. For example: - https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/9827342837937 - https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/9827342837937,47584736360 - https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/ref:my_ref_id
- Include variants
include_variantstrue/false - Whether to include the language variants in the response
- Include video preview
include_video_previewtrue/false - Whether to include the `video_preview` object (animated thumbnail preview metadata) in the response
Outputs
Result returned by the service.
responseobject- Object containing metadata for a video
Example output
{
"response": {
"ad_keys": "example",
"clip_source_video_id": "example",
"complete": false,
"created_at": "example",
"created_by": {
"email": "example",
"id": "example-id",
"type": "example"
},
"cue_points": [],
"custom_fields": {},
"delivery_type": "remote",
"description": "example",
"digital_master_id": "example",
"drm_disabled": false,
"duration": 0,
"economics": "AD_SUPPORTED",
"folder_id": "example",
"forensic_watermarking": "ACTIVE",
"geo": {
"countries": [],
"exclude_countries": false,
"restricted": false
},
"has_digital_master": false,
"id": "example-id",
"images": {},
"labels": [],
"link": {
"text": "example",
"url": "example"
},
"long_description": "example",
"name": "Example",
"offline_enabled": false,
"original_filename": "example",
"playback_rights_id": "example",
"projection": "equirectangular",
"published_at": "example",
"reference_id": "example",
"schedule": {
"ends_at": "example",
"starts_at": "example"
},
"sharing": {
"by_external_acct": false,
"by_id": "example",
"by_reference": false,
"source_id": "example",
"to_external_acct": false
},
"state": "ACTIVE",
"tags": [],
"text_tracks": [],
"transcripts": [],
"updated_at": "example",
"updated_by": {
"email": "example",
"id": "example-id",
"type": "example"
},
"variants": [],
"video_preview": {
"sources": [],
"start": 0
}
}
}Get Videos in Playlist
Get Videos in Playlist.
Inputs
- Playlist
playlist_idtextRequired - Playlist ID.
- Include details
include_detailstrue/false - When it's false, api call response won't include caption info in [text_tracks] at all and it makes the response returns quicker.
- Include video preview
include_video_previewtrue/false - Whether to include the `video_preview` object (animated thumbnail preview metadata) in the response
- Limit
limitnumber - Number of items to return - see [Get videos in a playlist](/cms/managing-videos/managing-playlists-using-cms-api.html#get_count_of_videos) for more informationFrom 1 to 100.
- Offset
offsetnumber - Number of items to skip - see [Paging Search Results](/cms/searching/using-cms-api-page-search-results.html) for more information
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"data": []
}
}Update Playlist
Update Playlist.
Inputs
- Playlist
playlist_idtextRequired - Playlist ID.
- Description
descriptiontext - playlist description
- Favorite
favoritetrue/false - whether playlist is in favorites list
- Name
nametext - the playlist name
- Reference id
reference_idtext - the playlist reference id (must be unique within the account)
- Search
searchtext - search string to retrieve the videos (smart playlists only)
- Search syntax
search_syntaxtext - the search syntax used for the search string; see [Managing Playlists](/cms/managing-videos/managing-playlists-using-cms-api.html)One of:
v1,v2. - Type
typetext - the playlist type: EXPLICIT or smart playlist typeOne of:
EXPLICIT,ACTIVATED_OLDEST_TO_NEWEST(Activated oldest to newest),ACTIVATED_NEWEST_TO_OLDEST(Activated newest to oldest),ALPHABETICAL,PLAYS_TOTAL(Plays total),PLAYS_TRAILING_WEEK(Plays trailing week),START_DATE_OLDEST_TO_NEWEST(Start date oldest to newest),START_DATE_NEWEST_TO_OLDEST(Start date newest to oldest). - Video ids
video_idstext - array of video ids (EXPLICIT playlists only) - maximum length: 1000
Outputs
Result returned by the service.
responseobject- Complete service response, including pagination.
Example output
{
"response": {
"account_id": "example",
"created_at": "2026-10-25T12:00:00Z",
"description": "example",
"favorite": false,
"id": "example-id",
"name": "Example",
"reference_id": "example",
"search": "example",
"state": "READY",
"type": "EXPLICIT",
"updated_at": "2026-10-25T12:00:00Z",
"video_ids": []
}
}Update Video
Update Video.
Inputs
- Video id
video_idtextRequired - Video ID (specified as `{video_id}}`).
- Ad keys
ad_keystext - string representing the ad key/value pairs assigned to the video. Key/value pairs are formatted as key=value and are separated by ampersands - can only be added on update, not creation
- Cue points
cue_pointslist - array of cue points - can be added on creation or update
- Custom fields
custom_fieldsobject - Custom fields to use for this request.
- Description
descriptiontext - video short description
- Drm disabled
drm_disabledtrue/false - if true, the video is not DRM-packaged - applies to accounts that are enabled for DRM only
- Economics
economicstext - whether video is `AD_SUPPORTED`One of:
AD_SUPPORTED(Ad supported),FREE. - Folder id
folder_idtext - id of the folder that contains the video
- Geo
geoobject - map of geo-filtering properties
- Labels
labelslist - Array of labels assigned to the video. See [Working with Labels](/cms/managing-videos/working-with-labels.html) for more information.
- Link
linkobject - map of related link properties - can only be added on update, not creation
- Long description
long_descriptiontext - video long description - can only be added on update, not creation
- Name
nametext - video title
- Offline enabled
offline_enabledtrue/false - whether video is enabled for offline viewing
- Playback rights id
playback_rights_idtext - Associates specified EPA playback rights with video.
- Reference id
reference_idtext - video reference-id (must be unique within the account)
- State
statetext - The state of the video: - ACTIVE: the video is playable - INACTIVE: the video is not playable - PENDING: - DELETED: the video has been deleted (within the past 10 days; after that, the API won't return the video)One of:
ACTIVE,INACTIVE. - Tags
tagslist - array of tags - maximum characters per tag is 1000
- Text tracks
text_trackslist - array of text tracks - can only be added on update, not creation
- Schedule start
schedule_startdate and time - The date and time the video becomes available.
- Schedule end
schedule_enddate and time - The date and time the video stops being available.
Outputs
Result returned by the service.
responseobject- Object containing metadata for a video
Example output
{
"response": {
"ad_keys": "example",
"clip_source_video_id": "example",
"complete": false,
"created_at": "example",
"created_by": {
"email": "example",
"id": "example-id",
"type": "example"
},
"cue_points": [],
"custom_fields": {},
"delivery_type": "remote",
"description": "example",
"digital_master_id": "example",
"drm_disabled": false,
"duration": 0,
"economics": "AD_SUPPORTED",
"folder_id": "example",
"forensic_watermarking": "ACTIVE",
"geo": {
"countries": [],
"exclude_countries": false,
"restricted": false
},
"has_digital_master": false,
"id": "example-id",
"images": {},
"labels": [],
"link": {
"text": "example",
"url": "example"
},
"long_description": "example",
"name": "Example",
"offline_enabled": false,
"original_filename": "example",
"playback_rights_id": "example",
"projection": "equirectangular",
"published_at": "example",
"reference_id": "example",
"schedule": {
"ends_at": "example",
"starts_at": "example"
},
"sharing": {
"by_external_acct": false,
"by_id": "example",
"by_reference": false,
"source_id": "example",
"to_external_acct": false
},
"state": "ACTIVE",
"tags": [],
"text_tracks": [],
"transcripts": [],
"updated_at": "example",
"updated_by": {
"email": "example",
"id": "example-id",
"type": "example"
},
"variants": [],
"video_preview": {
"sources": [],
"start": 0
}
}
}