VIDA Backend API (1.0.0)

Download OpenAPI specification:Download

Welcome to the Vida API

The Vida API allows seamless integration with your media asset management process, from ingesting assets to handling complex delivery configurations. Every aspect of media management can be controlled through the Vida RESTful API, offering the flexibility and scalability to meet the needs of content creators, broadcasters, and media distributors. With automation, secure architecture, and AI-driven tools, Vida enhances every step of your media workflow.

Authentication

Vida uses OAuth-based authentication through Google or Microsoft, with multi-factor authentication (MFA) available for added security. Include your access token in the Authorization header for each request.

Assets

Create and manage Assets.

Get details for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"additional": {"alt_no": "string",
"captions": true,
"category": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"framerate": "string",
"genre": "string",
"inventory_type": "string",
"is_preview_app_enabled": true,
"legacy_ingest_date": "string",
"multiversion": ["string"
],
"note": "string",
"part_no": "string",
"part_total": "string",
"production_company": "string",
"production_no": "string",
"shooting_end_date": "string",
"shooting_start_date": "string",
"star_rating": 0,
"subtitle": "string",
"subtype": "string",
"synopsis": "string",
"synopsis_short": "string",
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"type": "string",
"variation": "string",
"version": "string",
"vida_number": "string"
},
"attachments": [{"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
}
],
"audioTracks": [{"audio_description": "string",
"bit_depth": "string",
"channels": ["L"
],
"class": "string",
"codec": "string",
"language": "string",
"layout": "string",
"loudness": "string",
"loudness_standard": "string",
"number": "string",
"qc_status": "string",
"sample_rate": "string",
"tech": "string"
}
],
"core": {"client_ref": "string",
"episode_name": "string",
"episode_number": 0,
"facility_of_origin": "string",
"original_filename": "string",
"programme_number": "string",
"series_name": "string",
"series_number": 0
},
"ext_asset_info": {"artist": "string",
"barcode_field": "string",
"dynamic_range": "string",
"order_number": "string",
"origin": "string",
"sequence_no": "string"
},
"ext_title_info": {"eidr_number": "string",
"library_sales_rights": true,
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"release_year": "string",
"season_title": "string",
"tx_date": "string"
},
"file_metadata": {"aspect_ratio": "string",
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"chroma_format": "string",
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"dropped_frames": true,
"duration": "string",
"duration_sec": 0,
"filesize": 0,
"format": "string",
"frame_rate_mode": "string",
"framerate": "string",
"interlace_mode": "string",
"pixel_aspect_ratio": 0,
"resolution": "string",
"source": "hybrik",
"timecode_start": "string",
"vida_resolution": "string",
"video": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"video_codec_mapping": "string"
},
"general": {"approval_status": 0,
"batch_id": "string",
"client_asset_id": "string",
"cold_only": true,
"collections": ["string"
],
"collections_details": [{"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"item_uuid": "string",
"name": "string",
"order": 0,
"uuid": "string"
}
],
"download_proxy_url": "string",
"download_url": "string",
"embargoed_to": "string",
"estimated_restore_at": "string",
"external_key": "string",
"file_ext": "string",
"file_url": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"hot_expires_at": "2019-08-24T14:15:22Z",
"is_proxy_only": true,
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"licensedPackageUuids": ["string"
],
"logs": [{"created_at": "string",
"message": "string"
}
],
"master_no": "string",
"md5": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"media_key": "string",
"original_filename": "string",
"parent": "string",
"preview_url": "string",
"processingStatus": "PLACEHOLDER",
"rating_uuids": ["string"
],
"s_object_id": "string",
"s_object_id_bk": "string",
"stage": 0,
"storage": "hot",
"storage_status": "active",
"subtitles": [{"language": "string",
"path": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"thumbnail_processing": true,
"thumbnail_tape_interval": "string",
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"type": "string",
"upload_source": "string",
"uploaded_at": "string",
"uuid": "string"
},
"locks": [{"asset_uuid": "string",
"expires": "string",
"lock_uuid": "string",
"type": "AI_JOB_EDIT",
"user_uuid": "string"
}
],
"logginginfo": [{"duration": "string",
"logging_type": "string",
"note": "string",
"offset": "string",
"timecode_in": "string",
"timecode_out": "string",
"uuid": "string"
}
],
"mediaset": {"parent_media_id": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"relationship": "string"
},
"transactions": [{"ai_model_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": {"email": "string",
"name": "string",
"uuid": "string"
},
"id": 0,
"order_id": 0,
"type": "ingest"
}
],
"user_media_data": {"aspect_ratio": "string",
"bars": true,
"clock_slate": true,
"elements": "string",
"framing": "string",
"image_aspect": "string",
"language": "string",
"player_offset": "string",
"retention": "string",
"seamless_segmented": "string"
}
}

Update an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

	object (PatchAssetAdditionalType)
	Array of objects (PatchAssetAudioTrackType)
	object (PatchAssetCoreType)
	object (PatchAssetExtAssetInfoType)
	object (PatchAssetExtTitleInfoType)
	object (PatchAssetGeneralType)
	object (PatchAssetMediaSetType)
	object (PatchAssetUserMediaDataType)

Responses

Request samples

Payload

Content type

application/json

{"additional": {"alt_no": "string",
"captions": true,
"category": "string",
"client_content_class_id": "string",
"content_class": "string",
"content_type": "string",
"description": "string",
"disposition": "string",
"framerate": "string",
"genre": "string",
"inventory_type": "string",
"is_preview_app_enabled": true,
"legacy_ingest_date": "string",
"multiversion": ["string"
],
"note": "string",
"part_no": "string",
"part_total": "string",
"player_offset": "string",
"production_company": "string",
"production_no": "string",
"shooting_end_date": "string",
"shooting_start_date": "string",
"star_rating": 0,
"subtitle": "string",
"subtype": "string",
"synopsis": "string",
"synopsis_short": "string",
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"type": "string",
"variation": "string",
"version": "string",
"vida_number": "string"
},
"audioTracks": [{"audio_description": "string",
"bit_depth": "string",
"channels": ["L"
],
"class": "string",
"codec": "string",
"language": "string",
"layout": "1.0",
"loudness": "string",
"loudness_standard": "string",
"qc_status": "string",
"sample_rate": "string",
"track": 0
}
],
"core": {"client_ref": "string",
"episode_name": "string",
"episode_number": 0,
"facility_of_origin": "string",
"original_filename": "string",
"programme_number": "string",
"series_name": "string",
"series_number": 0
},
"ext_asset_info": {"artist": "string",
"barcode_field": "string",
"dynamic_range": "string",
"order_number": "string",
"origin": "string",
"sequence_no": "string"
},
"ext_title_info": {"eidr_number": "string",
"library_sales_rights": true,
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"release_year": "string",
"season_title": "string",
"tx_date": "string"
},
"general": {"approval_status": 0,
"client_asset_id": "string",
"embargoed_to": "string",
"external_key": "string",
"is_quarantined": true,
"rating_uuids": ["string"
],
"revision_parent_uuid": "string",
"stage": 0,
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"thumbnail_timecode": "string"
},
"mediaset": {"parent_media_id": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"relationship": "string"
},
"user_media_data": {"aspect_ratio": "string",
"bars": true,
"clock_slate": true,
"elements": "string",
"framing": "string",
"image_aspect": "string",
"language": "string",
"player_offset": "string",
"retention": "string",
"seamless_segmented": "string"
}
}

Response samples

Content type

application/json

{"additional": {"alt_no": "string",
"captions": true,
"category": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"framerate": "string",
"genre": "string",
"inventory_type": "string",
"is_preview_app_enabled": true,
"legacy_ingest_date": "string",
"multiversion": ["string"
],
"note": "string",
"part_no": "string",
"part_total": "string",
"production_company": "string",
"production_no": "string",
"shooting_end_date": "string",
"shooting_start_date": "string",
"star_rating": 0,
"subtitle": "string",
"subtype": "string",
"synopsis": "string",
"synopsis_short": "string",
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"type": "string",
"variation": "string",
"version": "string",
"vida_number": "string"
},
"attachments": [{"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
}
],
"audioTracks": [{"audio_description": "string",
"bit_depth": "string",
"channels": ["L"
],
"class": "string",
"codec": "string",
"language": "string",
"layout": "string",
"loudness": "string",
"loudness_standard": "string",
"number": "string",
"qc_status": "string",
"sample_rate": "string",
"tech": "string"
}
],
"core": {"client_ref": "string",
"episode_name": "string",
"episode_number": 0,
"facility_of_origin": "string",
"original_filename": "string",
"programme_number": "string",
"series_name": "string",
"series_number": 0
},
"ext_asset_info": {"artist": "string",
"barcode_field": "string",
"dynamic_range": "string",
"order_number": "string",
"origin": "string",
"sequence_no": "string"
},
"ext_title_info": {"eidr_number": "string",
"library_sales_rights": true,
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"release_year": "string",
"season_title": "string",
"tx_date": "string"
},
"file_metadata": {"aspect_ratio": "string",
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"chroma_format": "string",
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"dropped_frames": true,
"duration": "string",
"duration_sec": 0,
"filesize": 0,
"format": "string",
"frame_rate_mode": "string",
"framerate": "string",
"interlace_mode": "string",
"pixel_aspect_ratio": 0,
"resolution": "string",
"source": "hybrik",
"timecode_start": "string",
"vida_resolution": "string",
"video": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"video_codec_mapping": "string"
},
"general": {"approval_status": 0,
"batch_id": "string",
"client_asset_id": "string",
"cold_only": true,
"collections": ["string"
],
"collections_details": [{"custom_cover": true,
"custom_cover_path": "string",
"description": "string",
"item_uuid": "string",
"name": "string",
"order": 0,
"uuid": "string"
}
],
"download_proxy_url": "string",
"download_url": "string",
"embargoed_to": "string",
"estimated_restore_at": "string",
"external_key": "string",
"file_ext": "string",
"file_url": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"hot_expires_at": "2019-08-24T14:15:22Z",
"is_proxy_only": true,
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"licensedPackageUuids": ["string"
],
"logs": [{"created_at": "string",
"message": "string"
}
],
"master_no": "string",
"md5": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"media_key": "string",
"original_filename": "string",
"parent": "string",
"preview_url": "string",
"processingStatus": "PLACEHOLDER",
"rating_uuids": ["string"
],
"s_object_id": "string",
"s_object_id_bk": "string",
"stage": 0,
"storage": "hot",
"storage_status": "active",
"subtitles": [{"language": "string",
"path": "string"
}
],
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"thumbnail_processing": true,
"thumbnail_tape_interval": "string",
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"type": "string",
"upload_source": "string",
"uploaded_at": "string",
"uuid": "string"
},
"locks": [{"asset_uuid": "string",
"expires": "string",
"lock_uuid": "string",
"type": "AI_JOB_EDIT",
"user_uuid": "string"
}
],
"logginginfo": [{"duration": "string",
"logging_type": "string",
"note": "string",
"offset": "string",
"timecode_in": "string",
"timecode_out": "string",
"uuid": "string"
}
],
"mediaset": {"parent_media_id": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"relationship": "string"
},
"transactions": [{"ai_model_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": {"email": "string",
"name": "string",
"uuid": "string"
},
"id": 0,
"order_id": 0,
"type": "ingest"
}
],
"user_media_data": {"aspect_ratio": "string",
"bars": true,
"clock_slate": true,
"elements": "string",
"framing": "string",
"image_aspect": "string",
"language": "string",
"player_offset": "string",
"retention": "string",
"seamless_segmented": "string"
}
}

Delete an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

assetUuids required	Array of strings
deleteReason required	string
deletionBillable required	boolean

Responses

Request samples

Payload

Content type

application/json

{"assetUuids": ["string"
],
"deleteReason": "string",
"deletionBillable": true
}

Response samples

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string"
}

