6 image models · capabilities and pricing in one placeSee pricing →
API documentationLiveness check

OGA DEVELOPER CENTER

API v1 · Last verified 2026-08-15

Liveness check

Confirm that the API process can respond.

GET/health
Browse common endpoints

Overview

This endpoint reports process liveness only. It does not prove that tasks, private assets, or workers are ready. Deployment probes may use it for process health; traffic admission should also inspect readiness.

Authentication: No authentication

Request

This endpoint has no path, query, or request-body parameters.

Response

JSON endpoints use the standard response envelope. HTTP status represents the request outcome; business errors are not disguised as HTTP 200.

HTTPMeaning
200Request succeeded

Complete success example (optional fields vary by state)

{
  "code": 0,
  "message": "success",
  "data": {
    "status": "ok"
  },
  "request_id": "8f25b42f-2ed1-4ad7-99de-61d7f779bc7b",
  "timestamp": "2026-08-10T00:00:00Z"
}

Important boundaries

  • Public endpoint; it does not read an API key or incur a charge.

Open the machine-readable OpenAPI

Code & API explorer

GET · /health

curl -X GET "$OGA_BASE_URL/health" \
  -H "X-Request-Id: <UUID_V4>" \
  -H "Accept-Language: en-US"