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.

Ad Break Analysis

Resolve, or order, an asset's ad break analysis without building a cart.

Resolve, or order, an asset's ad break analysis

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

Unique Client identifier in the system

Responses

Ad Break Platform Specs

Create and manage the ad break rules of a delivery platform.

/ad-break-platform-specs

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ad-break-platform-spec/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ad-break-platform-spec/{uuid}

Authorizations:
customAuthorizer

Responses

/ad-break-platform-spec/{uuid}

Authorizations:
customAuthorizer

Responses

/ad-break-platform-spec

Authorizations:
customAuthorizer

Responses

Ad Break Points

The pool of ad break points held against an asset, each approved, rejected or not yet assessed.

/ad-break-points/asset/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ad-break-points/asset/{uuid}

Authorizations:
customAuthorizer

Responses

/ad-break-points/asset/{uuid}/evaluation

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ad-break-points/asset/{uuid}/anchors

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ad-break-point

Authorizations:
customAuthorizer

Responses

/ad-break-point/{uuid}

Authorizations:
customAuthorizer

Responses

/ad-break-point/{uuid}

Authorizations:
customAuthorizer

Responses

/ad-break-points/asset/{uuid}/decisions

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ad-break-points/decisions/summary

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ad-break-points/asset/{uuid}/approval

Authorizations:
customAuthorizer

Responses

Ad Break Rejection Reasons

The fixed list of reasons a suggested ad break can be refused.

/ad-break-rejection-reasons

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ad-break-rejection-reason

Authorizations:
customAuthorizer

Responses

/ad-break-rejection-reason/{uuid}

Authorizations:
customAuthorizer

Responses

/ad-break-rejection-reason/{uuid}

Authorizations:
customAuthorizer

Responses

AI

AI-powered asset operations.

/ai/models

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/ai/search

Authorizations:
customAuthorizer

Responses

AI-powered asset search v2 with comprehensive filter support and JSON mode

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

Unique Client identifier in the system

Responses

Analyze Metadata

Analyze and enrich asset metadata.

/analyze-metadata/percentages

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/analyze-metadata/{uuid}/data

Authorizations:
customAuthorizer

Responses

/analyze-metadata/{uuid}/status

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Ask VIDA

In-app conversational assistant (read-only Q&A + navigation).

/assistant/command

Authorizations:
customAuthorizer

Responses

/assistant/transcribe

Authorizations:
customAuthorizer

Responses

/assistant/voice/session

Authorizations:
customAuthorizer

Responses

AsperaPublishLimits

Create and manage Aspera Publish Limits

/aspera-publish-limits

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/aspera-publish-limit/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/aspera-publish-limit/{uuid}

Authorizations:
customAuthorizer

Responses

/aspera-publish-limit/{uuid}

Authorizations:
customAuthorizer

Responses

/aspera-publish-limit

Authorizations:
customAuthorizer

Responses

Assets

Create and manage Assets.

List Assets details

Authorizations:
customAuthorizer
query Parameters
uuids
Array of arrays

UUIDs

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
object (NeverExists)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Preview cloning one asset's audio track configuration onto other assets (#2067)

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

Unique Client identifier in the system

Request Body schema: application/json
required
source_asset_uuid
required
string

Asset whose audio track configuration is copied

target_uuids
required
Array of strings

Assets the configuration would be copied onto; the source itself is reported, not refused

Responses

Request samples

Content type
application/json
{
  • "source_asset_uuid": "string",
  • "target_uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "languages": {
    },
  • "source": {
    },
  • "summary": {
    },
  • "targets": [
    ]
}

Preview applying the client's Default Audio Settings entry matching each asset's channel count (#2070)

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

Unique Client identifier in the system

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

Assets the client's Default Audio Settings entry for their channel count would be applied onto

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "entries": {
    },
  • "languages": {
    },
  • "summary": {
    },
  • "targets": [
    ]
}

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.

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

Responses

Request samples

Content type
application/json
{ }

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.

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

Responses

Request samples

Content type
application/json
{ }

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.

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

Responses

Request samples

Content type
application/json
{ }

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.

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

Responses

Request samples

Content type
application/json
{ }

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

Responses

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
[
  • {
    }
]

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
}

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
}

Metadata CSV import upload signature

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"
}

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

query Parameters
include_deleted
string

Include the asset even when soft-deleted (requires browse_deleted_assets permission)

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "additional": {
    },
  • "attachments": [
    ],
  • "audioTracks": [
    ],
  • "core": {
    },
  • "ext_asset_info": {
    },
  • "ext_title_info": {
    },
  • "file_metadata": {
    },
  • "general": {
    },
  • "locks": [
    ],
  • "logginginfo": [
    ],
  • "mediaset": {
    },
  • "player_watermark": {
    },
  • "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 (PatchAssetAdditionalType)
Array of objects (PatchAssetAudioTrackType)
object (PatchAssetCoreType)
object (PatchAssetExtAssetInfoType)
object (PatchAssetExtTitleInfoType)
object (PatchAssetGeneralType)
object (PatchAssetMediaSetType)
object (PatchAssetUserMediaDataType)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "additional": {
    },
  • "attachments": [
    ],
  • "audioMeasurementsDiscarded": [
    ],
  • "audioTracks": [
    ],
  • "core": {
    },
  • "ext_asset_info": {
    },
  • "ext_title_info": {
    },
  • "file_metadata": {
    },
  • "general": {
    },
  • "locks": [
    ],
  • "logginginfo": [
    ],
  • "mediaset": {
    },
  • "player_watermark": {
    },
  • "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
true

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a signed url for an Asset

A signed url will be returned immediately only for a hot storage asset. A cold storage asset download link will be created and sent after finished restoration and copy to hot storage.

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

target-sqs
string

Target sqs queue

media-pulse-uuid
string

UUID from Media Pulse

aspera
string

Aspera

contact-name
string

Contact Name

Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "coldStorageRetrieval": true,
  • "location": "string"
}

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

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

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.

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

Responses

Request samples

Content type
application/json
{ }

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.

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
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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.

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

Responses

Request samples

Content type
application/json
{ }

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

taskId
string

Maestro Task ID. If passed, asset links will redirect to the Maestro App.

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "overviewSheet": {
    },
  • "videoErrorsSheet": {
    },
  • "audioErrorsSheet": {
    },
  • "inSceneTextLogSheet": {
    },
  • "recommendationsSheet": {
    },
  • "gradeRegion": "us",
  • "workspace": "string",
  • "projectUuid": "string",
  • "taskId": "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

source
enum

Source of request

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

/asset/{uuid}/audio-metadata-corrections

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

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

source
enum

Source of request

Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

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.

Responses

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.

Responses

Response samples

Content type
application/json
{
  • "link": "string",
  • "uri": "string"
}

Download setup for an Asset

Authorizations:
customAuthorizer
path Parameters
hash
required
string

Hash

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

config_uuid
string

UUID of config

Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Get a download link for an Asset

Authorizations:
customAuthorizer
path Parameters
hash
required
string

Hash

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"
}

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.

Responses

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.

Responses

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

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

Responses

Request samples

Content type
application/json
{ }

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
string

Unique identifier for the asset; generated and returned in the response when omitted

batchId
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

revision_parent_uuid
string

UUID of the asset this one is a new revision of

is_only_placeholder
boolean

Create the asset record only, without opening a multipart upload

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",
  • "revision_parent_uuid": "string",
  • "is_only_placeholder": true
}

Response samples

Content type
application/json
{
  • "Bucket": "string",
  • "Key": "string",
  • "UploadId": "string",
  • "uuid": "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",
  • "uuids": [
    ]
}

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

original
boolean

When true and the asset is not a video, returns a signed URL for the original file instead of a proxy. Ignored for video. Requires the download_non_video_assets permission.

Responses

Request samples

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

Response samples

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

Export an Asset to the storage mount

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
{
  • "limit": 0,
  • "remaining_slots": 0,
  • "revoked": true,
  • "shared": true,
  • "shares": [
    ]
}

Remove an Asset from the storage mount

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
{
  • "limit": 0,
  • "remaining_slots": 0,
  • "revoked": true,
  • "shared": true,
  • "shares": [
    ]
}

List storage mount shares

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.

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "remaining_slots": 0,
  • "revoked": true,
  • "shared": true,
  • "shares": [
    ]
}

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

Responses

Response samples

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

Delete from 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

Responses

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

Responses

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
object
trackNumber
string

Responses

Request samples

Content type
application/json
{
  • "modelUuid": "string",
  • "options": {
    },
  • "trackNumber": "string"
}

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

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
partNumber
required
number
uploadId
required
string

Responses

Request samples

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

Response samples

Content type
application/json
"string"

Create a Virtual Asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

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",
  • "uuids": [
    ]
}

Get the stored asset version 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.

Responses

Response samples

Content type
application/json
{
  • "assetUuid": "string",
  • "diffs": [
    ],
  • "lastId": 0,
  • "total": 0,
  • "versions": [
    ]
}

Get the asset change history without regenerating or publishing it

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Responses

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

Responses

Response samples

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

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 (PatchAssetAdditionalType)
Array of objects (PatchAssetAudioTrackType)
object (PatchAssetCoreType)
object (PatchAssetExtAssetInfoType)
object (PatchAssetExtTitleInfoType)
object (PatchAssetGeneralType)
object (PatchAssetMediaSetType)
object (PatchAssetUserMediaDataType)

Responses

Request samples

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

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

Request Body schema: application/json
required
released
required
boolean

Responses

Request samples

Content type
application/json
{
  • "released": true
}

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

Responses

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

Responses

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

Responses

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.

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

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"
}

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

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
{
  • "body": "string",
  • "created_at": "string",
  • "entity_id": "string",
  • "entity_type": "order",
  • "group": {
    },
  • "updated_at": "string",
  • "user": {
    },
  • "uuid": "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

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

Responses

Request samples

Content type
application/json
{ }

Response samples

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

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

source
enum

Source of request

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Resolve who can access an asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

query Parameters
as-of
string

ISO 8601 date or date-time to resolve access as of. Defaults to now.

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
object (NeverExists)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "as_of": "string",
  • "asset": {
    },
  • "blanket_grants": [
    ],
  • "paths": [
    ]
}

Attachments

Manage file attachments.

/attachment

Authorizations:
customAuthorizer

Responses

/attachment/{uuid}

Authorizations:
customAuthorizer

Responses

/attachment/{uuid}

Authorizations:
customAuthorizer

Responses

Breaking News

Create and manage Breaking News

Get active breaking news for guests

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

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Responses

Get paginated list of breaking news

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

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Responses

Create new breaking news

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

Unique Client identifier in the system

Request Body schema: application/json
required
Array
title
required
string

Title of the breaking news

description
required
string

Content of the breaking news

active
required
boolean

Whether the breaking news is currently active

start_date
string

Start date of the breaking news, can be null

end_date
string

End date of the breaking news, can be null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get breaking news by UUID

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

UUID of entity

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Update breaking news by UUID

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
Array
title
string

Title of the breaking news

description
string

Content of the breaking news

active
boolean

Whether the breaking news is currently active

start_date
string

Start date of the breaking news, can be null

end_date
string

End date of the breaking news, can be null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete breaking news by UUID

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

UUID of entity

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Bulk Actions

Execute bulk actions on assets.

/bulk-actions

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/bulk-actions/all

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/bulk-actions/history

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/bulk-actions/all/history

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/bulk-actions/stats

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/bulk-action

