Skip to main content
Glama

IvedaAI: FaceMatch

ivedaai_face_match
Destructive

Search and manage face matches in IvedaAI video analytics. Retrieve match lists, find matches by time, camera, age, gender, and emotion, view latest detections, and delete outdated entries.

Instructions

IvedaAI API — FaceMatch operations. Response JSON: "status" is the HTTP status code; "truncated"/"timedOut" flag a cut-off response.

GET /api/face/{faceKeyId}/matches — Get match list path: faceKeyId*:integer

GET /api/face/matches — Search face matches query: offset?:integer, page?:any, pageNumber?:integer, pageSize?:integer, paged?:boolean, size?:any, sort?:any, sort.sorted?:boolean, sort.unsorted?:boolean, start*:string(yyyy-MM-dd HH:mm:ss), unpaged?:boolean, end*:string(yyyy-MM-dd HH:mm:ss), ainvrIds?:integer, cameraIds?:integer, footageIds?:integer, categories?:string, nameContains?:string, scores?:number, age?:string enum:1-19|20-29|30-39|40-49|50-59|60-69|70-100, gender?:string enum:Female|Male|Unknown, emotion?:string enum:Angry|Happy|Neutral|Sad|Surprised|Unknown, hasMask?:boolean, allCameras?:boolean, allFootages?:boolean

DELETE /api/face/matches/{matchId} — Delete face match path: matchId*:integer

GET /api/face/matches/latest — Latest face matches query: ainvrIds?:integer, cameraIds*:integer, categories?:string, nameContains?:string, age?:string enum:1-19|20-29|30-39|40-49|50-59|60-69|70-100, gender?:string enum:Female|Male|Unknown, emotion?:string enum:Angry|Happy|Neutral|Sad|Surprised|Unknown, scores?:number, hasMask?:boolean, allCameras?:boolean, start*:string(yyyy-MM-dd HH:mm:ss), size?:integer

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoJSON request body, or form field values when uploading a file.
fileNoLocal file to upload, for operations that accept a file.
pathNoPath parameters, e.g. { "cameraId": 12 }
queryNoQuery string parameters for this operation.
operationYesWhich API operation to call, from the list in this tool's description.
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already flag destructiveHint=true, and the description aligns by including a DELETE operation. It adds useful context about response JSON (status, truncated/timedOut flags) but does not disclose side effects of deletion, error handling, or authentication requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense yet well-structured, using indentation and clear labels for each endpoint. It front-loads the response note and operation list, and every line adds specific value without fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With four distinct operations and no output schema, the description gives a thorough parameter map and response flag explanation, but it lacks narrative on pagination behavior, error handling, or how to select among operations. It is a solid reference but not a complete operational guide.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The generic schema is augmented by the description's detailed parameter lists, including types, required markers, and enums for each operation. This provides essential invocation details, though it does not explain the semantic meaning of parameters like 'scores' or 'nameContains'.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly lists four endpoints with specific verbs (Get, Search, Delete, Latest) and resources (face matches), making the tool's purpose unambiguous. It clearly distinguishes FaceMatch operations from sibling tools like ivedaai_face and ivedaai_face_category by focusing solely on match-related operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives or how to choose among the four operations. It lacks contextual cues such as 'use Search for filtering by attributes' or 'use Get match list when you have a faceKeyId'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/WillORepO/ivedaAI-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server