Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.healos.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Error Handling

The API uses standard HTTP status codes and returns consistent JSON error objects.

​
Error Response Format

All errors return a JSON object with an error field: 
{
  "error": "Patient not found"
}
Validation errors include a details object mapping field names to arrays of error messages: 
{
  "error": "Validation error",
  "details": {
    "name": ["String must contain at least 1 character(s)"]
  }
}

​
Status Codes

CodeDescription
200Success
201Resource created
400Validation error or bad request
401Missing or invalid API key
403Insufficient scope for this operation
404Resource not found
429Rate limit exceeded
500Internal server error
A 404 response does not distinguish between “resource does not exist” and “resource belongs to another user” — this is intentional to prevent enumeration attacks.