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]>
14 KiB
FlowRunsApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| autoGetFlowRun | GET /v1/auto/flow-runs/{id} | Get a flow run by id |
| autoListFlowRuns | GET /v1/auto/flow-runs | List flow runs |
| autoResumeFlowRun | POST /v1/auto/flow-runs/{id}/requests/{requestId} | Resume a paused flow run with human input |
| autoRetryFlowRun | POST /v1/auto/flow-runs/{id}/retry | Retry a failed flow run |
| flowBulkCancelFlowRuns | POST /v1/flow/flow-runs/bulk/cancel | Bulk cancel running flow runs |
| flowGetFlowRun | GET /v1/flow/flow-runs/{id} | Get a flow run by id |
| flowListFlowRuns | GET /v1/flow/flow-runs | List flow runs |
| flowResumeFlowRun | POST /v1/flow/flow-runs/{id}/requests/{requestId} | Resume a paused flow run with human input |
| flowRetryFlowRun | POST /v1/flow/flow-runs/{id}/retry | Retry a failed flow run |
autoGetFlowRun
AutoFlowRun autoGetFlowRun(id)
Get a flow run by id
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val id : kotlin.String = id_example // kotlin.String |
try {
val result : AutoFlowRun = apiInstance.autoGetFlowRun(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#autoGetFlowRun")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#autoGetFlowRun")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
autoListFlowRuns
AutoListFlowRuns200Response autoListFlowRuns(flowId, status, cursor, limit, createdAfter, createdBefore)
List flow runs
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val flowId : kotlin.String = flowId_example // kotlin.String |
val status : kotlin.collections.List<kotlin.String> = // kotlin.collections.List<kotlin.String> |
val cursor : kotlin.String = cursor_example // kotlin.String |
val limit : kotlin.Int = 56 // kotlin.Int |
val createdAfter : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime |
val createdBefore : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime |
try {
val result : AutoListFlowRuns200Response = apiInstance.autoListFlowRuns(flowId, status, cursor, limit, createdAfter, createdBefore)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#autoListFlowRuns")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#autoListFlowRuns")
e.printStackTrace()
}
Parameters
| flowId | kotlin.String| | [optional] | | status | kotlin.collections.List<kotlin.String>| | [optional] [enum: RUNNING, SUCCEEDED, FAILED, TIMEOUT, PAUSED, STOPPED] | | cursor | kotlin.String| | [optional] | | limit | kotlin.Int| | [optional] [default to 10] | | createdAfter | java.time.OffsetDateTime| | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| createdBefore | java.time.OffsetDateTime | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
autoResumeFlowRun
kotlin.Any autoResumeFlowRun(id, requestId, body)
Resume a paused flow run with human input
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val id : kotlin.String = id_example // kotlin.String |
val requestId : kotlin.String = requestId_example // kotlin.String |
val body : kotlin.Any = Object // kotlin.Any |
try {
val result : kotlin.Any = apiInstance.autoResumeFlowRun(id, requestId, body)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#autoResumeFlowRun")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#autoResumeFlowRun")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | | | requestId | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| body | kotlin.Any | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
autoRetryFlowRun
kotlin.Any autoRetryFlowRun(id)
Retry a failed flow run
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val id : kotlin.String = id_example // kotlin.String |
try {
val result : kotlin.Any = apiInstance.autoRetryFlowRun(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#autoRetryFlowRun")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#autoRetryFlowRun")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
flowBulkCancelFlowRuns
kotlin.Any flowBulkCancelFlowRuns(flowBulkCancelFlowRunsRequest)
Bulk cancel running flow runs
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val flowBulkCancelFlowRunsRequest : FlowBulkCancelFlowRunsRequest = // FlowBulkCancelFlowRunsRequest |
try {
val result : kotlin.Any = apiInstance.flowBulkCancelFlowRuns(flowBulkCancelFlowRunsRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#flowBulkCancelFlowRuns")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#flowBulkCancelFlowRuns")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| flowBulkCancelFlowRunsRequest | FlowBulkCancelFlowRunsRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
flowGetFlowRun
FlowFlowRun flowGetFlowRun(id)
Get a flow run by id
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val id : kotlin.String = id_example // kotlin.String |
try {
val result : FlowFlowRun = apiInstance.flowGetFlowRun(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#flowGetFlowRun")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#flowGetFlowRun")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
flowListFlowRuns
FlowListFlowRuns200Response flowListFlowRuns(flowId, status, tags, cursor, limit, createdAfter, createdBefore)
List flow runs
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val flowId : kotlin.String = flowId_example // kotlin.String |
val status : kotlin.collections.List<kotlin.String> = // kotlin.collections.List<kotlin.String> |
val tags : kotlin.collections.List<kotlin.String> = // kotlin.collections.List<kotlin.String> |
val cursor : kotlin.String = cursor_example // kotlin.String |
val limit : kotlin.Int = 56 // kotlin.Int |
val createdAfter : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime |
val createdBefore : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime |
try {
val result : FlowListFlowRuns200Response = apiInstance.flowListFlowRuns(flowId, status, tags, cursor, limit, createdAfter, createdBefore)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#flowListFlowRuns")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#flowListFlowRuns")
e.printStackTrace()
}
Parameters
| flowId | kotlin.String| | [optional] | | status | kotlin.collections.List<kotlin.String>| | [optional] [enum: RUNNING, SUCCEEDED, FAILED, TIMEOUT, PAUSED, STOPPED] | | tags | kotlin.collections.List<kotlin.String>| | [optional] | | cursor | kotlin.String| | [optional] | | limit | kotlin.Int| | [optional] [default to 10] | | createdAfter | java.time.OffsetDateTime| | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| createdBefore | java.time.OffsetDateTime | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
flowResumeFlowRun
kotlin.Any flowResumeFlowRun(id, requestId, body)
Resume a paused flow run with human input
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val id : kotlin.String = id_example // kotlin.String |
val requestId : kotlin.String = requestId_example // kotlin.String |
val body : kotlin.Any = Object // kotlin.Any |
try {
val result : kotlin.Any = apiInstance.flowResumeFlowRun(id, requestId, body)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#flowResumeFlowRun")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#flowResumeFlowRun")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | | | requestId | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| body | kotlin.Any | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
flowRetryFlowRun
FlowFlowRun flowRetryFlowRun(id, flowRetryFlowRunRequest)
Retry a failed flow run
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = FlowRunsApi()
val id : kotlin.String = id_example // kotlin.String |
val flowRetryFlowRunRequest : FlowRetryFlowRunRequest = // FlowRetryFlowRunRequest |
try {
val result : FlowFlowRun = apiInstance.flowRetryFlowRun(id, flowRetryFlowRunRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling FlowRunsApi#flowRetryFlowRun")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FlowRunsApi#flowRetryFlowRun")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| flowRetryFlowRunRequest | FlowRetryFlowRunRequest | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json