DRdroidrun
Tools/Recordings

Start a device recording

Changed on
post/devices/{deviceId}/recordings

Request

  • Base URL
    https://api.mobilerun.ai
  • URL
    https://api.mobilerun.ai/devices/{deviceId}/recordings
  • Auth
    HTTP bearer

Path parameters

deviceIdstring required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

namestring
qualityinteger

Capture quality from 1 (lowest) to 10 (full stream quality). Defaults to the device's full quality. Honored only by devices that support adjustable capture quality.

retentionDaysinteger
typesstring[] nullable

Artifacts to capture: trajectory (input actions; on some devices only when the device announces trajectory capture), video, and audio (captured into the video artifact, so it requires video; honored only by devices that support audio capture). Defaults to trajectory and video, narrowed to what the device produces.

Example request

{
  "$schema": "https://example.com/schemas/StartInputBody.json"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

actionsinteger required
deviceIdstring required
endedAtstring date-time
errorstring
expiresAtstring date-time required
idstring required
namestring required
startedAtstring date-time required
statusstring required
typesstring[] nullable required

Example response

{
  "$schema": "https://example.com/schemas/RecordingInfo.json"
}

Changes

  • 4ad548c528a8Revision changes
    • info

      the endpoint scheme security ServiceKey was removed from the API

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      added the new optional request property

  • fc388ab21a20Revision changes
    • info

      api tag Tools/Recordings added

    • info

      api tag Recordings removed