API Reference

Admin

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Ocr Health

GET/api/v1/admin/ocr/statusz

Get OCR service health status including GPU availability.

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

status: "degraded" or "ok" or "unavailable"

One of the following:

"degraded"

"ok"

"unavailable"

device: optional string

error_message: optional string

gpu_available: optional boolean

gpu_device_count: optional number

gpu_device_name: optional string

Get Ocr Health

HTTP

HTTP

TypeScript

Python

Go

Java

curl https://api.cloud.llamaindex.ai/api/v1/admin/ocr/statusz \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

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"
}