1. AI_API
Graduation API
  • AI_API
    • API Root
      GET
    • API Health Status
      GET
    • Water Hyacinth Detection
      POST
    • Schemas
      • PredictionSchema
  • backend_API
    • Profiles
      • List profiles
      • Create profile
      • Update profile
      • Delete profile
    • Classification Runs
      • List classification runs
      • Create classification run
      • Update classification run
      • Delete classification run
    • Schemas
      • Profile
      • ProfileInput
      • ClassificationRun
      • ClassificationRunInput
  • Water Hyacinth Detection API
    • Describe the API entrypoint
      GET
    • Describe the mounted API base path
      GET
    • Predict water-hyacinth coverage and bounding boxes for one image
      POST
    • Predict water-hyacinth coverage and bounding boxes for multiple images
      POST
    • Check API readiness
      GET
    • Schemas
      • BatchPredictionItem
      • Body_predict_batch_endpoint_api_v1_water_hyacinth_predict_batch_post
      • Body_predict_endpoint_api_v1_water_hyacinth_predict_post
      • BoundingBox
      • HTTPValidationError
      • HealthResponse
      • PredictionResponse
      • ValidationError
Github Repo
  1. AI_API

API Health Status

GET
/health
Last modified:2026-05-08 19:48:38
Maintainer:Yousef Dawood

🌿 Health Check#

Verifies that the Water Hyacinth API is online and operational.
This endpoint can be used for:
Uptime monitoring
Deployment verification
Service health validation

Request

None

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://13.60.65.62:3000/health'
Response Response Example
{
    "status": "string"
}
Modified at 2026-05-08 19:48:38
Previous
API Root
Next
Water Hyacinth Detection
Built with