Get subtitles for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"subs": [{"language": "string",
"path": "string"
}
]
}

Get a Hybrik Analyze for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"deep_properties": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"general_properties": {"asset": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"audio": [{"bitrate_kb": 0,
"bitrate_mode": "string",
"channel_designators": ["string"
],
"channel_order": "string",
"channels": 0,
"codec": "string",
"duration_sec": 0,
"language": "string",
"pid": 0,
"sample_format": "string",
"sample_rate": 0,
"sample_size": 0
}
],
"container": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"timecode": [{"format": "string",
"source": "string",
"start_value": "string"
}
],
"video": {"bit_resolution": 0,
"bitrate_kb": 0,
"bitrate_mode": "string",
"chroma_format": "string",
"clean_aperture_height": 0,
"clean_aperture_width": 0,
"codec": "string",
"color_matrix": "string",
"color_primaries": "string",
"color_space": "string",
"color_trc": "string",
"dar": 0,
"duration_sec": 0,
"frame_rate": 0,
"frame_rate_mode": "string",
"height": 0,
"interlace_mode": "string",
"par": 0,
"pid": 0,
"profile": "string",
"width": 0
}
},
"hybrik_profile": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
}
}

Get a playlist for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

"string"

Get a Hybrik QA for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Get pdf with an Asset details

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"url": "string"
}

