frames

Get high-confidence frame objects

Retrieve high-confidence object detections from frames for use as reference embeddings in object search, filtered by sensor and time range.

get/frames/high-confidence-objects

Request

Query parameters

sensorIdstring required
objectIdstring

This parameter is incompatible with maxResultSize. Only one of them can exist in the query.

fromTimestampstring date-time required
toTimestampstring date-time required
maxResultSizeinteger

This parameter is incompatible with objectId. Only one of them can exist in the query.

minConfidencenumber double

Response

Successful Operation.

Example response

{
  "objects": [
    {
      "frameId": "10",
      "sensorId": "cam-1",
      "objectId": "1",
      "bbox": {
        "topY": 0.5,
        "rightX": 1.7,
        "bottomY": 0.8,
        "leftX": 0.6,
        "embeddings": [
          {
            "vector": [
              0.1
            ]
          }
        ],
        "confidence": 0.95,
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "confidence": 0.95,
      "info": {
        "additionalProperty1": "value1",
        "additionalProperty2": "value2"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 9 revisions of this API.