API Reference

Admin

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Ocr Health

client.Admin.GetOcrStatus(ctx) (*AdminGetOcrStatusResponse, error)

GET/api/v1/admin/ocr/statusz

Get OCR service health status including GPU availability.

ReturnsExpand Collapse

type AdminGetOcrStatusResponse struct{…}

Response model for OCR service health/GPU status.

Status AdminGetOcrStatusResponseStatus

One of the following:

const AdminGetOcrStatusResponseStatusDegraded AdminGetOcrStatusResponseStatus = "degraded"

const AdminGetOcrStatusResponseStatusOk AdminGetOcrStatusResponseStatus = "ok"

const AdminGetOcrStatusResponseStatusUnavailable AdminGetOcrStatusResponseStatus = "unavailable"

Device stringOptional

ErrorMessage stringOptional

GPUAvailable boolOptional

GPUDeviceCount int64Optional

GPUDeviceName stringOptional

Get Ocr Health

Go

HTTP

TypeScript

Python

Go

Java

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llamacloud-admin-go"
  "github.com/run-llama/llamacloud-admin-go/option"
)

func main() {
  client := llamacloudadmin.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Admin.GetOcrStatus(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Status)
}

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