List Asset Storage Logs

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id	string Unique Client identifier in the system
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page

Responses

Response samples

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"id": 0,
"message": "string",
"storageChangeDirection": "hotToCold"
}
]

List an Asset Storage Statuses

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"s3Status": "string",
"wasabiStatus": "string"
}

Get transcriptions for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"assetUuid": "string",
"default": true,
"source": "Whisper",
"status": "pending",
"uuid": "string"
}
]

Upload to Vimeo

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"link": "string",
"uri": "string"
}

Get historical asset locks which represent successful edits by users

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"asset_uuid": "string",
"expires": "string",
"lock_uuid": "string",
"type": "AI_JOB_EDIT",
"user_uuid": "string"
}
]

Get details of before / after state of the asset lock

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"after": [{"confidence": 0,
"data": {"content": "string",
"instances": [{"Height": 0,
"Left": 0,
"Top": 0,
"Width": 0,
"instance_type": "BoundingBox",
"start": "string"
}
],
"note": "string",
"parent": "string",
"translations": [{"content": "string",
"language": "string"
}
]
},
"end": 0,
"id": 0,
"start": 0,
"type": "label-detection"
}
],
"before": [{"confidence": 0,
"data": {"content": "string",
"instances": [{"Height": 0,
"Left": 0,
"Top": 0,
"Width": 0,
"instance_type": "BoundingBox",
"start": "string"
}
],
"note": "string",
"parent": "string",
"translations": [{"content": "string",
"language": "string"
}
]
},
"end": 0,
"id": 0,
"start": 0,
"type": "label-detection"
}
]
}

