Get asset
Get an asset
/api/v2/assets/{asset}Authentication WLT-Api-Key
Read asset metadata and part roles by short ID. Create a download URL separately when you need the bytes. Read the guide.
Path parameters
assetstringrequiredResponses
200
Successful Response
application/json
A project-owned media asset.
idstringrequiredAsset id, asset_<hex>.
displayNamestring | nullrequiredUser-visible label.
mimeTypestringrequiredMedia MIME type, e.g. image/png.
statestringLifecycle state. Only READY assets can be read or used by a task.
"CREATED""CREATED", "UPLOADING", "READY", "DELETED"widthinteger | nullPixel width when known.
heightinteger | nullPixel height when known.
sizeBytesstring | nullSize in bytes serialized as a string for large-integer compatibility with JSON consumers.
checksumstring | nullChecksum when available.
createTimestring | nullServer-assigned.
date-timetypestring | nullAsset type, e.g. image. Null for an untyped upload.
partsarray<AssetPart>The asset's media files. Empty until the upload completes; an untyped asset then holds one part covering the whole media.
structureobject | nullWhat a reader needs besides the bytes.
producedByProducedBy | nullHow the asset came to exist, when that was recorded.
transientbooleanTrue when the bytes are not retained: an upload made while the account does not retain content, or an output of an operation that purges. Both are deleted an hour after the last operation that names them finishes; an upload no operation consumes is deleted by age instead. contentPath is null for such an asset; read it through :createReadUrl.
falsecontentPathstring | nullAlready percent-encoded path for the asset. Append it unchanged to baseUrl before ? and signedQuery. This path does not grant access by itself. Null until the asset is READY or when unavailable; use assets/{asset}:createReadUrl as a fallback.
urlstring | nullUnsigned content URL for the asset, baseUrl + contentPath. It does not grant access by itself: the web app's read-prefix cookie authorizes it, and an API client appends ? and a read prefix's signedQuery or uses assets/{asset}:createReadUrl instead. Null whenever contentPath is.
422
Validation Error
application/json
detailarray<ValidationError>