Skip to content

Readiness

GET

/v1/health/ready

const url = 'http://localhost:8080/v1/health/ready';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/v1/health/ready

Readiness — checks only the CRITICAL in-cluster dependencies (database, redis, storage). It deliberately EXCLUDES the OCR/LLM provider probes (which fan out over the network, including the off-cluster LLM) so a slow provider never flaps the API out of its Service. Returns 503 when a critical dependency is down.

Responses

200

Successful Response

application/json

Example ^generated

example