API Documentation

🔐 Authentication Required

All API requests require an API key. Include your key in the X-API-Key header. Request an API key here.

Base URL

https://api.sonzo.io

Endpoints

GET /health

Health Check

Check if the API is running and the model is loaded.

# Request
curl https://api.sonzo.io/health

# Response
{
  "status": "healthy",
  "service": "SonZo.ai SLR API",
  "model_loaded": true
}

GET /

API Information

Get API version, supported signs, and patent information.

# Response
{
  "service": "SonZo.ai SLR API",
  "version": "1.0.0",
  "model_loaded": true,
  "num_classes": 50,
  "classes": ["hello", "thank_you", ...],
  "patent": "Patent Pending 63/918,518"
}

POST /api/slr/recognize

Recognize Sign Language

Submit video frames for ASL recognition. Returns the recognized sign with confidence score.

Header	Type	Description
X-API-Key	string required	Your API key
Content-Type	string	application/json

Body Parameter	Type	Description
frames	array required	Array of base64-encoded video frames (16 frames recommended)

# Request
curl -X POST https://api.sonzo.io/api/slr/recognize \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "frames": ["base64_frame_1", "base64_frame_2", ...]
  }'

# Response
{
  "success": true,
  "sign": "hello",
  "confidence": 0.94,
  "alternatives": [
    {"sign": "hi", "confidence": 0.03}
  ]
}

Supported Signs

Currently supporting 50 common ASL signs including:

hello thank you yes no please help family mother drink + 40 more

Rate Limits

Plan	Requests/Month	Rate Limit
Free	25	1 request/second
Pro ($299/mo)	2,000	10 requests/second
Enterprise	Unlimited	Custom

Error Codes

Code	Meaning
401	Invalid or missing API key
429	Rate limit exceeded
400	Invalid request (missing frames, bad format)
500	Server error