Skip to navigation
System ComponentsMiddlewareAPI Gateway / MCPVideo Analytics APIVideo Analytics API Referenceclustering

Label a behavior cluster

View as Markdown
Assign a label to a behavior cluster using the cluster details in the request body.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Details regarding the cluster and the label
sensorIdstringRequiredformat: "^.{0,10000}$"<=10000 characters
modelVersionstringRequiredformat: "^.{0,10000}$"<=10000 characters
clusterIndexstringRequiredformat: "^.{0,10000}$"<=10000 characters
labelstringRequiredformat: "^.{0,10000}$"<=10000 characters

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.
successboolean

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error