Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Path Parameters

deviceId
string
required

Body

application/json
name
string
Pattern: ^[A-Za-z0-9_.-]{1,64}$
quality
integer<int64>

Capture quality from 1 (lowest) to 10 (full stream quality). Defaults to the device's full quality. Honored by bring-your-own iPhones.

Required range: 1 <= x <= 10
retentionDays
integer<int64>
Required range: 1 <= x <= 90
types
string[] | null

Artifacts to capture: trajectory (input actions), video, and audio (captured into the video artifact, so it requires video; honored by bring-your-own iPhones). Defaults to trajectory and video, narrowed to what the device produces.

Response

Created

actions
integer<int64>
required
deviceId
string
required
display
object
required
expiresAt
string<date-time>
required
id
string
required
name
string
required
startedAt
string<date-time>
required
status
string
required
types
string[] | null
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/RecordingInfo.json"

endedAt
string<date-time>
error
string
video
object