Skip to content
Whisper ASR Webservice

Search is only available in production builds. Try building and previewing the site to test it out locally.

GET /

Summary

Returns the root index response of the API, typically serving as a health check or entry point.

Intent

Provides a lightweight endpoint to verify the API is reachable and operational, often used for health checks, uptime monitoring, or service discovery.

Parameters

No parameters.

Request example

Terminal window
curl -X GET http://localhost:8000/

Response example

{
  "message": "OK",
  "status": "healthy"
}

Error cases

  • 503 — when the service is unavailable or starting up

Gotchas

  • The exact response body shape is not guaranteed without additional context — inspect the actual handler implementation to confirm the returned payload structure.
  • No authentication is required, making this safe to call from public health check systems, but also meaning it should not expose sensitive information.
  • Some reverse proxies or load balancers may intercept requests to ’/’ before they reach this handler, potentially returning a different response than expected.
  • If the API is versioned (e.g., /v1/), this root endpoint may behave differently from versioned entry points and could be deprecated or removed in future versions.