Common Schema

All Annie Insights API endpoints share common request parameters and response patterns.

Standard Request Parameters

Every image-based endpoint requires these three parameters:

Parameter	Type	Required	Description
PatientID	string	✅ Yes	Unique patient identifier from your system
TimeStamp	string	✅ Yes	Analysis session timestamp (e.g., "2026-05-24")
ImageName	string	✅ Yes	Full URL to the dental image to analyze

Example Request Body

{
  "PatientID": "P-001",
  "TimeStamp": "2026-05-24",
  "ImageName": "https://your-storage.com/images/patient-photo.jpg"
}

Image URL Requirements

• Must be a publicly accessible HTTPS URL
• Supported formats: JPEG, PNG
• Maximum file size: 20MB
• Recommended resolution: 1024×768 or higher

Standard Response Fields

Field	Type	Description
Version	string	API version used for processing
PatientID	string	Echoed from request
TimeStamp	string	Echoed from request
ImageName	string	Processed image filename
Results	object	Endpoint-specific analysis results
OutputImageUrl	string	Annotated image URL (SAS-protected, 72h expiry)

Optional Parameters

Some endpoints accept additional optional parameters:

Parameter	Type	Available On	Description
StandardName	string	Frontal Segmentation	Evaluation standard (default: "ICON")
PlotLabels	boolean	Frontal Segmentation	Show classification labels on output
DrawContours	boolean	Segmentation endpoints	Draw contour outlines on output