Skip to content

Sensors

A sensor is a specific device that is used to capture or generate files. For instance, a camera, smartphone, or drone are each an example of a device that could be used to capture images and/or videos. Within the API, individual files can be associated with a sensor via the "sensor" standard attribute. This provides a way to annotate related files, but it also enables the opportunity for increased quality of the results. This is because certain functions within the API can leverage known sensor information to better influence their processing, such as a device with a known lens calibration, or modifying the lens distortion estimation so that images from the same sensor are grouped together.

Get a list of sensors

Returns a list of all available sensors. Each sensor in the list is represented by its URI.

Route: /v3{instance-uri}/sensors
Method: GET

Sample response body:

{
  "success": true,
  "data": {
    "sensors": [
      "/sensors/dji-air-2s",
      "/sensors/dji-mavic-2-pro",
      "/sensors/dji-phantom-4",
      "/sensors/dji-phantom-4-pro",
      "/sensors/dji-phantom-4-pro-v2",
      "/sensors/insta360-one-rs-1-inch-360-edition"
    ]
  }
}

Get details of a sensor

Returns the details for an individual sensor.

Route: /v3{instance-uri}{sensor-uri}
Method: GET

Sample response body:

{
  "success": true,
  "data": {
    "sensor": {
      "uri": "/sensors/dji-mavic-2-pro",
      "name": "DJI Mavic 2 Pro"
    }
  }
}

Description of the response attributes:

  • "uri" - Resource identifier for this sensor.
  • "name" - Name of the sensor.