API v1

The asset object

For active assets, size_bytes and sha256 are required.

View Markdown
  • Images and videos also include width and height; audio and video include duration_ms.
  • Images omit duration_ms; audio omits dimensions.
  • Active assets omit failure_reason.
  • Unavailable assets include failure_reason and omit all these measurements.
  • Processing assets omit both measurements and failure_reason.

Attributes

#asset_idstringRequired

ID assigned to the asset by the platform.

Length36–36Formatast- and 32 hex digits
#statusstringRequired

Current state; see the value notes for its meaning.

processingProcessing
activeAsset is ready to use
unavailableUnavailable
#objectstringRequired

Identifies the kind of object returned.

Alwaysasset
#media_typestringRequired

The kind of media in this file.

One ofimageaudiovideo
#modelstringRequired

ID of the model used for this request.

dreamina-seedance-2-0-260128Seedance 2.0
dreamina-seedance-2-0-fast-260128Seedance 2.0 Fast
dreamina-seedance-2-0-mini-260615Seedance 2.0 Mini
#namestring

Optional display name. Control characters, line or paragraph separators and bidirectional text controls are not accepted.

Length1–64
#created_atintegerRequired

Creation time as whole seconds since the Unix epoch.

Range≥ 0
#updated_atintegerRequired

Most recent update time as whole Unix seconds.

Range≥ 0
#widthinteger

Width in pixels, required for active images and videos. Omitted for audio, processing assets and unavailable assets.

Range≥ 1
#heightinteger

Height in pixels, required for active images and videos. Omitted for audio, processing assets and unavailable assets.

Range≥ 1
#duration_msinteger

Measured duration in milliseconds, required for active audio and video. Omitted for images and for assets that are processing or unavailable.

Range≥ 1
#size_bytesinteger

Stored size in bytes, required when active and omitted while processing or unavailable.

Range≥ 1
#sha256string

SHA-256 of the bytes actually stored, required when active and omitted while processing or unavailable.

Length64–64Format64 hex digits
#failure_reasonstring

Required reason when unavailable. Omitted while processing and when active.

source_url_not_allowedThe source address does not meet the fetch policy
source_fetch_failedThe source file could not be fetched
source_too_largeThe source file is too large
media_type_mismatchThe media type does not match
media_constraints_violatedThe file does not meet the media requirements
review_rejectedThe asset did not pass review
review_unavailableAsset review is temporarily unavailable
internal_errorThe service could not complete the request

Read this object with Check an asset.