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

13 KiB

FoldersApi

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

Method HTTP request Description
autoCreateFolder POST /v1/auto/folders Create a folder
autoDeleteFolder DELETE /v1/auto/folders/{id} Delete a folder
autoGetFolder GET /v1/auto/folders/{id} Get a folder by id
autoListFolders GET /v1/auto/folders List folders
autoUpdateFolder POST /v1/auto/folders/{id} Update a folder
flowCreateFolder POST /v1/flow/folders Create a folder
flowDeleteFolder DELETE /v1/flow/folders/{id} Delete a folder
flowGetFolder GET /v1/flow/folders/{id} Get a folder by id
flowListFolders GET /v1/flow/folders List folders
flowUpdateFolder POST /v1/flow/folders/{id} Update a folder

autoCreateFolder

kotlin.Any autoCreateFolder(autoCreateApiKeyRequest)

Create a folder

Example

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

val apiInstance = FoldersApi()
val autoCreateApiKeyRequest : AutoCreateApiKeyRequest =  // AutoCreateApiKeyRequest | 
try {
    val result : kotlin.Any = apiInstance.autoCreateFolder(autoCreateApiKeyRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FoldersApi#autoCreateFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FoldersApi#autoCreateFolder")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
autoCreateApiKeyRequest AutoCreateApiKeyRequest

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

autoDeleteFolder

autoDeleteFolder(id)

Delete a folder

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

null (empty response body)

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

autoGetFolder

kotlin.Any autoGetFolder(id)

Get a folder by id

Example

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

val apiInstance = FoldersApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.autoGetFolder(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FoldersApi#autoGetFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FoldersApi#autoGetFolder")
    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

autoListFolders

kotlin.Any autoListFolders()

List folders

Example

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

val apiInstance = FoldersApi()
try {
    val result : kotlin.Any = apiInstance.autoListFolders()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FoldersApi#autoListFolders")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FoldersApi#autoListFolders")
    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

autoUpdateFolder

kotlin.Any autoUpdateFolder(id, autoUpdateAppConnectionRequest)

Update a folder

Example

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

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

Parameters

| id | kotlin.String| | |

Name Type Description Notes
autoUpdateAppConnectionRequest AutoUpdateAppConnectionRequest

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

flowCreateFolder

FlowFolder flowCreateFolder(autoCreateApiKeyRequest)

Create a folder

Example

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

val apiInstance = FoldersApi()
val autoCreateApiKeyRequest : AutoCreateApiKeyRequest =  // AutoCreateApiKeyRequest | 
try {
    val result : FlowFolder = apiInstance.flowCreateFolder(autoCreateApiKeyRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FoldersApi#flowCreateFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FoldersApi#flowCreateFolder")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
autoCreateApiKeyRequest AutoCreateApiKeyRequest

Return type

FlowFolder

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

flowDeleteFolder

flowDeleteFolder(id)

Delete a folder

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

null (empty response body)

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

flowGetFolder

kotlin.Any flowGetFolder(id)

Get a folder by id

Example

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

val apiInstance = FoldersApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.flowGetFolder(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FoldersApi#flowGetFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FoldersApi#flowGetFolder")
    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

flowListFolders

kotlin.collections.List<FlowFolder> flowListFolders()

List folders

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<FlowFolder>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

flowUpdateFolder

kotlin.Any flowUpdateFolder(id, autoUpdateAppConnectionRequest)

Update a folder

Example

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

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

Parameters

| id | kotlin.String| | |

Name Type Description Notes
autoUpdateAppConnectionRequest AutoUpdateAppConnectionRequest

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