Lock an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id	string Unique Client identifier in the system
type required	string `Type of data to be locked for edits`
confirm	boolean `Confirm take over of existing lock by another user`
action required	string Action to perform with lock. Can be `create` or `refresh` or `unlock`

Responses

Response samples

Content type

application/json

{"asset_uuid": "string",
"expires": "string",
"lock_uuid": "string",
"type": "AI_JOB_EDIT",
"user_uuid": "string"
}

Create an Asset

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Add a File to an Asset from Aspera

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

batchId required	string Batch identifier
internalFilename required	string Internal filename used within the system for the asset
originalFilename required	string Original filename of the asset
sourcePath required	string Source path where the asset is stored

Responses

Request samples

Payload

Content type

application/json

{"batchId": "string",
"internalFilename": "string",
"originalFilename": "string",
"sourcePath": "string"
}

Response samples

Content type

application/json

{"cookie": "string",
"destinationRoot": "string",
"token": "string"
}

Get download proxy for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

contact_name	string Name of the contact associated with the download proxy
contact_uuid	string UUID of the contact associated with the download proxy
opportunity_name	string Name of the opportunity associated with the download proxy
opportunity_uuid	string UUID of the opportunity associated with the download proxy

Responses

Request samples

Payload

Content type

application/json

{"contact_name": "string",
"contact_uuid": "string",
"opportunity_name": "string",
"opportunity_uuid": "string"
}

Response samples

Content type

application/json

{"url": "string"
}

Register to Rasp

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"expired_at": "2019-08-24T14:15:22Z",
"ruid": "string"
}

Delete from a Rasp register

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Create an Asset Trailer

Trailer is created from asset clips.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

imgCount

required

number

The number of images or clips to be used for the trailer

Responses

Request samples

Payload

Content type

application/json

{"imgCount": 0
}

Response samples

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string"
}

Create an Asset Trailer

Trailer is created from images.

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

imgCount

required

number

The number of images or clips to be used for the trailer

Responses

Request samples

Payload

Content type

application/json

{"imgCount": 0
}

Response samples

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string"
}

Create transcription for an Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

modelUuid required	string Unique identifier for the model associated with the job
	object Optional job options, including tone settings
trackNumber	string Optional track number associated with the job

Responses

Request samples

Payload

Content type

application/json

{"modelUuid": "string",
"options": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null,
"description": null
},
"trackNumber": "string"
}

Response samples

Content type

application/json

{"jobUuid": "string"
}

Abort an upload

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

uploadId

required

string

Unique identifier for the upload session to be aborted

Responses

Request samples

Payload

Content type

application/json

{"uploadId": "string"
}

Complete an upload

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

required	Array of objects (UploadAssetCompletePart) List of uploaded parts
uploadId required	string The ID of the upload session

Responses

Request samples

Payload

Content type

application/json

{"parts": [{"ETag": "string",
"PartNumber": 0
}
],
"uploadId": "string"
}

Create an upload

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

partNumber required	number The part number of the uploaded
uploadId required	string Unique identifier for the upload

Responses

Request samples

Payload

Content type

application/json

{"partNumber": 0,
"uploadId": "string"
}

Response samples

Content type

application/json

"string"

Create a Virtual Asset

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

timecodeIn required	string Starting timecode for the virtual asset
timecodeOut required	string Ending timecode for the virtual asset

Responses

Request samples

Payload

Content type

application/json

{"timecodeIn": "string",
"timecodeOut": "string"
}

Response samples

Content type

application/json

{"uuid": "string"
}

Create an Asset from Aspera

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

required

Array of objects (PostAsperaAssetToAssetTypeFiles)

List of files for aspera

Responses

Request samples

Payload

Content type

application/json

{"files": [{"batchId": "string",
"internalFilename": "string",
"originalFilename": "string",
"sourcePath": "string",
"uploadSource": "Launchpad",
"uuid": "string"
}
]
}

Response samples

Content type

application/json

{"cookie": "string",
"destinationRoot": "string",
"token": "string"
}

Update an Asset embargo date

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

	object (PatchAssetAdditionalType)
	Array of objects (PatchAssetAudioTrackType)
	object (PatchAssetCoreType)
	object (PatchAssetExtAssetInfoType)
	object (PatchAssetExtTitleInfoType)
	object (PatchAssetGeneralType)
	object (PatchAssetMediaSetType)
	object (PatchAssetUserMediaDataType)

Responses

Request samples

Payload

Content type

application/json

