Skip to main content

Generates image tags for an image

POST /v1/tag/image/{deviceSerial}

Summary​

Generates image tags for an image.

Details​

Request body: JSON object.

Supports optional maxLabels and minConfidence.

Authentication​

No operation-level security requirement is documented here.

Parameters​

NameInTypeRequiredDescriptionExample
deviceSerialpathstringYesThe device serial number.Example value

Request Body​

Required: Yes

application/json​

  • deviceID (integer (int64), optional)
  • videoClipID (integer (int64), optional)
  • epochTime (integer (int64), optional)
  • epochTimeMs (integer (int64), optional)
  • objectName (string, optional)
  • maxLabels (integer (int32), optional)
  • minConfidence (number (float), optional)

Example

{
  "deviceID": 201,
  "videoClipID": 1,
  "epochTime": 1711800000,
  "epochTimeMs": 1711800000,
  "objectName": "Example value",
  "maxLabels": 1,
  "minConfidence": 98.4
}

Responses​

200​

Success

application/json​

  • array of ImageLabel
    • label (string, optional)
    • confidence (number (float), optional)

Example

[
  {
    "label": "Example value",
    "confidence": 98.4
  }
]