VIDA
API docs by Redocly

VIDA Backend API (1.0.0)

Download OpenAPI specification:

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.

List Assets details

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

uuids
Array of arrays

UUIDs

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assets update

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
filename
required
string

File name

Responses

Request samples

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
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
deleteUploadJobs
boolean

Delete upload jobs

deleteReason
required
string

Reason for deletion

deletionBillable
required
boolean

Is deletion billable

assetUuids
required
Array of strings

List of asset uuids

Responses

Request samples

Content type
application/json
{
  • "deleteUploadJobs": true,
  • "deleteReason": "string",
  • "deletionBillable": true,
  • "assetUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Get thumbnail URLs for multiple assets by UUID

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uuids
required
Array of strings

List of asset UUIDs to fetch thumbnails for

Responses

Request samples

Content type
application/json
{
  • "uuids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

List all assets

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Archived Assets

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ingested Assets

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List latest Assets

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate Mediapulse JSON for Assets

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "message": "Accepted"
}

List All Assets on map

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
polyenc
required
string

Assets Poly

Responses

Request samples

Content type
application/json
{
  • "polyenc": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Request assets deletion

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
delete_reason
required
string

Delete reason for the asset

asset_uuids
required
Array of strings

List of asset uuids

Responses

Request samples

Content type
application/json
{
  • "delete_reason": "string",
  • "asset_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "actionUuid": "string"
}

Set Assets as Cold

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
assets
required
Array of strings

List of asset uuids

forceMoveToCold
boolean

Force move to cold

Responses

Request samples

Content type
application/json
{
  • "assets": [
    ],
  • "forceMoveToCold": true
}

Response samples

Content type
application/json
true

Set Search Assets as cold

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
text
string

Text input for searching assets

object (AssetSearchFiltersTypeV2)

Filters applied to narrow down the search results

fields
Array of strings

List of specific fields to include in the search results

advanced_mode
boolean

Flag indicating whether advanced search mode is enabled

forceMoveToCold
boolean

Allows setting assets as cold only while bypassing proxy/waveform validation errors

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "filters": {
    },
  • "fields": [
    ],
  • "advanced_mode": true,
  • "forceMoveToCold": true
}

Response samples

Content type
application/json
true

Set assets as hot

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
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

Content type
application/json
{
  • "assets": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Get price for set as hot/cold

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
discount_code
string

Optional discount code to apply to the search

assets
required
Array of strings

List of asset uuids

department_field_uuid
string

Optional department field uuid

Responses

Request samples

Content type
application/json
{
  • "discount_code": "string",
  • "assets": [
    ],
  • "department_field_uuid": "string"
}

Response samples

Content type
application/json
{
  • "currency": "string",
  • "discount_name": "string",
  • "discount_prices": {
    },
  • "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
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
text
string

Text input for searching assets

object (AssetSearchFiltersTypeV2)

Filters applied to narrow down the search results

fields
Array of strings

List of specific fields to include in the search results

advanced_mode
boolean

Flag indicating whether advanced search mode is enabled

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "filters": {
    },
  • "fields": [
    ],
  • "advanced_mode": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Get price for set as hot/cold from search

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
discount_code
string

Optional discount code to apply to the search

text
string

Text input for searching assets

object (AssetSearchFiltersTypeV2)

Filters applied to narrow down the search results

fields
Array of strings

List of specific fields to include in the search results

advanced_mode
boolean

Flag indicating whether advanced search mode is enabled

department_field_uuid
string

Optional department field uuid

Responses

Request samples

Content type
application/json
{
  • "discount_code": "string",
  • "text": "string",
  • "filters": {
    },
  • "fields": [
    ],
  • "advanced_mode": true,
  • "department_field_uuid": "string"
}

Response samples

Content type
application/json
{
  • "currency": "string",
  • "discount_name": "string",
  • "discount_prices": {
    },
  • "discount_status": "active",
  • "price_per_gb": 0,
  • "total_assets": 0,
  • "total_bytes": 0,
  • "total_price": 0
}

Batch Assets update

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
assets
required
Array of strings

List of asset identifiers to be updated

required
object (PatchAssetToAssetType)

Payload containing the update details for the assets

Responses

Request samples

Content type
application/json
{
  • "assets": [
    ],
  • "payload": {
    }
}

Request asset deletion

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
asset_uuids
required
Array of strings

List of asset uuids

Responses

Request samples

Content type
application/json
{
  • "asset_uuids": [
    ]
}

Response samples

Content type
application/json
true

Export a list of assets in landingpad

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Force ingest of landingpad assets

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
filekeys
required
Array of strings

List of s3 file keys

Responses

Request samples

Content type
application/json
{
  • "filekeys": [
    ]
}

Delete landingpad assets

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
filekeys
required
Array of strings

List of s3 file keys

Responses

Request samples

Content type
application/json
{
  • "filekeys": [
    ]
}

Get details for an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

origin
string

Asset origin

source
enum

Source of request

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "additional": {
    },
  • "attachments": [
    ],
  • "audioTracks": [
    ],
  • "core": {
    },
  • "ext_asset_info": {
    },
  • "ext_title_info": {
    },
  • "file_metadata": {
    },
  • "general": {
    },
  • "locks": [
    ],
  • "logginginfo": [
    ],
  • "mediaset": {
    },
  • "transactions": [
    ],
  • "user_media_data": {
    }
}

Update an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
object (GeneralProperty)

General property

object (CoreProperty)

Core asset information

object (PatchAssetUserMediaData)

User media data associated with the asset

Array of objects (PatchAssetAudioTrack)

Audio tracks associated with the asset

object (PatchAssetAdditional)

Additional asset details

object (PatchAssetExtTitleInfo)

Extended title information related to the asset

object (PatchAssetExtAssetInfo)

Extended asset information such as licensing and metadata

object (PatchAssetMediaSet)

Mediaset details

Responses

Request samples

Content type
application/json
{
  • "general": {
    },
  • "core": {
    },
  • "user_media_data": {
    },
  • "audioTracks": [
    ],
  • "additional": {
    },
  • "ext_title_info": {
    },
  • "ext_asset_info": {
    },
  • "mediaset": {
    }
}

Response samples

Content type
application/json
{
  • "additional": {
    },
  • "attachments": [
    ],
  • "audioTracks": [
    ],
  • "core": {
    },
  • "ext_asset_info": {
    },
  • "ext_title_info": {
    },
  • "file_metadata": {
    },
  • "general": {
    },
  • "locks": [
    ],
  • "logginginfo": [
    ],
  • "mediaset": {
    },
  • "transactions": [
    ],
  • "user_media_data": {
    }
}

Delete an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
deleteUploadJobs
boolean

Delete upload jobs

deleteReason
required
string

Reason for deletion

deletionBillable
required
boolean

Is deletion billable

assetUuids
required
Array of strings

List of asset uuids

Responses

Request samples

Content type
application/json
{
  • "deleteUploadJobs": true,
  • "deleteReason": "string",
  • "deletionBillable": true,
  • "assetUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Get download proxy for Timed Texts

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Get a Hybrik Analyze for an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

source
enum

Source of request

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "deep_properties": {
    },
  • "general_properties": {
    },
  • "hybrik_profile": {
    }
}

Get a playlist for an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

origin
string

Asset origin

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
"string"

Get a list of related Assets

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

source
enum

Source of request

Cache-Control
object

Overrides default cache behaviour.

Responses

Patch related assets

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
attach
required
Array of strings

List of array relations to attach

detach
required
Array of strings

List of array relations to detach

Responses

Request samples

Content type
application/json
{
  • "attach": [
    ],
  • "detach": [
    ]
}

Get a list of possibly related Assets

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Patch related assets

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uuid
required
string

Unique identifier for the dependant asset

relationPlayerOffset
required
string

player offset for the dependant asset

isOffsetBackward
required
boolean

is offset backward for the dependant asset

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "relationPlayerOffset": "string",
  • "isOffsetBackward": true
}

Get a Hybrik QA for an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Get a PDF with an Asset details

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

origin
string

Asset origin

source
enum

Source of request

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Get a QC Report with an requested data

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

source
enum

Source of request

Request Body schema: application/json
required
required
object (QCReportHeader)

Data for headers

required
object (QCReportOverview)

Data for overview worksheet

object (QCReportVideoErrors)

Data for video errors worksheet

object (QCReportAudioErrors)

Data for audio errors worksheet

object (QCReportInSceneTextLog)

Data for in-scene text log worksheet

object (QCReportRecommendations)

Data for recommendations worksheet

gradeRegion
required
string
Enum: "us" "eu"

Grade region for the report

workspace
required
string

Workspace for url

projectUuid
string

QC Project UUID. If passed, asset links will redirect to the QC project view

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "overviewSheet": {
    },
  • "videoErrorsSheet": {
    },
  • "audioErrorsSheet": {
    },
  • "inSceneTextLogSheet": {
    },
  • "recommendationsSheet": {
    },
  • "gradeRegion": "us",
  • "workspace": "string",
  • "projectUuid": "string"
}

Response samples

Content type
application/json
{
  • "url": "string"
}

List Asset Storage Logs

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List an Asset Storage Statuses

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "s3Status": "string",
  • "wasabiStatus": "string"
}

Get transcriptions for an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Upload to Vimeo

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

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

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Get details of before / after state of the asset lock

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "after": [
    ],
  • "before": [
    ]
}

Lock an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

type
required
enum

Type of data to be locked for edits

confirm
string

Confirm take over of existing lock by another user

action
required
enum

Action type to perform with lock

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
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uuid
required
string

Unique identifier for the asset

batchId
required
string

Identifier for the batch to which this asset belongs

originalFilename
required
string

Original name of the file uploaded by the user

internalFilename
required
string

Internal filename used within the system

series_title
string

Series title of the asset

Array of objects (AssetTagType)

Tags associated with the asset

star_rating
number

Star rating of the asset

object (AssetCoords)

Coordinates of the asset

contentType
string

Content type of the asset

tapeNumber
string

Tape number of the asset

coldOnly
boolean

Flag indicating if the asset can be stored only in cold storage

processingStatus
string
Enum: "PLACEHOLDER" "CREATED" "INITIALIZING" "REUPLOADED" "ANALYSE_REUPLOADED" "PRORES_REUPLOADED" "AWAITING_ANALYSE" "CREATING_PRORES" "ASPERA_LANDINGPAD_COPY" "ANALYSE" "CREATING_PROXY" "CREATING_STREAM" "DONE" "ERROR" "QA_FAILED" "DELETED"

Processing status of the asset

type
string
Enum: "video" "audio" "image" "subtitle" "archive" "document" "other" "font"

Type of the asset

externalKey
string

External key associated with the asset

sObjectID
string

Salesforce object ID associated with the asset

uploadSource
string
Enum: "Launchpad" "VIDA UI" "Landingpad"

Upload source of the asset

theme
string

Theme of the asset

contentClass
string

Content class of the asset

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "batchId": "string",
  • "originalFilename": "string",
  • "internalFilename": "string",
  • "series_title": "string",
  • "tags": [
    ],
  • "star_rating": 0,
  • "coords": {
    },
  • "contentType": "string",
  • "tapeNumber": "string",
  • "coldOnly": true,
  • "processingStatus": "PLACEHOLDER",
  • "type": "video",
  • "externalKey": "string",
  • "sObjectID": "string",
  • "uploadSource": "Launchpad",
  • "theme": "string",
  • "contentClass": "string"
}

Response samples

Content type
application/json
{
  • "AbortDate": "2019-08-24T14:15:22Z",
  • "AbortRuleId": "string",
  • "Bucket": "string",
  • "BucketKeyEnabled": true,
  • "ChecksumAlgorithm": "CRC32",
  • "Key": "string",
  • "RequestCharged": "requester",
  • "SSECustomerAlgorithm": "string",
  • "SSECustomerKeyMD5": "string",
  • "SSEKMSEncryptionContext": "string",
  • "SSEKMSKeyId": "string",
  • "ServerSideEncryption": "AES256",
  • "UploadId": "string"
}

Add a File to an Asset from Aspera

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
batchId
required
string

Batch identifier

originalFilename
required
string

Original filename of the asset

internalFilename
required
string

Internal filename used within the system for the asset

sourcePath
required
string

Source path where the asset is stored

Responses

Request samples

Content type
application/json
{
  • "batchId": "string",
  • "originalFilename": "string",
  • "internalFilename": "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

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

origin
string

Asset origin

Request Body schema: application/json
required
contact_uuid
string

UUID of the contact associated with the download proxy

opportunity_uuid
string

UUID of the opportunity associated with the download proxy

contact_name
string

Name of the contact associated with the download proxy

opportunity_name
string

Name of the opportunity associated with the download proxy

Responses

Request samples

Content type
application/json
{
  • "contact_uuid": "string",
  • "opportunity_uuid": "string",
  • "contact_name": "string",
  • "opportunity_name": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "urls": [
    ]
}

Register to Rasp

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "expired_at": "2019-08-24T14:15:22Z",
  • "ruid": "string"
}

Delete from Rasp register

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Request asset deletion

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
delete_reason
required
string

Delete reason for the asset

Responses

Request samples

Content type
application/json
{
  • "delete_reason": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "reason": "string",
  • "updatedAt": "string",
  • "uuid": "string"
}

Request asset deletion

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
true

Create an Asset Trailer

Trailer is created from asset clips.

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
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

