Skip to main content

Status API

REST endpoint for checking the API server status.

Endpoints

MethodEndpointDescription
GET/api/statusGet server status

GET /api/status

Returns the current status of the EvalStudio API server.

Response (200 OK)

{
"name": "evalstudio",
"version": "0.0.1",
"status": "ok",
"timestamp": "2026-01-26T14:28:04.270Z",
"node": "v20.19.6"
}

Response Fields

FieldTypeDescription
namestringPackage name ("evalstudio")
versionstringCurrent version
statusstringServer status ("ok" or "error")
timestampstringISO 8601 timestamp
nodestringNode.js version running the server

Example

curl http://localhost:3000/api/status

Use Cases

  • Health checks: Load balancer or Kubernetes readiness probes
  • Monitoring: Track API server uptime
  • Debugging: Verify server is running and responding