Skip to main content

Function: prepareAssetUpload()

prepareAssetUpload(client, props): Promise<{ uploadUrl: string; uploadToken: string; }>

Prepares an asset upload by generating an upload URL and token.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; projectName: string; } = prepareAssetUploadParamsSchema

Path parameters (orgName, projectName)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

body​

{ filename: string; contentType: string; size: number; } = prepareAssetUploadBodySchema

Request body with file information

body.filename​

string = ...

body.contentType​

string = ...

body.size​

number = ...

Returns​

Promise<{ uploadUrl: string; uploadToken: string; }>

Promise resolving to upload URL, token, and user upload ID

Operation Id​

prepare-asset-upload

Example​

const upload = await prepareAssetUpload(client, {
  params: { orgName: 'my-org', projectName: 'my-project' },
  body: { filename: 'model.glb', contentType: 'model/gltf-binary', size: 1024000 }
});