Skip to main content
GET
Get Asset

Authorizations

Authorization
string
header
required

Send an account API key in the Authorization: Bearer <key> header.

Headers

OpenPMM-Request-Id
string

Optional request ID. OpenPMM returns this value when it is valid. Otherwise, OpenPMM creates a request ID.

Maximum string length: 128

Path Parameters

workspace_id
string
required

Unique workspace ID.

Example:

"ws_01JABCDEF"

asset_id
string
required

Unique asset ID.

Example:

"ast_01JABCDEF"

Query Parameters

include
enum<string>

Set to download to include a five-minute download URL.

Available options:
download

Response

The requested asset.

id
string
required

Unique asset ID.

Example:

"ast_01JABCDEF"

object
string
required
Allowed value: "asset"
type
enum<string>
required

Generic asset type. video does not select a provider placement.

Available options:
card,
video,
poster
label
string
required
Example:

"Launch artwork"

dimensions
string
required
Example:

"1200x675"

width
integer | null
required
Required range: x >= 1
Example:

1200

height
integer | null
required
Required range: x >= 1
Example:

675

duration_sec
integer | null
required
Required range: x >= 0
format
string | null
required
Example:

"x-landscape"

byte_size
integer | null
required
Required range: x >= 0
Example:

248312

content_type
string | null
required
Example:

"image/webp"

status
enum<string>
required
Available options:
pending_upload,
ready
checksum
object | null
required
inspected_at
string<date-time> | null
required
Example:

"2026-08-09T12:00:00.000Z"

retention
object
required
created_at
string<date-time> | null
required
Example:

"2026-08-09T12:00:00.000Z"

download_url
string<uri>
download_url_expires_at
string<date-time>
Example:

"2026-08-09T12:00:00.000Z"