Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-175678720.5 KB
frames

Get frame based objects with high confidence. These object detections can be used for reference embedding, based on which object search can be done. Please check the input descriptions to check its dependencies.

get/frames/high-confidence-objects

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"
      }
    }
  ]
}