v1

latestOpenAPI 3.0.3Apache 2.02026-07-175678720.5 KB

frames

Get raw frame metadata

get/frames

Query parameters

sensorIdstring required

frameIdstring

This parameter is incompatible with maxResultSize, timestamp or time range params (fromTimestamp and toTimestamp). Only one of them can exist in the query.

timestampstring

This parameter is used for querying frame at a particular point of time. It is incompatible with maxResultSize, frameId or time range params (fromTimestamp and toTimestamp). Only one of them can exist in the query.

fromTimestampstring date-time

This parameter is used for querying frames in a time range. It is incompatible with timestamp or frameId. Only one of them can exist in the query.

toTimestampstring date-time

This parameter is used for querying frames in a time range. It is incompatible with timestamp or frameId. Only one of them can exist in the query.

maxResultSizeinteger

This parameter is incompatible with timestamp or frameId. Only one of them can exist in the query.

Response

Successful Operation.

Example response

{
  "frames": [
    {
      "version": "1",
      "objects": [
        {
          "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"
            }
          },
          "type": "Person",
          "id": "1",
          "info": {
            "additionalProperty1": "value1",
            "additionalProperty2": "value2"
          },
          "embedding": {
            "info": {
              "additionalProperty1": "value1",
              "additionalProperty2": "value2"
            }
          }
        }
      ],
      "timestamp": "2022-08-25T00:00:00.000Z",
      "sensorId": "cam-1",
      "info": {
        "additionalProperty1": "value1",
        "additionalProperty2": "value2"
      }
    }
  ]
}