Start recording a session

POST

/sessions/{id}/recording/start

Host only

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

Recording started

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/sessions//recording/start' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "success": true,
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
        "egress_id": "string",
        "name": "string",
        "file_path": "string",
        "duration": 0,
        "file_size": 0,
        "status": "recording",
        "storage_type": "string",
        "retry_count": 0,
        "error_message": "string",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    },
    "timestamp": 0
}

Modified at 2026-02-10 08:33:01

Get active recording for a session

Stop recording a session