asset_download
ManagementDownload Asset
Request a download URL for an asset, optionally converting to a target format.
Args:
- asset_id: required
- format: optional conversion target: png, jpg, jpeg, webp, avif, tif or tiff for images; glb, fbx or obj for 3D assets. gif, heif and svg are accepted but currently return the original file unchanged; for a vector version, ask recommend for a vectorize model. Omit to download the original file as stored. Video and audio have no conversion formats: omit it for them.
- team_id, project_id: required for OAuth callers
Returns: download URL and metadata.
When saving the returned URL with a CLI such as curl, always follow redirects (for example: curl -L -o file.png "<url>") because asset transform URLs may redirect before serving the file.
Example: "Download this asset as WebP" -> asset_id="asset_xxx", format="webp"
open-world
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| asset_id | string | ✓ | Asset ID. |
| format | enum(gif | heif | jpeg | jpg | png | svg | webp | avif | tif | tiff | glb | fbx | obj) | — | Optional conversion target; gif, heif and svg currently return the original unchanged. Omit to download the original file as stored; video and audio have no conversion formats. |
| team_id | string | — | Team ID. Required with project_id for OAuth callers; an API key is scoped by the key. |
| project_id | string | — | Project ID. Required with team_id for OAuth callers; an API key is scoped by the key. |
| response_format | enum(json | markdown) | json | Output format: 'json' for structured data, 'markdown' for human-readable text. |