Content type
application/json
{
  • "imgCount": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Create an Asset Trailer

Trailer is created from images.

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
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

Content type
application/json
{
  • "imgCount": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Create transcription for an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
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 (PostJobOptions)

Optional job options, including tone settings

trackNumber
string

Optional track number associated with the job

speed
string

Transcription Whisper Speed

sourceLanguage
string

Transcription Whisper Source Language of asset

trackId
number

Audio track id for the job

Responses

Request samples

Content type
application/json
{
  • "modelUuid": "string",
  • "options": {
    },
  • "trackNumber": "string",
  • "speed": "string",
  • "sourceLanguage": "string",
  • "trackId": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Abort an upload

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
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

Content type
application/json
{
  • "uploadId": "string"
}

Response samples

Content type
application/json
{
  • "RequestCharged": "requester"
}

Complete an upload

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uploadId
required
string

The ID of the upload session

required
Array of objects (UploadAssetCompletePart)

List of uploaded parts

Responses

Request samples

Content type
application/json
{
  • "uploadId": "string",
  • "parts": [
    ]
}

Response samples

Content type
application/json
{
  • "Bucket": "string",
  • "BucketKeyEnabled": true,
  • "ChecksumCRC32": "string",
  • "ChecksumCRC32C": "string",
  • "ChecksumSHA1": "string",
  • "ChecksumSHA256": "string",
  • "ETag": "string",
  • "Expiration": "string",
  • "Key": "string",
  • "Location": "string",
  • "RequestCharged": "requester",
  • "SSEKMSKeyId": "string",
  • "ServerSideEncryption": "AES256",
  • "VersionId": "string"
}

Create an upload part

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uploadId
required
string

Unique identifier for the upload

partNumber
required
number

The part number of the uploaded

Responses

Request samples

Content type
application/json
{
  • "uploadId": "string",
  • "partNumber": 0
}

Response samples

Content type
application/json
"string"

Create a Virtual Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
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

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
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (PostAsperaAssetToAsset)

List of files for aspera

deliveryPackUuid
string

Optional delivery pack UUID

Responses

Request samples

Content type
application/json
{
  • "files": [
    ],
  • "deliveryPackUuid": "string"
}

Response samples

Content type
application/json
{
  • "cookie": "string",
  • "destinationRoot": "string",
  • "token": "string"
}

Generate and publish asset version differences

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Detect audio language

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Update an Asset embargo date

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
object (GeneralProperty)

General property

object (CoreProperty)

Core asset information

object (PatchAssetUserMediaData)

User media data associated with the asset

Array of objects (PatchAssetAudioTrack)

Audio tracks associated with the asset

object (PatchAssetAdditional)

Additional asset details

object (PatchAssetExtTitleInfo)

Extended title information related to the asset

object (PatchAssetExtAssetInfo)

Extended asset information such as licensing and metadata

object (PatchAssetMediaSet)

Mediaset details

Responses

Request samples

Content type
application/json
{
  • "general": {
    },
  • "core": {
    },
  • "user_media_data": {
    },
  • "audioTracks": [
    ],
  • "additional": {
    },
  • "ext_title_info": {
    },
  • "ext_asset_info": {
    },
  • "mediaset": {
    }
}

Response samples

Content type
application/json
true

Toggle QC report visibility to the client for a QC Project asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Response samples

Content type
application/json
true

Regenerate an Asset Proxy

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

List archive contents from an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Regenerate HLS Audio for an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Get asset archive contents

Authorizations:
customAuthorizer
path Parameters
type
required
string

Export type

uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Finish an Aspera Upload

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
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

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",
  • "type": "EntityNotFoundError"
}

Get asset comments

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

source
enum

Source of request

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "cookie": "string",
  • "paths": [
    ],
  • "token": "string"
}

Create an asset comment

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uuid
required
string

Unique identifier for the comment

body
required
string

Comment body text

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "body": "string"
}

Response samples

Content type
application/json
"string"

Soft-delete a comment on an asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

commentUuid
required
string

UUID of comment

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Edit a comment on an asset — atomically soft-deletes the original and creates a new one

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

commentUuid
required
string

UUID of comment

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
body
required
string

New comment body text

Responses

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "body": "string",
  • "created_at": "string",
  • "entity_id": "string",
  • "entity_type": "order",
  • "group": {
    },
  • "updated_at": "string",
  • "user": {
    },
  • "uuid": "string"
}

Get orders for an Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "hasPendingOrders": true,
  • "orders": [
    ],
  • "total": 0
}

Bulk Operations

Manage bulk operations

Cancel a bulk operation

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Cart

Create and manage Carts.

List Assets in a Cart

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

embargoed
required
string

Filter by embargoed

quarantined
required
string

Filter by quarantined

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count Items in a Cart

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
0
0

List Cart extra

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

List prices for a Cart

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
Array of objects (PostCartSummaryDestinations)

List of destination configurations, each with a unique identifier

Array of objects (JobTypePayloadInterface)

List of jobs associated with the cart

discount_code
string

Optional discount code applied to the cart

order_type
string
Enum: "delivery_destination" "email_delivery" "workflow" "warm_up" "external_workflow"

Type of order being placed

delivery_emails
Array of strings

List of email addresses for delivery notifications

download_limit
number

Maximum number of downloads allowed for this order

department_field_uuid
string

Department field UUID

restore_tier
string

Restore tier

Responses

Request samples

Content type
application/json
{
  • "destinations": [
    ],
  • "jobs": [
    ],
  • "discount_code": "string",
  • "order_type": "delivery_destination",
  • "delivery_emails": [
    ],
  • "download_limit": 0,
  • "department_field_uuid": "string",
  • "restore_tier": "string"
}

Response samples

Content type
application/json
{
  • "cold": 0,
  • "discount_name": "string",
  • "discount_prices": {
    },
  • "discount_status": "active",
  • "formulas": {
    },
  • "in_progress_cold": 0,
  • "price": {
    },
  • "restore_speed": "default",
  • "settings": {
    },
  • "structuredFormulas": [
    ],
  • "total": 0
}

List items with filename conventions

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
order_package_title
required
string

Title of the package

order_no
required
string

Order number

required
object (ConventionDataFilenamesForCartPayloadType)

List of filenames for the cart

Responses

Request samples

Content type
application/json
{
  • "order_package_title": "string",
  • "order_no": "string",
  • "overridden_conventions_data": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Validate Items in a Cart

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
order_type
required
string
Enum: "delivery_destination" "email_delivery" "workflow" "warm_up" "external_workflow"

Type of order

Responses

Request samples

Content type
application/json
{
  • "order_type": "delivery_destination"
}

Response samples

Content type
application/json
[ ]

Add search to a Cart

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
text
string

Text input for searching assets

object (AssetSearchFiltersTypeV2)

Filters applied to narrow down the search results

fields
Array of strings

List of specific fields to include in the search results

advanced_mode
boolean

Flag indicating whether advanced search mode is enabled

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "filters": {
    },
  • "fields": [
    ],
  • "advanced_mode": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Add Items to a Cart

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
Array
type
required
string
Enum: "asset" "collection" "order"

The type of the item

entity_uuid
required
string

The UUID of the entity

required
object (PostOrderItemExtra)

Additional information for the order item (optional)

item_uuids
Array of strings

List of item UUIDs (optional, used for type === order)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Delete Items from a Cart

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Create a fast order cart

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Response samples

Content type
application/json
{
  • "cart_uuid": "string"
}

Collections

Create and manage Collections

List Collections details

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
string

Filter

views-date-from
required
string

Views date from

views-date-to
required
string

Views date to

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List my collections details

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
string

Filter

views-date-from
required
string

Views date from

views-date-to
required
string

Views date to

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List shared collections details

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
string

Filter

views-date-from
required
string

Views date from

views-date-to
required
string

Views date to

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/collections/searchV2

Authorizations:
customAuthorizer
Request Body schema: application/json
required
accessType
string (CollectionSearchAccessType)
Enum: "all" "my" "shared"
object (CollectionSearchFilters)

Responses

Request samples

Content type
application/json
{
  • "accessType": "all",
  • "filters": {
    }
}

Search Collections with Dynamic Filtering

Search collections with flexible filtering and sorting. Supports three access types: all (all accessible collections), my (collections owned by user), shared (collections shared with user).

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
page
number

Page number (0-indexed)

perPage
number

Items per page

accessType
string
Enum: "all" "my" "shared"

Access type filter: all (all accessible), my (owned by user), shared (shared with user)

object (DynamicFilterRequestDTO)

Dynamic filter request

object (DynamicSortRequestDTO)

Dynamic sort request

text
string

Legacy text filter (for backward compatibility)

viewsDateFrom
string

Legacy views date from filter (for backward compatibility)

viewsDateTo
string

Legacy views date to filter (for backward compatibility)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "accessType": "all",
  • "filters": {
    },
  • "sort": {
    },
  • "text": "string",
  • "viewsDateFrom": "string",
  • "viewsDateTo": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get a Collection

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "description": "string",
  • "inherit_access": true,
  • "is_public": true,
  • "items": [
    ],
  • "name": "string",
  • "number_of_assets": 0,
  • "number_of_embargoed": 0,
  • "owner": "string",
  • "owner_name": "string",
  • "shared_to_teams": [
    ],
  • "thumbnails": [
    ],
  • "total": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "users": [
    ],
  • "uuid": "string"
}

Update a Collection

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
name
string

An updated collection name

description
string

An updated collection description