{"additional": {"alt_no": "string",
"captions": true,
"category": "string",
"client_content_class_id": "string",
"content_class": "string",
"content_type": "string",
"description": "string",
"disposition": "string",
"framerate": "string",
"genre": "string",
"inventory_type": "string",
"is_preview_app_enabled": true,
"legacy_ingest_date": "string",
"multiversion": ["string"
],
"note": "string",
"part_no": "string",
"part_total": "string",
"player_offset": "string",
"production_company": "string",
"production_no": "string",
"shooting_end_date": "string",
"shooting_start_date": "string",
"star_rating": 0,
"subtitle": "string",
"subtype": "string",
"synopsis": "string",
"synopsis_short": "string",
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"type": "string",
"variation": "string",
"version": "string",
"vida_number": "string"
},
"audioTracks": [{"audio_description": "string",
"bit_depth": "string",
"channels": ["L"
],
"class": "string",
"codec": "string",
"language": "string",
"layout": "1.0",
"loudness": "string",
"loudness_standard": "string",
"qc_status": "string",
"sample_rate": "string",
"track": 0
}
],
"core": {"client_ref": "string",
"episode_name": "string",
"episode_number": 0,
"facility_of_origin": "string",
"original_filename": "string",
"programme_number": "string",
"series_name": "string",
"series_number": 0
},
"ext_asset_info": {"artist": "string",
"barcode_field": "string",
"dynamic_range": "string",
"order_number": "string",
"origin": "string",
"sequence_no": "string"
},
"ext_title_info": {"eidr_number": "string",
"library_sales_rights": true,
"original_title": "string",
"other_title": "string",
"programme_subtitle": "string",
"release_year": "string",
"season_title": "string",
"tx_date": "string"
},
"general": {"approval_status": 0,
"client_asset_id": "string",
"embargoed_to": "string",
"external_key": "string",
"is_quarantined": true,
"rating_uuids": ["string"
],
"revision_parent_uuid": "string",
"stage": 0,
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"thumbnail_timecode": "string"
},
"mediaset": {"parent_media_id": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"relationship": "string"
},
"user_media_data": {"aspect_ratio": "string",
"bars": true,
"clock_slate": true,
"elements": "string",
"framing": "string",
"image_aspect": "string",
"language": "string",
"player_offset": "string",
"retention": "string",
"seamless_segmented": "string"
}
}

Response samples

Content type

application/json

true

Regenerate an Asset Proxy

Authorizations:

customAuthorizer

path Parameters

uuid

required

string

Unique item identifier in the system

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

true

Finish an Aspera Upload

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

batch_id required	string Batch identifier
is_reuploaded required	boolean Flag indicating whether the asset has been re-uploaded

Responses

Request samples

Payload

Content type

application/json

{"batch_id": "string",
"is_reuploaded": true
}

Response samples

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string"
}

List Assets details

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Assets update

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

filename

required

string

File name

Responses

Request samples

Payload

Content type

application/json

{"filename": "string"
}

Response samples

Content type

application/json

{"key": "string",
"policy": "string",
"url": "string",
"x_amz_algorithm": "string",
"x_amz_credential": "string",
"x_amz_date": "string",
"x_amz_security_token": "string",
"x_amz_signature": "string"
}

Delete Assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

assetUuids required	Array of strings
deleteReason required	string
deletionBillable required	boolean

Responses

Request samples

Payload

Content type

application/json

{"assetUuids": ["string"
],
"deleteReason": "string",
"deletionBillable": true
}

Response samples

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string"
}

List All Assets

Authorizations:

customAuthorizer

header Parameters

Cache-Control	object Overrides default cache behaviour.
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Get Archived Assets

Authorizations:

customAuthorizer

header Parameters

Cache-Control	object Overrides default cache behaviour.
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Get Ingest Assets List

Authorizations:

customAuthorizer

header Parameters

Cache-Control	object Overrides default cache behaviour.
order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

List latest Assets

Authorizations:

customAuthorizer

header Parameters

order-by	string Set order by
order-dir	string Set order dir
page	number Set page
per-page	number Set items per page
vida-client-id	string Unique Client identifier in the system

Responses

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Generate Mediapulse JSON for Assets

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Responses

Response samples

Content type

application/json

{"message": "Accepted"
}

List All Assets on map

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

polyenc

required

string

Assets Poly

Responses

Request samples

Payload

Content type

application/json

{"polyenc": "string"
}

Response samples

Content type

application/json

