Skip to content
Sandbox Agent
GitHub Get Started
HTTP API

Start desktop recording.

POST
/v1/desktop/recording/start

Starts an ffmpeg x11grab recording against the managed desktop and returns the created recording metadata.

Request Body required

Section titled “Request Body required ”
object
fps
integer format: int32
nullable

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Desktop recording started

object
bytes
required
integer format: int64
endedAt
string
nullable
fileName
required
string
id
required
string
processId
string
nullable
startedAt
required
string
status
required
string
Allowed values: recording completed failed

409

Section titled “409 ”

Desktop runtime is not ready or a recording is already active

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties

502

Section titled “502 ”

Desktop recording failed

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties