Skip to content
Kindgi

client.system

client.system — the system operations.

On AsyncKindgi every method is the same, awaited.

client.system.health()

Section titled “client.system.health()”
health(*, timeout: float | None = None) -> HealthResult

Liveness probe. GET /health

Public. Returns { ok: true } when the process is reachable.

client.system.openapi()

Section titled “client.system.openapi()”
openapi(*, timeout: float | None = None) -> SystemOpenapiResponse

OpenAPI 3.1 spec document. GET /v1/openapi.json

Public. Returns the machine-readable spec for this deployment. Used by SDK codegen (a snapshot ships in the @kindgi/api package as @kindgi/api/openapi.json).