Files
sdk/docs/PodAPIApi.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

14 KiB

PodAPIApi

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

Method HTTP request Description
cloudApiControllerAddPod POST /v1/cloud/add-pod Api Controller Add Pod
cloudApiControllerDeletePod POST /v1/cloud/delete-pod Api Controller Delete Pod
cloudApiControllerGetPod GET /v1/cloud/get-pod Api Controller Get Pod
cloudApiControllerGetPods GET /v1/cloud/get-pods Api Controller Get Pods
cloudApiControllerUpdatePod POST /v1/cloud/update-pod Api Controller Update Pod
nexusAddPod POST /v1/nexus/add-pod add Pod
nexusDeletePod POST /v1/nexus/delete-pod delete Pod
nexusGetPod GET /v1/nexus/get-pod get Pod
nexusGetPods GET /v1/nexus/get-pods get Pods
nexusUpdatePod POST /v1/nexus/update-pod update Pod

cloudApiControllerAddPod

CloudControllersResponse cloudApiControllerAddPod(cloudObjectPod)

Api Controller Add Pod

add a pod

Example

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

val apiInstance = PodAPIApi()
val cloudObjectPod : CloudObjectPod =  // CloudObjectPod | The details of the pod
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerAddPod(cloudObjectPod)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#cloudApiControllerAddPod")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#cloudApiControllerAddPod")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectPod CloudObjectPod The details of the pod

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeletePod

CloudControllersResponse cloudApiControllerDeletePod(cloudObjectPod)

Api Controller Delete Pod

delete a pod

Example

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

val apiInstance = PodAPIApi()
val cloudObjectPod : CloudObjectPod =  // CloudObjectPod | The details of the pod
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeletePod(cloudObjectPod)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#cloudApiControllerDeletePod")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#cloudApiControllerDeletePod")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectPod CloudObjectPod The details of the pod

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetPod

CloudObjectPod cloudApiControllerGetPod(id)

Api Controller Get Pod

get pod

Example

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

val apiInstance = PodAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the pod
try {
    val result : CloudObjectPod = apiInstance.cloudApiControllerGetPod(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#cloudApiControllerGetPod")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#cloudApiControllerGetPod")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The id ( owner/name ) of the pod

Return type

CloudObjectPod

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetPods

CloudObjectPod cloudApiControllerGetPods(pageSize, p)

Api Controller Get Pods

get all pods

Example

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

val apiInstance = PodAPIApi()
val pageSize : kotlin.String = pageSize_example // kotlin.String | The size of each page
val p : kotlin.String = p_example // kotlin.String | The number of the page
try {
    val result : CloudObjectPod = apiInstance.cloudApiControllerGetPods(pageSize, p)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#cloudApiControllerGetPods")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#cloudApiControllerGetPods")
    e.printStackTrace()
}

Parameters

| pageSize | kotlin.String| The size of each page | |

Name Type Description Notes
p kotlin.String The number of the page

Return type

CloudObjectPod

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerUpdatePod

CloudControllersResponse cloudApiControllerUpdatePod(id, cloudObjectPod)

Api Controller Update Pod

update pod

Example

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

val apiInstance = PodAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the pod
val cloudObjectPod : CloudObjectPod =  // CloudObjectPod | The details of the pod
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdatePod(id, cloudObjectPod)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#cloudApiControllerUpdatePod")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#cloudApiControllerUpdatePod")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| The id ( owner/name ) of the pod | |

Name Type Description Notes
cloudObjectPod CloudObjectPod The details of the pod

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusAddPod

NexusResponse nexusAddPod(cloudObjectPod)

add Pod

Add a pod

Example

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

val apiInstance = PodAPIApi()
val cloudObjectPod : CloudObjectPod =  // CloudObjectPod | The details of the pod
try {
    val result : NexusResponse = apiInstance.nexusAddPod(cloudObjectPod)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#nexusAddPod")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#nexusAddPod")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectPod CloudObjectPod The details of the pod

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeletePod

NexusResponse nexusDeletePod(cloudObjectPod)

delete Pod

Delete a pod

Example

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

val apiInstance = PodAPIApi()
val cloudObjectPod : CloudObjectPod =  // CloudObjectPod | The details of the pod
try {
    val result : NexusResponse = apiInstance.nexusDeletePod(cloudObjectPod)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#nexusDeletePod")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#nexusDeletePod")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectPod CloudObjectPod The details of the pod

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetPod

CloudObjectPod nexusGetPod(id)

get Pod

Get a pod

Example

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

val apiInstance = PodAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the pod
try {
    val result : CloudObjectPod = apiInstance.nexusGetPod(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#nexusGetPod")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#nexusGetPod")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The id (owner/name) of the pod

Return type

CloudObjectPod

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetPods

CloudObjectPod nexusGetPods(pageSize, p)

get Pods

Get all pods

Example

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

val apiInstance = PodAPIApi()
val pageSize : kotlin.String = pageSize_example // kotlin.String | The size of each page
val p : kotlin.String = p_example // kotlin.String | The page number
try {
    val result : CloudObjectPod = apiInstance.nexusGetPods(pageSize, p)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#nexusGetPods")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#nexusGetPods")
    e.printStackTrace()
}

Parameters

| pageSize | kotlin.String| The size of each page | |

Name Type Description Notes
p kotlin.String The page number

Return type

CloudObjectPod

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusUpdatePod

NexusResponse nexusUpdatePod(id, cloudObjectPod)

update Pod

Update a pod

Example

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

val apiInstance = PodAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the pod
val cloudObjectPod : CloudObjectPod =  // CloudObjectPod | The details of the pod
try {
    val result : NexusResponse = apiInstance.nexusUpdatePod(id, cloudObjectPod)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PodAPIApi#nexusUpdatePod")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PodAPIApi#nexusUpdatePod")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| The id (owner/name) of the pod | |

Name Type Description Notes
cloudObjectPod CloudObjectPod The details of the pod

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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