Authorizations:
customAuthorizer
Request Body schema: application/json
required
actionType
required
string (BulkActionType)
Enum: "console-log" "assets-delete" "assets-set-as-cold-only" "assets-set-as-hot" "assets-set-quarantine" "assets-request-deletion" "assets-reject-deletion-request" "assets-batch-update" "assets-regenerate-filenames" "assets-clone-audio-tracks" "assets-apply-audio-default" "add-items-to-collections" "add-items-to-projects" "add-items-to-licensed-packages" "add-items-to-cart" "add-order-to-cart" "add-cart-to-collections" "add-order-to-collections" "remove-items-from-collections" "remove-items-from-projects" "remove-items-from-licensed-packages" "order-fast-download" "order-retry-dd-jobs" "order-retry-clipping" "delivery-pack-approve-jobs" "delivery-pack-reject-jobs" "delivery-pack-resolve-jobs" "delivery-packs-delete" "upload-jobs-set-qc-required" "delivery-pack-request-metadata-recognition" "delivery-pack-restart-metadata-recognition" "delivery-pack-pick-metadata-results" "delivery-pack-delete-jobs" "job-types-admin-edit" "jobs-retry" "retry-salesforce-clipping" "retry-orders" "users-client-access" "users-set-policies" "users-set-suppliers" "notification-subscriptions-create" "notification-subscriptions-update" "notification-subscriptions-delete" "source-objects-import" "assets-csv-import" "collection-csv-import" "csv-export-assets" "csv-export-video-codec-mappings" "csv-export-orders" "csv-export-rights-contracts" "csv-export-users" "csv-export-kpi" "csv-export-rights-contract-download-log" "csv-export-landingpad" "csv-export-collection-analytics" "csv-export-delivery-pack"
dataType
required
string (BulkActionDataType)
Enum: "uuids" "filters"
required
ActionPayloadUuids (object) or ActionPayloadFilters (object)

Responses

Request samples

Content type
application/json
{
  • "actionType": "console-log",
  • "dataType": "uuids",
  • "payload": {
    }
}

/bulk-action/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
isCancelForMfa
required
boolean

Responses

Request samples

Content type
application/json
{
  • "isCancelForMfa": true
}

/bulk-action/{uuid}/resume

Authorizations:
customAuthorizer
Request Body schema: application/json
required
code
required
string
skipMfaCode
boolean

Super-admin only: when true, the MFA code is not required nor verified — the task is resumed (started) immediately. Ignored for non-super-admin callers.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "skipMfaCode": true
}

/bulk-action/{uuid}/priority

Authorizations:
customAuthorizer
Request Body schema: application/json
required
priority
required
number

Responses

Request samples

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

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.

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

Responses

Request samples

Content type
application/json
{ }

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.

Responses

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.

Responses

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,
  • "counts": {
    },
  • "discount_name": "string",
  • "discount_prices": {
    },
  • "discount_status": "active",
  • "existing_analyses": [
    ],
  • "existing_dependency_jobs": {
    },
  • "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
[ ]

Create a fast order cart

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 (PostOrderItem)

Responses

Request samples

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

Response samples

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

Delete Items from a Cart

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

Unique Client identifier in the system

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
0
0

CloudFront

CloudFront cookie management.

/cookie

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

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

created-at-from
string

Created at from

created-at-to
string

Created at to

updated-at-from
string

Updated at from

updated-at-to
string

Updated at to

filter-scope
enum

Filter scope

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

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

created-at-from
string

Created at from

created-at-to
string

Created at to

updated-at-from
string

Updated at from

updated-at-to
string

Updated at to

filter-scope
enum

Filter scope

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

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

created-at-from
string

Created at from

created-at-to
string

Created at to

updated-at-from
string

Updated at from

updated-at-to
string

Updated at to

filter-scope
enum

Filter scope

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

/collections/searchV2

Authorizations:
customAuthorizer

Responses

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"
}

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

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
}

/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

/collection/{uuid}/search

Authorizations:
customAuthorizer

Responses

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
}

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": [
    ]
}

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"
}

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": [
    ]
}

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

Responses

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

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

Conform

Render a conformed asset from a Maestro conform document.

Apply an accepted conform document

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

Unique Client identifier in the system

Responses

Resolve, or order, an asset's music-and-effects stem

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

Unique Client identifier in the system

Responses

Resolve, or order, the alignment measurement for a reference/candidate pair

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

Unique Client identifier in the system

Responses

Credentials

Create and manage Credentials

/credentials/{type}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/credentials

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/credential/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/credential/{uuid}

Authorizations:
customAuthorizer

Responses

/credential/{uuid}

Authorizations:
customAuthorizer

Responses

/credential/youtube

Authorizations:
customAuthorizer
Request Body schema: application/json
required
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "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": {
    }
}

/credential

Authorizations:
customAuthorizer

Responses

Dashboards

Create and manage Dashboards.

/dashboards

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/dashboard/default

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/dashboard/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/dashboard/{uuid}

Authorizations:
customAuthorizer

Responses

/dashboard/{uuid}

Authorizations:
customAuthorizer

Responses

/dashboard

Authorizations:
customAuthorizer

Responses

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.

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "status": "draft",
  • "email": {
    },
  • "configs": [
    ],
  • "publish": {
    },
  • "filenameConventions": {
    },
  • "allowFilenameOverrideInCart": true,
  • "allowLanguageOverrideInCart": 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

allowLanguageOverrideInCart
boolean

Allow audio language 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,
  • "allowLanguageOverrideInCart": true,
  • "type": "file"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "status": "draft",
  • "email": {
    },
  • "configs": [
    ],
  • "publish": {
    },
  • "filenameConventions": {
    },
  • "allowFilenameOverrideInCart": true,
  • "allowLanguageOverrideInCart": 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

Responses

Response samples

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

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

allowLanguageOverrideInCart
boolean

Allow audio language 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,
  • "allowLanguageOverrideInCart": true,
  • "type": "file",
  • "uuid": "string"
}

Response samples

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

Create a Delivery Destination config

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 Config

rules
required
Array of strings

Set of rules per every asset type

Responses

Request samples

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

Response samples

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

Edit a Delivery Destination config

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

configUuid
required
string

UUID of delivery destination config

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
name
string

Name of Delivery Destination Config

rules
Array of strings

Set of rules per every asset type

Responses

Request samples

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

Response samples

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

Delete a Delivery Destination config

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

configUuid
required
string

UUID of delivery destination config

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Response samples

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

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": [
    ]
}

Delivery Packs

Create and manage Delivery Packs.

Get Paginated Delivery Packs

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

Unique Client identifier in the system

from
string

From

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Get one Delivery Pack

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

from
string

From

Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "approved_at": "string",
  • "rejected_at": "string",
  • "rejected_reasons": [
    ],
  • "is_template": true,
  • "templateSuppliers": [
    ],
  • "licensed_packages": [
    ],
  • "can_be_restored": true,
  • "can_upload_assets": true,
  • "analyse_jobs_completed": true,
  • "matched_assets": [
    ],
  • "auto_submitted": true,
  • "auto_approved": true
}

Update delivery pack

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
approved_at
string
object (SimpleType)
created_at
required
string
is_template
boolean
licensed_package_uuids
Array of strings
required
object (DeliveryMetadataInterface)
Deprecated

**

name
required
string
required
object (GetMinifiedUserDetailsType)
rejected_at
string
object (SimpleType)
rejected_reasons
Array of strings
supplier_uuid
string
template_supplier_uuids
Array of strings
template_uuid
string
updated_at
required
string

Responses

Request samples

Content type
application/json
{
  • "approved_at": "string",
  • "approved_by": {
    },
  • "created_at": "string",
  • "is_template": true,
  • "licensed_package_uuids": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "owner": {
    },
  • "rejected_at": "string",
  • "rejected_by": {
    },
  • "rejected_reasons": [
    ],
  • "supplier_uuid": "string",
  • "template_supplier_uuids": [
    ],
  • "template_uuid": "string",
  • "updated_at": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "approved_at": "string",
  • "rejected_at": "string",
  • "rejected_reasons": [
    ],
  • "is_template": true,
  • "templateSuppliers": [
    ],
  • "licensed_packages": [
    ],
  • "can_be_restored": true,
  • "can_upload_assets": true,
  • "analyse_jobs_completed": true,
  • "matched_assets": [
    ],
  • "auto_submitted": true,
  • "auto_approved": true
}

Get valid delivery pack URL

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.

Responses

Response samples

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

Get upload jobs for delivery pack

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

query Parameters
status
string

Delivery upload job status

metadata_filled
boolean

Filter by state of mandatory metadata

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

/delivery-packs/searchV2

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Search upload jobs by Elasticsearch assets

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

query Parameters
status
string

Delivery upload job status

metadata_filled
boolean

Filter by state of mandatory metadata

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
advanced_mode
boolean
false (boolean) or Array of strings

Aggregations to compute: omitted for all of them, false for none, or the names of the ones wanted.

object (EntityFilters)
es_only
boolean
fields
Array of strings
object (AssetSearchFiltersTypeV2)
selected_asset_uuids
Array of strings
text
string

Responses

Request samples

Content type
application/json
{
  • "advanced_mode": true,
  • "aggs": false,
  • "entity_filters": {
    },
  • "es_only": true,
  • "fields": [
    ],
  • "filters": {
    },
  • "selected_asset_uuids": [
    ],
  • "text": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get upload jobs statuses for delivery pack

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.

Responses

Response samples

Content type
application/json
{
  • "rejected": 0,
  • "draft": 0,
  • "pending_approval": 0,
  • "approved": 0,
  • "completed": 0
}

Get delivery pack templates

Authorizations:
customAuthorizer
query Parameters
keyword
string

Keyword

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Get delivery pack templates for selector

Authorizations:
customAuthorizer
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
[
  • {
    }
]

Delivery Pack count

Authorizations:
customAuthorizer
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
{
  • "rejected": 0,
  • "draft": 0,
  • "pending_approval": 0
}

Get upload statistics

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

Unique Client identifier in the system

from
required
string

From date

to
required
string

To date

granularity
required
enum

Granularity (day, month, year)

Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "count": 0,
  • "date": "string"
}

Get upload statistics by status (last 7 days)

Authorizations:
customAuthorizer
path Parameters
status
required
string

Upload job status (draft, pending_approval, rejected, approved)

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
object (NeverExists)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "count": 0,
  • "date": "string"
}

Get total statistics

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

Unique Client identifier in the system

from
string

From date

Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

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

KPI statistics

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
object (NeverExists)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Create new Delivery Pack

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

Unique Client identifier in the system

Request Body schema: application/json
required
approved_at
string
object (SimpleType)
is_template
boolean
licensed_package_uuids
Array of strings
required
object (DeliveryMetadataInterface)
Deprecated

**

name
required
string
owner_uuid
string
rejected_at
string
object (SimpleType)
rejected_reasons
Array of strings
supplier_uuid
string
template_supplier_uuids
Array of strings
template_uuid
string

Responses

Request samples

Content type
application/json
{
  • "approved_at": "string",
  • "approved_by": {
    },
  • "is_template": true,
  • "licensed_package_uuids": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "owner_uuid": "string",
  • "rejected_at": "string",
  • "rejected_by": {
    },
  • "rejected_reasons": [
    ],
  • "supplier_uuid": "string",
  • "template_supplier_uuids": [
    ],
  • "template_uuid": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "approved_at": "string",
  • "rejected_at": "string",
  • "rejected_reasons": [
    ],
  • "is_template": true,
  • "templateSuppliers": [
    ],
  • "licensed_packages": [
    ],
  • "can_be_restored": true,
  • "can_upload_assets": true,
  • "analyse_jobs_completed": true,
  • "matched_assets": [
    ],
  • "auto_submitted": true,
  • "auto_approved": true
}

Submit Freshdesk ticket

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

Subject of the Freshdesk ticket

description
required
string

Description

issue_type
required
string

Freshdesk ticket type

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "issue_type": "string"
}

Response samples

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

Finalize delivery pack - locks file operations and enables auto-submission

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
{
  • "uuid": "string",
  • "name": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "approved_at": "string",
  • "rejected_at": "string",
  • "rejected_reasons": [
    ],
  • "is_template": true,
  • "templateSuppliers": [
    ],
  • "licensed_packages": [
    ],
  • "can_be_restored": true,
  • "can_upload_assets": true,
  • "analyse_jobs_completed": true,
  • "matched_assets": [
    ],
  • "auto_submitted": true,
  • "auto_approved": true
}

Submit delivery pack for approval

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
{
  • "uuid": "string",
  • "name": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "approved_at": "string",
  • "rejected_at": "string",
  • "rejected_reasons": [
    ],
  • "is_template": true,
  • "templateSuppliers": [
    ],
  • "licensed_packages": [
    ],
  • "can_be_restored": true,
  • "can_upload_assets": true,
  • "analyse_jobs_completed": true,
  • "matched_assets": [
    ],
  • "auto_submitted": true,
  • "auto_approved": true
}

Check upload 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
filenames
required
Array of strings

List of filenames to check

