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

18 KiB

WorkflowAPIApi

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

Method HTTP request Description
cloudApiControllerAddWorkflow POST /v1/cloud/add-workflow Api Controller Add Workflow
cloudApiControllerDeleteWorkflow POST /v1/cloud/delete-workflow Api Controller Delete Workflow
cloudApiControllerGetGlobalWorkflows GET /v1/cloud/get-global-workflows Api Controller Get Global Workflows
cloudApiControllerGetWorkflow GET /v1/cloud/get-workflow Api Controller Get Workflow
cloudApiControllerGetWorkflows GET /v1/cloud/get-workflows Api Controller Get Workflows
cloudApiControllerUpdateWorkflow POST /v1/cloud/update-workflow Api Controller Update Workflow
nexusAddWorkflow POST /v1/nexus/add-workflow add Workflow
nexusDeleteWorkflow POST /v1/nexus/delete-workflow delete Workflow
nexusGetGlobalWorkflows GET /v1/nexus/get-global-workflows get Global Workflows
nexusGetWorkflow GET /v1/nexus/get-workflow get Workflow
nexusGetWorkflows GET /v1/nexus/get-workflows get Workflows
nexusUpdateWorkflow POST /v1/nexus/update-workflow update Workflow

cloudApiControllerAddWorkflow

CloudControllersResponse cloudApiControllerAddWorkflow(cloudObjectWorkflow)

Api Controller Add Workflow

add workflow

Example

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

val apiInstance = WorkflowAPIApi()
val cloudObjectWorkflow : CloudObjectWorkflow =  // CloudObjectWorkflow | The details of the workflow
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerAddWorkflow(cloudObjectWorkflow)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WorkflowAPIApi#cloudApiControllerAddWorkflow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WorkflowAPIApi#cloudApiControllerAddWorkflow")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectWorkflow CloudObjectWorkflow The details of the workflow

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeleteWorkflow

CloudControllersResponse cloudApiControllerDeleteWorkflow(cloudObjectWorkflow)

Api Controller Delete Workflow

delete workflow

Example

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

val apiInstance = WorkflowAPIApi()
val cloudObjectWorkflow : CloudObjectWorkflow =  // CloudObjectWorkflow | The details of the workflow
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteWorkflow(cloudObjectWorkflow)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WorkflowAPIApi#cloudApiControllerDeleteWorkflow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WorkflowAPIApi#cloudApiControllerDeleteWorkflow")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectWorkflow CloudObjectWorkflow The details of the workflow

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetGlobalWorkflows

kotlin.collections.List<CloudObjectWorkflow> cloudApiControllerGetGlobalWorkflows()

Api Controller Get Global Workflows

get global workflows

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectWorkflow>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetWorkflow

CloudObjectWorkflow cloudApiControllerGetWorkflow(id)

Api Controller Get Workflow

get workflow

Example

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

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

Parameters

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

Return type

CloudObjectWorkflow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetWorkflows

kotlin.collections.List<CloudObjectWorkflow> cloudApiControllerGetWorkflows(owner)

Api Controller Get Workflows

get workflows

Example

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

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

Parameters

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

Return type

kotlin.collections.List<CloudObjectWorkflow>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerUpdateWorkflow

CloudControllersResponse cloudApiControllerUpdateWorkflow(id, cloudObjectWorkflow)

Api Controller Update Workflow

update workflow

Example

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

val apiInstance = WorkflowAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the workflow
val cloudObjectWorkflow : CloudObjectWorkflow =  // CloudObjectWorkflow | The details of the workflow
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateWorkflow(id, cloudObjectWorkflow)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WorkflowAPIApi#cloudApiControllerUpdateWorkflow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WorkflowAPIApi#cloudApiControllerUpdateWorkflow")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
cloudObjectWorkflow CloudObjectWorkflow The details of the workflow

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusAddWorkflow

NexusResponse nexusAddWorkflow(cloudObjectWorkflow)

add Workflow

Add a workflow

Example

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

val apiInstance = WorkflowAPIApi()
val cloudObjectWorkflow : CloudObjectWorkflow =  // CloudObjectWorkflow | The details of the workflow
try {
    val result : NexusResponse = apiInstance.nexusAddWorkflow(cloudObjectWorkflow)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WorkflowAPIApi#nexusAddWorkflow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WorkflowAPIApi#nexusAddWorkflow")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectWorkflow CloudObjectWorkflow The details of the workflow

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeleteWorkflow

NexusResponse nexusDeleteWorkflow(cloudObjectWorkflow)

delete Workflow

Delete a workflow

Example

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

val apiInstance = WorkflowAPIApi()
val cloudObjectWorkflow : CloudObjectWorkflow =  // CloudObjectWorkflow | The details of the workflow
try {
    val result : NexusResponse = apiInstance.nexusDeleteWorkflow(cloudObjectWorkflow)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WorkflowAPIApi#nexusDeleteWorkflow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WorkflowAPIApi#nexusDeleteWorkflow")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectWorkflow CloudObjectWorkflow The details of the workflow

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetGlobalWorkflows

kotlin.collections.List<CloudObjectWorkflow> nexusGetGlobalWorkflows()

get Global Workflows

Get global workflows

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectWorkflow>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetWorkflow

CloudObjectWorkflow nexusGetWorkflow(id)

get Workflow

Get a workflow

Example

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

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

Parameters

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

Return type

CloudObjectWorkflow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetWorkflows

kotlin.collections.List<CloudObjectWorkflow> nexusGetWorkflows(owner)

get Workflows

Get workflows

Example

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

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

Parameters

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

Return type

kotlin.collections.List<CloudObjectWorkflow>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusUpdateWorkflow

NexusResponse nexusUpdateWorkflow(id, cloudObjectWorkflow)

update Workflow

Update a workflow

Example

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

val apiInstance = WorkflowAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the workflow
val cloudObjectWorkflow : CloudObjectWorkflow =  // CloudObjectWorkflow | The details of the workflow
try {
    val result : NexusResponse = apiInstance.nexusUpdateWorkflow(id, cloudObjectWorkflow)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling WorkflowAPIApi#nexusUpdateWorkflow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling WorkflowAPIApi#nexusUpdateWorkflow")
    e.printStackTrace()
}

Parameters

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

Name Type Description Notes
cloudObjectWorkflow CloudObjectWorkflow The details of the workflow

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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