custom_cover
boolean

An updated collection cover

filename
string

An updated collection filename

Array of objects (PatchCollectionItem)

New collection collection items

delete_items
Array of strings

Collection items to delete

owner
string

An updated collection owner

users
Array of strings

An updated collection users

Array of objects (ParentCollection)

An updated collection parent

shared_to_team_uuids
Array of strings

An updated collection shared to team uuids

inherit_access
required
boolean

Inherit access from parent collection

is_public
required
boolean

Anyone can browse this collection

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "custom_cover": true,
  • "filename": "string",
  • "add_items": [
    ],
  • "delete_items": [
    ],
  • "owner": "string",
  • "users": [
    ],
  • "parentIds": [
    ],
  • "shared_to_team_uuids": [
    ],
  • "inherit_access": true,
  • "is_public": true
}

Response samples

Content type
application/json
{
  • "access_type": "owned",
  • "children": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "description": "string",
  • "inherit_access": true,
  • "is_public": true,
  • "name": "string",
  • "number_of_assets": 0,
  • "number_of_embargoed": 0,
  • "number_of_quarantined": 0,
  • "number_of_virtual": 0,
  • "owner": "string",
  • "owner_name": "string",
  • "parents": [
    ],
  • "shared_to_teams": [
    ],
  • "thumbnails": [
    ],
  • "totalViews": 0,
  • "totalViewsRanking": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "users": [
    ],
  • "uuid": "string",
  • "watermark_config": {
    }
}

/collection/{uuid}

Authorizations:
customAuthorizer

Responses

List collection items details

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
required
string

Filter

tx-date-from
required
string

Date from

tx-date-to
required
string

Date to

facility-of-origin
required
string

Facility of origin

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/collection/{uuid}/search

Authorizations:
customAuthorizer
Request Body schema: application/json
required
any (PostSearchTypeV2)

Responses

Request samples

Content type
application/json
null

Export collection items by Elasticsearch assets

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Create a Collection

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uuid
required
string

An unique identifier for a new collection

name
required
string

A name for a new collection

description
required
string

A description of a new collection

inherit_access
required
boolean

Inherit access from parent collection

is_public
required
boolean

Anyone can browse this collection

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "inherit_access": true,
  • "is_public": true
}

Response samples

Content type
application/json
{
  • "access_type": "owned",
  • "children": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "description": "string",
  • "inherit_access": true,
  • "is_public": true,
  • "name": "string",
  • "number_of_assets": 0,
  • "number_of_embargoed": 0,
  • "number_of_quarantined": 0,
  • "number_of_virtual": 0,
  • "owner": "string",
  • "owner_name": "string",
  • "parents": [
    ],
  • "shared_to_teams": [
    ],
  • "thumbnails": [
    ],
  • "totalViews": 0,
  • "totalViewsRanking": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "users": [
    ],
  • "uuid": "string",
  • "watermark_config": {
    }
}

Export collection details

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Request Body schema: application/json
required
fields
required
Array of strings

Field names to export

selected_asset_uuids
Array of strings

Filter assets to export

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "selected_asset_uuids": [
    ]
}

Get Access Type

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
collection_uuids
required
Array of strings

Collection unique identifiers

Responses

Request samples

Content type
application/json
{
  • "collection_uuids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Upload a Collection

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
filename
required
string

A filename for a new collection

file_uuid
required
string

An unique identifier for a new collection

file_type
required
string

A filename for a new collection

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "file_uuid": "string",
  • "file_type": "string"
}

Response samples

Content type
application/json
{
  • "access_type": "owned",
  • "children": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "description": "string",
  • "inherit_access": true,
  • "is_public": true,
  • "name": "string",
  • "number_of_assets": 0,
  • "number_of_embargoed": 0,
  • "number_of_quarantined": 0,
  • "number_of_virtual": 0,
  • "owner": "string",
  • "owner_name": "string",
  • "parents": [
    ],
  • "shared_to_teams": [
    ],
  • "thumbnails": [
    ],
  • "totalViews": 0,
  • "totalViewsRanking": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "users": [
    ],
  • "uuid": "string",
  • "watermark_config": {
    }
}

Create a Collection with confirmation

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
filename
required
string

A filename of a new collection

file_key
required
string

A file key of a new collection

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "file_key": "string"
}

Response samples

Content type
application/json
"string"

Add order to collection

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
order_uuid
required
string

An order uuid

Responses

Request samples

Content type
application/json
{
  • "order_uuid": "string"
}

Add order to collections

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
order_uuid
required
string

An order uuid

collection_uuids
required
Array of strings

Collection unique identifiers

Responses

Request samples

Content type
application/json
{
  • "order_uuid": "string",
  • "collection_uuids": [
    ]
}

Add items to Collection

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (PatchCollectionItem)

New collection items data

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Add items to Collections

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (PatchCollectionItem)

New collection items data

collection_uuids
required
Array of strings

Collection unique identifiers

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "collection_uuids": [
    ]
}

Add Cart Items to Collection

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Add Cart Items to Collections

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
collection_uuids
required
Array of strings

Collection unique identifiers

Responses

Request samples

Content type
application/json
{
  • "collection_uuids": [
    ]
}

Remove subcollection from Collection

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
collection_uuids
required
Array of strings

Collection unique identifiers

Responses

Request samples

Content type
application/json
{
  • "collection_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Creates collection small thumbnail

Creates small thumbnail for collection if it has custom cover

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Add search results to Collection

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
object (PostSearchV2)

A search query

collections
required
Array of strings

Collection list

collection_name
string

Collection name

users
Array of strings

Users unique identifier

Responses

Request samples

Content type
application/json
{
  • "query": {
    },
  • "collections": [
    ],
  • "collection_name": "string",
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Remove items from Collection

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
items
required
Array of strings

Item unique identifiers

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Remove items from multiple Collections

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
items
required
Array of strings

Item unique identifiers

collection_uuids
required
Array of strings

Collection unique identifiers

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "collection_uuids": [
    ]
}

Get a Collection analytics

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "chartData": {
    },
  • "logs": [
    ],
  • "viewsCount30Days": 0,
  • "viewsCountPrevious30Days": 0
}

Get a Collection analytics log

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

views-date-from
required
string

Views date from

views-date-to
required
string

Views date to

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export collection analytics logs

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

views-date-from
required
string

Views date from

views-date-to
required
string

Views date to

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Request Body schema: application/json
required
fields
required
Array of strings

Field names to export

selected_asset_uuids
Array of strings

Filter assets to export

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "selected_asset_uuids": [
    ]
}

Delivery Destinations

Create and manage Delivery Destinations.

Get Paginated Delivery Destinations

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
string

Filter by name

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one Delivery Destination

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "status": "draft",
  • "email": {
    },
  • "configs": [
    ],
  • "publish": {
    },
  • "filenameConventions": {
    },
  • "allowFilenameOverrideInCart": true,
  • "type": "file"
}

Edit a Delivery Destination

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
name
required
string

Name of Delivery Destination

status
required
string
Enum: "draft" "active"

Status of delivery

required
object (DeliveryDestinationEmailInput)

Mailing lists to send notifications and links

required
Array of objects (DeliveryDestinationConfigInput)

Delivery Destination configurations

object (PublishForDeliveryDestinationInput)

Publish option for all configs

object (DeliveryDestinationFilenameConventionsInput)

Filename Conventions configuration

allowFilenameOverrideInCart
boolean

Allow filename override in cart

type
required
string
Enum: "file" "title"

Type of delivery

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "draft",
  • "email": {
    },
  • "configs": [
    ],
  • "publish": {
    },
  • "filenameConventions": {
    },
  • "allowFilenameOverrideInCart": true,
  • "type": "file"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "status": "draft",
  • "email": {
    },
  • "configs": [
    ],
  • "publish": {
    },
  • "filenameConventions": {
    },
  • "allowFilenameOverrideInCart": true,
  • "type": "file"
}

Delete chosen Delivery Destination

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Create new Delivery Destination

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
name
required
string

Name of Delivery Destination

status
required
string
Enum: "draft" "active"

Status of delivery

required
object (DeliveryDestinationEmailInput)

Mailing lists to send notifications and links

required
Array of objects (DeliveryDestinationConfigInput)

Delivery Destination configurations

object (PublishForDeliveryDestinationInput)

Publish option for all configs

object (DeliveryDestinationFilenameConventionsInput)

Filename Conventions configuration

allowFilenameOverrideInCart
boolean

Allow filename override in cart

type
required
string
Enum: "file" "title"

Type of delivery

uuid
required
string

UUID of Delivery Destination

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "draft",
  • "email": {
    },
  • "configs": [
    ],
  • "publish": {
    },
  • "filenameConventions": {
    },
  • "allowFilenameOverrideInCart": true,
  • "type": "file",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "status": "draft",
  • "email": {
    },
  • "configs": [
    ],
  • "publish": {
    },
  • "filenameConventions": {
    },
  • "allowFilenameOverrideInCart": true,
  • "type": "file"
}

Returns targets for chosen type of Delivery Destination

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
type
required
string
Enum: "youtube-vimeo" "youtube-vimeo-2" "youtube-vimeo-3" "youtube-vimeo-4" "youtube-vimeo-5" "youtube-vimeo-6" "itunes" "itunes-2" "itunes-3" "itunes-4" "itunes-5" "itunes-6" "itunes-7" "itunes-8" "xdcam" "xdcam-2" "xdcam-3" "xdcam-4" "xdcam-5" "xdcam-6" "hls" "clip" "complex"

Type of transcode

Array of objects (AudioTrackForNormalTranscodeInput)

Audio tracks

object (ComplexInfoForTranscodeInput)

Complex info for transcode

required
object (HybrikTranscodeOptionsForTargetGenerationInput)

Hybrik transcode options for target generation

Responses

Request samples

Content type
application/json
{
  • "type": "youtube-vimeo",
  • "audioTracks": [
    ],
  • "complexInfo": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "generatedTargets": [
    ],
  • "definitions": [
    ]
}

Licensed Packages

Create and manage Licensed Packages.

List Licensed Packages

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
required
Array of arrays

Filters Licensed Packages, Keyword for filter in name, description and external reference

status
enum

Filters Licensed Packages, status can be draft or active

view-state
enum

Filters Licensed Packages, view-state can be none, promo, hero or pinned

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

contract_in
string

Contract in

contract_out
string

Contract out

expires_before
string

Expires before

contract_uuids
Array of arrays

Filters Licensed Packages, List of contract unique identifiers

partner_uuids
Array of arrays

Filters Licensed Packages, List of partners unique identifiers

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/licensed-packages/searchV2

Authorizations:
customAuthorizer
Request Body schema: application/json
required
object (LicensedPackageSearchFilters)

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

/licensed-package/{uuid}/search

Authorizations:
customAuthorizer
Request Body schema: application/json
required
any (PostSearchTypeV2)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Export licensed package assets by Elasticsearch

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

List Licensed Packages for Connect2

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
required
Array of arrays

Filters Licensed Packages, Keyword for filter in name, description and external reference

status
enum

Filters Licensed Packages, status can be draft or active

view-state
enum

Filters Licensed Packages, view-state can be none, promo, hero or pinned

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

expires_before
string

Expires before

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Licensed Package

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "contracts": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "description": "string",
  • "external_reference": "string",
  • "items": [
    ],
  • "max_expires_at": "string",
  • "name": "string",
  • "number_of_assets": 0,
  • "number_of_embargoed_assets": 0,
  • "options": {
    },
  • "owner": "string",
  • "owner_name": "string",
  • "status": "string",
  • "total": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "view_state": "string"
}

Update a Licensed Package

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
status
required
string
Enum: "draft" "active"

Status of the licensed package

external_reference
string

External reference identifier for linking to upstream or client-owned systems

custom_cover
boolean

Indicates whether a custom cover is used

custom_cover_path
string

Path to the custom cover image

contract_uuids
required
Array of strings

List of contract UUIDs associated with the licensed package

Responses

Request samples

Content type
application/json
{
  • "status": "draft",
  • "external_reference": "string",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "contract_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "contracts": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "description": "string",
  • "external_reference": "string",
  • "items": [
    ],
  • "max_expires_at": "string",
  • "name": "string",
  • "number_of_assets": 0,
  • "number_of_embargoed_assets": 0,
  • "options": {
    },
  • "owner": "string",
  • "owner_name": "string",
  • "status": "string",
  • "total": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "view_state": "string"
}

Delete a Licensed Package

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Get a Licensed Package for Connect2

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "contracts": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "description": "string",
  • "external_reference": "string",
  • "items": [
    ],
  • "max_expires_at": "string",
  • "name": "string",
  • "number_of_assets": 0,
  • "number_of_embargoed_assets": 0,
  • "options": {
    },
  • "owner": "string",
  • "owner_name": "string",
  • "status": "string",
  • "total": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "view_state": "string"
}

List Licensed Package Items

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

downloaded
string

Is downloaded

tx-date-from
string

Date from

tx-date-to
string

Date to

facility-of-origin
string

Facility of origin

type
string

Type

text
string

Text to filter

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Licensed Package Items for Connect2

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

downloaded
string

Is downloaded

tx-date-from
string

Date from

tx-date-to
string

Date to

facility-of-origin
string

Facility of origin

type
string

Type

text
string

Text to filter

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Licensed Package Users from Rights Contracts with accessible content

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

text
string

Text to filter

mail
string

User email

partner-id
string

Partner id

supplier-uuid
string

Supplier uuid

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Licensed Package

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
name
required
string

Name of the licensed package

description
required
string

Description of the licensed package

external_reference
string

External reference identifier for linking to upstream or client-owned systems

view_state
required
string
Enum: "none" "promo" "hero" "pinned"

Current view state of the licensed package

required
object (LicensedPackageOptions)

Options and settings for the licensed package

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "external_reference": "string",
  • "view_state": "none",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "contracts": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_cover": true,
  • "custom_cover_path": "string",
  • "description": "string",
  • "external_reference": "string",
  • "items": [
    ],
  • "max_expires_at": "string",
  • "name": "string",
  • "number_of_assets": 0,
  • "number_of_embargoed_assets": 0,
  • "options": {
    },
  • "owner": "string",
  • "owner_name": "string",
  • "status": "string",
  • "total": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "string",
  • "view_state": "string"
}

Download Setup for a Licensed Package

Creates a download setup for a Licensed Package or a download setup for Licensed Package Items if Asset uuids or Licensed Package Item uuids are given.

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
download_uuids
Array of strings

List of licensed packages UUIDs for the download

download_asset_uuids
Array of strings

List of asset UUIDs for the downloaded

keep_folders_structure
boolean

Indicates whether to preserve the folder structure during download

required
object (PostSearchV2)

Search criteria for selecting licensed packages to download

partner_uuid
required
string

UUID of the partner initiating the download

download_type
required
string
Enum: "ASPERA" "HTTPS"

Type of download

Responses

Request samples

Content type
application/json
{
  • "download_uuids": [
    ],
  • "download_asset_uuids": [
    ],
  • "keep_folders_structure": true,
  • "search": {
    },
  • "partner_uuid": "string",
  • "download_type": "ASPERA"
}

Response samples

