The readable hardlink, relative to the library root. Null when it could not be made, and null for any caller that is not the origin studio, since it names that studio, a month and a filename (#9).
mime required
string
origin_studio required
string | null
The studio that first stored these bytes. Null for any caller that is not that studio, so a dedup hit or a shared read never reveals another studio (#9).
pinned required
boolean
sha256 required
string
state required
string (ready | missing | corrupt)
thumb required
string
This API's path to the thumbnail, e.g. /api/v1/assets/{id}/thumb?w=320. Needs the Bearer header; a page prefixes /helm to go through its proxy.
url required
string
This API's path to the bytes, e.g. /api/v1/assets/{id}. Needs the Bearer header; a page prefixes /helm to go through its proxy.
warnings
string[]
Present on an adopt or upload response when something short of failure happened, such as no library link.
width required
integer | null
AssetKind
One of image, video, audio, other.
Capability
One of kv, records, assets, gallery, timeline, jobs, gallery.read_all, kv.shared, handoff.send.
Error
Field
Type
About
details
object
error required
string
A stable snake_case code a program branches on.
message required
string
A sentence for a person.
ExportPlan
Field
Type
About
duration_s required
number
frames required
integer
mode required
string (copy | conform)
`copy` copies the picture and re-encodes the sound; `conform` re-encodes both. Nothing copies sound.
installations.last_failure and jobs.last_error (02 §4). Install codes: clone_failed, tool_missing, env_failed, step_failed, step_timeout, cancelled, interrupted, auth_required, disk_space, weights_failed, linked_missing, uninstall_failed. env_failed (creating a Python environment) has no step_index. A task job's code is the studio's own.
A reference with in and out points; sources are never modified or copied (R44). `in` and `out` are times in the source, `at` is where it sits in the sequence, and an image clip uses `hold` instead.
Where it sits in the sequence. Assigned when clips are laid end to end.
audio
boolean
Whether a video clip's own sound plays under it. Defaults to true.
gain_db
number
Applied to this clip's own sound. Defaults to 0.
hold
number
How long an image is held. Images only, and never with in or out.
in
number
Where the clip starts in its source. Defaults to 0.
out
number
Where it ends in its source. Defaults to the source's end.
studio_id
string | null
The studio whose asset this is, for the clip's hue and name. Null when the caller could not learn it from an item it may read. Set by the daemon, and ignored in a request.
What every clip is conformed to (R44, R47). Geometry and rates only: the codec belongs to the export's preset, not the document. Output is always stereo, and is tagged BT.709 limited range when it is re-encoded.