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

20 KiB

StoreAPIApi

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

Method HTTP request Description
cloudApiControllerAddStore POST /v1/cloud/add-store Api Controller Add Store
cloudApiControllerDeleteStore POST /v1/cloud/delete-store Api Controller Delete Store
cloudApiControllerGetGlobalStores GET /v1/cloud/get-global-stores Api Controller Get Global Stores
cloudApiControllerGetStore GET /v1/cloud/get-store Api Controller Get Store
cloudApiControllerGetStores GET /v1/cloud/get-stores Api Controller Get Stores
cloudApiControllerRefreshStoreVectors POST /v1/cloud/refresh-store-vectors Api Controller Refresh Store Vectors
cloudApiControllerUpdateStore POST /v1/cloud/update-store Api Controller Update Store
nexusAddStore POST /v1/nexus/add-store add Store
nexusDeleteStore POST /v1/nexus/delete-store delete Store
nexusGetGlobalStores GET /v1/nexus/get-global-stores get Global Stores
nexusGetStore GET /v1/nexus/get-store get Store
nexusGetStores GET /v1/nexus/get-stores get Stores
nexusRefreshStoreVectors POST /v1/nexus/refresh-store-vectors refresh Store Vectors
nexusUpdateStore POST /v1/nexus/update-store update Store

cloudApiControllerAddStore

CloudControllersResponse cloudApiControllerAddStore(cloudObjectStore)

Api Controller Add Store

add store

Example

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

val apiInstance = StoreAPIApi()
val cloudObjectStore : CloudObjectStore =  // CloudObjectStore | The details of the store
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerAddStore(cloudObjectStore)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#cloudApiControllerAddStore")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#cloudApiControllerAddStore")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectStore CloudObjectStore The details of the store

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeleteStore

CloudControllersResponse cloudApiControllerDeleteStore(cloudObjectStore)

Api Controller Delete Store

delete store

Example

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

val apiInstance = StoreAPIApi()
val cloudObjectStore : CloudObjectStore =  // CloudObjectStore | The details of the store
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteStore(cloudObjectStore)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#cloudApiControllerDeleteStore")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#cloudApiControllerDeleteStore")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectStore CloudObjectStore The details of the store

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetGlobalStores

kotlin.collections.List<CloudObjectStore> cloudApiControllerGetGlobalStores()

Api Controller Get Global Stores

get global stores

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectStore>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetStore

CloudObjectStore cloudApiControllerGetStore(id)

Api Controller Get Store

get store

Example

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

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

Parameters

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

Return type

CloudObjectStore

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetStores

kotlin.collections.List<CloudObjectStore> cloudApiControllerGetStores(owner)

Api Controller Get Stores

get stores

Example

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

val apiInstance = StoreAPIApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of the store
try {
    val result : kotlin.collections.List<CloudObjectStore> = apiInstance.cloudApiControllerGetStores(owner)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#cloudApiControllerGetStores")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#cloudApiControllerGetStores")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
owner kotlin.String The owner of the store

Return type

kotlin.collections.List<CloudObjectStore>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerRefreshStoreVectors

CloudControllersResponse cloudApiControllerRefreshStoreVectors(cloudObjectStore)

Api Controller Refresh Store Vectors

refresh store vectors

Example

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

val apiInstance = StoreAPIApi()
val cloudObjectStore : CloudObjectStore =  // CloudObjectStore | The details of the store
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerRefreshStoreVectors(cloudObjectStore)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#cloudApiControllerRefreshStoreVectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#cloudApiControllerRefreshStoreVectors")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectStore CloudObjectStore The details of the store

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerUpdateStore

CloudControllersResponse cloudApiControllerUpdateStore(id, cloudObjectStore)

Api Controller Update Store

update store

Example

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

val apiInstance = StoreAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the store
val cloudObjectStore : CloudObjectStore =  // CloudObjectStore | The details of the store
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateStore(id, cloudObjectStore)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#cloudApiControllerUpdateStore")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#cloudApiControllerUpdateStore")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
cloudObjectStore CloudObjectStore The details of the store

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusAddStore

NexusResponse nexusAddStore(nexusStore)

add Store

Add a knowledge store

Example

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

val apiInstance = StoreAPIApi()
val nexusStore : NexusStore =  // NexusStore | The details of the store
try {
    val result : NexusResponse = apiInstance.nexusAddStore(nexusStore)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#nexusAddStore")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#nexusAddStore")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
nexusStore NexusStore The details of the store

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeleteStore

NexusResponse nexusDeleteStore(nexusStore)

delete Store

Delete a knowledge store

Example

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

val apiInstance = StoreAPIApi()
val nexusStore : NexusStore =  // NexusStore | The details of the store
try {
    val result : NexusResponse = apiInstance.nexusDeleteStore(nexusStore)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#nexusDeleteStore")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#nexusDeleteStore")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
nexusStore NexusStore The details of the store

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetGlobalStores

kotlin.collections.List<NexusStore> nexusGetGlobalStores()

get Global Stores

Get global knowledge stores

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<NexusStore>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetStore

NexusStore nexusGetStore(id)

get Store

Get a knowledge store

Example

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

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

Parameters

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

Return type

NexusStore

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetStores

kotlin.collections.List<NexusStore> nexusGetStores(owner)

get Stores

Get knowledge stores

Example

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

val apiInstance = StoreAPIApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of the stores
try {
    val result : kotlin.collections.List<NexusStore> = apiInstance.nexusGetStores(owner)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#nexusGetStores")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#nexusGetStores")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
owner kotlin.String The owner of the stores

Return type

kotlin.collections.List<NexusStore>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusRefreshStoreVectors

NexusResponse nexusRefreshStoreVectors(nexusStore)

refresh Store Vectors

Refresh store vectors

Example

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

val apiInstance = StoreAPIApi()
val nexusStore : NexusStore =  // NexusStore | The details of the store
try {
    val result : NexusResponse = apiInstance.nexusRefreshStoreVectors(nexusStore)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#nexusRefreshStoreVectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#nexusRefreshStoreVectors")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
nexusStore NexusStore The details of the store

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusUpdateStore

NexusResponse nexusUpdateStore(id, nexusStore)

update Store

Update a knowledge store

Example

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

val apiInstance = StoreAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the store
val nexusStore : NexusStore =  // NexusStore | The details of the store
try {
    val result : NexusResponse = apiInstance.nexusUpdateStore(id, nexusStore)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling StoreAPIApi#nexusUpdateStore")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling StoreAPIApi#nexusUpdateStore")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
nexusStore NexusStore The details of the store

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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