rrweb docs
rrwebDocs

English

简体中文

English

简体中文

Get recording screenshot​

GET
/recordings/{recordingId}/screenshot

Capture a screenshot at a chosen playback position. Request /recordings/{recordingId}/screenshot.png, .jpeg, or .webp, or select a format with the Accept header. A file extension takes precedence over the header.

Authorizations

Private API Key
Private API Key
Bearer token for authentication. Use your private API key as the token.
or
Presigned URL
Presigned URL
Use a presigned URL generated by the List Recordings endpoint with includeSignedUrls=true. Time-constrained and scoped to a single recording, so it can be exposed publicly in your replayer.
Show parameters: TenantId, KeyId, Expires, Signature
TenantId
Your organization ID. Included automatically in generated presigned URLs; keep the returned value unchanged.
KeyId
Identifies the key used to verify the presigned URL. Included automatically in generated URLs; keep the returned value unchanged.
Expires
Expiration timestamp (UNIX seconds)
Signature
Authenticates the presigned URL. Use the URL returned by the API without changing its path or authentication parameters.

Parameters​

Path Parameters

recordingId*

The recording ID

Type
string
Required
Example"000e8400-e00b-00d0-a716-446655440000"
Format
"uuid"

Query Parameters

time

Playback position selector. Supports offset, percent, and epoch formats: offset:5000, offset:-5000, percent:50, or epoch:1702900000000. Defaults to offset:0.

Type
string
Example"offset:0"
width

Width in pixels from 1 to 4096. Defaults to 1280 when omitted. If height is provided and width is omitted, width is derived from the recording viewport ratio when metadata is available. Values outside this range return 400.

Type
string
Example"1280"
height

Height in pixels from 1 to 4096. Defaults to 720 when omitted and recording viewport metadata is unavailable. If width is provided or both dimensions are omitted, height is derived from the recording viewport ratio when metadata is available. Values outside this range return 400.

Type
string
Example"720"
quality

Quality from 1 to 100 for JPEG and WebP output (default: 80). Ignored for PNG.

Type
string
Example"80"

Responses​

Screenshot image

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI