Device Streams

List Streams

List every stream configured on a device.

Required scope: device:read

List Streams

get

List every stream configured on a device. Credentials are stripped from URLs and known credential-bearing object keys are removed from each stream's source.

Authorizations

bearerAuthapiKeyQuery

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters

workspacestringRequired

Workspace ID (URL slug).

deviceIdstringRequired

Device ID.

Responses

200

Streams configured on the device.

application/json

401

Missing or invalid API key.

application/json

403

API key is bound to a different device, or this endpoint is not permitted for device-scoped keys, a source device belongs to another workspace, or a feature gate (for example AI1 creation, roboflowLiteMode) blocks the request.

application/json

404

Device, stream, configuration, or source device not found. Read requests for devices owned by another workspace also return 404.

application/json

get

/{workspace}/devices/v2/{deviceId}/streams

HTTPcURLJavaScriptPython

GET /{workspace}/devices/v2/{deviceId}/streams HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "status": "text",
      "pipeline_id": "text",
      "workflow_id": "text",
      "source": "text",
      "started_at": "2026-05-19T18:23:46.789Z",
      "last_event_at": "2026-05-19T18:23:46.789Z",
      "camera_fps": 1,
      "inference_fps": 1,
      "sharpness": 1,
      "error": "text"
    }
  ]
}

Example Request

curl "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams?api_key=$ROBOFLOW_API_KEY"

Example Response

{
  "data": [
    {
      "id": "stream_abc",
      "name": "entrance-cam",
      "status": "running",
      "pipeline_id": "pipe_123",
      "workflow_id": "wf_456",
      "source": "rtsp://192.168.1.100:554/live",
      "started_at": "2026-04-28T10:00:00.000Z",
      "last_event_at": "2026-04-28T12:30:00.000Z",
      "camera_fps": 29.97,
      "inference_fps": 12.4,
      "sharpness": 0.82,
      "error": null
    }
  ]
}

Source sanitization

The source field is always passed through a sanitizer before it is returned:

• If the source is a URL, any userinfo (scheme://user:pass@host/...) is stripped. For example, rtsp://admin:[email protected]:554/live becomes rtsp://192.168.1.100:554/live.

• If the source is an object, keys whose lowercase name is password, passwd, secret, api_key, apikey, auth, authorization, token, or access_token are dropped from the response. All other keys are preserved.

• Arrays and nested objects are sanitized recursively.

Get Stream

Retrieve a single stream. Returns 404 if the stream does not exist on the device, or if the device does not exist or does not belong to your workspace.

Required scope: device:read

Get a Stream

get

Retrieve a single stream on a device.

Authorizations

bearerAuthapiKeyQuery

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters

workspacestringRequired

Workspace ID (URL slug).

deviceIdstringRequired

Device ID.

streamIdstringRequired

Stream ID.

Responses

200

The stream.

application/json

idstring · nullableOptional

namestring · nullableOptional

statusstring · nullableOptional

Stream status reported by the streams service (for example "running", "stopped", or transitional states).

pipeline_idstring · nullableOptional

workflow_idstring · nullableOptional

sourceone ofOptional

Sanitized source descriptor. URL userinfo is stripped; object keys named password, passwd, secret, api_key, apikey, auth, authorization, token, or access_token are removed.

string · nullableOptional

or

objectOptional

or

started_atstring · date-time · nullableOptional

last_event_atstring · date-time · nullableOptional

camera_fpsnumber · nullableOptional

Camera frame rate reported by the device heartbeat.

inference_fpsnumber · nullableOptional

Inference pipeline frame rate reported by the device heartbeat.

sharpnessnumber · nullableOptional

Image sharpness score reported by the device heartbeat.

errorstring · nullableOptional

401

Missing or invalid API key.

application/json

403

API key is bound to a different device, or this endpoint is not permitted for device-scoped keys, a source device belongs to another workspace, or a feature gate (for example AI1 creation, roboflowLiteMode) blocks the request.

application/json

404

Device, stream, configuration, or source device not found. Read requests for devices owned by another workspace also return 404.

application/json

get

/{workspace}/devices/v2/{deviceId}/streams/{streamId}

HTTPcURLJavaScriptPython

GET /{workspace}/devices/v2/{deviceId}/streams/{streamId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "status": "text",
  "pipeline_id": "text",
  "workflow_id": "text",
  "source": "text",
  "started_at": "2026-05-19T18:23:46.789Z",
  "last_event_at": "2026-05-19T18:23:46.789Z",
  "camera_fps": 1,
  "inference_fps": 1,
  "sharpness": 1,
  "error": "text"
}

Example Request

curl "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}?api_key=$ROBOFLOW_API_KEY"

The response body matches a single item from the list endpoint (not wrapped in a data array).