[{"alt_no": "string",
"aspect_ratio": "string",
"audio_channel_count": 0,
"audio_charts": {"ebu_r128_y_max": 0,
"ebu_r128_y_min": 0,
"level_db": 0,
"nr_samples": 0,
"peak_db": 0,
"rms_level_y_max": 0,
"rms_level_y_min": 0
},
"audio_codec": "string",
"audio_tracks": [{"class": "string",
"language": "string",
"layout": "string"
}
],
"bit_depth": 0,
"bitrate": 0,
"bitrate_mode": "string",
"black_borders": {"analysis_type": "string",
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"category": "string",
"chroma_format": "string",
"clean_aperture": "string",
"client_asset_id": "string",
"client_content_class_id": "string",
"client_ref": "string",
"cold_only": true,
"collections": ["string"
],
"color_matrix_coefficients": "string",
"color_primaries": "string",
"color_space": "string",
"color_transfer_characteristics": "string",
"container_duration": 0,
"container_format": "string",
"content_class": "string",
"content_class_id": "string",
"content_type": "string",
"coords": {"x": 0,
"y": 0
},
"delete_reason": "string",
"deleted_at": "string",
"deleted_by": "string",
"deletion_billable": true,
"delivery_pack_name": "string",
"description": "string",
"disposition": "string",
"droppedFrames": true,
"duration": "string",
"elements": "string",
"embargoed_to": "string",
"encoded_pixels": "string",
"episode_name": "string",
"episode_number": 0,
"estimated_restore_at": "string",
"external_key": "string",
"facility_of_origin": "string",
"file_url": "string",
"filename": "string",
"format": "string",
"framerate": "string",
"genre": "string",
"groups": [{"aspera_download_credential_uuid": "string",
"aspera_upload_credential_uuid": "string",
"asset_qa_enabled": true,
"auto_audio_language_detection": true,
"client_id": "string",
"custom_languages_enabled": true,
"default_policies": {"additionalProperties": null,
"properties": null,
"type": null
},
"detect_labels_image": true,
"detect_labels_video": true,
"display_upload_date": true,
"download_limit": 0,
"enable_cold_storage": true,
"enable_directly_cold": true,
"enable_stay_in_hot": true,
"event_based_ingest_enabled": true,
"external_bucket_credential_uuid": "string",
"external_supervisor_emails": "string",
"fa_is_required": true,
"internal_bucket_exists": true,
"internal_bucket_host": "string",
"internal_bucket_name": "string",
"internal_bucket_region": "string",
"job_id": "string",
"lastMediapulseSyncTime": 0,
"librarian_group_id": 0,
"logo": {"download_link": "string",
"file": "string",
"file_type": "string",
"status": "pending",
"upload_access": {"additionalProperties": null,
"properties": null,
"required": null,
"type": null
},
"uuid": "string",
"view_link": "string"
},
"mediapulse_client_name": "string",
"mediapulse_download_sqs_queue": "string",
"mediapulse_download_sqs_queue_1mp": "string",
"mediapulse_download_sqs_queue_la": "string",
"name": "string",
"proxy_filename_source_property": "string",
"purge_assets_safety_net_days": 0,
"support_email": "string",
"tedial_sqs_priority": {"additionalProperties": null,
"properties": null,
"type": null
},
"tedial_xml_sqs_queue": "string",
"tedial_xml_sqs_queue_1mp": "string",
"tedial_xml_sqs_queue_la": "string",
"transcribe_uploaded_assets": true,
"useHybrikData": true,
"uuid": "string"
}
],
"height": 0,
"hot_expires_at": "2019-08-24T14:15:22Z",
"image_aspect": "string",
"interlace_mode": "string",
"interlacing": {"analysis_result": "string",
"analysis_type": "string",
"bff": 0,
"is_3_2_telecined": true,
"is_4th_frame_telecined": true,
"progressive": 0,
"ratio": 0,
"tff": 0,
"undetermined": 0
},
"inventory_type": "string",
"is_quarantined": true,
"is_uploaded": true,
"is_virtual": true,
"language": "string",
"legacy_ingest_date": "string",
"library_sales_rights": true,
"md5": {"date": "string",
"hash": "string"
},
"metadata_sub_type": "string",
"multiversion": ["string"
],
"note": "string",
"note_truncated": "string",
"object_id": "string",
"object_id_bk": "string",
"offset": "string",
"origin": "string",
"original_filename": "string",
"other_title": "string",
"physical_version_description": "string",
"physical_version_title": "string",
"pixel_aspect_ratio": 0,
"player_offset": "string",
"processing_status": "PLACEHOLDER",
"production_company": "string",
"production_no": "string",
"profile": "string",
"programme_number": "string",
"purged_at": "string",
"rating_uuids": ["string"
],
"release_year": "string",
"resolution": "string",
"revision": 0,
"revision_parent_uuid": "string",
"s_object_id": "string",
"s_object_id_bk": "string",
"season_title": "string",
"segment": "string",
"series_name": "string",
"series_number": 0,
"size": "string",
"storage": "hot",
"storage_status": "active",
"synopsis": "string",
"synopsis_short": "string",
"tags": [{"id": 0,
"name": "string",
"value": "string"
}
],
"tape_no": "string",
"theme": "string",
"theme_code": "string",
"thumbnail_processing": true,
"thumbnails": [{"contentType": "string",
"details": {"height": 0,
"interval": 0,
"width": 0
},
"type": "external",
"url": "string"
}
],
"timecode_in": "string",
"timecode_out": "string",
"timecode_start": "string",
"transcriptions": ["string"
],
"tx_date": "string",
"type": "string",
"upload_source": "Launchpad",
"uploaded_at": "string",
"uploaded_by": "string",
"uuid": "string",
"variation": "string",
"version": "string",
"vida_number": "string",
"vida_resolution": "string",
"video_codec": "string",
"video_codec_mapping": "string",
"video_codec_name": "string",
"video_duration": 0,
"video_interlacing_analysis_result": "string",
"width": 0
}
]

Set Assets as Cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

assets

required

Array of strings

List of asset uuids

Responses

Request samples

Payload

Content type

application/json

{"assets": ["string"
]
}

Response samples

Content type

application/json

true

Set Search Assets as cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

advanced_mode	boolean Flag indicating whether advanced search mode is enabled
discount_code	string
fields	Array of strings List of specific fields to include in the search results
	object (AssetSearchFiltersTypeV2) Filters applied to narrow down the search results
text	string Text input for searching assets

Responses

Request samples

Payload

Content type

application/json

{"advanced_mode": true,
"discount_code": "string",
"fields": ["string"
],
"filters": {"alt_no": ["string"
],
"aspect_ratio": ["string"
],
"audio_tracks_class": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"bit_depth": [0
],
"bitrate": {"from": 0,
"to": 0
},
"bitrate_mode": ["string"
],
"category": ["string"
],
"chroma_format": ["string"
],
"clean_aperture": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"cold_only": true,
"collection_uuid": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_primaries": ["string"
],
"color_space": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_duration": {"from": 0,
"to": 0
},
"container_format": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"delivery_pack_name": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"encoded_pixels": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"format": ["string"
],
"framerate": ["string"
],
"genre": ["string"
],
"height": [0
],
"image_aspect": ["string"
],
"ingest_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"interlace_mode": ["string"
],
"inventory_type": ["string"
],
"is_deleted": true,
"is_dirty": true,
"is_preview_app_enabled": true,
"is_purged": true,
"is_quarantined": true,
"is_virtual": true,
"language": ["string"
],
"legacy_ingest_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"library_sales_rights": true,
"licensed_package_uuids": ["string"
],
"metadata_sub_type": ["string"
],
"multiversion": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"origin": ["string"
],
"orphan_filter": "string",
"physical_version_description": ["string"
],
"physical_version_title": ["string"
],
"pixel_aspect_ratio": [0
],
"player_offset": {"from": 0,
"to": 0
},
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"profile": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"revision": [0
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"storage": ["hot"
],
"synopsis": ["string"
],
"tagsValue": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"transcriptions": ["string"
],
"tx_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"type": ["string"
],
"updated_at": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"upload_source": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"vida_resolution": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"video_duration": {"from": 0,
"to": 0
},
"video_interlacing_analysis_result": ["string"
],
"width": [0
]
},
"text": "string"
}

Response samples

Content type

application/json

true

Set assets as hot

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

assets

required

Array of strings

List of asset uuids

Responses

Request samples

Payload

Content type

application/json

{"assets": ["string"
]
}

Response samples

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string"
}

Get price for set as hot/cold

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

assets required	Array of strings List of asset uuids
department_field_uuid	string
discount_code	string Optional discount code to apply to the search

Responses

Request samples

Payload

Content type

application/json

{"assets": ["string"
],
"department_field_uuid": "string",
"discount_code": "string"
}

Response samples

Content type

application/json

{"currency": "string",
"discount_name": "string",
"discount_prices": {"price_per_gb": 0,
"total_price": 0
},
"discount_status": "active",
"price_per_gb": 0,
"total_assets": 0,
"total_bytes": 0,
"total_price": 0
}

Set Search Assets as hot

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

advanced_mode	boolean Flag indicating whether advanced search mode is enabled
discount_code	string
fields	Array of strings List of specific fields to include in the search results
	object (AssetSearchFiltersTypeV2) Filters applied to narrow down the search results
text	string Text input for searching assets

Responses

Request samples

Payload

Content type

application/json

{"advanced_mode": true,
"discount_code": "string",
"fields": ["string"
],
"filters": {"alt_no": ["string"
],
"aspect_ratio": ["string"
],
"audio_tracks_class": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"bit_depth": [0
],
"bitrate": {"from": 0,
"to": 0
},
"bitrate_mode": ["string"
],
"category": ["string"
],
"chroma_format": ["string"
],
"clean_aperture": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"cold_only": true,
"collection_uuid": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_primaries": ["string"
],
"color_space": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_duration": {"from": 0,
"to": 0
},
"container_format": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"delivery_pack_name": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"encoded_pixels": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"format": ["string"
],
"framerate": ["string"
],
"genre": ["string"
],
"height": [0
],
"image_aspect": ["string"
],
"ingest_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"interlace_mode": ["string"
],
"inventory_type": ["string"
],
"is_deleted": true,
"is_dirty": true,
"is_preview_app_enabled": true,
"is_purged": true,
"is_quarantined": true,
"is_virtual": true,
"language": ["string"
],
"legacy_ingest_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"library_sales_rights": true,
"licensed_package_uuids": ["string"
],
"metadata_sub_type": ["string"
],
"multiversion": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"origin": ["string"
],
"orphan_filter": "string",
"physical_version_description": ["string"
],
"physical_version_title": ["string"
],
"pixel_aspect_ratio": [0
],
"player_offset": {"from": 0,
"to": 0
},
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"profile": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"revision": [0
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"storage": ["hot"
],
"synopsis": ["string"
],
"tagsValue": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"transcriptions": ["string"
],
"tx_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"type": ["string"
],
"updated_at": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"upload_source": ["string"
],
"uuid": ["string"
],
"variation": ["string"
],
"version": ["string"
],
"vida_number": ["string"
],
"vida_resolution": ["string"
],
"video_codec": ["string"
],
"video_codec_mapping": ["string"
],
"video_duration": {"from": 0,
"to": 0
},
"video_interlacing_analysis_result": ["string"
],
"width": [0
]
},
"text": "string"
}

