Skip to main content
GET
Retrieve an organization asset

Authorizations

Authorization
string
header
required

Organisation API key, sent as Authorization: Bearer chk_live_….

  • chk_live_… — production inference, live credits, livemode: true, is_staging: false.
  • chk_stg_… — real inference classified as staging, the same live credits, livemode: true, is_staging: true.
  • chk_test_… — identical pipeline against the fixture backend, test credits, livemode: false.

Keys are stored hashed; only the prefix (chk_live_a1b2…) is ever displayed again. A key may be scoped to a subset of endpoint families — calling outside its scopes is a 403.

Path Parameters

id
string<uuid>
required

Response

Asset metadata.

Permanent organization asset. Scene size includes all image layers and YAML. Only available assets have signed links and can be selected for new jobs.

id
string<uuid>
required

Asset UUID, including for custom background scenes.

object
string
required
Allowed value: "asset"
category
enum<string>
required
Available options:
background,
license_plate,
banner,
logo,
misc
kind
enum<string>
required
deprecated

Legacy alias of category, retained for existing clients.

Available options:
background,
license_plate,
banner,
logo,
misc
name
string
required
content_type
string
required
size_bytes
integer
required

Total bytes in the asset package.

Required range: x >= 0
total_size_bytes
integer
required

Total bytes including all scene layers and YAML.

Required range: x >= 0
state
enum<string>
required
Available options:
available,
uploading,
deleting,
delete_failed,
deleted
created
integer<int64>
required

Epoch seconds, UTC.

Example:

1755300000

banner_placement
enum<string> | null
Available options:
top,
bottom,
null
background_id
integer | null

Historical numeric scene ID used in custom-- selectors.

Short-lived signed preview URL. Empty or omitted for unavailable assets; misc files use attachment downloads.

download_url
string

Short-lived signed download URL. Uses attachment Content-Disposition for misc files. Empty or omitted when unavailable.

files
object[]

Background package files returned by GET for an available scene. Includes all layers and YAML with individual signed download URLs. Omitted when unavailable.