Skip to content
EyesOnItDocumentation6.1

List streams

GET/api/v1/streams

Retrieve the camera sources your integration can access. Use a stream’s id to request its details on the next page.

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

Request

Section titled “Request”

Run this request from the terminal you configured on the overview page.

Terminal window
curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  --header "Accept: application/json" \
  "${EOI_API_BASE_URL}/streams"

Response

Section titled “Response”

A successful request returns 200 OK and a JSON array of stream objects. This fictional response excerpt shows selected fields from one camera.

[
  {
    "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.

An empty array, [], means no streams match the request within this caller’s camera access. Confirm that a camera is configured and that the token has access to it.

Filter by an external ID

Section titled “Filter by an external ID”

If your integration assigns external IDs to cameras, add the optional externalId query parameter. It accepts 1–128 characters and matches the saved external ID exactly. The response is still an array.

Terminal window
curl --fail-with-body --silent --show-error --get \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  --data-urlencode "externalId=warehouse-loading-bay" \
  "${EOI_API_BASE_URL}/streams"

Handle errors

Section titled “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.
422 Check the length and value of externalId if you supplied it.

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

Next step

Section titled “Next step”

Copy the id of the camera you want, then Get a stream.

Full reference

Section titled “Full reference”

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

Image preview