Get raw frame metadata

GET

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

GET

/api/v3.3/analytics/frames

curl -G https://ai.nvidia.com/api/v3.3/analytics/frames \
     -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

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

Retrieve raw 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.

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

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.

fromTimestampdatetimeOptional

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.

toTimestampdatetimeOptional

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.

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.

frameslist of objects

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

idlong0-10000

objectslist of objects

timestampdatetime

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

infomap from strings to stringsOptional

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error