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

15 KiB

ImageAPIApi

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

Method HTTP request Description
cloudApiControllerAddImage POST /v1/cloud/add-image Api Controller Add Image
cloudApiControllerDeleteImage POST /v1/cloud/delete-image Api Controller Delete Image
cloudApiControllerGetImage GET /v1/cloud/get-image Api Controller Get Image
cloudApiControllerGetImages GET /v1/cloud/get-images Api Controller Get Images
cloudApiControllerUpdateImage POST /v1/cloud/update-image Api Controller Update Image
nexusAddImage POST /v1/nexus/add-image add Image
nexusDeleteImage POST /v1/nexus/delete-image delete Image
nexusGetImage GET /v1/nexus/get-image get Image
nexusGetImages GET /v1/nexus/get-images get Images
nexusUpdateImage POST /v1/nexus/update-image update Image

cloudApiControllerAddImage

CloudControllersResponse cloudApiControllerAddImage(cloudObjectImage)

Api Controller Add Image

add a image

Example

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

val apiInstance = ImageAPIApi()
val cloudObjectImage : CloudObjectImage =  // CloudObjectImage | The details of the image
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerAddImage(cloudObjectImage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ImageAPIApi#cloudApiControllerAddImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ImageAPIApi#cloudApiControllerAddImage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectImage CloudObjectImage The details of the image

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeleteImage

CloudControllersResponse cloudApiControllerDeleteImage(cloudObjectImage)

Api Controller Delete Image

delete a image

Example

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

val apiInstance = ImageAPIApi()
val cloudObjectImage : CloudObjectImage =  // CloudObjectImage | The details of the image
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteImage(cloudObjectImage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ImageAPIApi#cloudApiControllerDeleteImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ImageAPIApi#cloudApiControllerDeleteImage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectImage CloudObjectImage The details of the image

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetImage

CloudObjectImage cloudApiControllerGetImage(id)

Api Controller Get Image

get image

Example

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

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

Parameters

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

Return type

CloudObjectImage

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetImages

CloudObjectImage cloudApiControllerGetImages(pageSize, p)

Api Controller Get Images

get all images

Example

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

val apiInstance = ImageAPIApi()
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 : CloudObjectImage = apiInstance.cloudApiControllerGetImages(pageSize, p)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ImageAPIApi#cloudApiControllerGetImages")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ImageAPIApi#cloudApiControllerGetImages")
    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

CloudObjectImage

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerUpdateImage

CloudControllersResponse cloudApiControllerUpdateImage(id, cloudObjectImage)

Api Controller Update Image

update image

Example

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

val apiInstance = ImageAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the image
val cloudObjectImage : CloudObjectImage =  // CloudObjectImage | The details of the image
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateImage(id, cloudObjectImage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ImageAPIApi#cloudApiControllerUpdateImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ImageAPIApi#cloudApiControllerUpdateImage")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
cloudObjectImage CloudObjectImage The details of the image

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusAddImage

NexusResponse nexusAddImage(cloudObjectImage)

add Image

Add an image

Example

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

val apiInstance = ImageAPIApi()
val cloudObjectImage : CloudObjectImage =  // CloudObjectImage | The details of the image
try {
    val result : NexusResponse = apiInstance.nexusAddImage(cloudObjectImage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ImageAPIApi#nexusAddImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ImageAPIApi#nexusAddImage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectImage CloudObjectImage The details of the image

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeleteImage

NexusResponse nexusDeleteImage(cloudObjectImage)

delete Image

Delete an image

Example

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

val apiInstance = ImageAPIApi()
val cloudObjectImage : CloudObjectImage =  // CloudObjectImage | The details of the image
try {
    val result : NexusResponse = apiInstance.nexusDeleteImage(cloudObjectImage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ImageAPIApi#nexusDeleteImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ImageAPIApi#nexusDeleteImage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectImage CloudObjectImage The details of the image

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetImage

CloudObjectImage nexusGetImage(id)

get Image

Get an image

Example

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

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

Parameters

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

Return type

CloudObjectImage

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetImages

CloudObjectImage nexusGetImages(pageSize, p)

get Images

Get all images

Example

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

val apiInstance = ImageAPIApi()
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 : CloudObjectImage = apiInstance.nexusGetImages(pageSize, p)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ImageAPIApi#nexusGetImages")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ImageAPIApi#nexusGetImages")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
p kotlin.String The page number

Return type

CloudObjectImage

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusUpdateImage

NexusResponse nexusUpdateImage(id, cloudObjectImage)

update Image

Update an image

Example

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

val apiInstance = ImageAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the image
val cloudObjectImage : CloudObjectImage =  // CloudObjectImage | The details of the image
try {
    val result : NexusResponse = apiInstance.nexusUpdateImage(id, cloudObjectImage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ImageAPIApi#nexusUpdateImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ImageAPIApi#nexusUpdateImage")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
cloudObjectImage CloudObjectImage The details of the image

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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