Content type
application/json
{
  • "cookie": "string",
  • "faspPort": 0,
  • "paths": [
    ],
  • "remoteHost": "string",
  • "remoteUser": "string",
  • "sshPort": 0,
  • "token": "string",
  • "transferUuid": "string"
}

List Licensed Package Items download availability

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
asset_uuids
required
Array of strings

List of asset UUIDs that will be checked, if empty array, will return for all items

Responses

Request samples

Content type
application/json
{
  • "asset_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": true,
  • "property2": true
}

List Licensed Package Partners

Returns list of a valid Partners for a Licensed Package with the information if the Partner can still download this LicensedPackage. Download availability is based on Download Limit. If anything can be downloaded from Licensed Package canBeDownloaded will be return as true.

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
asset_uuids
Array of strings

List of asset UUIDs that will be downloaded

Responses

Request samples

Content type
application/json
{
  • "asset_uuids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Trigger Notification for a Licensed Package

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
asset_uuids
required
Array of strings

List of asset UUIDs associated with the licensed package notification

emails
required
Array of strings

List of email addresses to send the notification to

rights_contract_uuids
required
Array of strings

List of rights contract UUIDs associated with the licensed package notification

Responses

Request samples

Content type
application/json
{
  • "asset_uuids": [
    ],
  • "emails": [
    ],
  • "rights_contract_uuids": [
    ]
}

Add items to Licensed Package

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (PatchLicensedPackageItem)

List of asset uuids and notes

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Add items to Licensed Packages

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (PatchLicensedPackageItem)

List of asset uuids and notes

licensed_package_uuids
required
Array of strings

Licensed Package unique identifiers

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "licensed_package_uuids": [
    ]
}

Add search to Licensed Package

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
text
string

Text input for searching assets

object (AssetSearchFiltersTypeV2)

Filters applied to narrow down the search results

fields
Array of strings

List of specific fields to include in the search results

advanced_mode
boolean

Flag indicating whether advanced search mode is enabled

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "filters": {
    },
  • "fields": [
    ],
  • "advanced_mode": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Delete items from Licensed Package

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
items
required
Array of strings

List of asset UUIDs to remove from the licensed package

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Delete items from Licensed Packages

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
items
required
Array of strings

List of asset UUIDs to remove from the licensed package

licensed_package_uuids
required
Array of strings

Licensed Package unique identifiers

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "licensed_package_uuids": [
    ]
}

Delete multiple Licensed Packages

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
licensed_package_uuids
required
Array of strings

UUIDs of licensed packages to delete

Responses

Request samples

Content type
application/json
{
  • "licensed_package_uuids": [
    ]
}

Export licensed package details

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (LicensedPackageFieldsData)

List of fields to select

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ]
}

Orders

Create and manage Orders.

List Orders

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

name-subject
string

Name of subject

delivery-status
string

Delivery status

download-status
string

Download status

status
string

Status

combined-status
string

Combined status

orders-type
required
enum

Filter

date-from
string

Date from

date-to
string

Date to

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search Orders with Dynamic Filtering

Search orders with flexible filtering and sorting.

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
page
number

Page number (0-indexed)

perPage
number

Items per page

object (DynamicFilterRequestDTO)

Dynamic filter request

object (DynamicSortRequestDTO)

Dynamic sort request

ordersType
string
Enum: "shared-packs" "all" "shared" "own"

Order type filter (for backward compatibility)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "filters": {
    },
  • "sort": {
    },
  • "ordersType": "shared-packs"
}

Response samples

Content type
application/json
[
  • {
    }
]

/order/searchV2

Authorizations:
customAuthorizer
Request Body schema: application/json
required
object (OrderSearchFilters)
ordersType
string (GetOrdersHeaderType)
Enum: "shared-packs" "all" "shared" "own"
requiresApproval
boolean

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "ordersType": "shared-packs",
  • "requiresApproval": true
}

Response samples

Content type
application/json
[
  • {
    }
]

List orders in approval flow

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

name-subject
string

Name of subject

delivery-status
string

Delivery status

download-status
string

Download status

status
string

Status

combined-status
string

Combined status

orders-type
required
enum

Filter

date-from
string

Date from

date-to
string

Date to

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an Order

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "approval_comment": "string",
  • "approval_status": 0,
  • "approved_items_count": {
    },
  • "cartable": true,
  • "clearance_notes_uri": "string",
  • "combined_order_status": "string",
  • "comment": "string",
  • "completed_items": 0,
  • "could_be_downloaded": true,
  • "created_at": "string",
  • "currency": "string",
  • "delivery_date": "string",
  • "delivery_destinations": [
    ],
  • "delivery_emails": "string",
  • "delivery_status": "created",
  • "download_limit": 0,
  • "download_status": "string",
  • "embargo_warning_accepted": true,
  • "estimated_restore_at": "2019-08-24T14:15:22Z",
  • "expires_at": "string",
  • "has_approved_item": true,
  • "has_embargoed_asset": true,
  • "has_rejected_item": true,
  • "media_pulse_id": "string",
  • "order_download_links": [
    ],
  • "order_shared": "string",
  • "package_title": "string",
  • "publish_progress": 0,
  • "purchase_order_no": "string",
  • "requires_approval": true,
  • "reviewer": "string",
  • "reviewers": [
    ],
  • "reviewers_names": "string",
  • "sales_force_id": "string",
  • "sales_force_name": "string",
  • "sales_force_uri": "string",
  • "shared_by": "string",
  • "status": "Created",
  • "subject": "string",
  • "thumbnail": "string",
  • "total_assets": 0,
  • "total_bytes": 0,
  • "total_deleted_assets": 0,
  • "total_downloadable_assets": 0,
  • "total_downloaded_assets": 0,
  • "total_price": 0,
  • "transcode_progress": 0,
  • "type": "delivery_destination",
  • "used_department": "string",
  • "used_discount_name": "string",
  • "user": "string",
  • "uuid": "string",
  • "workflow_jobs": [
    ],
  • "workflow_type": "ai"
}

Edit an Order

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
send_as_shared_pack
required
boolean

Indicates whether the order should be sent as a shared pack

status
required
string

Status of the order

comment
string

Optional comment for the order

expires_at
number

The expiration date of the order

sf_unlock
boolean

Indicates whether the order should be unlocked for sf

Responses

Request samples

Content type
application/json
{
  • "send_as_shared_pack": true,
  • "status": "string",
  • "comment": "string",
  • "expires_at": 0,
  • "sf_unlock": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

List items for an Order

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

downloaded
string

Is downloaded

tx-date-from
string

Date from

tx-date-to
string

Date to

facility-of-origin
string

Facility of origin

type
string

Type

text
string

Text to filter

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Approve Order Items

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
all
required
boolean

Indicates whether to apply the status to all order items

status
required
string

Status of the order items

Array of objects (PatchOrderAssetProperty)

A list of order items with their unique identifiers and status

rejection_reason
string

Optional free-text rejection reason applied to rejected items

Responses

Request samples

Content type
application/json
{
  • "all": true,
  • "status": "string",
  • "assets": [
    ],
  • "rejection_reason": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Get signed clearance notes link

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "clearance_notes_uri": "string"
}

Get an Order confirmation pdf

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "url": "string"
}

List Redelivery Emails

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • "string"
]

Lists order status changes

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "logs": [
    ],
  • "statuses": [
    ]
}

Lists all file transfer events for an order (downloads for email-delivery orders, publish jobs for delivery-destination orders)

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List an Order related emails

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • "string"
]

List orders from a Mediapulse

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

tx-date-from
string

Date from

tx-date-to
string

Date to

text
string

Text

po
string

Filters mediapulse orders by purchase number

wo_no
string

