Files
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

36 KiB

FlowsApi

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

Method HTTP request Description
autoCountFlows GET /v1/auto/flows/count Count flows
autoCreateFlow POST /v1/auto/flows Create a flow
autoDeleteFlow DELETE /v1/auto/flows/{id} Delete a flow
autoGetFlow GET /v1/auto/flows/{id} Get a flow by id
autoGetFlowTemplate GET /v1/auto/flows/{id}/template Export flow as template
autoListFlows GET /v1/auto/flows List flows
autoUpdateFlow POST /v1/auto/flows/{id} Apply an operation to a flow
automationsApplyOperation POST /v1/automations/flows/{id}/operations Apply a flow operation to the latest version
automationsCreateFlow POST /v1/automations/flows Create a flow (with an initial draft version)
automationsCreateVersion POST /v1/automations/flows/{id}/versions Create a draft version
automationsDeleteFlow DELETE /v1/automations/flows/{id} Delete a flow (with its versions and runs)
automationsDisableFlow POST /v1/automations/flows/{id}/disable Disable a flow (removes any POLLING schedule)
automationsEnableFlow POST /v1/automations/flows/{id}/enable Enable a flow (POLLING triggers create a schedule)
automationsGetFlow GET /v1/automations/flows/{id} Get a flow and its latest version
automationsListFlows GET /v1/automations/flows List flows
automationsListVersions GET /v1/automations/flows/{id}/versions List a flow's versions
automationsUpdateFlow PATCH /v1/automations/flows/{id} Update flow metadata
flowCountFlows GET /v1/flow/flows/count Count flows
flowCreateFlow POST /v1/flow/flows Create a flow
flowDeleteFlow DELETE /v1/flow/flows/{id} Delete a flow
flowGetFlow GET /v1/flow/flows/{id} Get a flow by id
flowGetFlowTemplate GET /v1/flow/flows/{id}/template Export flow as template
flowGetHumanInputForm GET /v1/flow/human-input/form/{flowId} Get human input form definition for a flow
flowGetStepFile GET /v1/flow/step-files Get a file produced by a flow step
flowListFlows GET /v1/flow/flows List flows
flowUpdateFlow POST /v1/flow/flows/{id} Apply an operation to a flow

autoCountFlows

kotlin.Any autoCountFlows(folderId)

Count flows

Example

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

