CareEZ · API Reference

Clinical AI API Docs

Live, callable REST endpoints for IDDSI food texture classification and aspiration risk screening. Built by Carewells Limited, Hong Kong social enterprise.

● 3 Endpoints Live OpenAPI 3.0 No Auth Required CORS: * v1.0.0
⚠ Clinical Disclaimer: Prototype rule-based classifiers — all outputs are decision-support tools only. Clinical decisions require assessment by a qualified Speech-Language Pathologist (SLP). Not approved for standalone clinical use.
Endpoints at a glance
POST
/api/iddsi-classify
Classify a food or liquid from a text description. Returns IDDSI Level 0–7 with confidence score and bilingual explanation.
Live
POST
/api/iddsi-classify-image
Upload a photo of a food or liquid. Visual AI returns IDDSI level with confidence score.
Live
POST
/api/voice-aspiration-screen
Describe swallowing symptoms in free text. Returns risk level (low / moderate / high), score 0–100, and clinical recommendation.
Live
POST
/api/iddsi-classify-audio
Swallowing audio → IDDSI inference via voice analysis. Research-staged; coordinating with audio analysis agent.
Research-Staged
⬇ Download OpenAPI YAML ⬇ Download Postman Collection 🌐 Multilingual Examples Try the demo ↗ IDDSI Framework ↗ ✉ API access enquiries
Developer Resources
📦
Postman Collection
Postman v2.1 collection with all 10 requests, pre-request scripts, collection variables ({{base_url}}), and automated tests. Import directly into Postman Desktop or VS Code.
⬇ Download JSON
🌐
Multilingual cURL Examples
cURL samples in 9 languages (en, zh-HK, zh-CN, ja, tl, id, vi, th, es) for /api/iddsi-classify and 4-language examples for aspiration screening and image upload.
View Examples ↗
📋
OpenAPI Specification
Full OpenAPI 3.0.3 YAML spec — import into any compatible tool (Insomnia, Stoplight, Redoc). Includes all schemas, examples, and response definitions.
⬇ Download YAML