API Reference

Admin

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Ocr Health

AdminGetOcrStatusResponse admin().getOcrStatus(AdminGetOcrStatusParamsparams = AdminGetOcrStatusParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/admin/ocr/statusz

Get OCR service health status including GPU availability.

ParametersExpand Collapse

AdminGetOcrStatusParams params

ReturnsExpand Collapse

class AdminGetOcrStatusResponse:

Response model for OCR service health/GPU status.

Status status

One of the following:

DEGRADED("degraded")

OK("ok")

UNAVAILABLE("unavailable")

Optional<String> device

Optional<String> errorMessage

Optional<Boolean> gpuAvailable

Optional<Long> gpuDeviceCount

Optional<String> gpuDeviceName

Get Ocr Health

Java

HTTP

TypeScript

Python

Go

Java

package ai.llamaindex.llamacloudadmin.example;

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.admin.AdminGetOcrStatusParams;
import ai.llamaindex.llamacloudadmin.models.admin.AdminGetOcrStatusResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

        AdminGetOcrStatusResponse response = client.admin().getOcrStatus();
    }
}

200 example

{
  "status": "degraded",
  "device": "device",
  "error_message": "error_message",
  "gpu_available": true,
  "gpu_device_count": 0,
  "gpu_device_name": "gpu_device_name"
}

Returns Examples

200 example

{
  "status": "degraded",
  "device": "device",
  "error_message": "error_message",
  "gpu_available": true,
  "gpu_device_count": 0,
  "gpu_device_name": "gpu_device_name"
}