API Documentation

VisionEra REST API

Integrate face recognition, vehicle detection, and body analysis into your applications. Generate API keys from your dashboard and start making requests in minutes.

Get API KeyBase URL: https://visionera.live/api

Authentication

All API requests require an API key passed via the X-API-Key header. Generate API keys from your Dashboard → API Keys page.

curl -H "X-API-Key: ve_live_abc123..." https://visionera.live/api/...

API Endpoints

POST/api/faces/compare

1:1 Face Verification

Compare two face images to determine if they belong to the same person. Returns a similarity score and match decision.

Rate Limit60 requests/minute
Max File Size2 MB per image
FormatsJPEG, PNG, WebP, GIF

Parameters

source
filerequired

First face image

target
filerequired

Second face image

cURL Example

curl -X POST https://visionera.live/api/faces/compare   -H "X-API-Key: your_api_key_here" \
  -F "source=@photo1.jpg"   -F "target=@photo2.jpg"

Response

{
  "match": true,
  "similarity": 0.94,
  "confidence": "high",
  "faces_detected": {
    "image1": 1,
    "image2": 1
  }
}

Rate Limits

Rate limits are enforced per API key. When you exceed the limit, you'll receive a 429 Too Many Requests response. Rate limit headers are included in every response.

EndpointRate LimitBurst Limit
1:1 Face Compare60 req/min10 req/sec
1:N Face Search30 req/min5 req/sec
N:N Batch Match10 req/min2 req/sec
Video Analyze10 req/min2 req/sec
Video Status120 req/min20 req/sec

Rate Limit Headers

X-RateLimit-Limit: 60

X-RateLimit-Remaining: 45

X-RateLimit-Reset: 1625097600

Upload Constraints

🖼️ Images

  • • Formats: JPEG, PNG, WebP, GIF
  • • Max size: 2 MB per image (Free), 10 MB (Pro), 20 MB (Enterprise)
  • • Min resolution: 64x64 pixels
  • • Face must be clearly visible

🎬 Videos

  • • Formats: MP4, WebM, MOV, AVI
  • • Max size: 500 MB
  • • Max duration: 10 minutes recommended
  • • Processing is asynchronous (poll job status)

Error Codes

CodeMeaningResolution
400Bad RequestCheck request parameters and file formats
401UnauthorizedVerify your API key is valid and active
403ForbiddenYour plan may not support this endpoint
413Payload Too LargeReduce file size within plan limits
429Too Many RequestsWait and retry, or upgrade your plan
500Internal ErrorContact support at info@visionera.live

Ready to Integrate?

Generate your API key and start building with VisionEra in minutes.

Generate API KeyContact Sales