Responses

Request samples

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

Response samples

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

/delivery-pack/mandatory-fields

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/delivery-pack/mandatory-fields/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/delivery-pack/mandatory-fields/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
fields
required
Array of strings
MandatoryFieldStage (string) or null

Responses

Request samples

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

/delivery-pack/mandatory-fields/{uuid}

Authorizations:
customAuthorizer

Responses

Upload Jobs

Manage delivery upload jobs.

/upload-job/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/upload-job/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
approved_at
required
string
required
object (GetMinifiedUserDetailsType)
object (AssetInterface)
required
Array of objects (DeliveryUploadJobAssetInterface)
created_at
required
string
deleted_at
required
string or null
object
has_duplicates
string or null (AssetDuplicateStatus)
Enum: "unique" "warning" null
required
object (DeliveryUploadJobAssetInterface)
required
object (DeliveryMetadataInterface)
required
object
qc_required
required
boolean
rejected_at
required
string
required
object (GetMinifiedUserDetailsType)
rejected_reason
required
string
resolved_at
required
string
required
object (GetMinifiedUserDetailsType)
status
required
string (DeliveryUploadJobStatusEnum)
Enum: "draft" "pending_approval" "approved" "rejected"
updated_at
required
string
object (SignatureV4)

Responses

Request samples

Content type
application/json
{
  • "approved_at": "string",
  • "approved_by": {
    },
  • "asset": {
    },
  • "asset_history": [
    ],
  • "created_at": "string",
  • "deleted_at": "string",
  • "error": {
    },
  • "has_duplicates": "unique",
  • "latest_asset": {
    },
  • "metadata": {
    },
  • "metadata_stats": {
    },
  • "qc_required": true,
  • "rejected_at": "string",
  • "rejected_by": {
    },
  • "rejected_reason": "string",
  • "resolved_at": "string",
  • "resolved_by": {
    },
  • "status": "draft",
  • "updated_at": "string",
  • "upload_access": {
    }
}

/upload-job/{uuid}/preview

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/upload-job

Authorizations:
customAuthorizer

Responses

/upload-job/aspera

Authorizations:
customAuthorizer

Responses

Create Aspera upload jobs (snake_case transfer-specs contract) and return Aspera Node transfer specs

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

Unique Client identifier in the system

Request Body schema: application/json
required
delivery_pack_uuid
required
string

Identifies the delivery pack these files belong to

required
Array of objects (AsperaTransferSpecFileRequest)

Files to upload and queue for transfer (max 100 per request; batch larger uploads)

object (AsperaUploadMetadataRequest)

Common asset metadata applied as defaults to all files; overridable per-file

Responses

Request samples

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

Response samples

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

/upload-job/{uuid}/upload-part

Authorizations:
customAuthorizer
Request Body schema: application/json
required
partNumber
required
number
uploadId
required
string

Responses

Request samples

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

/upload-job/{uuid}/upload-abort

Authorizations:
customAuthorizer
Request Body schema: application/json
required
uploadId
required
string

Responses

Request samples

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

/upload-job/{uuid}/upload-complete

Authorizations:
customAuthorizer
Request Body schema: application/json
required
required
Array of objects (UploadAssetCompletePart)
uploadId
required
string

Responses

Request samples

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

/upload-job/{uuid}/aspera/re-upload

Authorizations:
customAuthorizer

Responses

Devices

Manage user devices.

Create a new device ready for pairing

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

Unique Client identifier in the system

Responses

Pair device with activation code

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

Unique Client identifier in the system

Request Body schema: application/json
required
code
required
string

Device pairing code

email
required
string

User email

arch
required
string

System architecture

cpus
required
number

Number of CPUs

hostname
required
string

Hostname of the device

platform
required
string

Platform of the device

release
required
string

System release

totalmem
required
number

Total memory in bytes

networkInterfaces
required
Array of strings

Network interface MAC addresses

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "email": "string",
  • "arch": "string",
  • "cpus": 0,
  • "hostname": "string",
  • "platform": "string",
  • "release": "string",
  • "totalmem": 0,
  • "networkInterfaces": [
    ]
}

Get user's active paired devices

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

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Responses

Unpair device

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Discount Codes

Create and manage Discount Codes.

/discount-codes

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/discount-codes/all

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/discount-code/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/discount-code/{uuid}

Authorizations:
customAuthorizer

Responses

/discount-code/{uuid}

Authorizations:
customAuthorizer

Responses

/discount-code

Authorizations:
customAuthorizer

Responses

Emails

Send and manage Emails.

/email

Authorizations:
customAuthorizer
Request Body schema: application/json
required
content
required
string
email
required
string
name
required
string
phone_number
required
string
surname
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "email": "string",
  • "name": "string",
  • "phone_number": "string",
  • "surname": "string"
}

/email/suppressions

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/email/suppressions

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

Responses

Request samples

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

Email Template Content Config

Configure email template content.

/email-template-content-config

Authorizations:
customAuthorizer
Request Body schema: application/json
required
default_subject
required
string
default_text
required
string
default_title
string
override_subject
string
override_text
string
override_title
string
object (EmailTemplateParameterDetails)
parameters
required
Array of strings
template_name
required
string

Responses

Request samples

Content type
application/json
{
  • "default_subject": "string",
  • "default_text": "string",
  • "default_title": "string",
  • "override_subject": "string",
  • "override_text": "string",
  • "override_title": "string",
  • "parameter_details": {
    },
  • "parameters": [
    ],
  • "template_name": "string"
}

Response samples

Content type
application/json
{
  • "default_subject": "string",
  • "default_text": "string",
  • "default_title": "string",
  • "override_subject": "string",
  • "override_text": "string",
  • "override_title": "string",
  • "parameter_details": {
    },
  • "parameters": [
    ],
  • "template_name": "string",
  • "uuid": "string"
}

/email-template-content-config

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/email-template-content-config/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-template-content-config/{uuid}

Authorizations:
customAuthorizer

Responses

/email-template-content-config/{uuid}

Authorizations:
customAuthorizer

Responses

/email-template-content-config/batch/update

Authorizations:
customAuthorizer

Responses

Email Templates

Create and manage Email Templates.

/email-template/names

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-templates

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-templates/client

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-templates/global

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-template/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-template/{uuid}

Authorizations:
customAuthorizer

Responses

/email-template/{uuid}

Authorizations:
customAuthorizer

Responses

/email-template/types/client

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-template/types/global

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-template/types

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-template/type/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/email-template/type/{uuid}

Authorizations:
customAuthorizer

Responses

/email-template/type/{uuid}

Authorizations:
customAuthorizer

Responses

/email-template/type

Authorizations:
customAuthorizer

Responses

/email-template

Authorizations:
customAuthorizer

Responses

/email-template/upload

Authorizations:
customAuthorizer

Responses

/email-template/type/{uuid}/send-test

Authorizations:
customAuthorizer

Responses

/email-template/{uuid}/send-test

Authorizations:
customAuthorizer

Responses

Fields

Create and manage metadata Fields.

/fields

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/field/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/field/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
description
string or null
required
object (FieldEnabledInterface)
extra
string
have_discount
required
boolean
label
required
string
parent_field_uuid
required
string
vida_id
required
number

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "enabled": {
    },
  • "extra": "string",
  • "have_discount": true,
  • "label": "string",
  • "parent_field_uuid": "string",
  • "vida_id": 0
}

/field/{uuid}

Authorizations:
customAuthorizer

Responses

/field

Authorizations:
customAuthorizer
Request Body schema: application/json
required
description
string or null
required
object (FieldEnabledInterface)
extra
string
have_discount
required
boolean
is_global
boolean
key
required
string or boolean
label
required
string
parent_field_uuid
required
string
type_uuid
required
string
vida_id
required
number

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "enabled": {
    },
  • "extra": "string",
  • "have_discount": true,
  • "is_global": true,
  • "key": "string",
  • "label": "string",
  • "parent_field_uuid": "string",
  • "type_uuid": "string",
  • "vida_id": 0
}

Field Types

Create and manage Field Types.

/field-types

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/field-type/{name}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/field-type/{name}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
required
string
parent_field_type_name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_field_type_name": "string"
}

/field-type/{name}

Authorizations:
customAuthorizer

Responses

/field-type

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
required
string
parent_field_type_name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_field_type_name": "string"
}

/field-types/bulk

Authorizations:
customAuthorizer
Request Body schema: application/json
required
field_type_names
required
Array of strings

Responses

Request samples

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

/field-types/all

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Filename Conventions

Create and manage Filename Conventions.

/filename-conventions

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

/filename-convention/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "default_for": [
    ],
  • "file_safe": true,
  • "is_used": true,
  • "name": "string",
  • "notable_fields": [
    ],
  • "separator": "space",
  • "template": "string",
  • "uuid": "string"
}

/filename-convention/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
file_safe
required
boolean
is_used
required
boolean or null
name
required
string
separator
required
string (SeparatorType)
Enum: "space" "hyphen" "underscore" "none" "slash"
template
required
string

Responses

Request samples

Content type
application/json
{
  • "file_safe": true,
  • "is_used": true,
  • "name": "string",
  • "separator": "space",
  • "template": "string"
}

Response samples

Content type
application/json
{
  • "default_for": [
    ],
  • "file_safe": true,
  • "is_used": true,
  • "name": "string",
  • "notable_fields": [
    ],
  • "separator": "space",
  • "template": "string",
  • "uuid": "string"
}

/filename-convention/{uuid}

Authorizations:
customAuthorizer

Responses

/filename-convention

Authorizations:
customAuthorizer
Request Body schema: application/json
required
file_safe
required
boolean
is_used
required
boolean or null
name
required
string
separator
required
string (SeparatorType)
Enum: "space" "hyphen" "underscore" "none" "slash"
template
required
string

Responses

Request samples

Content type
application/json
{
  • "file_safe": true,
  • "is_used": true,
  • "name": "string",
  • "separator": "space",
  • "template": "string"
}

Response samples

Content type
application/json
{
  • "default_for": [
    ],
  • "file_safe": true,
  • "is_used": true,
  • "name": "string",
  • "notable_fields": [
    ],
  • "separator": "space",
  • "template": "string",
  • "uuid": "string"
}

/filename-convention/{uuid}/default-for

Authorizations:
customAuthorizer
Request Body schema: application/json
required
Array of objects (FilenameConventionDefaultForInterface)
Array of objects (FilenameConventionDefaultForInterface)

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
{
  • "default_for": [
    ],
  • "file_safe": true,
  • "is_used": true,
  • "name": "string",
  • "notable_fields": [
    ],
  • "separator": "space",
  • "template": "string",
  • "uuid": "string"
}

/filename-convention/alias

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

/filename-convention/alias

Authorizations:
customAuthorizer
Request Body schema: application/json
required
aliases
required
Array of strings
required
Array of NotableFieldType (strings) or null
full_name
required
string

Responses

Request samples

Content type
application/json
{
  • "aliases": [
    ],
  • "exclusive_for": [
    ],
  • "full_name": "string"
}

Response samples

Content type
application/json
{
  • "aliases": [
    ],
  • "exclusive_for": [
    ],
  • "full_name": "string",
  • "uuid": "string"
}

/filename-convention/alias/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "aliases": [
    ],
  • "exclusive_for": [
    ],
  • "full_name": "string",
  • "uuid": "string"
}

/filename-convention/alias/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
aliases
required
Array of strings
required
Array of NotableFieldType (strings) or null
full_name
required
string

Responses

Request samples

Content type
application/json
{
  • "aliases": [
    ],
  • "exclusive_for": [
    ],
  • "full_name": "string"
}

Response samples

Content type
application/json
{
  • "aliases": [
    ],
  • "exclusive_for": [
    ],
  • "full_name": "string",
  • "uuid": "string"
}

/filename-convention/alias/{uuid}

Authorizations:
customAuthorizer

Responses

/filename-convention/create-filenames

Authorizations:
customAuthorizer
Request Body schema: application/json
required
object
required
Array of objects

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Groups

Create and manage Groups (clients).

/groups

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Lightweight setup-status poll for the client list

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

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Responses

