---
title: "GET /media/recordedImage.jpeg"
method: GET
path: "/media/recordedImage.jpeg"
tags: ["Media"]
---

# GET /media/recordedImage.jpeg

`GET /media/recordedImage.jpeg`

This endpoint retrieves an image based on a specified timestamp. You can indicate whether the image must be captured exactly at that timestamp or allow a nearest match before or after. The timestamp must be submitted in ISO 8601 format.
Each request must include one timestamp parameter and specify the desired image type — either `main` or `preview`. Alternatively, by submitting a `pageToken`, the next/previous image from the last image is returned. In this case, none of the other parameters are used.
Be aware that the image type `main` is rate-limited, and should not be used in quick succession. Additionally, it requires that a recording is available at the given timestamp param. If no recording is available at the given timestamp param a 404 NOT FOUND will be returned.
If an overlay is requested in the `include` parameter, then at least one overlayId must be provided as part of the `overlayId__in` parameter. The list of available overlay ids can be retrieved using the GET /media/recordedImage.jpeg:listFieldValues API.

## Query parameters

- `deviceId` string
- `pageToken` string
- `type` 'preview' | 'main'
- `timestamp__lt` string, date-time
- `timestamp__lte` string, date-time
- `timestamp` string, date-time
- `timestamp__gte` string, date-time
- `timestamp__gt` string, date-time
- `overlayId__in` string[]
- `targetWidth` integer
- `targetHeight` integer
- `include` string[]

## Response `200`

OK

## Other responses

- `400` — The supplied object is invalid. Error detail will contain the validation error.
- `401` — You are not authenticated. Please authenticate and try again.
- `403` — You have no permission to access the specified resource.
- `404` — Referenced resource could not be found.
- `500` — Something went wrong in the server. Please try again.

---

[API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)