Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

Media asset ID, prefixed media_.

Response

Media asset retrieved.

amount_charged
number | null
required

USD amount charged to the account's balance for this generation. null if the generation wasn't billed.

completed_at
string | null
required

ISO 8601 timestamp when the asset reached a terminal state. null while processing.

created_at
string
required

ISO 8601 timestamp when the generation was requested.

currency
string
required

Currency of amount_charged. Always usd.

error_message
string | null
required

Why generation failed. null unless status is failed.

file
object | null
required

The produced file, usable anywhere attachments are accepted. null until the asset is ready.

generation
object
required

The inputs the asset was generated from.

id
string
required

Media asset ID, prefixed media_.

media_type
enum<string>
required

The kind of media this asset holds.

Available options:
video,
image
Example:

"video"

source
enum<string>
required

How the asset was created. Always generated.

Available options:
generated
Example:

"generated"

status
enum<string>
required

Lifecycle state: processing while generation runs, ready when the file is available, failed when generation failed and the charge was refunded.

Available options:
processing,
ready,
failed
Example:

"processing"