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

OGA DEVELOPER CENTER

API v1 · Last verified 2026-08-15

Readiness check

Check whether task storage, private assets, and workers can accept traffic.

GET/health/ready
Browse common endpoints

Overview

Send new business traffic to an instance only when data.ready is true. An unready instance returns a non-2xx error envelope and must not be treated as available.

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
500Internal service error
503Instance is not ready

Complete success example (optional fields vary by state)

{
  "code": 0,
  "message": "success",
  "data": {
    "status": "ok",
    "ready": true,
    "components": {
      "api": {
        "status": "ok"
      },
      "task_store": {
        "status": "ok",
        "kind": "mysql-runtime"
      },
      "asset_store": {
        "status": "ok",
        "kind": "encrypted-private-filesystem"
      },
      "worker": {
        "status": "ok"
      },
      "shared_worker_runtime": {
        "status": "ok",
        "kind": "external"
      },
      "real_channel_routing": {
        "status": "ok",
        "kind": "external"
      },
      "scheduler_runtime": {
        "status": "ok",
        "kind": "advisory"
      },
      "identity_mirror": {
        "status": "ok",
        "kind": "advisory"
      }
    }
  },
  "request_id": "8f25b42f-2ed1-4ad7-99de-61d7f779bc7b",
  "timestamp": "2026-08-10T00:00:00Z"
}

Important boundaries

  • Public and read-only; it never creates a task or calls an upstream.

Open the machine-readable OpenAPI

Code & API explorer

GET · /health/ready

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