IvedaAI: Face
ivedaai_faceDetect faces in images, search for matches in footage, compare face descriptors for similarity, and retrieve face statistics. Delete face keys as needed.
Instructions
IvedaAI API — Face operations. Response JSON: "status" is the HTTP status code; "truncated"/"timedOut" flag a cut-off response.
POST /api/face — Face detection file: provide as {path, filename?, contentType?} — local file to upload as "file" form fields (pass via body): agQualityLevel?:string enum:high|low|medium, qualityLevel?:string enum:high|low|medium, sceneId?:integer, url?:string
DELETE /api/face/{faceKeyId} — Delete faceKey path: faceKeyId*:integer
POST /api/face/search — Face search query: ainvrIds?:integer, allCameras?:boolean, allFootages?:boolean, cameraIds?:integer, descriptor*:string, end*:string(yyyy-MM-dd[ HH:mm:ss[Z]]), footageIds?:integer, limit?:integer, scores?:number, start*:string(yyyy-MM-dd[ HH:mm:ss[Z]])
POST /api/face/similarity — Face similarity body: { descriptor1?:string, descriptor2?:string }
POST /api/face/statistics — Get face statistics body: FaceStatisticRequest — required: by; ivedaai_get_schema for all fields
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | JSON request body, or form field values when uploading a file. | |
| file | No | Local file to upload, for operations that accept a file. | |
| path | No | Path parameters, e.g. { "cameraId": 12 } | |
| query | No | Query string parameters for this operation. | |
| operation | Yes | Which API operation to call, from the list in this tool's description. |