Initiates a new multipart upload for a single asset.

post

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

Behavior: Prepares a new asset upload by creating the upload record and generating
pre-signed URLs for each upload part. The client should upload each part directly to the provided
URLs, then call the complete endpoint when all parts are uploaded. The file is split into parts
based on the total file size.

Authorization: Requires a valid Bearer token.

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

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 file name, size, parent folder, and MIME type.

Represents a request to initiate a new asset upload session, specifying the target location, file details, and upload options.

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.

relatedContentId

uuid | null

Gets or sets the Content ID of the related content record to associate this asset to.
Note that by specifying this attribute then the parentId and relativePath attributes are both ignored.

parentId

uuid | null

Gets or sets the Parent AssetId (folder) to add the upload to. Note that if there is a full relativePath, then it is appended to this parent path. If this value is omitted then the file will be added to the predefined incoming folder.
This is ignored if the ExistingAssetId or if the RelatedContentId has a value

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.

displayName

string | null

Gets or sets the display name of the file to upload (does not include the path) and must include the file extension
This is ignored if the ExistingAssetId has a value

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:

uploadReplaceOptions

array of objects | null

Gets or sets if the asset already exists on the server, this decides how to handle the situation with related assets.

uploadReplaceOptions

Allowed:

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The upload was initiated and part URLs were generated.

400The request body is missing or invalid.

401Caller is not authenticated.