Files
sdk/docs/PlatformApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
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]>
2026-07-25 07:10:32 -07:00

7.7 KiB

PlatformApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
autoGetPlatform GET /v1/auto/platforms/{id} Get platform settings
autoUpdatePlatform POST /v1/auto/platforms/{id} Update platform settings
flowGetAnalytics GET /v1/flow/analytics Get platform analytics data
flowGetPlatform GET /v1/flow/platforms/{id} Get platform settings
flowGetQueueMetrics GET /v1/flow/queue-metrics Get worker queue metrics (EE)
flowUpdatePlatform POST /v1/flow/platforms/{id} Update platform settings

autoGetPlatform

kotlin.Any autoGetPlatform(id)

Get platform settings

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PlatformApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.autoGetPlatform(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PlatformApi#autoGetPlatform")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PlatformApi#autoGetPlatform")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

autoUpdatePlatform

kotlin.Any autoUpdatePlatform(id, autoUpdatePlatformRequest)

Update platform settings

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PlatformApi()
val id : kotlin.String = id_example // kotlin.String | 
val autoUpdatePlatformRequest : AutoUpdatePlatformRequest =  // AutoUpdatePlatformRequest | 
try {
    val result : kotlin.Any = apiInstance.autoUpdatePlatform(id, autoUpdatePlatformRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PlatformApi#autoUpdatePlatform")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PlatformApi#autoUpdatePlatform")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
autoUpdatePlatformRequest AutoUpdatePlatformRequest

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

flowGetAnalytics

kotlin.Any flowGetAnalytics()

Get platform analytics data

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PlatformApi()
try {
    val result : kotlin.Any = apiInstance.flowGetAnalytics()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PlatformApi#flowGetAnalytics")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PlatformApi#flowGetAnalytics")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

flowGetPlatform

FlowPlatform flowGetPlatform(id)

Get platform settings

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PlatformApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : FlowPlatform = apiInstance.flowGetPlatform(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PlatformApi#flowGetPlatform")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PlatformApi#flowGetPlatform")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String

Return type

FlowPlatform

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

flowGetQueueMetrics

kotlin.Any flowGetQueueMetrics()

Get worker queue metrics (EE)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PlatformApi()
try {
    val result : kotlin.Any = apiInstance.flowGetQueueMetrics()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PlatformApi#flowGetQueueMetrics")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PlatformApi#flowGetQueueMetrics")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

flowUpdatePlatform

kotlin.Any flowUpdatePlatform(id, flowUpdatePlatformRequest)

Update platform settings

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PlatformApi()
val id : kotlin.String = id_example // kotlin.String | 
val flowUpdatePlatformRequest : FlowUpdatePlatformRequest =  // FlowUpdatePlatformRequest | 
try {
    val result : kotlin.Any = apiInstance.flowUpdatePlatform(id, flowUpdatePlatformRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PlatformApi#flowUpdatePlatform")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PlatformApi#flowUpdatePlatform")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
flowUpdatePlatformRequest FlowUpdatePlatformRequest

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json