For the complete documentation index, see llms.txt. This page is also available as Markdown.

Health Check

A quick way to verify that the API is operational and accessible.

Utils:Health-Check

get

Health check endpoint.

Returns: HealthResponse with status, service name, and timestamp

Header parameters
x-api-keystring · nullableOptional
Responses
200

Successful Response

application/json

Health check response schema

statusstringRequired
servicestringRequired
timestampstringRequired
get/api/v1/health
GET /api/v1/health HTTP/1.1
Accept: */*
{
  "status": "text",
  "service": "text",
  "timestamp": "text"
}

Last updated