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

FormAPIApi

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

Method HTTP request Description
cloudApiControllerAddForm POST /v1/cloud/add-form Api Controller Add Form
cloudApiControllerDeleteForm POST /v1/cloud/delete-form Api Controller Delete Form
cloudApiControllerGetForm GET /v1/cloud/get-form Api Controller Get Form
cloudApiControllerGetFormData GET /v1/cloud/get-form-data Api Controller Get Form Data
cloudApiControllerGetForms GET /v1/cloud/get-forms Api Controller Get Forms
cloudApiControllerGetGlobalForms GET /v1/cloud/get-global-forms Api Controller Get Global Forms
cloudApiControllerUpdateForm POST /v1/cloud/update-form Api Controller Update Form
nexusAddForm POST /v1/nexus/add-form add Form
nexusDeleteForm POST /v1/nexus/delete-form delete Form
nexusGetForm GET /v1/nexus/get-form get Form
nexusGetFormData GET /v1/nexus/get-form-data get Form Data
nexusGetForms GET /v1/nexus/get-forms get Forms
nexusGetGlobalForms GET /v1/nexus/get-global-forms get Global Forms
nexusUpdateForm POST /v1/nexus/update-form update Form

cloudApiControllerAddForm

CloudControllersResponse cloudApiControllerAddForm(cloudObjectForm)

Api Controller Add Form

add form

Example

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

val apiInstance = FormAPIApi()
val cloudObjectForm : CloudObjectForm =  // CloudObjectForm | The details of the form
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerAddForm(cloudObjectForm)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormAPIApi#cloudApiControllerAddForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormAPIApi#cloudApiControllerAddForm")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectForm CloudObjectForm The details of the form

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeleteForm

CloudControllersResponse cloudApiControllerDeleteForm(cloudObjectForm)

Api Controller Delete Form

delete form

Example

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

val apiInstance = FormAPIApi()
val cloudObjectForm : CloudObjectForm =  // CloudObjectForm | The details of the form
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteForm(cloudObjectForm)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormAPIApi#cloudApiControllerDeleteForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormAPIApi#cloudApiControllerDeleteForm")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectForm CloudObjectForm The details of the form

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetForm

CloudObjectForm cloudApiControllerGetForm(id)

Api Controller Get Form

get form

Example

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

val apiInstance = FormAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of form
try {
    val result : CloudObjectForm = apiInstance.cloudApiControllerGetForm(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormAPIApi#cloudApiControllerGetForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormAPIApi#cloudApiControllerGetForm")
    e.printStackTrace()
}

Parameters

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

Return type

CloudObjectForm

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetFormData

kotlin.collections.List<CloudObjectForm> cloudApiControllerGetFormData(owner)

Api Controller Get Form Data

get forms

Example

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

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

Parameters

Name Type Description Notes
owner kotlin.String The owner of form

Return type

kotlin.collections.List<CloudObjectForm>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetForms

kotlin.collections.List<CloudObjectForm> cloudApiControllerGetForms(owner)

Api Controller Get Forms

get forms

Example

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

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

Parameters

Name Type Description Notes
owner kotlin.String The owner of form

Return type

kotlin.collections.List<CloudObjectForm>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetGlobalForms

kotlin.collections.List<CloudObjectForm> cloudApiControllerGetGlobalForms()

Api Controller Get Global Forms

get global forms

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectForm>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerUpdateForm

CloudControllersResponse cloudApiControllerUpdateForm(id, cloudObjectForm)

Api Controller Update Form

update form

Example

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

val apiInstance = FormAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the form
val cloudObjectForm : CloudObjectForm =  // CloudObjectForm | The details of the form
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateForm(id, cloudObjectForm)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormAPIApi#cloudApiControllerUpdateForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormAPIApi#cloudApiControllerUpdateForm")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
cloudObjectForm CloudObjectForm The details of the form

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusAddForm

NexusResponse nexusAddForm(nexusForm)

add Form

Add a form

Example

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

val apiInstance = FormAPIApi()
val nexusForm : NexusForm =  // NexusForm | The details of the form
try {
    val result : NexusResponse = apiInstance.nexusAddForm(nexusForm)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormAPIApi#nexusAddForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormAPIApi#nexusAddForm")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
nexusForm NexusForm The details of the form

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeleteForm

NexusResponse nexusDeleteForm(nexusForm)

delete Form

Delete a form

Example

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

val apiInstance = FormAPIApi()
val nexusForm : NexusForm =  // NexusForm | The details of the form
try {
    val result : NexusResponse = apiInstance.nexusDeleteForm(nexusForm)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormAPIApi#nexusDeleteForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormAPIApi#nexusDeleteForm")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
nexusForm NexusForm The details of the form

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetForm

NexusForm nexusGetForm(id)

get Form

Get a form

Example

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

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

Parameters

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

Return type

NexusForm

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetFormData

kotlin.collections.List<NexusForm> nexusGetFormData(owner)

get Form Data

Get form data

Example

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

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

Parameters

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

Return type

kotlin.collections.List<NexusForm>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetForms

kotlin.collections.List<NexusForm> nexusGetForms(owner)

get Forms

Get forms

Example

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

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

Parameters

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

Return type

kotlin.collections.List<NexusForm>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetGlobalForms

kotlin.collections.List<NexusForm> nexusGetGlobalForms()

get Global Forms

Get global forms

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<NexusForm>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusUpdateForm

NexusResponse nexusUpdateForm(id, nexusForm)

update Form

Update a form

Example

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

val apiInstance = FormAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the form
val nexusForm : NexusForm =  // NexusForm | The details of the form
try {
    val result : NexusResponse = apiInstance.nexusUpdateForm(id, nexusForm)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormAPIApi#nexusUpdateForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormAPIApi#nexusUpdateForm")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
nexusForm NexusForm The details of the form

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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