Get a stream

GET/api/v1/streams/{streamId}

Use the id returned by List streams to retrieve one camera’s configuration and state.

Requires a bearer service token with monitor:read. Follow Set up your connection for the server address and token.

Path parameter

Parameter	Type	Required	Description
streamId	UUID	Yes	The id returned for this camera by List streams.

Request

Replace the fictional ID below with an id from your own list response.

export EOI_STREAM_ID="8c5fd3a7-32e0-43b9-977d-a2554174be82"
curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  --header "Accept: application/json" \
  "${EOI_API_BASE_URL}/streams/${EOI_STREAM_ID}"

Response

A successful request returns 200 OK and one stream object. This fictional response excerpt shows selected fields.

{
  "id": "8c5fd3a7-32e0-43b9-977d-a2554174be82",
  "revision": 3,
  "name": "Loading bay",
  "location": "Warehouse",
  "sourceKind": "rtsp"
}

Field	Meaning
id	Stable stream UUID. Use it as streamId in requests for this camera.
revision	Configuration revision. Use it when a later update operation requires a revision check.
name	Camera’s display name.
location	Camera’s location label, or null when unset.
sourceKind	Source type, such as rtsp, http, file, device, or unknown.

Handle errors

HTTP status	What to check
401	Supply a valid, unexpired service token issued for this server.
403	Ask your administrator to check the token’s capabilities and workspace access.
404	The stream is unavailable to this caller or the ID no longer exists. List streams again with the same credentials and choose a returned ID.
422	Supply a valid UUID for streamId.

cURL’s --fail-with-body returns a nonzero exit code for HTTP errors and retains the response body for inspection.

Next step

Return to List streams to choose another camera.

Full reference

See the Streams reference for all operations and complete request and response models.