/group/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/group/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
ai_processing_checkout_enabled
boolean
aspera_download_credential_uuid
string
aspera_upload_credential_uuid
string
asset_qa_enabled
boolean
auto_audio_language_detection
boolean
auto_dialogue_track_detection
boolean
client_id
string or null
object
object (CustomAppLinks)
custom_languages_enabled
boolean
object
detect_labels_image
boolean
detect_labels_video
boolean
display_upload_date
boolean
download_limit
number
enable_cold_storage
boolean
enable_directly_cold
boolean
enable_mfa_passkey
boolean
enable_mfa_sms
boolean
enable_mfa_totp
boolean
enable_stay_in_hot
boolean
event_based_ingest_enabled
boolean
external_bucket_credential_uuid
string
external_supervisor_emails
string
fa_is_required
boolean
hybrik_tag
string
hybrik_wasabi_credentials_docker_name
string
hybrik_wasabi_credentials_name
string
internal_bucket_host
string
internal_bucket_name
string
internal_bucket_region
string
job_id
string
librarian_group_id
number
mediapulse_client_name
string
mediapulse_download_sqs_queue
string
mediapulse_download_sqs_queue_1mp
string
mediapulse_download_sqs_queue_la
string
name
string
policies
Array of strings
proxy_filename_source_property
string
purge_assets_safety_net_days
number
support_email
string
object
transcribe_uploaded_assets
boolean
uuid
string
object
wacm_trial
boolean
object

Responses

Request samples

Content type
application/json
{
  • "ai_processing_checkout_enabled": true,
  • "aspera_download_credential_uuid": "string",
  • "aspera_upload_credential_uuid": "string",
  • "asset_qa_enabled": true,
  • "auto_audio_language_detection": true,
  • "auto_dialogue_track_detection": true,
  • "client_id": "string",
  • "config": {
    },
  • "custom_app_links": {
    },
  • "custom_languages_enabled": true,
  • "default_policies": {
    },
  • "detect_labels_image": true,
  • "detect_labels_video": true,
  • "display_upload_date": true,
  • "download_limit": 0,
  • "enable_cold_storage": true,
  • "enable_directly_cold": true,
  • "enable_mfa_passkey": true,
  • "enable_mfa_sms": true,
  • "enable_mfa_totp": true,
  • "enable_stay_in_hot": true,
  • "event_based_ingest_enabled": true,
  • "external_bucket_credential_uuid": "string",
  • "external_supervisor_emails": "string",
  • "fa_is_required": true,
  • "hybrik_tag": "string",
  • "hybrik_wasabi_credentials_docker_name": "string",
  • "hybrik_wasabi_credentials_name": "string",
  • "internal_bucket_host": "string",
  • "internal_bucket_name": "string",
  • "internal_bucket_region": "string",
  • "job_id": "string",
  • "librarian_group_id": 0,
  • "mediapulse_client_name": "string",
  • "mediapulse_download_sqs_queue": "string",
  • "mediapulse_download_sqs_queue_1mp": "string",
  • "mediapulse_download_sqs_queue_la": "string",
  • "name": "string",
  • "policies": [
    ],
  • "proxy_filename_source_property": "string",
  • "purge_assets_safety_net_days": 0,
  • "support_email": "string",
  • "tedial_sqs_priority": {
    },
  • "transcribe_uploaded_assets": true,
  • "uuid": "string",
  • "viewConfig": {
    },
  • "wacm_trial": true,
  • "wizard_policies": {
    }
}

/group/{uuid}

Authorizations:
customAuthorizer

Responses

/group/{uuid}/config

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/group/{uuid}/config

Authorizations:
customAuthorizer

Responses

/group/configs

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Rollback group config to a specific version

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
versionId
required
number

The ID of the version to rollback to

confirm
required
boolean

Confirmation of the rollback

Responses

Request samples

Content type
application/json
{
  • "versionId": 0,
  • "confirm": true
}

/group/config/change-log

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/group/{uuid}/users

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

List multi-client policies for wizard Step 6

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
object (NeverExists)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Validate emails for wizard Step 7 (Attach Users)

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

Unique Client identifier in the system

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

Responses

Request samples

Content type
application/json
null

Response samples

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

/group/origin

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/group

Authorizations:
customAuthorizer
Request Body schema: application/json
required
ai_processing_checkout_enabled
boolean
aspera_download_credential_uuid
string
aspera_upload_credential_uuid
string
asset_qa_enabled
boolean
auto_audio_language_detection
boolean
auto_dialogue_track_detection
boolean
client_id
string or null
object
object (CustomAppLinks)
custom_languages_enabled
boolean
object
detect_labels_image
boolean
detect_labels_video
boolean
display_upload_date
boolean
download_limit
number
enable_cold_storage
boolean
enable_directly_cold
boolean
enable_mfa_passkey
boolean
enable_mfa_sms
boolean
enable_mfa_totp
boolean
enable_stay_in_hot
boolean
event_based_ingest_enabled
boolean
external_bucket_credential_uuid
string
external_supervisor_emails
string
fa_is_required
boolean
hybrik_tag
string
hybrik_wasabi_credentials_docker_name
string
hybrik_wasabi_credentials_name
string
internal_bucket_host
string
internal_bucket_name
string
internal_bucket_region
string
job_id
string
librarian_group_id
number
mediapulse_client_name
string
mediapulse_download_sqs_queue
string
mediapulse_download_sqs_queue_1mp
string
mediapulse_download_sqs_queue_la
string
name
required
string
policies
Array of strings
proxy_filename_source_property
string
purge_assets_safety_net_days
number
support_email
string
object
transcribe_uploaded_assets
boolean
uuid
required
string
wacm_trial
boolean
object (WizardConfig)
object

Responses

Request samples

Content type
application/json
{
  • "ai_processing_checkout_enabled": true,
  • "aspera_download_credential_uuid": "string",
  • "aspera_upload_credential_uuid": "string",
  • "asset_qa_enabled": true,
  • "auto_audio_language_detection": true,
  • "auto_dialogue_track_detection": true,
  • "client_id": "string",
  • "config": {
    },
  • "custom_app_links": {
    },
  • "custom_languages_enabled": true,
  • "default_policies": {
    },
  • "detect_labels_image": true,
  • "detect_labels_video": true,
  • "display_upload_date": true,
  • "download_limit": 0,
  • "enable_cold_storage": true,
  • "enable_directly_cold": true,
  • "enable_mfa_passkey": true,
  • "enable_mfa_sms": true,
  • "enable_mfa_totp": true,
  • "enable_stay_in_hot": true,
  • "event_based_ingest_enabled": true,
  • "external_bucket_credential_uuid": "string",
  • "external_supervisor_emails": "string",
  • "fa_is_required": true,
  • "hybrik_tag": "string",
  • "hybrik_wasabi_credentials_docker_name": "string",
  • "hybrik_wasabi_credentials_name": "string",
  • "internal_bucket_host": "string",
  • "internal_bucket_name": "string",
  • "internal_bucket_region": "string",
  • "job_id": "string",
  • "librarian_group_id": 0,
  • "mediapulse_client_name": "string",
  • "mediapulse_download_sqs_queue": "string",
  • "mediapulse_download_sqs_queue_1mp": "string",
  • "mediapulse_download_sqs_queue_la": "string",
  • "name": "string",
  • "policies": [
    ],
  • "proxy_filename_source_property": "string",
  • "purge_assets_safety_net_days": 0,
  • "support_email": "string",
  • "tedial_sqs_priority": {
    },
  • "transcribe_uploaded_assets": true,
  • "uuid": "string",
  • "wacm_trial": true,
  • "wizard": {
    },
  • "wizard_policies": {
    }
}

/group/{uuid}/logo

Authorizations:
customAuthorizer
Request Body schema: application/json
required
file_name
required
string
file_type
required
string
logo_type
required
string (GroupLogoType)
Enum: "document_logo" "watermark_logo" "client_logo_light" "client_logo_dark" "connect2_logo_header" "connect2_logo_footer" "connect2_logo_login" "email_logo" "shared_collection_watermark" "storefront_logo_login" "storefront_logo_header" "storefront_hero_banner"

Responses

Request samples

Content type
application/json
{
  • "file_name": "string",
  • "file_type": "string",
  • "logo_type": "document_logo"
}

/group/{uuid}/logo

Authorizations:
customAuthorizer
Request Body schema: application/json
required
group_logo_uuid
required
string
status
required
string
Enum: "error" "uploaded"

Responses

Request samples

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

/group/{uuid}/logo

Authorizations:
customAuthorizer
Request Body schema: application/json
required
group_logo_uuid
required
string

Responses

Request samples

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

/group/{uuid}/audio-default-mapping

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/group/{uuid}/audio-default-mapping

Authorizations:
customAuthorizer

Responses

/group/reindex

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/group/reindex

Authorizations:
customAuthorizer
Request Body schema: application/json
required
is_partial
required
boolean
required
Array of objects
requested_at
string

Responses

Request samples

Content type
application/json
{
  • "is_partial": true,
  • "jobs": [
    ],
  • "requested_at": "string"
}

/group/{uuid}/supplier-aspera-keys

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/group/{uuid}/supplier-aspera-keys/extra

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/group/{uuid}/supplier-aspera-key/{supplier_uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

/group/{uuid}/supplier-aspera-key/{supplier_uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

/group/{uuid}/configuration/export

Authorizations:
customAuthorizer
Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "database": {
    },
  • "firestore": {
    }
}

/group/{uuid}/configuration/import

Authorizations:
customAuthorizer

Responses

/groups/hostname/regex

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

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

Create a hostname for a client

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

The hostname to validate, e.g. "example.connect2.vida.studio"

type
required
string
Enum: "connect2" "storefront"

The application type for this hostname

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "type": "connect2"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "message": "string",
  • "valid": true
}

Validate a hostname for a client

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

The hostname to validate, e.g. "example.connect2.vida.studio"

type
required
string
Enum: "connect2" "storefront"

The application type for this hostname

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "type": "connect2"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "message": "string",
  • "valid": true
}

Hybrik

Hybrik transcoding operations.

/hybrik/{uuid}/list

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/hybrik/job/{jobId}/restart

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

Responses

Request samples

Content type
application/json
{ }

/hybrik/job/{jobId}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/hybrik/job/create

Authorizations:
customAuthorizer
Request Body schema: application/json
required
definitions
object
expiration
number
name
required
string
required
object
priority
number
schema
string
subscription_key
string
object (TaskRetryHybrikJobRequest)
task_tags
Array of strings
user_data
any
user_tag
string

Responses

Request samples

Content type
application/json
{
  • "definitions": { },
  • "expiration": 0,
  • "name": "string",
  • "payload": {
    },
  • "priority": 0,
  • "schema": "string",
  • "subscription_key": "string",
  • "task_retry": {
    },
  • "task_tags": [
    ],
  • "user_data": null,
  • "user_tag": "string"
}

Jobs

Create and manage transcoding Jobs.

/job/types

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/job/types/admin

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/job/type/{uuid}

Authorizations:
customAuthorizer

Responses

/job/type

Authorizations:
customAuthorizer

Responses

/job/dependencies/satisfied

Authorizations:
customAuthorizer

Responses

/jobs/asset/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/job/{uuid}

Authorizations:
customAuthorizer

Responses

/job/{uuid}

Authorizations:
customAuthorizer

Responses

Update the status of a job (allowed statuses: completed, failed)

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: "completed" "failed"

The new status of the job (allowed: completed, failed)

Responses

Request samples

Content type
application/json
{
  • "status": "completed"
}

KPI Thresholds

Create and manage KPI thresholds.

/kpi-thresholds

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/kpi-threshold/{type}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "at_risk_threshold": 0,
  • "comparison_direction": "higher_is_better",
  • "kpi_key": "throughput-volume",
  • "target_value": 0,
  • "unit_value": "percent"
}

Partially update a KPI threshold by kpiKey

Authorizations:
customAuthorizer
path Parameters
type
required
string

Type

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Request Body schema: application/json
required
target_value
number

Target value for the KPI threshold

at_risk_threshold
number

At-risk threshold value

unit_value
string
Enum: "percent" "count" "minutes" "hours" "days"

Unit of measurement for the threshold value

comparison_direction
string
Enum: "higher_is_better" "lower_is_better"

Comparison direction for the KPI

Responses

Request samples

