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

4.7 KiB

SampleDataApi

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

Method HTTP request Description
autoGetSampleData GET /v1/auto/sample-data Get sample data for a flow step
flowGetSampleData GET /v1/flow/sample-data Get sample data for a flow step
flowSaveSampleData POST /v1/flow/sample-data Save sample data for a flow step

autoGetSampleData

kotlin.Any autoGetSampleData(flowId, flowVersionId, stepName)

Get sample data for a flow step

Example

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

val apiInstance = SampleDataApi()
val flowId : kotlin.String = flowId_example // kotlin.String | 
val flowVersionId : kotlin.String = flowVersionId_example // kotlin.String | 
val stepName : kotlin.String = stepName_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.autoGetSampleData(flowId, flowVersionId, stepName)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SampleDataApi#autoGetSampleData")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SampleDataApi#autoGetSampleData")
    e.printStackTrace()
}

Parameters

| flowId | kotlin.String| | | | flowVersionId | kotlin.String| | |

Name Type Description Notes
stepName 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

flowGetSampleData

kotlin.Any flowGetSampleData(flowId, flowVersionId, stepName)

Get sample data for a flow step

Example

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

val apiInstance = SampleDataApi()
val flowId : kotlin.String = flowId_example // kotlin.String | 
val flowVersionId : kotlin.String = flowVersionId_example // kotlin.String | 
val stepName : kotlin.String = stepName_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.flowGetSampleData(flowId, flowVersionId, stepName)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SampleDataApi#flowGetSampleData")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SampleDataApi#flowGetSampleData")
    e.printStackTrace()
}

Parameters

| flowId | kotlin.String| | | | flowVersionId | kotlin.String| | |

Name Type Description Notes
stepName 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

flowSaveSampleData

kotlin.Any flowSaveSampleData(flowSaveSampleDataRequest)

Save sample data for a flow step

Example

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

val apiInstance = SampleDataApi()
val flowSaveSampleDataRequest : FlowSaveSampleDataRequest =  // FlowSaveSampleDataRequest | 
try {
    val result : kotlin.Any = apiInstance.flowSaveSampleData(flowSaveSampleDataRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SampleDataApi#flowSaveSampleData")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SampleDataApi#flowSaveSampleData")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
flowSaveSampleDataRequest FlowSaveSampleDataRequest

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