Get enhanced frame metadata

GET

https://ai.nvidia.com/api/v3.3/analytics/frames/enhanced

GET

/api/v3.3/analytics/frames/enhanced

curl -G https://ai.nvidia.com/api/v3.3/analytics/frames/enhanced \
     -d frameId=4 \
     --data-urlencode fromTimestamp=2022-08-25T00:00:00.000Z \
     -d sensorId=sensorId \
     --data-urlencode timestamp=2022-08-25T00:00:00.000Z \
     --data-urlencode toTimestamp=2022-08-25T00:00:10.000Z

{
  "enhancedFrames": [
    {
      "version": "1",
      "id": "1",
      "objects": [
        null
      ],
      "timestamp": "2024-01-15T09:30:00Z",
      "sensorId": "cam-1",
      "socialDistancing": {
        "clusters": [
          {
            "points": [
              {
                "x": 1.1,
                "y": 0.5
              }
            ]
          }
        ],
        "proximityDetections": 1,
        "threshold": 1.1
      },
      "rois": [
        {
          "id": "hazard_zone_1",
          "type": "Person",
          "count": 1
        }
      ],
      "fov": [
        {
          "id": "1",
          "type": "Person",
          "count": 1
        }
      ],
      "info": {
        "additionalProperty1": "value1",
        "additionalProperty2": "value2"
      }
    }
  ]
}

Retrieve enhanced frame metadata for a sensor, optionally filtered by frame identifier, timestamp, time range, and result limit.

Query parameters

sensorIdstringRequiredformat: "^.{0,10000}$"<=10000 characters

frameIdstringOptionalformat: "^.{0,10000}$"<=10000 characters

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

timestampdatetimeOptional

This parameter is used for querying enhanced 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.

fromTimestampdatetimeOptional

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

toTimestampdatetimeOptional

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

maxResultSizelongOptional1-1000Defaults to 25

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

Response headers

Access-Control-Allow-OriginstringOptionalformat: "^.{0,10000}$"<=10000 characters

CORS header to allow cross-origin requests.

X-RateLimit-LimitintegerOptional

The maximum number of requests allowed in the current time period.

X-RateLimit-RemainingintegerOptional

The number of requests remaining in the current time period.

X-RateLimit-ResetintegerOptional

The time when the rate limit will be reset (Unix timestamp).

Response

Successful Operation.

enhancedFrameslist of objects

versionstringformat: "^.{0,10000}$"<=10000 characters

idstringformat: "^.{0,10000}$"<=10000 characters

objectslist of any

timestampdatetime

sensorIdstringformat: "^.{0,10000}$"<=10000 characters

socialDistancingobject

roislist of objects

fovlist of objects

infomap from strings to stringsOptional

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error