Content type
application/json
{
  • "target_value": 0,
  • "at_risk_threshold": 0,
  • "unit_value": "percent",
  • "comparison_direction": "higher_is_better"
}

Response samples

Content type
application/json
{
  • "at_risk_threshold": 0,
  • "comparison_direction": "higher_is_better",
  • "kpi_key": "throughput-volume",
  • "target_value": 0,
  • "unit_value": "percent"
}

/kpi-threshold/{type}

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

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"
}

Add a KPI threshold

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

Unique Client identifier in the system

Request Body schema: application/json
required
kpi_key
required
string
Enum: "throughput-volume" "rejection-rate" "rework-rate" "issue-resolution-rate" "mean-issue-resolution-time" "throughput-trend" "first-pass-approval-rate" "rejection-reason-distribution" "open-issue-count" "resolved-issue-count"

KPI key identifier

target_value
required
number

Target value for the KPI threshold

at_risk_threshold
number

At-risk threshold value

unit_value
required
string
Enum: "percent" "count" "minutes" "hours" "days"

Unit of measurement for the threshold value

comparison_direction
required
string
Enum: "higher_is_better" "lower_is_better"

Comparison direction for the KPI

Responses

Request samples

Content type
application/json
{
  • "kpi_key": "throughput-volume",
  • "target_value": 0,
  • "at_risk_threshold": 0,
  • "unit_value": "percent",
  • "comparison_direction": "higher_is_better"
}

Response samples

Content type
application/json
{
  • "at_risk_threshold": 0,
  • "comparison_direction": "higher_is_better",
  • "kpi_key": "throughput-volume",
  • "target_value": 0,
  • "unit_value": "percent"
}

Languages

Create and manage Languages.

/languages

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/languages/all

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/languages/client

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/languages/client

Authorizations:
customAuthorizer
Request Body schema: application/json
required
archive
required
boolean
audio
required
boolean
code
required
string
document
required
boolean
image
required
boolean
label
required
string
language_label
required
string
language_uuid
required
string
other
required
boolean
timed_text
required
boolean
title_manager
required
boolean
video
required
boolean

Responses

Request samples

Content type
application/json
{
  • "archive": true,
  • "audio": true,
  • "code": "string",
  • "document": true,
  • "image": true,
  • "label": "string",
  • "language_label": "string",
  • "language_uuid": "string",
  • "other": true,
  • "timed_text": true,
  • "title_manager": true,
  • "video": true
}

/languages/client/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
archive
required
boolean
audio
required
boolean
code
required
string
document
required
boolean
image
required
boolean
label
required
string
language_label
required
string
language_uuid
required
string
other
required
boolean
timed_text
required
boolean
title_manager
required
boolean
video
required
boolean

Responses

Request samples

Content type
application/json
{
  • "archive": true,
  • "audio": true,
  • "code": "string",
  • "document": true,
  • "image": true,
  • "label": "string",
  • "language_label": "string",
  • "language_uuid": "string",
  • "other": true,
  • "timed_text": true,
  • "title_manager": true,
  • "video": true
}

/languages/client/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
archive
required
boolean
audio
required
boolean
code
required
string
document
required
boolean
image
required
boolean
label
required
string
language_label
required
string
language_uuid
required
string
other
required
boolean
timed_text
required
boolean
title_manager
required
boolean
video
required
boolean

Responses

Request samples

Content type
application/json
{
  • "archive": true,
  • "audio": true,
  • "code": "string",
  • "document": true,
  • "image": true,
  • "label": "string",
  • "language_label": "string",
  • "language_uuid": "string",
  • "other": true,
  • "timed_text": true,
  • "title_manager": true,
  • "video": true
}

Licensed Packages

Create and manage Licensed Packages.

List Licensed Packages

Authorizations:
customAuthorizer
query Parameters
contract_in
string

Contract in

contract_out
string

Contract out

expires_before
string

Expires before

created_via
enum

Filters Licensed Packages by what created them: send-via-connect2

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

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
string

Filters Licensed Packages. Matches the package (name, description, external reference, uuid), the people on it (owner, whoever added items, and the members of a licensee holding a contract on it), the contract and licensee themselves, and the fields of the assets the package contains (filename / asset uid, client ref, series, episode and — for BBCMG — programme and tape number). Packages matched through their assets carry matched_assets in the response.

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

Cache-Control
object

Overrides default cache behaviour.

Responses

/licensed-packages/searchV2

Authorizations:
customAuthorizer

Responses

/licensed-package/{uuid}/search

Authorizations:
customAuthorizer

Responses

List Licensed Packages for Connect2

Authorizations:
customAuthorizer
query Parameters
expires_before
string

Expires before

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
string

Filters Licensed Packages. Matches the package (name, description, external reference, uuid), the people on it (owner, whoever added items, and the members of a licensee holding a contract on it), the contract and licensee themselves, and the fields of the assets the package contains (filename / asset uid, client ref, series, episode and — for BBCMG — programme and tape number). Packages matched through their assets carry matched_assets in the response.

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

Cache-Control
object

Overrides default cache behaviour.

Responses

Get all Content Corner landing page sections for Connect2 in a single request

Authorizations:
customAuthorizer
query Parameters
expires_before
string

Expires before

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

filter
string

Filters Licensed Packages. Matches the package (name, description, external reference, uuid), the people on it (owner, whoever added items, and the members of a licensee holding a contract on it), the contract and licensee themselves, and the fields of the assets the package contains (filename / asset uid, client ref, series, episode and — for BBCMG — programme and tape number). Packages matched through their assets carry matched_assets in the response.

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

Cache-Control
object

Overrides default cache behaviour.

Responses

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

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": [
    ]
}

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

Responses

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

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

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

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

scope
enum

Scope of the results: current_client limits users and their policies to the current client, all_clients (default) returns everything

policy
string

Policy uuid — only users that have this policy attached

app
enum

App — only users that can log into this app (have its login permission)

no-supplier
string

Filter users without a supplier assigned in the current group (pass "true" to enable)

Cache-Control
object

Overrides default cache behaviour.

Responses

Resolve who can access a licensed package

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

query Parameters
ended-after
string

ISO 8601 date. Drops contract windows that ended before it. Defaults to full history.

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Responses

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

status
string
Enum: "draft" "active"

Status of the licensed package, draft when omitted

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",
  • "status": "draft",
  • "options": {
    }
}

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"
}

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": [
    ]
}

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": [
    ]
}

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": [
    ]
}

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": [
    ]
}

Localization

Manage localization settings.

Logging Info

Manage asset logging information.

GET Logging Info (EDL) by UUID

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.

Responses

Update Logging Info (EDL) by UUID

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
string

UUID of the logging info

logging_type
string

UUID of the logging type

note
string

Additional note for the logging info

textless_required
string

Indicates if textless version is required

selector
string

Selector for the logging info

grade
string

Grade for the logging info

response
string

Response for the logging info

event
string
Enum: "Slate" "Opening titles" "Lower third" "Burnt-in subtitle" "Programme graphic" "Archive text" "Scene text (in picture)" "Clothing text" "End credits" "Textless element"

QC Text Log event of the logging info

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "logging_type": "string",
  • "note": "string",
  • "textless_required": "string",
  • "selector": "string",
  • "grade": "string",
  • "response": "string",
  • "event": "Slate"
}

Delete Logging Info (EDL) by UUID

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 all Logging Infos (EDL) for an asset

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

query Parameters
page
string

Page number; sending per-page switches the response to the paginated shape

per-page
string

Items per page (1-1000, default 500)

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

Update Logging Infos (EDL) for 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
Array
uuid
string

UUID of the logging info

logging_type
string

UUID of the logging type

note
string

Additional note for the logging info

textless_required
string

Indicates if textless version is required

selector
string

Selector for the logging info

grade
string

Grade for the logging info

response
string

Response for the logging info

event
string
Enum: "Slate" "Opening titles" "Lower third" "Burnt-in subtitle" "Programme graphic" "Archive text" "Scene text (in picture)" "Clothing text" "End credits" "Textless element"

QC Text Log event of the logging info

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Create Logging Info (EDL)

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

Unique Client identifier in the system

Request Body schema: application/json
required
Array
uuid
required
string

UUID of the logging info

asset
required
string

UUID of the asset this logging info is related to

logging_type
required
string

UUID of the logging type

note
string

Additional note for the logging info

textless_required
string

Indicates if textless version is required

selector
string

Selector for the logging info

grade
string

Grade for the logging info

response
string

Response for the logging info

event
string
Enum: "Slate" "Opening titles" "Lower third" "Burnt-in subtitle" "Programme graphic" "Archive text" "Scene text (in picture)" "Clothing text" "End credits" "Textless element"

QC Text Log event of the logging info

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get auto complete notes for Logging Info (EDL)

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

Unique Client identifier in the system

Request Body schema: application/json
required
Array
logging_type_uuid
required
string

UUID of the logging type

keyword
required
string

Keyword for the logging info

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Set Status for Logging Info (EDL) by UUID

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
string
Enum: "Signed Off" "Best Possible" "Creative Intent" "Fixed" "Fix Required"

Status to set for the logging info

Responses

Request samples

Content type
application/json
{
  • "status": "Signed Off"
}

Edit a QC recommendation — atomically soft-deletes the original and creates a replacement attributed to the editor

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

New recommendation detail

status
string
Enum: "Signed Off" "Best Possible" "Creative Intent" "Fixed" "Fix Required"

Status for the recommendation

Responses

Request samples

Content type
application/json
{
  • "note": "string",
  • "status": "Signed Off"
}

Create Logging Info Response

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

Text of the logging info response

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Update Logging Info Response

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

Text of the logging info response

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete Logging Info Response

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 Logging Info Response History by UUID

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.

Responses

GET Audit History for a QC report (all QC error entry events)

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

category
enum

Filter by category: entry (create/edit/delete) or status

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

GET prediction reviews of an asset (what operators did with detected entries)

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

GET prediction reviews counted by day, outcome and predicted label

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

Unique Client identifier in the system

from
string

Decided on or after this date

to
string

Decided on or before this date

label
string

Only reviews whose prediction was this logging type name

client
string

Only reviews of this client (super admin; others always see their own)

Cache-Control
object

Overrides default cache behaviour.

Responses

Validate a VidChecker AQC XML report against an asset before import

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Import a VidChecker AQC XML report into 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

Responses

Logging Types

Create and manage Logging Types.

/logging-types

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/logging-type/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/logging-type/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
extra
string
icon
string
name
string

Responses

Request samples

Content type
application/json
{
  • "extra": "string",
  • "icon": "string",
  • "name": "string"
}

/logging-type/{uuid}

Authorizations:
customAuthorizer

Responses

/logging-type

Authorizations:
customAuthorizer

Responses

MediaPulse

MediaPulse integration operations.

/mediapulse/client/{id}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Metadata Snapshots

Manage metadata snapshots.

/metadata-snapshot

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/metadata-snapshot

Authorizations:
customAuthorizer

Responses

Response samples

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

/metadata-snapshot

Authorizations:
customAuthorizer

Responses

Response samples

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

/metadata-snapshot

Authorizations:
customAuthorizer

Responses

/metadata-snapshot/run

Authorizations:
customAuthorizer

Responses

/metadata-snapshot/download/{hash}

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "expires_at": "string",
  • "filename": "string",
  • "size": 0,
  • "type": "string",
  • "url": "string"
}

N8N Subscriptions

Manage N8N webhook subscriptions.

Create N8N subscription

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

Unique Client identifier in the system

Request Body schema: application/json
required
webhookUrl
required
string

Webhook URL where events will be delivered

application
required
string

Application name (vida, launchpad, storefront, connect2 or mediafactory)

eventTypes
required
Array of strings

List of event types to subscribe to

groupUuids
Array of strings

Optional list of group UUIDs to filter events

workflowId
string

Optional workflow ID from n8n

nodeId
string

Optional node ID from n8n

workflowName
string

Optional workflow name from n8n

Responses

Request samples

Content type
application/json
{
  • "webhookUrl": "string",
  • "application": "string",
  • "eventTypes": [
    ],
  • "groupUuids": [
    ],
  • "workflowId": "string",
  • "nodeId": "string",
  • "workflowName": "string"
}

Delete N8N subscription

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 N8N subscription status

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.

Responses

Update N8N subscription settings (e.g. after node settings change)

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

Unique Client identifier in the system

Responses

Deactivate N8N subscription

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Deactivate N8N subscriptions by workflow ID

Authorizations:
customAuthorizer
path Parameters
workflowId
required
string

n8n workflow ID

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Get event types for N8N application

Authorizations:
customAuthorizer
path Parameters
application
required
string

Application name (vida, launchpad, storefront, connect2 or mediafactory)

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
{
  • "application": "string",
  • "eventTypes": [
    ]
}

Get accessible groups for N8N subscriptions

Authorizations:
customAuthorizer
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
{
  • "groups": [
    ]
}

Notifications

Manage user notifications.

/notifications

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

/notifications/combined

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

/notification/mark-as-read/{uuid}

Authorizations:
customAuthorizer

Responses

Response samples

Content type
application/json
{
  • "category": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "event_type": "string",
  • "id": 0,
  • "message": {
    },
  • "read_at": "2019-08-24T14:15:22Z",
  • "subject": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "string"
}

/notifications/mark-as-read

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

Responses

Request samples

Content type
application/json
{ }

Notifications Config

Manage notification configuration.

/notifications-config

Authorizations:
customAuthorizer
Request Body schema: application/json
required
asset_added_licensed_package
required
boolean
material_availability_start
required
boolean
object (NotificationTypesConfig)
order_download_expiry_reminder
required
boolean
reminder_days_before_order_download_expiry
number
rights_contract_end
required
boolean
rights_contract_start
required
boolean
sort_assets_list_by_field
required
string
sort_assets_list_order_dir
required
string

Responses

Request samples

Content type
application/json
{
  • "asset_added_licensed_package": true,
  • "material_availability_start": true,
  • "notification_types_config": {
    },
  • "order_download_expiry_reminder": true,
  • "reminder_days_before_order_download_expiry": 0,
  • "rights_contract_end": true,
  • "rights_contract_start": true,
  • "sort_assets_list_by_field": "string",
  • "sort_assets_list_order_dir": "string"
}

Response samples

Content type
application/json
{
  • "asset_added_licensed_package": true,
  • "material_availability_start": true,
  • "notification_types_config": {
    },
  • "order_download_expiry_reminder": true,
  • "reminder_days_before_order_download_expiry": 0,
  • "rights_contract_end": true,
  • "rights_contract_start": true,
  • "sort_assets_list_by_field": "string",
  • "sort_assets_list_order_dir": "string",
  • "uuid": "string"
}

/notifications-config

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notifications-config/filters

Authorizations:
customAuthorizer

Responses

/notifications-config/filters

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notifications-config/{uuid}

Authorizations:
customAuthorizer

Responses

/notifications-config/{uuid}

Authorizations:
customAuthorizer

Responses

Notification Subscriptions

Manage notification subscriptions.

/notification-subscription/types

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscriptions/setup

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscriptions

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscriptions/all

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscriptions/{type}/users

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscriptions/{type}/subscriptions

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscription/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscription/{uuid}

Authorizations:
customAuthorizer

Responses

/notification-subscription/{uuid}

Authorizations:
customAuthorizer

Responses

/notification-subscription/{uuid}/notifications

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscriptions/user/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/notification-subscription

Authorizations:
customAuthorizer

Responses

/notification-subscriptions/batch-all

Authorizations:
customAuthorizer

Responses

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

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" "accessible"

Order type filter (for backward compatibility)

Responses

Request samples

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

/order/searchV2

Authorizations:
customAuthorizer

Responses

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

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.

Responses

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
}

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

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"
}

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.

Responses

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.

Responses

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.

Responses

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.

Responses

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

An Aspera Download setup for an Order

Authorizations:
customAuthorizer
path Parameters
hash
required
string

Hash

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
{
  • "cookie": "string",
  • "faspPort": 0,
  • "paths": [
    ],
  • "remoteHost": "string",
  • "remoteUser": "string",
  • "sshPort": 0,
  • "token": "string",
  • "transferUuid": "string"
}

List download links for an Order

Authorizations:
customAuthorizer
path Parameters
hash
required
string

Hash

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
[
  • {
    }
]

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.

Responses

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

Create an Order

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

Unique Client identifier in the system

Responses

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

Download row ids: an order item uuid, optionally suffixed with : to download only the file that config produced

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"
}

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": [
    ]
}

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": [
    ]
}

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

Responses

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"
}

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": [
    ]
}

/order/{uuid}/search

Authorizations:
customAuthorizer

Responses

/order/{uuid}/approve

Authorizations:
customAuthorizer

Responses

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"
}

Partners

Create and manage Partners.

List Licensees

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

Unique Client identifier in the system

filter
string

Filters Licensees. Matches the licensee itself (name, external partner id, uuid), the users attached to it (by display name, email or uuid), its rights contracts (name, contract id), the licensed packages held on those contracts (name, external reference) and — through those packages — the fields of the assets they contain (filename / asset uid, client ref, series, episode, programme number, tape number). Licensees matched through their assets carry matched_assets and matched_via_contracts in the response.

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

/partner/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/partner/{uuid}

Authorizations:
customAuthorizer

Responses

/partner/{uuid}

Authorizations:
customAuthorizer

Responses

/partner

Authorizations:
customAuthorizer

Responses

/partner/{uuid}/attach-users

Authorizations:
customAuthorizer

Responses

/partner/{uuid}/detach-users

Authorizations:
customAuthorizer

Responses

Permissions

List and manage Permissions.

/permission/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/permission/{uuid}

Authorizations:
customAuthorizer

Responses

/permission/{uuid}

Authorizations:
customAuthorizer

Responses

/permissions

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/permission

Authorizations:
customAuthorizer

Responses

Policies

Create and manage Policies.

/policies

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/policies/empty

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/policies/list

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/policy/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/policy/{uuid}

Authorizations:
customAuthorizer

Responses

/policy/{uuid}

Authorizations:
customAuthorizer

Responses

/policy/{uuid}/users

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/policy/{uuid}/logs

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/policy/{uuid}/export

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/policies/import

Authorizations:
customAuthorizer

Responses

/policy

Authorizations:
customAuthorizer

Responses

/policies/{uuid}/groups

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/policies/{uuid}/groups

Authorizations:
customAuthorizer

Responses

/policies/{uuid}/groups/{groupUuid}

Authorizations:
customAuthorizer

Responses

Preview Requests

Create and manage Preview Requests.

/preview-requests

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/preview-request/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/preview-requests/searchV2

Authorizations:
customAuthorizer

Responses

/preview-request/retry

Authorizations:
customAuthorizer

Responses

/preview-request/{uuid}/search

Authorizations:
customAuthorizer

Responses

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, project identifier, people, assets)

project-type
string

Project type

project-status
string

Project status

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.

Responses

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

Responses

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

Responses

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

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

Responses

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.

Responses

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

Responses

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)

error_uuid
string

UUID of the QC error (LoggingInfo) the comment is attached to (optional)

Responses

QA Configs

Create and manage QA configurations.

/qa-configs

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/qa-config/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/qa-config/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
asset_type
string
audio_bit_depth
Array of numbers
audio_codec
Array of strings
audio_sample_rate
Array of numbers
bit_depth
Array of numbers
channel_count
Array of numbers
channels_per_track
Array of numbers
chroma_format
Array of strings
dropped_frames
boolean
file_extension
Array of strings
framerate
Array of strings
height
Array of numbers
interlace_mode
Array of strings
timecode_start
Array of strings
video_codec
Array of strings
width
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "asset_type": "string",
  • "audio_bit_depth": [
    ],
  • "audio_codec": [
    ],
  • "audio_sample_rate": [
    ],
  • "bit_depth": [
    ],
  • "channel_count": [
    ],
  • "channels_per_track": [
    ],
  • "chroma_format": [
    ],
  • "dropped_frames": true,
  • "file_extension": [
    ],
  • "framerate": [
    ],
  • "height": [
    ],
  • "interlace_mode": [
    ],
  • "timecode_start": [
    ],
  • "video_codec": [
    ],
  • "width": [
    ]
}

/qa-config/{uuid}

Authorizations:
customAuthorizer

Responses

/qa-config

Authorizations:
customAuthorizer
Request Body schema: application/json
required
asset_type
required
string
audio_bit_depth
required
Array of numbers
audio_codec
required
Array of strings
audio_sample_rate
required
Array of numbers
bit_depth
required
Array of numbers
channel_count
required
Array of numbers
channels_per_track
required
Array of numbers
chroma_format
required
Array of strings
dropped_frames
required
boolean
file_extension
required
Array of strings
framerate
required
Array of strings
height
required
Array of numbers
interlace_mode
required
Array of strings
timecode_start
required
Array of strings
uuid
required
string
video_codec
required
Array of strings
width
required
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "asset_type": "string",
  • "audio_bit_depth": [
    ],
  • "audio_codec": [
    ],
  • "audio_sample_rate": [
    ],
  • "bit_depth": [
    ],
  • "channel_count": [
    ],
  • "channels_per_track": [
    ],
  • "chroma_format": [
    ],
  • "dropped_frames": true,
  • "file_extension": [
    ],
  • "framerate": [
    ],
  • "height": [
    ],
  • "interlace_mode": [
    ],
  • "timecode_start": [
    ],
  • "uuid": "string",
  • "video_codec": [
    ],
  • "width": [
    ]
}

QC Reports

Generate and manage QC reports.

Export QC report as JSON for a given asset UUID

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 (NeverExists)

Responses

Request samples

Content type
application/json
{ }

Import a previously exported VIDA QC JSON report into the specified 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 (QcReportImportBody)

Responses

Request samples

Content type
application/json
null

Claim a QC report — records today as the QC date for the asset header (Assign to me)

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 (NeverExists)

Responses

Request samples

Content type
application/json
{ }

Quarantine Configs

Create and manage Quarantine configurations.

/quarantine-configs

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/quarantine-config/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/quarantine-config/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
group_uuid
required
string
required
object (QuarantineConfigRules)
supplier_uuid
string

Responses

Request samples

Content type
application/json
{
  • "group_uuid": "string",
  • "rules": {
    },
  • "supplier_uuid": "string"
}

/quarantine-config/{uuid}

Authorizations:
customAuthorizer

Responses

/quarantine-config

Authorizations:
customAuthorizer
Request Body schema: application/json
required
group_uuid
required
string
required
object (QuarantineConfigRules)
supplier_uuid
string

Responses

Request samples

Content type
application/json
{
  • "group_uuid": "string",
  • "rules": {
    },
  • "supplier_uuid": "string"
}

Rates

Manage pricing rates.

/rates

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "billing_day_of_the_month": 0,
  • "currency": "string",
  • "monthly": {
    },
  • "transactional": {
    }
}

/rates

Authorizations:
customAuthorizer
Request Body schema: application/json
required
billing_day_of_the_month
number
currency
string
object (RatesMonthlyType)
object (RatesTransactionalType)

Responses

Request samples

Content type
application/json
{
  • "billing_day_of_the_month": 0,
  • "currency": "string",
  • "monthly": {
    },
  • "transactional": {
    }
}

Response samples

Content type
application/json
{ }

Ratings

Create and manage Ratings.

/ratings

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/rating/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/rating/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
string
system_uuid
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "system_uuid": "string"
}

/rating/{uuid}

Authorizations:
customAuthorizer

Responses

/rating

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
required
string
system_uuid
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "system_uuid": "string"
}

/rating/systems

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/rating/system/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/rating/system/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

/rating/system/{uuid}

Authorizations:
customAuthorizer

Responses

/rating/system

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

Release Notes

Create and manage Release Notes.

/release/note/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Update release note payload

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
string
Enum: "Published" "Draft" "Rejected"

Release note status

sprint
string

Sprint identifier

title
string

Release note title

description
string

Release note description

Responses

Request samples

Content type
application/json
{
  • "status": "Published",
  • "sprint": "string",
  • "title": "string",
  • "description": "string"
}

/release/note/{uuid}

Authorizations:
customAuthorizer

Responses

Create release note payload

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

Unique Client identifier in the system

Request Body schema: application/json
required
number
required
string

Release note number / identifier

issue_type
string
Enum: "Task" "Feature" "Bug"

GitHub issue type

sprint
required
string

Sprint identifier

title
required
string

Release note title

description
required
string

