Skip to content
Scenario Docs
Get started
API Reference
Assets

Download

Get Status
client.assets.download.getStatus(stringjobID, DownloadGetStatusParams { projectId } query?, RequestOptionsoptions?): DownloadGetStatusResponse { jobId, jobStatus, downloadUrl }
GET/assets/download/{jobId}
Request
client.assets.download.request(stringassetID, DownloadRequestParams { projectId, targetFormat } params, RequestOptionsoptions?): DownloadRequestResponse { url, mimeType }
POST/assets/{assetId}/download
Request Batch
client.assets.download.requestBatch(DownloadRequestBatchParams { options, query, dryRun, projectId } params, RequestOptionsoptions?): DownloadRequestBatchResponse { jobId }
POST/assets/download
ModelsExpand Collapse
DownloadGetStatusResponse { jobId, jobStatus, downloadUrl }
jobId: string

The job id associated with the download request

jobStatus: string

The current job status

downloadUrl?: string

The download url

DownloadRequestResponse { url, mimeType }
url: string

The signed URL to download the asset in the requested format, or its original file when targetFormat is omitted

mimeType?: string

Mime type of the file served at url

DownloadRequestBatchResponse { jobId }
jobId: string

The job id associated with the download request