val apiInstance = FlowsApi()
val folderId : kotlin.String = folderId_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.autoCountFlows(folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#autoCountFlows")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#autoCountFlows")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
folderId kotlin.String [optional]

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

autoCreateFlow

AutoFlow autoCreateFlow(autoCreateFlowRequest)

Create a flow

Example

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

val apiInstance = FlowsApi()
val autoCreateFlowRequest : AutoCreateFlowRequest =  // AutoCreateFlowRequest | 
try {
    val result : AutoFlow = apiInstance.autoCreateFlow(autoCreateFlowRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#autoCreateFlow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#autoCreateFlow")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
autoCreateFlowRequest AutoCreateFlowRequest

Return type

AutoFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

autoDeleteFlow

autoDeleteFlow(id)

Delete a flow

Example

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

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

autoGetFlow

AutoFlow autoGetFlow(id, versionId)

Get a flow by id

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
val versionId : kotlin.String = versionId_example // kotlin.String | 
try {
    val result : AutoFlow = apiInstance.autoGetFlow(id, versionId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#autoGetFlow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#autoGetFlow")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
versionId kotlin.String [optional]

Return type

AutoFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

autoGetFlowTemplate

kotlin.Any autoGetFlowTemplate(id)

Export flow as template

Example

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

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

autoListFlows

AutoListFlows200Response autoListFlows(folderId, status, name, cursor, limit)

List flows

Example

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

val apiInstance = FlowsApi()
val folderId : kotlin.String = folderId_example // kotlin.String | 
val status : kotlin.String = status_example // kotlin.String | 
val name : kotlin.String = name_example // kotlin.String | 
val cursor : kotlin.String = cursor_example // kotlin.String | 
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : AutoListFlows200Response = apiInstance.autoListFlows(folderId, status, name, cursor, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#autoListFlows")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#autoListFlows")
    e.printStackTrace()
}

Parameters

| folderId | kotlin.String| | [optional] | | status | kotlin.String| | [optional] [enum: ENABLED, DISABLED] | | name | kotlin.String| | [optional] | | cursor | kotlin.String| | [optional] |

Name Type Description Notes
limit kotlin.Int [optional] [default to 10]

Return type

AutoListFlows200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

autoUpdateFlow

AutoFlow autoUpdateFlow(id, autoUpdateFlowRequest)

Apply an operation to a flow

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
val autoUpdateFlowRequest : AutoUpdateFlowRequest =  // AutoUpdateFlowRequest | 
try {
    val result : AutoFlow = apiInstance.autoUpdateFlow(id, autoUpdateFlowRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#autoUpdateFlow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#autoUpdateFlow")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
autoUpdateFlowRequest AutoUpdateFlowRequest

Return type

AutoFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsApplyOperation

AutomationsFlowVersion automationsApplyOperation(id, automationsFlowOperation)

Apply a flow operation to the latest version

A CHANGE_STATUS op enables/disables the flow (returns the Flow); every other op mutates the latest version's step tree (returns the FlowVersion).

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
val automationsFlowOperation : AutomationsFlowOperation =  // AutomationsFlowOperation | 
try {
    val result : AutomationsFlowVersion = apiInstance.automationsApplyOperation(id, automationsFlowOperation)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#automationsApplyOperation")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#automationsApplyOperation")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
automationsFlowOperation AutomationsFlowOperation

Return type

AutomationsFlowVersion

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsCreateFlow

AutomationsPopulatedFlow automationsCreateFlow(automationsCreateFlowRequest)

Create a flow (with an initial draft version)

Example

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

val apiInstance = FlowsApi()
val automationsCreateFlowRequest : AutomationsCreateFlowRequest =  // AutomationsCreateFlowRequest | 
try {
    val result : AutomationsPopulatedFlow = apiInstance.automationsCreateFlow(automationsCreateFlowRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#automationsCreateFlow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#automationsCreateFlow")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
automationsCreateFlowRequest AutomationsCreateFlowRequest

Return type

AutomationsPopulatedFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsCreateVersion

AutomationsFlowVersion automationsCreateVersion(id, automationsCreateVersionRequest)

Create a draft version

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
val automationsCreateVersionRequest : AutomationsCreateVersionRequest =  // AutomationsCreateVersionRequest | 
try {
    val result : AutomationsFlowVersion = apiInstance.automationsCreateVersion(id, automationsCreateVersionRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#automationsCreateVersion")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#automationsCreateVersion")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
automationsCreateVersionRequest AutomationsCreateVersionRequest

Return type

AutomationsFlowVersion

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsDeleteFlow

automationsDeleteFlow(id)

Delete a flow (with its versions and runs)

Example

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

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

automationsDisableFlow

AutomationsFlow automationsDisableFlow(id)

Disable a flow (removes any POLLING schedule)

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

AutomationsFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsEnableFlow

AutomationsFlow automationsEnableFlow(id)

Enable a flow (POLLING triggers create a schedule)

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

AutomationsFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsGetFlow

AutomationsPopulatedFlow automationsGetFlow(id)

Get a flow and its latest version

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

AutomationsPopulatedFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsListFlows

AutomationsListFlows200Response automationsListFlows(limit)

List flows

Example

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

val apiInstance = FlowsApi()
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : AutomationsListFlows200Response = apiInstance.automationsListFlows(limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#automationsListFlows")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#automationsListFlows")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
limit kotlin.Int [optional] [default to 200]

Return type

AutomationsListFlows200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsListVersions

AutomationsListVersions200Response automationsListVersions(id, limit)

List a flow's versions

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : AutomationsListVersions200Response = apiInstance.automationsListVersions(id, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#automationsListVersions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#automationsListVersions")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
limit kotlin.Int [optional] [default to 200]

Return type

AutomationsListVersions200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

automationsUpdateFlow

AutomationsFlow automationsUpdateFlow(id, automationsPatchFlowRequest)

Update flow metadata

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
val automationsPatchFlowRequest : AutomationsPatchFlowRequest =  // AutomationsPatchFlowRequest | 
try {
    val result : AutomationsFlow = apiInstance.automationsUpdateFlow(id, automationsPatchFlowRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#automationsUpdateFlow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#automationsUpdateFlow")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
automationsPatchFlowRequest AutomationsPatchFlowRequest

Return type

AutomationsFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

flowCountFlows

FlowCountFlows200Response flowCountFlows(folderId)

Count flows

Example

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

val apiInstance = FlowsApi()
val folderId : kotlin.String = folderId_example // kotlin.String | 
try {
    val result : FlowCountFlows200Response = apiInstance.flowCountFlows(folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#flowCountFlows")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#flowCountFlows")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
folderId kotlin.String [optional]

Return type

FlowCountFlows200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

flowCreateFlow

FlowFlow flowCreateFlow(autoCreateFlowRequest)

Create a flow

Example

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

val apiInstance = FlowsApi()
val autoCreateFlowRequest : AutoCreateFlowRequest =  // AutoCreateFlowRequest | 
try {
    val result : FlowFlow = apiInstance.flowCreateFlow(autoCreateFlowRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#flowCreateFlow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#flowCreateFlow")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
autoCreateFlowRequest AutoCreateFlowRequest

Return type

FlowFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

flowDeleteFlow

flowDeleteFlow(id)

Delete a flow

Example

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

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

flowGetFlow

FlowFlow flowGetFlow(id, versionId)

Get a flow by id

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
val versionId : kotlin.String = versionId_example // kotlin.String | 
try {
    val result : FlowFlow = apiInstance.flowGetFlow(id, versionId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#flowGetFlow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#flowGetFlow")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
versionId kotlin.String [optional]

Return type

FlowFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

flowGetFlowTemplate

FlowTemplate flowGetFlowTemplate(id)

Export flow as template

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

FlowTemplate

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

flowGetHumanInputForm

kotlin.Any flowGetHumanInputForm(flowId)

Get human input form definition for a flow

Example

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

val apiInstance = FlowsApi()
val flowId : kotlin.String = flowId_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.flowGetHumanInputForm(flowId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#flowGetHumanInputForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#flowGetHumanInputForm")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
flowId kotlin.String

Return type

kotlin.Any

Authorization

No authorization required

HTTP request headers

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

flowGetStepFile

java.io.File flowGetStepFile(id)

Get a file produced by a flow step

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : java.io.File = apiInstance.flowGetStepFile(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#flowGetStepFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#flowGetStepFile")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String

Return type

java.io.File

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

flowListFlows

FlowListFlows200Response flowListFlows(folderId, status, name, cursor, limit)

List flows

Example

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

val apiInstance = FlowsApi()
val folderId : kotlin.String = folderId_example // kotlin.String | 
val status : kotlin.String = status_example // kotlin.String | 
val name : kotlin.String = name_example // kotlin.String | 
val cursor : kotlin.String = cursor_example // kotlin.String | 
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : FlowListFlows200Response = apiInstance.flowListFlows(folderId, status, name, cursor, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#flowListFlows")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#flowListFlows")
    e.printStackTrace()
}

Parameters

| folderId | kotlin.String| | [optional] | | status | kotlin.String| | [optional] [enum: ENABLED, DISABLED] | | name | kotlin.String| | [optional] | | cursor | kotlin.String| | [optional] |

Name Type Description Notes
limit kotlin.Int [optional] [default to 10]

Return type

FlowListFlows200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

flowUpdateFlow

FlowFlow flowUpdateFlow(id, autoUpdateFlowRequest)

Apply an operation to a flow

Example

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

val apiInstance = FlowsApi()
val id : kotlin.String = id_example // kotlin.String | 
val autoUpdateFlowRequest : AutoUpdateFlowRequest =  // AutoUpdateFlowRequest | 
try {
    val result : FlowFlow = apiInstance.flowUpdateFlow(id, autoUpdateFlowRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FlowsApi#flowUpdateFlow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FlowsApi#flowUpdateFlow")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
autoUpdateFlowRequest AutoUpdateFlowRequest

Return type

FlowFlow

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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