Skip to content

Retrieve snapshots and video

Choose a camera ID available to your caller. Snapshot reads use the stream read capability, while recording and preview resources can require media access and relevant licensing.

Terminal window
curl --silent --show-error \
--header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
--dump-header snapshot-headers.txt \
--output snapshot-response.bin \
--write-out '%{http_code}\n' \
"${EOI_API_BASE_URL}/streams/${EOI_STREAM_ID}/snapshot"

Check the status before displaying the saved body. Get stream snapshot returns JPEG bytes for 200, a warming response for 202, or 304 when the supplied If-None-Match matches the current snapshot. Respect Retry-After on warming responses. Keep the returned ETag with the cached image.

  1. Call List recordings to find event recordings, or Get archive camera availability for continuous archive coverage.
  2. Request recording playback by recording ID, or continuous playback for a stream and time interval.
  3. Read the returned descriptor and use its playback resources within their valid access context. Preserve time gaps in your application’s timeline.

Media tickets and preview credentials are scoped and short-lived. Obtain fresh descriptors after a user’s workspace changes. Use Create live preview session and Delete live preview session to manage the live-preview lifecycle when your integration needs live video.

Image preview