Skip to content

Get recording​

GET
/recordings/{recordingId}

Retrieve a recording descriptor, including metadata and related links. Bearer-token requests can set includeEvents=true to embed the replayable event stream in the response. Presigned detail URLs remain descriptor-only; use the signed events link for presigned event access.

Authorizations

Private API Key
Bearer token for authentication. Use your private API key as the token.

Parameters​

Path Parameters

recordingId*

The recording ID

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

Query Parameters

includeSignedUrls

Include presigned recording links in the detail response.

Type
boolean
Exampletrue
includeEvents

Include the recording event stream in the detail response.

Type
boolean
Exampletrue

Responses​

Successfully retrieved recording details

application/json
JSON
{
  
"recordingId": "550e8400-e29b-41d4-a716-446655440000",
  
"links": {
  
  
"self": "/recordings/550e8400-e29b-41d4-a716-446655440000",
  
  
"events": "/recordings/550e8400-e29b-41d4-a716-446655440000/events",
  
  
"player": "/recordings/550e8400-e29b-41d4-a716-446655440000/player",
  
  
"screenshot": "/recordings/550e8400-e29b-41d4-a716-446655440000/screenshot",
  
  
"eventsSigned": "/recordings/550e8400-e29b-41d4-a716-446655440000/events?expires=1735689600&keyId=key-2024-12&signature=a1b2c3d4e5f6...",
  
  
"playerSigned": "/recordings/550e8400-e29b-41d4-a716-446655440000/player.html?expires=1735689600&keyId=key-2024-12&signature=a1b2c3d4e5f6...",
  
  
"screenshotPngSigned": "/recordings/550e8400-e29b-41d4-a716-446655440000/screenshot.png?expires=1735689600&keyId=key-2024-12&signature=a1b2c3d4e5f6..."
  
},
  
"metadata": {
  
  
"additionalProperties": "string"
  
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI