---
title: "Extract a frame from a replay's recording"
method: GET
path: "/api/v1/replays/{id}/frame"
tags: ["Replays"]
---

# Extract a frame from a replay's recording

`GET /api/v1/replays/{id}/frame`

## Request

- Base URL: `https://session-replay.com`
- URL: `https://session-replay.com/api/v1/replays/{id}/frame`
- Auth: HTTP bearer

Return a single still from the replay's screen recording at the offset given, extracted per request and never stored. The image is JPEG, scaled down to the requested width and never scaled up past the recording's own size. Screenshot reports have no recording and are refused.

## Query parameters

- `offset_ms` integer, required
- `width` integer

## Headers

- `Authorization` string

## Response `200`

frame extracted

## Other responses

- `400`: the offset or width is not a value the endpoint accepts - a JSON:API error document
- `401`: unauthorized - a JSON:API error document
- `403`: the replay belongs to somebody else - a JSON:API error document
- `422`: the report is a screenshot or lost its recording - a JSON:API error document

---

[API](https://skmtc.dev/session-replay/apis/session-replay-api.md) · [All operations](https://skmtc.dev/session-replay/apis/session-replay-api/llms.txt) · [OpenAPI document](https://skmtc.dev/session-replay/apis/session-replay-api/revisions/120e5613bf95?raw)