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

17 KiB

VectorAPIApi

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

Method HTTP request Description
cloudApiControllerAddVector POST /v1/cloud/add-vector Api Controller Add Vector
cloudApiControllerDeleteAllVectors POST /v1/cloud/delete-all-vectors Api Controller Delete All Vectors
cloudApiControllerDeleteVector POST /v1/cloud/delete-vector Api Controller Delete Vector
cloudApiControllerGetGlobalVectors GET /v1/cloud/get-global-vectors Api Controller Get Global Vectors
cloudApiControllerGetVectors GET /v1/cloud/get-vectors Api Controller Get Vectors
cloudApiControllerUpdateVector POST /v1/cloud/update-vector Api Controller Update Vector
nexusAddVector POST /v1/nexus/add-vector add Vector
nexusDeleteAllVectors POST /v1/nexus/delete-all-vectors delete All Vectors
nexusDeleteVector POST /v1/nexus/delete-vector delete Vector
nexusGetGlobalVectors GET /v1/nexus/get-global-vectors get Global Vectors
nexusGetVectors GET /v1/nexus/get-vectors get Vectors
nexusUpdateVector POST /v1/nexus/update-vector update Vector

cloudApiControllerAddVector

CloudControllersResponse cloudApiControllerAddVector(cloudObjectVector)

Api Controller Add Vector

add vector

Example

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

val apiInstance = VectorAPIApi()
val cloudObjectVector : CloudObjectVector =  // CloudObjectVector | The details of the vector
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerAddVector(cloudObjectVector)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#cloudApiControllerAddVector")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#cloudApiControllerAddVector")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectVector CloudObjectVector The details of the vector

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeleteAllVectors

CloudControllersResponse cloudApiControllerDeleteAllVectors()

Api Controller Delete All Vectors

delete all vectors

Example

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

val apiInstance = VectorAPIApi()
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteAllVectors()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#cloudApiControllerDeleteAllVectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#cloudApiControllerDeleteAllVectors")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeleteVector

CloudControllersResponse cloudApiControllerDeleteVector(cloudObjectVector)

Api Controller Delete Vector

delete vector

Example

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

val apiInstance = VectorAPIApi()
val cloudObjectVector : CloudObjectVector =  // CloudObjectVector | The details of the vector
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteVector(cloudObjectVector)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#cloudApiControllerDeleteVector")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#cloudApiControllerDeleteVector")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectVector CloudObjectVector The details of the vector

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetGlobalVectors

kotlin.collections.List<CloudObjectVector> cloudApiControllerGetGlobalVectors()

Api Controller Get Global Vectors

get global vectors

Example

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

val apiInstance = VectorAPIApi()
try {
    val result : kotlin.collections.List<CloudObjectVector> = apiInstance.cloudApiControllerGetGlobalVectors()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#cloudApiControllerGetGlobalVectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#cloudApiControllerGetGlobalVectors")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectVector>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetVectors

kotlin.collections.List<CloudObjectVector> cloudApiControllerGetVectors()

Api Controller Get Vectors

get vectors

Example

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

val apiInstance = VectorAPIApi()
try {
    val result : kotlin.collections.List<CloudObjectVector> = apiInstance.cloudApiControllerGetVectors()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#cloudApiControllerGetVectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#cloudApiControllerGetVectors")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectVector>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerUpdateVector

CloudControllersResponse cloudApiControllerUpdateVector(id, cloudObjectVector)

Api Controller Update Vector

update vector

Example

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

val apiInstance = VectorAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the vector
val cloudObjectVector : CloudObjectVector =  // CloudObjectVector | The details of the vector
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateVector(id, cloudObjectVector)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#cloudApiControllerUpdateVector")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#cloudApiControllerUpdateVector")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
cloudObjectVector CloudObjectVector The details of the vector

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusAddVector

NexusResponse nexusAddVector(cloudObjectVector)

add Vector

Add a vector embedding

Example

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

val apiInstance = VectorAPIApi()
val cloudObjectVector : CloudObjectVector =  // CloudObjectVector | The details of the vector
try {
    val result : NexusResponse = apiInstance.nexusAddVector(cloudObjectVector)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#nexusAddVector")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#nexusAddVector")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectVector CloudObjectVector The details of the vector

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeleteAllVectors

NexusResponse nexusDeleteAllVectors()

delete All Vectors

Delete all vectors

Example

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

val apiInstance = VectorAPIApi()
try {
    val result : NexusResponse = apiInstance.nexusDeleteAllVectors()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#nexusDeleteAllVectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#nexusDeleteAllVectors")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeleteVector

NexusResponse nexusDeleteVector(cloudObjectVector)

delete Vector

Delete a vector embedding

Example

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

val apiInstance = VectorAPIApi()
val cloudObjectVector : CloudObjectVector =  // CloudObjectVector | The details of the vector
try {
    val result : NexusResponse = apiInstance.nexusDeleteVector(cloudObjectVector)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#nexusDeleteVector")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#nexusDeleteVector")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectVector CloudObjectVector The details of the vector

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetGlobalVectors

kotlin.collections.List<CloudObjectVector> nexusGetGlobalVectors()

get Global Vectors

Get global vectors

Example

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

val apiInstance = VectorAPIApi()
try {
    val result : kotlin.collections.List<CloudObjectVector> = apiInstance.nexusGetGlobalVectors()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#nexusGetGlobalVectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#nexusGetGlobalVectors")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectVector>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetVectors

kotlin.collections.List<CloudObjectVector> nexusGetVectors()

get Vectors

Get vectors

Example

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

val apiInstance = VectorAPIApi()
try {
    val result : kotlin.collections.List<CloudObjectVector> = apiInstance.nexusGetVectors()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#nexusGetVectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#nexusGetVectors")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectVector>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusUpdateVector

NexusResponse nexusUpdateVector(id, cloudObjectVector)

update Vector

Update a vector embedding

Example

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

val apiInstance = VectorAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the vector
val cloudObjectVector : CloudObjectVector =  // CloudObjectVector | The details of the vector
try {
    val result : NexusResponse = apiInstance.nexusUpdateVector(id, cloudObjectVector)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling VectorAPIApi#nexusUpdateVector")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling VectorAPIApi#nexusUpdateVector")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
cloudObjectVector CloudObjectVector The details of the vector

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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