ONonkernel
Browser Replays

Start a browser session replay recording

Start recording the browser session and return a replay ID.

post/browsers/{id_or_name}/replays

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/browsers/{id_or_name}/replays
  • Auth
    HTTP bearer

Path parameters

id_or_namestring required

Browser session ID or name

Request body

framerateinteger

Recording framerate in fps. Values above 20 require GPU to be enabled on the browser session.

max_duration_in_secondsinteger

Maximum recording duration in seconds.

record_audioboolean

Record audio in addition to video. When false (the default), the recording is video-only.

Response

Recording started successfully.

finished_atstring date-time nullable

Timestamp when replay finished

replay_idstring required

Unique identifier for the replay recording.

replay_view_urlstring

URL for viewing the replay recording.

started_atstring date-time nullable

Timestamp when replay started

Example response

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

Changes

No recorded changes to this operation across all 76 revisions of this API.