Skip to content
EyesOnItDocumentation6.1

Get Stream Snapshot

GET /api/v1/streams/{streamId}/snapshot

Access

Section titled “Access”

Authentication options declared in the contract include user cookie session or bearer service token.

The shared authentication policy requires monitor:read. Resource access also depends on the caller’s role, organization, camera grants, and the operation’s validation.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Parameters

Section titled “Parameters”
Name Location Required Type Description and constraints
streamId path Yes string (uuid)
If-None-Match header No string or null
X-EyesOnIt-Session-Id header No string (uuid) The sessionId the caller expects. Required when switching workspaces and for cookie requests after workspace rotation. A mismatched value returns 409 with X-EyesOnIt-Workspace-Changed: 1. Bootstrap with getCurrentPrincipal; never replay a mutation automatically after changing context. Bearer clients do not use this header.

cURL request template

Section titled “cURL request template”

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. This template sends the request when run.

Terminal window
curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  --dump-header response-headers.txt \
  --output response.bin \
  "${EOI_API_BASE_URL}/streams/${EOI_STREAMID}/snapshot"

Contract responses

Section titled “Contract responses”

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status Description Media type Body
200 Current demand-driven camera snapshot. image/jpeg string (binary)
202 The snapshot is warming up; retry after the requested delay. — Empty body
304 The current snapshot matches If-None-Match. — Empty body
503 The snapshot path is unavailable or exhausted. — Empty body
422 Validation Error application/json HTTPValidationError

Response headers for 200 include ETag, X-EOI-Stream-Revision, X-EOI-Snapshot-Captured-At, X-EOI-Snapshot-Width, X-EOI-Snapshot-Height.

Response headers for 202 include Retry-After, X-EOI-Snapshot-State, X-EOI-Snapshot-Reason.

Operation identifier getStreamSnapshot. Browse Snapshots and live preview.

Image preview