Skip to main content
GET
Get a screenshot at a timestamp
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Must be application/json.

Available options:
application/json

Path Parameters

id
string
required

The recording's id (UUID) or its public_link_id (the short code in the watch URL). Both are accepted.

Query Parameters

timestamp
number
required

Timestamp in seconds (may be fractional) of the frame to capture.

Required range: x >= 0
image_format
enum<string>
default:png

Image format: png or jpeg. Defaults to png.

Available options:
png,
jpeg

Response

Screenshot URL generated, or not ready yet.

recording_id
string
required
timestamp
number
required
image_format
enum<string>
required
Available options:
png,
jpeg
is_screenshot_ready
boolean
required

false when the recording's video file is outdated. Call POST /recordings/{id}/trigger-mp4 to regenerate it, then retry.

screenshot_url
string

Presigned URL to the image. Omitted entirely when is_screenshot_ready is false.

url_expires_in_seconds
integer

Lifetime of the presigned URL. Omitted entirely when is_screenshot_ready is false.