Release note description

release_uuid
string

UUID of the release this note belongs to

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "issue_type": "Task",
  • "sprint": "string",
  • "title": "string",
  • "description": "string",
  • "release_uuid": "string"
}

Check if note exists

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

Unique Client identifier in the system

Request Body schema: application/json
required
number
required
string

Release note number / identifier

issue_type
string
Enum: "Task" "Feature" "Bug"

GitHub issue type

sprint
required
string

Sprint identifier

title
required
string

Release note title

description
required
string

Release note description

release_uuid
string

UUID of the release this note belongs to

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "issue_type": "Task",
  • "sprint": "string",
  • "title": "string",
  • "description": "string",
  • "release_uuid": "string"
}

Batch delete release notes

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

Unique Client identifier in the system

Responses

Get paginated releases

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

Get single release

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.

Responses

Update existing 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
status
string
Enum: "Published" "Draft"

Release status

Responses

Request samples

Content type
application/json
{
  • "status": "Published"
}

/release/{uuid}

Authorizations:
customAuthorizer

Responses

Reports

Generate reports.

/report/export

Authorizations:
customAuthorizer

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 — the contract, its licensee, its licensed packages, the licensee members, or the assets those packages contain

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

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.

Responses

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

pre_contract_lead_time_days
number

Contract-level pre-contract lead time in whole days (material becomes available this many days before start). Omit to inherit the group default.

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": {
    },
  • "pre_contract_lead_time_days": 0,
  • "partner": {
    },
  • "licensed_package_uuids": [
    ],
  • "licensed_package_names": [
    ],
  • "licensed_package_count": 0,
  • "status": "string",
  • "partner_uuid": "string",
  • "licensed_packages_to_attach": [
    ],
  • "licensed_packages_to_detach": [
    ]
}

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

Responses

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.

Responses

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

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

pre_contract_lead_time_days
number

Contract-level pre-contract lead time in whole days (material becomes available this many days before start). Omit to inherit the group default.

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,
  • "pre_contract_lead_time_days": 0,
  • "partner_uuid": "string",
  • "licensed_package_uuids": [
    ]
}

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

Responses

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)

lead_time_days
number

Optional per-package pre-contract lead time in whole days. Omit to inherit the contract-level lead time (which falls back to the group default).

Responses

Request samples

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

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.

lead_time_days
number

Optional per-package pre-contract lead time in whole days. Send null to clear (inherit the contract-level lead time).

Responses

Request samples

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

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": [
    ]
}

Search

Search assets across collections and groups.

/search

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Autocomplete distinct values for a search field, narrowed like a regular search: the body is a normal searchV2 body plus `field` (target filter label), optional `q` (typed input) and `wildcard` (contains instead of prefix match). The target field own selection is ignored.

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

Unique Client identifier in the system

Responses

/search/filter-metadata/{type}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/searchV2

Authorizations:
customAuthorizer
Request Body schema: application/json
required
advanced_mode
boolean
false (boolean) or Array of strings

Aggregations to compute: omitted for all of them, false for none, or the names of the ones wanted.

object (EntityFilters)
es_only
boolean
fields
Array of strings
object (AssetSearchFiltersTypeV2)
selected_asset_uuids
Array of strings
text
string

Responses

Request samples

Content type
application/json
{
  • "advanced_mode": true,
  • "aggs": false,
  • "entity_filters": {
    },
  • "es_only": true,
  • "fields": [
    ],
  • "filters": {
    },
  • "selected_asset_uuids": [
    ],
  • "text": "string"
}

Aggregations and total of an asset search, without its hits

Same body, filters and permissions as POST /searchV2, answered as aggs and total beside an empty data. aggs in the body names the aggregations to compute; omitted, every one is.

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

Unique Client identifier in the system

Request Body schema: application/json
required
advanced_mode
boolean
false (boolean) or Array of strings

Aggregations to compute: omitted for all of them, false for none, or the names of the ones wanted.

object (EntityFilters)
es_only
boolean
fields
Array of strings
object (AssetSearchFiltersTypeV2)
selected_asset_uuids
Array of strings
text
string

Responses

Request samples

Content type
application/json
{
  • "advanced_mode": true,
  • "aggs": false,
  • "entity_filters": {
    },
  • "es_only": true,
  • "fields": [
    ],
  • "filters": {
    },
  • "selected_asset_uuids": [
    ],
  • "text": "string"
}

Response samples

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

/search/qc-required

Authorizations:
customAuthorizer
Request Body schema: application/json
required
advanced_mode
boolean
false (boolean) or Array of strings

Aggregations to compute: omitted for all of them, false for none, or the names of the ones wanted.

object (EntityFilters)
es_only
boolean
fields
Array of strings
object (AssetSearchFiltersTypeV2)
selected_asset_uuids
Array of strings
text
string

Responses

Request samples

Content type
application/json
{
  • "advanced_mode": true,
  • "aggs": false,
  • "entity_filters": {
    },
  • "es_only": true,
  • "fields": [
    ],
  • "filters": {
    },
  • "selected_asset_uuids": [
    ],
  • "text": "string"
}

/searchV2/clips

Authorizations:
customAuthorizer
Request Body schema: application/json
required
advanced_mode
boolean
false (boolean) or Array of strings

Aggregations to compute: omitted for all of them, false for none, or the names of the ones wanted.

object (EntityFilters)
es_only
boolean
fields
Array of strings
object (AssetSearchFiltersTypeV2)
selected_asset_uuids
Array of strings
text
string

Responses

Request samples

Content type
application/json
{
  • "advanced_mode": true,
  • "aggs": false,
  • "entity_filters": {
    },
  • "es_only": true,
  • "fields": [
    ],
  • "filters": {
    },
  • "selected_asset_uuids": [
    ],
  • "text": "string"
}

One keyword across every container type the caller may see. Body: `keyword` (required) and `per_group` (optional, 1-25, default 5). A type the caller holds no permission on is absent from `groups`; a type whose own query failed comes back with `status: "failed"`, as does every type sharing a keyword resolution that failed. `total` counts every match, except that orders stop at 1000 and then answer `total_capped: true`.

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

Unique Client identifier in the system

Request Body schema: application/json
required
keyword
string
per_group
number

Responses

Request samples

Content type
application/json
{
  • "keyword": "string",
  • "per_group": 0
}

Connect2

Send assets or licensed packages to licensees via Connect2

Send assets or licensed packages to licensees via Connect2 in one call

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

Unique Client identifier in the system

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

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "access_from": "string",
  • "access_until": "string",
  • "contracts": [
    ],
  • "counts": {
    },
  • "dry_run": true,
  • "licensees": [
    ],
  • "notify": true,
  • "packages": [
    ]
}

Settings

Manage application settings.

/settings

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Response samples

Content type
application/json
{
  • "group": {
    },
  • "thresholds": {
    }
}

/settings

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

Responses

Request samples

Content type
application/json
{
  • "group": {
    },
  • "thresholds": {
    }
}

Response samples

Content type
application/json
{ }

SourceBuckets

Link source S3 buckets to AWS credentials

/source-buckets

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/source-bucket

Authorizations:
customAuthorizer

Responses

/source-bucket/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
bucket
string
credential_uuid
string
hybrik_credentials_key
string

Hybrik vault credential-set name for this bucket, consumed by the cold ingest workflow (#1850).

name
string

Responses

Request samples

Content type
application/json
{
  • "bucket": "string",
  • "credential_uuid": "string",
  • "hybrik_credentials_key": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "bucket": "string",
  • "credential_name": "string",
  • "credential_uuid": "string",
  • "hybrik_credentials_key": "string",
  • "name": "string",
  • "uuid": "string"
}

/source-bucket/{uuid}

Authorizations:
customAuthorizer

Responses

/source-bucket/{uuid}/validate-keys

Authorizations:
customAuthorizer
Request Body schema: application/json
required
keys
required
Array of strings

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

/source-bucket/{uuid}/import

Authorizations:
customAuthorizer
Request Body schema: application/json
required
keys
required
Array of strings
target
required
string (SourceIngestTarget)
Enum: "cold" "hot"

Responses

Request samples

Content type
application/json
{
  • "keys": [
    ],
  • "target": "cold"
}

Response samples

Content type
application/json
{
  • "batch_uuid": "string",
  • "queued": 0
}

Stats

System statistics and analytics.

/stats/workorders-stages

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/stats/workorders-deadlines

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/stats/workorders-delivered

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/stats/storage

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/stats/audio-corrections

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/stats/audio-corrections/export

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Copy throughput for the admin DR copy speed chart

Authorizations:
customAuthorizer
query Parameters
lookbackPeriod
string

Lookback period in days (the UI sends 35 or 105)

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Responses

/stats/egress

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/stats/egress/transfers-list

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/stats/export-report

Authorizations:
customAuthorizer

Responses

Suppliers

Create and manage Suppliers.

/suppliers

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/suppliers/all

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/supplier/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/supplier/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
auto_approve_delivery_packs
boolean
emails
Array of strings
facility_of_origin
string
groups
Array of strings
is_global
boolean
landing_page
string
mobile_number
string
name
string
notifies_librarian_group
boolean
office_address
string
office_phone_number
string
picture
string
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "auto_approve_delivery_packs": true,
  • "emails": [
    ],
  • "facility_of_origin": "string",
  • "groups": [
    ],
  • "is_global": true,
  • "landing_page": "string",
  • "mobile_number": "string",
  • "name": "string",
  • "notifies_librarian_group": true,
  • "office_address": "string",
  • "office_phone_number": "string",
  • "picture": "string",
  • "users": [
    ]
}

/supplier/{uuid}

Authorizations:
customAuthorizer

Responses

/supplier

Authorizations:
customAuthorizer
Request Body schema: application/json
required
auto_approve_delivery_packs
boolean
emails
required
Array of strings
facility_of_origin
string
groups
required
Array of strings
is_global
boolean
landing_page
string
mobile_number
string
name
required
string
notifies_librarian_group
boolean
office_address
string
office_phone_number
string
picture
string
uuid
required
string

Responses

Request samples

Content type
application/json
{
  • "auto_approve_delivery_packs": true,
  • "emails": [
    ],
  • "facility_of_origin": "string",
  • "groups": [
    ],
  • "is_global": true,
  • "landing_page": "string",
  • "mobile_number": "string",
  • "name": "string",
  • "notifies_librarian_group": true,
  • "office_address": "string",
  • "office_phone_number": "string",
  • "picture": "string",
  • "uuid": "string"
}

Tags

Create and manage Tags.

/tag/{subject}/autocomplete/{searchString}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

Teams

Create and manage Teams.

/teams

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/team/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/team/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
string
shared_collection_uuids
Array of strings
user_uuids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "shared_collection_uuids": [
    ],
  • "user_uuids": [
    ]
}

/team/{uuid}

Authorizations:
customAuthorizer

Responses

/team

Authorizations:
customAuthorizer
Request Body schema: application/json
required
name
required
string
shared_collection_uuids
Array of strings
user_uuids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "shared_collection_uuids": [
    ],
  • "user_uuids": [
    ]
}

Tools

Internal utility tools.

Proxy requests to Rightsline API with automatic authentication and AWS Signature V4 signing

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

Unique Client identifier in the system

Request Body schema: application/json
required
httpMethod
required
string

HTTP method for the request

path
required
string

API path (e.g., /v4/some/endpoint)

Responses

Request samples

Content type
application/json
{
  • "httpMethod": "string",
  • "path": "string"
}

Response samples

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

/tools/bridge

Authorizations:
customAuthorizer

Responses

/tools/bbcmg-test-order

Authorizations:
customAuthorizer

Responses

/tools/github

Authorizations:
customAuthorizer

Responses

/tools/delete-aspera-key/{key_id}

Authorizations:
customAuthorizer

Responses

/tools/airtable

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

Responses

Request samples

Content type
application/json
{ }

Submit a generic support ticket for bugs or issues on the platform

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

Unique Client identifier in the system

Request Body schema: application/json
required
issue_type
required
string

Type of the issue (e.g. bug, feature_request, question)

title
required
string

Title of the support ticket

description
required
string

Detailed description of the issue

extra
string

Extra details (e.g. page URL, error message, steps to reproduce)

origin_url
string

Absolute URL of the page the ticket was raised from

