Get high-confidence frame objects

GET

https://ai.nvidia.com/api/v3.3/analytics/frames/high-confidence-objects

GET

/api/v3.3/analytics/frames/high-confidence-objects

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

{
  "objects": [
    {
      "frameId": "10",
      "sensorId": "cam-1",
      "objectId": "1",
      "timestamp": "2024-01-15T09:30:00Z",
      "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,
      "embedding": [
        1.1
      ],
      "info": {
        "additionalProperty1": "value1",
        "additionalProperty2": "value2"
      }
    }
  ]
}

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

Query parameters

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

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

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

fromTimestampdatetimeRequired

toTimestampdatetimeRequired

maxResultSizelongOptional1-100Defaults to 100

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

minConfidencedoubleOptional0-1Defaults to 0.8

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.

objectslist of objects

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

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

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

timestampdatetime

bboxobject

confidencedouble

embeddinglist of doubles or null

infomap from strings to stringsOptional

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error