Start a browser session replay recording

Start recording the browser session and return a replay ID.

POST /browsers/{id}/replays

Start a browser session replay recording

cURL

curl --request POST \
  --url https://api.onkernel.com/browsers/{id}/replays \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "framerate": 10,
  "max_duration_in_seconds": 2
}
'

201

{
  "replay_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "replay_view_url": "https://api.onkernel.com/browser/replays?jwt=eyJ0eXAi...&replay_id=7e2c1a9f-1234-4cde-9abc-ffeedd001122"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Browser session ID

Body

application/json

framerate · integer

Recording framerate in fps.

Required range: 1 <= x <= 20

max_duration_in_seconds · integer

Maximum recording duration in seconds.

Required range: x >= 1

Response

201

application/json

Recording started successfully.

Information about a browser replay recording.

replay_id · string · required

Unique identifier for the replay recording.

started_at · string<date-time> | null

Timestamp when replay started

finished_at · string<date-time> | null

Timestamp when replay finished

replay_view_url · string

URL for viewing the replay recording.

Example:

"https://api.onkernel.com/browser/replays?jwt=eyJ0eXAi...&replay_id=7e2c1a9f-1234-4cde-9abc-ffeedd001122"