Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and Android. Generated with openapi-generator kotlin (library=jvm-okhttp4, useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai. Co-authored-by: Hanzo Dev <[email protected]>
15 KiB
HealthApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| authzAuthzHealth | GET /v1/authz/health | Liveness probe |
| authzAuthzReadyz | GET /v1/authz/readyz | Readiness probe |
| autoGetDocs | GET /v1/auto/docs | Get auto-generated OpenAPI documentation |
| autoGetHealth | GET /v1/auto/health | Health check |
| consoleGetHealth | GET /v1/console/health | Check health of API and database |
| flowGetDocs | GET /v1/flow/docs | Get auto-generated OpenAPI documentation |
| flowGetHealth | GET /v1/flow/health | Health check |
| gatewayLivelinessCheck | GET /v1/gateway/health/liveliness | Liveliness check |
| gatewayReadinessCheck | GET /v1/gateway/health/readiness | Readiness check |
| mqHealthCheck | GET /v1/mq/health | Health check |
| mqServerInfo | GET /v1/mq/info | Server info |
| notifyNotifyHealth | GET /v1/notify/health | Liveness probe |
| pricingTriggerSync | POST /v1/pricing/sync | Trigger manual sync |
| referralsReferralsHealth | GET /v1/referrals/health | Liveness probe |
| streamHealthCheck | GET /health | Health check |
authzAuthzHealth
AuthzAuthzHealth200Response authzAuthzHealth()
Liveness probe
Always served, no auth required. Returns a static status object.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : AuthzAuthzHealth200Response = apiInstance.authzAuthzHealth()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#authzAuthzHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#authzAuthzHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
authzAuthzReadyz
AuthzAuthzReadyz200Response authzAuthzReadyz()
Readiness probe
Always served, no auth required. Returns a static readiness object.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : AuthzAuthzReadyz200Response = apiInstance.authzAuthzReadyz()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#authzAuthzReadyz")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#authzAuthzReadyz")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
autoGetDocs
kotlin.Any autoGetDocs()
Get auto-generated OpenAPI documentation
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : kotlin.Any = apiInstance.autoGetDocs()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#autoGetDocs")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#autoGetDocs")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
autoGetHealth
kotlin.Any autoGetHealth()
Health check
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : kotlin.Any = apiInstance.autoGetHealth()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#autoGetHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#autoGetHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
consoleGetHealth
ConsoleHealthResponse consoleGetHealth()
Check health of API and database
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : ConsoleHealthResponse = apiInstance.consoleGetHealth()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#consoleGetHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#consoleGetHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
flowGetDocs
kotlin.Any flowGetDocs()
Get auto-generated OpenAPI documentation
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : kotlin.Any = apiInstance.flowGetDocs()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#flowGetDocs")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#flowGetDocs")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
flowGetHealth
kotlin.Any flowGetHealth()
Health check
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : kotlin.Any = apiInstance.flowGetHealth()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#flowGetHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#flowGetHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
gatewayLivelinessCheck
kotlin.String gatewayLivelinessCheck()
Liveliness check
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : kotlin.String = apiInstance.gatewayLivelinessCheck()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#gatewayLivelinessCheck")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#gatewayLivelinessCheck")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.String
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
gatewayReadinessCheck
GatewayReadinessCheck200Response gatewayReadinessCheck()
Readiness check
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : GatewayReadinessCheck200Response = apiInstance.gatewayReadinessCheck()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#gatewayReadinessCheck")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#gatewayReadinessCheck")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
GatewayReadinessCheck200Response
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
mqHealthCheck
MqHealthCheck200Response mqHealthCheck()
Health check
Returns service health status. Does not require authentication.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : MqHealthCheck200Response = apiInstance.mqHealthCheck()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#mqHealthCheck")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#mqHealthCheck")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
mqServerInfo
MqServerInfo mqServerInfo()
Server info
Returns server information including version, cluster details, and JetStream status.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : MqServerInfo = apiInstance.mqServerInfo()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#mqServerInfo")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#mqServerInfo")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
notifyNotifyHealth
NotifyHealthResponse notifyNotifyHealth()
Liveness probe
Returns a fixed health body. Mirrors notifyd's `GET /v1/notify/health` verbatim so existing probes keep working unchanged. Unauthenticated.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : NotifyHealthResponse = apiInstance.notifyNotifyHealth()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#notifyNotifyHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#notifyNotifyHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
pricingTriggerSync
PricingTriggerSync200Response pricingTriggerSync()
Trigger manual sync
Manually triggers a pricing data sync from upstream providers. Requires API key authentication.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : PricingTriggerSync200Response = apiInstance.pricingTriggerSync()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#pricingTriggerSync")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#pricingTriggerSync")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
referralsReferralsHealth
referralsReferralsHealth()
Liveness probe
Auto-registered liveness probe (serve.go registers `GET /v1/referrals/health` for every mounted subsystem). Response body is not defined by this package.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
apiInstance.referralsReferralsHealth()
} catch (e: ClientException) {
println("4xx response calling HealthApi#referralsReferralsHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#referralsReferralsHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
streamHealthCheck
StreamHealthCheck200Response streamHealthCheck()
Health check
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = HealthApi()
try {
val result : StreamHealthCheck200Response = apiInstance.streamHealthCheck()
println(result)
} catch (e: ClientException) {
println("4xx response calling HealthApi#streamHealthCheck")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HealthApi#streamHealthCheck")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json