Skip to content
Scenario Docs
Get started
API Reference
Assets
Download

Request

assets.download.request(strasset_id, DownloadRequestParams**kwargs) -> DownloadRequestResponse
POST/assets/{assetId}/download

Request a link to download the given assetId in the given targetFormat

ParametersExpand Collapse
asset_id: str
target_format: Optional[Literal["gif", "heif", "jpeg", 10 more]]

The format to download the asset in

One of the following:
"gif"
"heif"
"jpeg"
"jpg"
"png"
"svg"
"webp"
"avif"
"tif"
"tiff"
"glb"
"fbx"
"obj"
ReturnsExpand Collapse
class DownloadRequestResponse: …
url: str

The signed URL to download the asset in the given format

Request

import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
response = client.assets.download.request(
    asset_id="assetId",
)
print(response.url)
{
  "url": "url"
}
Returns Examples
{
  "url": "url"
}