Stream info - Overshoot

{ "stream_id": "<string>", "source_type": "<string>", "uptime_seconds": 123, "fps": 123, "frame_width": 123, "frame_height": 123, "effective_width": 123, "effective_height": 123, "inferences_completed": 123, "inferences_failed": 123, "last_inference_latency_seconds": 123 }

Authorizations

Authorization

string

header

required

Provide your API key in the Authorization header as 'Bearer <api_key>'

Path Parameters

stream_id

string

required

Response

Stream info retrieved

Real-time information about a connected stream.

stream_id

string

required

Stream identifier

source_type

string

required

Transport type: native, webrtc, or livekit

state

enum<string>

required

Current stream state: pending (no frames yet), active (inferencing), idle (frames stopped)

Available options:

pending,

active,

idle

uptime_seconds

number

required

Seconds since stream was created

fps

number

required

Perceived frames per second (measured over last metrics interval)

frame_width

integer

required

Original video frame width in pixels

frame_height

integer

required

Original video frame height in pixels

effective_width

integer

required

Processing width after 720p cap

effective_height

integer

required

Processing height after 720p cap

inferences_completed

integer

required

Total successful inferences since stream start

inferences_failed

integer

required

Total failed inferences since stream start

last_inference_latency_seconds

number

required

Latency of the most recent inference (seconds)