Initiates a new multipart upload for a related asset (e.g., subtitle, proxy, thumbnail).

post

https://localhost:44395/api/asset/upload/start-related-asset

Behavior: Prepares an upload for a file that will be associated with an existing parent asset as a related asset. Generates pre-signed URLs for each upload part. Use this for uploading supplementary files such as subtitle tracks, proxy videos, or custom thumbnails.

Authorization: Requires a valid Bearer token.

Side Effects: An upload record is created. Pre-signed upload URLs are generated.

Error Scenarios: Returns 400 if the request body is missing or invalid. Returns 401 if the caller is not authenticated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The upload parameters including parent asset ID, file name, size, and relationship type.

Represents a request to initiate an upload for a related asset, such as a sidecar file or alternate rendition.

existingAssetId

uuid | null

Gets or sets the Existing AssetId (file) that should be overwritten with this upload. Note that by specifying this attribute then the parentId, relativePath and displayName are all ignored.

relatedAssetId

uuid | null

Gets or sets the related asset ID of the existingAsset that we're replacing. If this is used, most of the other properties are not needed.

newRelatedAssetMetadataType

uuid | null

Gets or sets the type of the related asset metadata to be created for a given ExistingAssetId. If specified, ExistingAssetId has to have a value defined.

relativePath

string | null

Gets or sets the filename to upload - or a full path with the filename at the end. This is ignored if the ExistingAssetId or if the RelatedContentId has a value

languageId

uuid | null

Gets or sets the language of the asset to upload. If this is left blank then the default system language is used.

contentLength

int64

Gets or sets the size of the asset to upload. This is used to calculate the upload parts.

chunkSize

int64

Gets or sets the size of the upload chunks. This should be adjusted to optimize the upload size based on the user's internet connection.

uploadOverwriteOption

string

enum

Cancel

Continue

Replace

AssetReplace

Allowed:

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200The related asset upload was initiated and part URLs were generated.

400The request body is missing or invalid.

401Caller is not authenticated.