---
title: Health
url: /sdks/go/dev/api/health/
docset: sdk-go
version: dev
latest_version: 0.1.8
source: ai-openshell/sdk-go@main:docs/src/api/health.md
---

> Documentation index: /sdks/go/dev/llms.txt. This page is for Go SDK dev.
> These docs are for the development version (ai-openshell/sdk-go@main). Latest released version (0.1.8): /sdks/go/0.1.8/api/health.md

# Health

Accessor: `client.Health()`

Check the health status of the connected OpenShell gateway.

## Check

Perform a health check against the gateway. Returns the overall status and
component-level details.

```go
result, err := client.Health().Check(ctx)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Gateway healthy: %v\n", result.Healthy)
```

This is useful for readiness probes or verifying connectivity before executing
other operations.

```go
// Quick connectivity check before starting work
if result, err := client.Health().Check(ctx); err != nil {
    log.Fatalf("Gateway unreachable: %v", err)
} else if !result.Healthy {
    log.Fatal("Gateway is not healthy")
}
```

See also: [Error Handling](/sdks/go/dev/error-handling/)
