v1

latestOpenAPI 3.0.32026-07-22112930.0 KB

Streams

Get stream

Returns current stream status and frame telemetry.

stream_time_ms is zero until the first frame arrives. After that, it is measured from the first captured frame. When a stream ends, live counters and timestamps are snapshotted — GET /streams/{id} on an ended stream returns those final values; fields may be null if the stream ended before the value existed.

get/streams/{stream_id}

Response

Stream state.

idstring uuid required

state'active' | 'ended' required

Lifecycle state. active while the stream accepts publishers and inference. ended once it has expired or been deleted — this transition is terminal.

stream_time_msnumber nullable

Stream-clock position in ms. Zero until the first frame arrives, then monotonically increasing from that first frame.

first_frame_at_msinteger nullable

Wall-clock Unix ms of the first frame ever ingested.

last_frame_at_msinteger nullable

Wall-clock Unix ms of the most recent frame.

last_frame_indexinteger nullable

Lifetime index of the most recent frame. frame_index=-1 resolves against this at request time.

first_available_frame_at_msinteger nullable

Wall-clock Unix ms of the oldest retained frame.

first_available_frame_indexinteger nullable

Lifetime index of the oldest frame still retained.

created_at_msinteger nullable

Wall-clock Unix ms of stream creation.

recent_fpsnumber nullable

Rolling FPS over the current frame-metrics bucket for active streams.

retained_frame_countinteger nullable

evicted_frame_countinteger nullable

expires_at_msinteger nullable

Wall-clock Unix ms when the lease will expire. null on ended streams.

ttl_secondsinteger nullable

ended_at_msinteger nullable

Wall-clock Unix ms when the stream entered the ended state.

end_reason'expired' | 'deleted' nullable

Why the stream ended. expired = system-driven termination, deleted = explicit DELETE. null while state == active.

audioboolean

Reserved for future audio support. Always false today.