Skip to main content
POST
/
browser
/
sessions
/
{id}
/
recording
/
start
Start Recording
curl --request POST \
  --url https://api.example.com/browser/sessions/{id}/recording/start
{
  "recordingId": "<string>",
  "status": "<string>"
}

​
Overview

Starts capturing an MP4 recording of the session’s virtual desktop. Only one recording can be active per session — starting again while a recording is in progress is a 409. Download the MP4 after stopping with GET /browser/sessions/{id}/recording.

​
Path Parameters

​
id
string
required
Browser session ID (UUID).

​
Example Request

curl -X POST "https://api.scrapengine.io/api/v1/browser/sessions/baa3f390-fa6e-4a24-b84a-a575a5f3a9c7/recording/start" \
  -H "Authorization: Bearer $SCRAPENGINE_API_KEY"

​
Response

​
Success Response (200)

​
recordingId
string
Identifier for this recording.
​
status
string
Recording state — recording when capture has begun.
Example Response: 
{
  "recordingId": "rec-01HX3...",
  "status": "recording"
}

​
Error Responses

StatusDescription
401Unauthorized — invalid or missing API key.
404Session not found or not owned by the caller.
409A recording is already in progress for this session.