Filters mediapulse orders by identifier

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Order

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Response samples

Content type
application/json
{
  • "coldStorageRetrieval": true,
  • "id": 0,
  • "uuid": "string"
}

Create an Order for fast download

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Create an Order for assets undeletion

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Download setup for an Order

Creates a download setup for an Order or a download setup for Order Items if Order Items uuids are given.

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
download_uuids
required
Array of strings

A list of UUIDs for the files to be downloaded

keep_folders_structure
required
boolean

Flag indicating whether to keep the folder structure during the download

config_uuid
required
string

The configuration UUID for the download request

download_type
required
string
Enum: "ASPERA" "HTTPS"

The type of the download request

Responses

Request samples

Content type
application/json
{
  • "download_uuids": [
    ],
  • "keep_folders_structure": true,
  • "config_uuid": "string",
  • "download_type": "ASPERA"
}

Response samples

Content type
application/json
{
  • "cookie": "string",
  • "faspPort": 0,
  • "paths": [
    ],
  • "remoteHost": "string",
  • "remoteUser": "string",
  • "sshPort": 0,
  • "token": "string",
  • "transferUuid": "string"
}

Retry Clipping

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
items
required
Array of strings

A list of item UUIDs to re-trigger clipping

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Retry Delivery Destinations Failed Jobs

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (OrderRetryDDJob)

A list of jobs to retry

Responses

Request samples

Content type
application/json
{
  • "jobs": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Retry failed clippings in order

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
order_item_uuids
Array of strings

A list of exact order item uuids to retry

Responses

Request samples

Content type
application/json
{
  • "order_item_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Retry delivery for Clips

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
emails
required
Array of strings

List of email addresses for redelivering the clips

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Get an Order delivery confirmation pdf

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Get Order delivery confirmation pdfs

Pdfs are being send by an email to an User

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uuids
required
Array of strings

A list of UUIDs to get order delivery confirmation pdfs

Responses

Request samples

Content type
application/json
{
  • "uuids": [
    ]
}

Set Aspera Download Success Status

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
transferUuid
required
string

The unique identifier for the aspera transfer

status
required
string

The aspera finished status of the download.

Responses

Request samples

Content type
application/json
{
  • "transferUuid": "string",
  • "status": "string"
}

Export an Order details

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

name-subject
string

Name of subject

delivery-status
string

Delivery status

download-status
string

Download status

status
string

Status

combined-status
string

Combined status

orders-type
required
enum

Filter

date-from
string

Date from

date-to
string

Date to

Request Body schema: application/json
required
required
Array of objects (DataSelector)

Selector

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Convert Pathe Ids to Uuids

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
ids
required
Array of strings

A list of path IDs

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

/order/{uuid}/search

Authorizations:
customAuthorizer
Request Body schema: application/json
required
any (PostSearchTypeV2)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Export order items by Elasticsearch assets

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/order/{uuid}/approve

Authorizations:
customAuthorizer
Request Body schema: application/json
required
comment
string
expires_at
number
send_as_shared_pack
required
boolean
sf_unlock
boolean
status
required
string
Enum: "approved" "submitted"

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "expires_at": 0,
  • "send_as_shared_pack": true,
  • "sf_unlock": true,
  • "status": "approved"
}

Manage Assigned Order Discounts

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
order_uuids
required
Array of strings

Uuids of orders to change discount

new_discount_uuid
string

Uuid of new discount

Responses

Request samples

Content type
application/json
{
  • "order_uuids": [
    ],
  • "new_discount_uuid": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

QC Projects

Manage QC Projects and access control

Get list of QC projects

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
string

Filter by keyword (name, description)

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Create a new QC Project

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Get details for a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Update a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Archive a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Provision a complete QC project in a single atomic operation

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

/projects/searchV2

Authorizations:
customAuthorizer
Request Body schema: application/json
required
object (ProjectSearchFilters)

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Add teams to a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Remove teams from a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Search assets in a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Responses

Export assets in a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Responses

Add items to a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (PatchCollectionItem)

New collection items data

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Add items to multiple QC Projects

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
required
Array of objects (PatchCollectionItem)

New collection items data

collection_uuids
required
Array of strings

Collection unique identifiers

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "collection_uuids": [
    ]
}

Remove items from a QC Project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
items
required
Array of strings

Item unique identifiers

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Remove items from multiple QC Projects

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
items
required
Array of strings

Item unique identifiers

collection_uuids
required
Array of strings

Collection unique identifiers

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "collection_uuids": [
    ]
}

Get list of project access rules

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Update a project access rule

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Delete a project access rule

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Create a new project access rule

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Test an access rule against a specific asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Get users connected to a QC Project (for @mention)

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Notify CS that QC is completed for a project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Notify teams that QC review is completed

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

message
string

Optional message to include in the review-completed notification

recipient_team_uuids
Array of arrays

UUIDs of teams to notify

Responses

Send QC report to client/production teams

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

subject
required
string

Subject line of the QC report notification email

body
required
string

Body / message content of the QC report notification

recipient_emails
required
Array of arrays

List of recipient email addresses

recipient_team_uuids
Array of arrays

UUIDs of teams whose members should also receive the notification (optional)

Responses

Send @mention notification in QC project

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

mentioned_user_uuid
required
string

UUID of the user being mentioned

comment_uuid
required
string

UUID of the comment in which the mention appears

comment_body
required
string

Full body of the comment containing the mention

asset_uuid
string

UUID of the asset the comment is attached to (optional)

asset_filename
string

Display filename of the asset (optional, skips DB lookup when provided)

Responses

Rights Contracts

Create and manage Rights Contracts.

List Rights Contracts

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

text
string

Text to filter

licensed-package-uuid
string

UUID of licensed package

start-before
string

Start before

end-after
string

End after

partner-id
string

Partner id

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Rights Contract

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "calculated_end_date": "string",
  • "calculated_start_date": "string",
  • "contract_id": "string",
  • "created_at": "string",
  • "download_limit": 0,
  • "download_limit_config": {
    },
  • "end_date": "string",
  • "licensed_package_count": 0,
  • "licensed_package_names": "string",
  • "licensed_packages": [
    ],
  • "materials_available_at": "string",
  • "name": "string",
  • "notifications_enabled": true,
  • "partner": {
    },
  • "start_date": "string",
  • "status": "string",
  • "updated_at": "string",
  • "uuid": "string"
}

Update a Rights Contract

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
name
required
string

Name of the rights contract

contract_id
required
string

Contract identifier

notifications_enabled
required
boolean

Flag indicating if notifications are enabled for the contract

download_limit
required
number

A number of times an item can be downloaded per contract

object (DownloadLimitConfigInterface)

Download limit configuration for the asset type

required
object (RightsContractPartner)

Partner details including UUID, name, and users count

licensed_package_uuids
required
Array of strings

List of UUIDs for licensed packages associated with the rights contract

licensed_package_names
required
Array of strings

List of names for licensed packages associated with the rights contract

licensed_package_count
required
number

Count of licensed packages associated with the rights contract

status
required
string

Current status of the rights contract

partner_uuid
required
string

UUID of the partner associated with the rights contract

licensed_packages_to_attach
required
Array of strings

List of licensed package UUIDs to attach to the rights contract

licensed_packages_to_detach
required
Array of strings

List of licensed package UUIDs to detach from the rights contract

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "contract_id": "string",
  • "notifications_enabled": true,
  • "download_limit": 0,
  • "download_limit_config": {
    },
  • "partner": {
    },
  • "licensed_package_uuids": [
    ],
  • "licensed_package_names": [
    ],
  • "licensed_package_count": 0,
  • "status": "string",
  • "partner_uuid": "string",
  • "licensed_packages_to_attach": [
    ],
  • "licensed_packages_to_detach": [
    ]
}

Response samples

Content type
application/json
{
  • "calculated_end_date": "string",
  • "calculated_start_date": "string",
  • "contract_id": "string",
  • "created_at": "string",
  • "download_limit": 0,
  • "download_limit_config": {
    },
  • "end_date": "string",
  • "licensed_package_count": 0,
  • "licensed_package_names": "string",
  • "licensed_packages": [
    ],
  • "materials_available_at": "string",
  • "name": "string",
  • "notifications_enabled": true,
  • "partner": {
    },
  • "start_date": "string",
  • "status": "string",
  • "updated_at": "string",
  • "uuid": "string"
}

Delete a Rights Contract

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Get a Rights Contract Logs

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Get download log for a Rights Contract

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

asset
string

Filter by asset filename or UUID

user
string

Filter by user email

date-from
string

From date (ISO 8601)

date-to
string

To date (ISO 8601)

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export download log for a Rights Contract as CSV

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

asset
string

Filter by asset filename or UUID

user
string

Filter by user email

date-from
string

From date (ISO 8601)

date-to
string

To date (ISO 8601)

Responses

Create a Rights Contract

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
uuid
required
string

Unique identifier for the rights contract

name
required
string

Name of the rights contract

contract_id
required
string

Contract identifier

notifications_enabled
required
boolean

Flag indicating if notifications are enabled for the contract

download_limit
required
number

A number of times an item can be downloaded per contract

partner_uuid
required
string

UUID of the partner associated with the rights contract

licensed_package_uuids
required
Array of strings

List of UUIDs for licensed packages associated with the rights contract

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "contract_id": "string",
  • "notifications_enabled": true,
  • "download_limit": 0,
  • "partner_uuid": "string",
  • "licensed_package_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "calculated_end_date": "string",
  • "calculated_start_date": "string",
  • "contract_id": "string",
  • "created_at": "string",
  • "download_limit": 0,
  • "download_limit_config": {
    },
  • "end_date": "string",
  • "licensed_package_count": 0,
  • "licensed_package_names": "string",
  • "licensed_packages": [
    ],
  • "materials_available_at": "string",
  • "name": "string",
  • "notifications_enabled": true,
  • "partner": {
    },
  • "start_date": "string",
  • "status": "string",
  • "updated_at": "string",
  • "uuid": "string"
}

Export a Rights Contract details

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

partner-id
string

Partner id

filter
string

Filter

page
string

Page number

per-page
string

Items per page

order-by
string

Order by field

order-dir
enum

Order direction

Request Body schema: application/json
required
required
Array of objects (RightsContractFieldsData)

List of fields to select

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ]
}

Set a Rights Contract to release

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "calculated_end_date": "string",
  • "calculated_start_date": "string",
  • "contract_id": "string",
  • "created_at": "string",
  • "download_limit": 0,
  • "download_limit_config": {
    },
  • "end_date": "string",
  • "licensed_package_count": 0,
  • "licensed_package_names": "string",
  • "licensed_packages": [
    ],
  • "materials_available_at": "string",
  • "name": "string",
  • "notifications_enabled": true,
  • "partner": {
    },
  • "start_date": "string",
  • "status": "string",
  • "updated_at": "string",
  • "uuid": "string"
}

Attach a Licensed Package to a Contract with optional date windows

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
licensed_package_uuid
required
string

UUID of the licensed package to attach

external_id
string

Optional external identifier for this association (e.g. Rightsline ID)

Responses

Request samples

Content type
application/json
{
  • "licensed_package_uuid": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "calculated_end_date": "string",
  • "calculated_start_date": "string",
  • "contract_id": "string",
  • "created_at": "string",
  • "download_limit": 0,
  • "download_limit_config": {
    },
  • "end_date": "string",
  • "licensed_package_count": 0,
  • "licensed_package_names": "string",
  • "licensed_packages": [
    ],
  • "materials_available_at": "string",
  • "name": "string",
  • "notifications_enabled": true,
  • "partner": {
    },
  • "start_date": "string",
  • "status": "string",
  • "updated_at": "string",
  • "uuid": "string"
}

Update date windows for a Licensed Package on a Contract

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
licensed_package_uuids
required
Array of strings

UUIDs of the licensed packages to update

external_id
string

Optional external identifier for this association (e.g. Rightsline ID). Send null to clear.

Responses

Request samples

Content type
application/json
{
  • "licensed_package_uuids": [
    ],
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "calculated_end_date": "string",
  • "calculated_start_date": "string",
  • "contract_id": "string",
  • "created_at": "string",
  • "download_limit": 0,
  • "download_limit_config": {
    },
  • "end_date": "string",
  • "licensed_package_count": 0,
  • "licensed_package_names": "string",
  • "licensed_packages": [
    ],
  • "materials_available_at": "string",
  • "name": "string",
  • "notifications_enabled": true,
  • "partner": {
    },
  • "start_date": "string",
  • "status": "string",
  • "updated_at": "string",
  • "uuid": "string"
}

Attach multiple Licensed Packages to a Contract

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
licensed_package_uuids
required
Array of strings

UUIDs of licensed packages to attach to the contract

Responses

Request samples

Content type
application/json
{
  • "licensed_package_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "calculated_end_date": "string",
  • "calculated_start_date": "string",
  • "contract_id": "string",
  • "created_at": "string",
  • "download_limit": 0,
  • "download_limit_config": {
    },
  • "end_date": "string",
  • "licensed_package_count": 0,
  • "licensed_package_names": "string",
  • "licensed_packages": [
    ],
  • "materials_available_at": "string",
  • "name": "string",
  • "notifications_enabled": true,
  • "partner": {
    },
  • "start_date": "string",
  • "status": "string",
  • "updated_at": "string",
  • "uuid": "string"
}

Transcode Containers

Create and manage transcode container configurations.

Get all transcode containers

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Get details for a transcode container

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "kind": "string",
  • "label": "string",
  • "uuid": "string"
}

Update existing transcode container

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
kind
required
string

Container kind (format)

label
required
string

Display label

Responses

Request samples

Content type
application/json
{
  • "kind": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "kind": "string",
  • "label": "string",
  • "uuid": "string"
}

Delete a transcode container

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Create new transcode container

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
kind
required
string

Container kind (format)

label
required
string

Display label

Responses

Request samples

Content type
application/json
{
  • "kind": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "kind": "string",
  • "label": "string",
  • "uuid": "string"
}

Transcode Types

Create and manage transcode type configurations.

Get all transcode types

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
[
  • {
    }
]

Get details for a transcode type

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "name": "string",
  • "transcode_containers": [
    ],
  • "uuid": "string",
  • "video_codec_mappings": [
    ]
}

Update existing transcode type

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
name
required
string

Name of the transcode type

container_uuids
required
Array of strings

Container UUIDs

codec_mapping_uuids
required
Array of strings

Codec mapping UUIDs

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "container_uuids": [
    ],
  • "codec_mapping_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "transcode_containers": [
    ],
  • "uuid": "string",
  • "video_codec_mappings": [
    ]
}

Delete a transcode type

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
any (undefined)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": null,
  • "message": "string",
  • "name": "string",
  • "stack": "string",
  • "type": "EntityNotFoundError"
}

Create new transcode type

Authorizations:
customAuthorizer
header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
name
required
string

Name of the transcode type

container_uuids
required
Array of strings

Container UUIDs

codec_mapping_uuids
required
Array of strings

Codec mapping UUIDs

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "container_uuids": [
    ],
  • "codec_mapping_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "transcode_containers": [
    ],
  • "uuid": "string",
  • "video_codec_mappings": [
    ]
}