sentry_event_id
string

Sentry event id for the error behind this report, when one was captured

sentry_trace_id
string

Sentry trace id for the session, when Sentry is initialised

Responses

Request samples

Content type
application/json
{
  • "issue_type": "string",
  • "title": "string",
  • "description": "string",
  • "extra": "string",
  • "origin_url": "string",
  • "sentry_event_id": "string",
  • "sentry_trace_id": "string"
}

Response samples

Content type
application/json
{
  • "ticket_url": "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.

Responses

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.

Responses

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

Responses

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.

Responses

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.

Responses

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

Responses

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": [
    ]
}

Transcriptions

Manage asset transcriptions.

/transcription/{uuid}/list

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/transcription/{uuid}/summaries

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/transcription/{uuid}/summary

Authorizations:
customAuthorizer
Request Body schema: application/json
required
modelUuid
required
string
object
trackNumber
string

Responses

Request samples

Content type
application/json
{
  • "modelUuid": "string",
  • "options": {
    },
  • "trackNumber": "string"
}

User Administration

Administrative user management.

/user-admin

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/user-admin

Authorizations:
customAuthorizer
Request Body schema: application/json
required
confirm
boolean
date_format
string
default_policy_to_attach
string (GroupDefaultPolicyType)
Enum: "sharing_email_order" "sharing_shared_pack" "sharing_collection" "vida" "launchpad" "storefront" "connect2" "mediafactory" "qc_client" "qc_supplier" "qc_vdms_client_services"
default_transfer_speed
string
department_field_uuid
string
email
required
string
groups
required
Array of strings
landing_page
string
mfa_enabled
string
mobile_number
string
name
required
string
office_address
string
office_phone_number
string
picture
string
policy_uuids
Array of strings
supplier
string
theme
string
time_format
string
timezone
string
uuid
required
string

Responses

Request samples

Content type
application/json
{
  • "confirm": true,
  • "date_format": "string",
  • "default_policy_to_attach": "sharing_email_order",
  • "default_transfer_speed": "string",
  • "department_field_uuid": "string",
  • "email": "string",
  • "groups": [
    ],
  • "landing_page": "string",
  • "mfa_enabled": "string",
  • "mobile_number": "string",
  • "name": "string",
  • "office_address": "string",
  • "office_phone_number": "string",
  • "picture": "string",
  • "policy_uuids": [
    ],
  • "supplier": "string",
  • "theme": "string",
  • "time_format": "string",
  • "timezone": "string",
  • "uuid": "string"
}

/user-admin/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/user-admin/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
supplier
string

Responses

Request samples

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

/user-admin/{uuid}

Authorizations:
customAuthorizer

Responses

/user-admin/batch

Authorizations:
customAuthorizer
Request Body schema: application/json
required
confirm
boolean
default_policy_for
string (GroupDefaultPolicyType)
Enum: "sharing_email_order" "sharing_shared_pack" "sharing_collection" "vida" "launchpad" "storefront" "connect2" "mediafactory" "qc_client" "qc_supplier" "qc_vdms_client_services"
emails
required
Array of strings
policy_uuid
string
supplier_uuid
string

Responses

Request samples

Content type
application/json
{
  • "confirm": true,
  • "default_policy_for": "sharing_email_order",
  • "emails": [
    ],
  • "policy_uuid": "string",
  • "supplier_uuid": "string"
}

/user-admin/policies

Authorizations:
customAuthorizer
Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

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

User

Current user profile and preferences.

/user/login

Authorizations:
customAuthorizer
Request Body schema: application/json
required
VidaAppType (string) or "workflow" (string) or "vida-premiere-panel" (string)
baseUrl
required
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "app": "vida",
  • "baseUrl": "string",
  • "email": "string"
}

/user/link

Authorizations:
customAuthorizer
Request Body schema: application/json
required
provider
required
any
token
required
string

Responses

Request samples

Content type
application/json
{
  • "provider": null,
  • "token": "string"
}

/user

Authorizations:
customAuthorizer
Request Body schema: application/json
required
confirm
boolean
date_format
string
default_policy_to_attach
string (GroupDefaultPolicyType)
Enum: "sharing_email_order" "sharing_shared_pack" "sharing_collection" "vida" "launchpad" "storefront" "connect2" "mediafactory" "qc_client" "qc_supplier" "qc_vdms_client_services"
default_transfer_speed
string
department_field_uuid
string
email
required
string
groups
required
Array of strings
landing_page
string
mfa_enabled
string
mobile_number
string
name
required
string
office_address
string
office_phone_number
string
picture
string
policy_uuids
Array of strings
supplier
string
theme
string
time_format
string
timezone
string
uuid
required
string

Responses

Request samples

Content type
application/json
{
  • "confirm": true,
  • "date_format": "string",
  • "default_policy_to_attach": "sharing_email_order",
  • "default_transfer_speed": "string",
  • "department_field_uuid": "string",
  • "email": "string",
  • "groups": [
    ],
  • "landing_page": "string",
  • "mfa_enabled": "string",
  • "mobile_number": "string",
  • "name": "string",
  • "office_address": "string",
  • "office_phone_number": "string",
  • "picture": "string",
  • "policy_uuids": [
    ],
  • "supplier": "string",
  • "theme": "string",
  • "time_format": "string",
  • "timezone": "string",
  • "uuid": "string"
}

/user

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/user

Authorizations:
customAuthorizer
Request Body schema: application/json
required
date_format
string
default_transfer_speed
string
department_field_uuid
string
email
string
groups
Array of strings
landing_page
string
mfa_enabled
string
mobile_number
string
name
string
office_address
string
office_phone_number
string
picture
string
policy_uuids
Array of strings
supplier
string
theme
string
time_format
string
timezone
string
object (ViewConfigType)

Responses

Request samples

Content type
application/json
{
  • "date_format": "string",
  • "default_transfer_speed": "string",
  • "department_field_uuid": "string",
  • "email": "string",
  • "groups": [
    ],
  • "landing_page": "string",
  • "mfa_enabled": "string",
  • "mobile_number": "string",
  • "name": "string",
  • "office_address": "string",
  • "office_phone_number": "string",
  • "picture": "string",
  • "policy_uuids": [
    ],
  • "supplier": "string",
  • "theme": "string",
  • "time_format": "string",
  • "timezone": "string",
  • "viewConfig": {
    }
}

/user/auth/me

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/user/auth/me

Authorizations:
customAuthorizer
Request Body schema: application/json
required
date_format
string
default_transfer_speed
string
department_field_uuid
string
email
string
groups
Array of strings
landing_page
string
mfa_enabled
string
mobile_number
string
name
string
office_address
string
office_phone_number
string
picture
string
policy_uuids
Array of strings
supplier
string
theme
string
time_format
string
timezone
string
object (ViewConfigType)

Responses

Request samples

Content type
application/json
{
  • "date_format": "string",
  • "default_transfer_speed": "string",
  • "department_field_uuid": "string",
  • "email": "string",
  • "groups": [
    ],
  • "landing_page": "string",
  • "mfa_enabled": "string",
  • "mobile_number": "string",
  • "name": "string",
  • "office_address": "string",
  • "office_phone_number": "string",
  • "picture": "string",
  • "policy_uuids": [
    ],
  • "supplier": "string",
  • "theme": "string",
  • "time_format": "string",
  • "timezone": "string",
  • "viewConfig": {
    }
}

/user/auth/apps

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/user/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/user/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
date_format
string
default_transfer_speed
string
department_field_uuid
string
email
string
groups
Array of strings
landing_page
string
mfa_enabled
string
mobile_number
string
name
string
office_address
string
office_phone_number
string
picture
string
policy_uuids
Array of strings
supplier
string
theme
string
time_format
string
timezone
string
object (ViewConfigType)

Responses

Request samples

Content type
application/json
{
  • "date_format": "string",
  • "default_transfer_speed": "string",
  • "department_field_uuid": "string",
  • "email": "string",
  • "groups": [
    ],
  • "landing_page": "string",
  • "mfa_enabled": "string",
  • "mobile_number": "string",
  • "name": "string",
  • "office_address": "string",
  • "office_phone_number": "string",
  • "picture": "string",
  • "policy_uuids": [
    ],
  • "supplier": "string",
  • "theme": "string",
  • "time_format": "string",
  • "timezone": "string",
  • "viewConfig": {
    }
}

/user/{uuid}

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

Responses

Request samples

Content type
application/json
{ }

/user/generate-api-token

Authorizations:
customAuthorizer
Request Body schema: application/json
required
expires_at
required
string
user_uuid
required
string

Responses

Request samples

Content type
application/json
{
  • "expires_at": "string",
  • "user_uuid": "string"
}

/user/custom-token

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/user/device-token

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/user/{uuid}/reset-mfa

Authorizations:
customAuthorizer

Responses

/user/auth/me/recovery-codes

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/user/auth/me/recovery-codes

Authorizations:
customAuthorizer

Responses

Redeem an MFA recovery code

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

Unique Client identifier in the system

Request Body schema: application/json
required
email
required
string

Email address of the account to recover

code
required
string

One unused recovery code issued to that account

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "code": "string"
}

/user/{uuid}/mfa-status

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/user/auth/me/avatar

Authorizations:
customAuthorizer

Responses

/user/auth/me/avatar

Authorizations:
customAuthorizer

Responses

/user/auth/me/avatar/provider

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/user/auth/me/avatar/import

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

Responses

Request samples

Content type
application/json
{ }

Resolve a user’s accessible content across every access path

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UID of user

query Parameters
as-of
string

ISO 8601 date or date-time to resolve access as of. Defaults to now.

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.

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "as_of": "string",
  • "assets": [
    ],
  • "assets_total": 0,
  • "blanket_grants": [
    ],
  • "expired_shared_packs": [
    ],
  • "paths": [
    ],
  • "user": {
    }
}

Users

User management operations.

/users/share

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/users/activity

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/users

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

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

Responses

Request samples

Content type
application/json
{ }

/users

Authorizations:
customAuthorizer
Request Body schema: application/json
required
delete_reason
string
user_uuids
required
Array of strings

Responses

Request samples

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

Video Codec Mappings

Manage video codec mappings.

/video-codec-mappings

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/video-codec-mappings/csv

Authorizations:
customAuthorizer
Request Body schema: application/json
required
filename
required
string

Responses

Request samples

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

/video-codec-mapping/{uuid}

Authorizations:
customAuthorizer
header Parameters
Cache-Control
object

Overrides default cache behaviour.

Responses

/video-codec-mapping/{uuid}

Authorizations:
customAuthorizer
Request Body schema: application/json
required
display_name
required
string
profile
required
string
uuid
required
string
video_codec
required
string

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "profile": "string",
  • "uuid": "string",
  • "video_codec": "string"
}

/video-codec-mapping/{uuid}

Authorizations:
customAuthorizer

Responses

/video-codec-mapping

Authorizations:
customAuthorizer
Request Body schema: application/json
required
display_name
required
string
profile
required
string
video_codec
required
string

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "profile": "string",
  • "video_codec": "string"
}

Workflows

Create and manage Workflows.

Get workflows

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

Unique Client identifier in the system

Cache-Control
object

Overrides default cache behaviour.

Responses

Get workflow by uuid

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
id
required
number

Workflow ID

uuid
required
string

Workflow UUID

name
required
string

Workflow name

webhook_url
required
string

Webhook URL for the workflow

comment
required
string

Comment for the workflow

required
Array of objects (SimpleType)

Groups attached to the workflow

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "name": "string",
  • "webhook_url": "string",
  • "comment": "string",
  • "groups": [
    ]
}

Update workflow

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

Workflow name

webhook_url
string

Webhook URL for the workflow

comment
string

Comment for the workflow

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "webhook_url": "string",
  • "comment": "string"
}

Delete workflow

Authorizations:
customAuthorizer
path Parameters
uuid
required
string

UUID of entity

header Parameters
vida-client-id
required
string

Unique Client identifier in the system

Responses

Add workflow

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

Unique Client identifier in the system

Request Body schema: application/json
required
uuid
required
string

Workflow UUID

name
required
string

Workflow name

webhook_url
required
string

Webhook URL for the workflow

comment
string

Comment for the workflow

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "webhook_url": "string",
  • "comment": "string"
}