Response samples

Content type

application/json

{"code": 0,
"data": null,
"message": "string",
"name": "string",
"stack": "string"
}

Get price for set as hot/cold from search

Authorizations:

customAuthorizer

header Parameters

vida-client-id

string

Unique Client identifier in the system

Request Body schema: application/json
required

advanced_mode	boolean Flag indicating whether advanced search mode is enabled
department_field_uuid	string
discount_code	string Optional discount code to apply to the search
fields	Array of strings List of specific fields to include in the search results
	object (AssetSearchFiltersTypeV2) Filters applied to narrow down the search results
text	string Text input for searching assets

Responses

Request samples

Payload

Content type

application/json

{"advanced_mode": true,
"department_field_uuid": "string",
"discount_code": "string",
"fields": ["string"
],
"filters": {"alt_no": ["string"
],
"aspect_ratio": ["string"
],
"audio_tracks_class": ["string"
],
"audio_tracks_language": ["string"
],
"audio_tracks_layout": ["string"
],
"bit_depth": [0
],
"bitrate": {"from": 0,
"to": 0
},
"bitrate_mode": ["string"
],
"category": ["string"
],
"chroma_format": ["string"
],
"clean_aperture": ["string"
],
"client_asset_id": ["string"
],
"client_ref": ["string"
],
"cold_only": true,
"collection_uuid": ["string"
],
"color_matrix_coefficients": ["string"
],
"color_primaries": ["string"
],
"color_space": ["string"
],
"color_transfer_characteristics": ["string"
],
"container_duration": {"from": 0,
"to": 0
},
"container_format": ["string"
],
"content_class": ["string"
],
"content_class_id": ["string"
],
"content_type": ["string"
],
"delivery_pack_name": ["string"
],
"description": ["string"
],
"disposition": ["string"
],
"duration": {"from": 0,
"to": 0
},
"elements": ["string"
],
"encoded_pixels": ["string"
],
"episode_name": ["string"
],
"episode_number": [0
],
"external_key": ["string"
],
"facility_of_origin": ["string"
],
"filename": ["string"
],
"format": ["string"
],
"framerate": ["string"
],
"genre": ["string"
],
"height": [0
],
"image_aspect": ["string"
],
"ingest_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"interlace_mode": ["string"
],
"inventory_type": ["string"
],
"is_deleted": true,
"is_dirty": true,
"is_preview_app_enabled": true,
"is_purged": true,
"is_quarantined": true,
"is_virtual": true,
"language": ["string"
],
"legacy_ingest_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"library_sales_rights": true,
"licensed_package_uuids": ["string"
],
"metadata_sub_type": ["string"
],
"multiversion": ["string"
],
"note": ["string"
],
"note_truncated": ["string"
],
"object_id": ["string"
],
"origin": ["string"
],
"orphan_filter": "string",
"physical_version_description": ["string"
],
"physical_version_title": ["string"
],
"pixel_aspect_ratio": [0
],
"player_offset": {"from": 0,
"to": 0
},
"processing_status": ["PLACEHOLDER"
],
"production_company": ["string"
],
"production_no": ["string"
],
"profile": ["string"
],
"programme_number": ["string"
],
"ratings": ["string"
],
"release_year": [0
],
"resolution": ["string"
],
"revision": [0
],
"season_title": ["string"
],
"segments": ["string"
],
"series_name": ["string"
],
"series_number": [0
],
"size": {"from": 0,
"to": 0
},
"stage": ["string"
],
"storage": ["hot"
],
"synopsis": ["string"
],
"tagsValue": ["string"
],
"tape_no": ["string"
],
"theme": ["string"
],
"theme_code": ["string"
],
"timecode_start": {"from": 0,
"to": 0
},
"transcriptions": ["string"
],
"tx_date": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"type": ["string"
],
"updated_at": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"upload_source": ["string"
],
"uuid": [

VIDA Backend API (1.0.0)

Welcome to the Vida API

Authentication

Assets

Get details for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update an Asset

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an Asset

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get subtitles for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get a Hybrik Analyze for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get a playlist for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get a Hybrik QA for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Get pdf with an Asset details

Authorizations:

path Parameters

header Parameters

Responses

Response samples

List Asset Storage Logs

Authorizations:

path Parameters

header Parameters

Responses

Response samples

List an Asset Storage Statuses

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get transcriptions for an Asset

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Upload to Vimeo

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get historical asset locks which represent successful edits by users

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required