Skip to main content
POST
/
v1
/
desktop
/
recording
/
start
Start desktop recording.
curl --request POST \
  --url http://localhost:2468/v1/desktop/recording/start \
  --header 'Content-Type: application/json' \
  --data '{
  "fps": 1
}'
{
  "bytes": 1,
  "fileName": "<string>",
  "id": "<string>",
  "startedAt": "<string>",
  "status": "recording",
  "endedAt": "<string>",
  "processId": "<string>"
}

Body

application/json
​
fps
integer<int32> | null
Required range: x >= 0

Response

Desktop recording started

​
bytes
integer<int64>
required
Required range: x >= 0
​
fileName
string
required
​
id
string
required
​
startedAt
string
required
​
status
enum<string>
required
Available options:
recording,
completed,
failed
​
endedAt
string | null
​
processId
string | null