API Reference

Assets

Download

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Status

client.assets.download.getStatus(stringjobID, RequestOptionsoptions?): DownloadGetStatusResponse { jobId, jobStatus, downloadUrl }

GET/assets/download/{jobId}

Retrieve the status and the url of a batch download assets request

ParametersExpand Collapse

jobID: string

ReturnsExpand 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

Get Status

TypeScript

HTTP

TypeScript

Python

import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

const response = await client.assets.download.getStatus('jobId');

console.log(response.jobId);

200 example

{
  "jobId": "jobId",
  "jobStatus": "jobStatus",
  "downloadUrl": "downloadUrl"
}

Returns Examples

200 example

{
  "jobId": "jobId",
  "jobStatus": "jobStatus",
  "downloadUrl": "downloadUrl"
}