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]>
13 KiB
TasksApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| searchCancelTasks | POST /v1/search/tasks/cancel | Cancel enqueued or processing tasks |
| searchDeleteTasks | DELETE /v1/search/tasks | Delete completed tasks |
| searchGetTask | GET /v1/search/tasks/{taskUid} | Get task details |
| searchListTasks | GET /v1/search/tasks | List all tasks |
| tasksTasksEvents | GET /v1/tasks/events | Realtime event stream (SSE, identity-gated) |
| tasksTasksGet | GET /v1/tasks/{resource} | Engine JSON API (namespaces, workflows, activities, …), identity-gated |
| tasksTasksMcp | POST /v1/tasks/mcp | Tasks MCP tool surface (JSON-RPC, identity-gated) |
| tasksTasksPost | POST /v1/tasks/{resource} | Engine JSON API write (identity-gated) |
searchCancelTasks
SearchSummarizedTaskView searchCancelTasks(uids, statuses, types, indexUids)
Cancel enqueued or processing tasks
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TasksApi()
val uids : kotlin.String = uids_example // kotlin.String |
val statuses : kotlin.String = statuses_example // kotlin.String |
val types : kotlin.String = types_example // kotlin.String |
val indexUids : kotlin.String = indexUids_example // kotlin.String |
try {
val result : SearchSummarizedTaskView = apiInstance.searchCancelTasks(uids, statuses, types, indexUids)
println(result)
} catch (e: ClientException) {
println("4xx response calling TasksApi#searchCancelTasks")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TasksApi#searchCancelTasks")
e.printStackTrace()
}
Parameters
| uids | kotlin.String| | [optional] | | statuses | kotlin.String| | [optional] | | types | kotlin.String| | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| indexUids | kotlin.String | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
searchDeleteTasks
SearchSummarizedTaskView searchDeleteTasks(uids, statuses, types, indexUids)
Delete completed tasks
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TasksApi()
val uids : kotlin.String = uids_example // kotlin.String |
val statuses : kotlin.String = statuses_example // kotlin.String |
val types : kotlin.String = types_example // kotlin.String |
val indexUids : kotlin.String = indexUids_example // kotlin.String |
try {
val result : SearchSummarizedTaskView = apiInstance.searchDeleteTasks(uids, statuses, types, indexUids)
println(result)
} catch (e: ClientException) {
println("4xx response calling TasksApi#searchDeleteTasks")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TasksApi#searchDeleteTasks")
e.printStackTrace()
}
Parameters
| uids | kotlin.String| | [optional] | | statuses | kotlin.String| | [optional] | | types | kotlin.String| | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| indexUids | kotlin.String | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
searchGetTask
SearchTaskView searchGetTask(taskUid)
Get task details
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TasksApi()
val taskUid : kotlin.Int = 56 // kotlin.Int |
try {
val result : SearchTaskView = apiInstance.searchGetTask(taskUid)
println(result)
} catch (e: ClientException) {
println("4xx response calling TasksApi#searchGetTask")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TasksApi#searchGetTask")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| taskUid | kotlin.Int |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
searchListTasks
SearchListTasks200Response searchListTasks(limit, from, uids, statuses, types, indexUids)
List all tasks
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TasksApi()
val limit : kotlin.Int = 56 // kotlin.Int |
val from : kotlin.Int = 56 // kotlin.Int | Task UID to start from
val uids : kotlin.String = uids_example // kotlin.String | Comma-separated task UIDs
val statuses : kotlin.String = statuses_example // kotlin.String | Comma-separated statuses (enqueued, processing, succeeded, failed, canceled)
val types : kotlin.String = types_example // kotlin.String | Comma-separated task types
val indexUids : kotlin.String = indexUids_example // kotlin.String | Comma-separated index UIDs
try {
val result : SearchListTasks200Response = apiInstance.searchListTasks(limit, from, uids, statuses, types, indexUids)
println(result)
} catch (e: ClientException) {
println("4xx response calling TasksApi#searchListTasks")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TasksApi#searchListTasks")
e.printStackTrace()
}
Parameters
| limit | kotlin.Int| | [optional] [default to 20] | | from | kotlin.Int| Task UID to start from | [optional] | | uids | kotlin.String| Comma-separated task UIDs | [optional] | | statuses | kotlin.String| Comma-separated statuses (enqueued, processing, succeeded, failed, canceled) | [optional] | | types | kotlin.String| Comma-separated task types | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| indexUids | kotlin.String | Comma-separated index UIDs | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
tasksTasksEvents
kotlin.String tasksTasksEvents()
Realtime event stream (SSE, identity-gated)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TasksApi()
try {
val result : kotlin.String = apiInstance.tasksTasksEvents()
println(result)
} catch (e: ClientException) {
println("4xx response calling TasksApi#tasksTasksEvents")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TasksApi#tasksTasksEvents")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.String
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
tasksTasksGet
kotlin.collections.Map<kotlin.String, kotlin.Any> tasksTasksGet(resource)
Engine JSON API (namespaces, workflows, activities, …), identity-gated
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TasksApi()
val resource : kotlin.String = resource_example // kotlin.String | 'Engine resource path (e.g. namespaces, nexus)'
try {
val result : kotlin.collections.Map<kotlin.String, kotlin.Any> = apiInstance.tasksTasksGet(resource)
println(result)
} catch (e: ClientException) {
println("4xx response calling TasksApi#tasksTasksGet")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TasksApi#tasksTasksGet")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| resource | kotlin.String | 'Engine resource path (e.g. namespaces, nexus)' |
Return type
kotlin.collections.Map<kotlin.String, kotlin.Any>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
tasksTasksMcp
kotlin.collections.Map<kotlin.String, kotlin.Any> tasksTasksMcp(requestBody)
Tasks MCP tool surface (JSON-RPC, identity-gated)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TasksApi()
val requestBody : kotlin.collections.Map<kotlin.String, kotlin.Any?> = Object // kotlin.collections.Map<kotlin.String, kotlin.Any?> |
try {
val result : kotlin.collections.Map<kotlin.String, kotlin.Any> = apiInstance.tasksTasksMcp(requestBody)
println(result)
} catch (e: ClientException) {
println("4xx response calling TasksApi#tasksTasksMcp")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TasksApi#tasksTasksMcp")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| requestBody | kotlin.collections.Map<kotlin.String, kotlin.Any?> |
Return type
kotlin.collections.Map<kotlin.String, kotlin.Any>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
tasksTasksPost
kotlin.collections.Map<kotlin.String, kotlin.Any> tasksTasksPost(resource, requestBody)
Engine JSON API write (identity-gated)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TasksApi()
val resource : kotlin.String = resource_example // kotlin.String |
val requestBody : kotlin.collections.Map<kotlin.String, kotlin.Any> = Object // kotlin.collections.Map<kotlin.String, kotlin.Any> |
try {
val result : kotlin.collections.Map<kotlin.String, kotlin.Any> = apiInstance.tasksTasksPost(resource, requestBody)
println(result)
} catch (e: ClientException) {
println("4xx response calling TasksApi#tasksTasksPost")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TasksApi#tasksTasksPost")
e.printStackTrace()
}
Parameters
| resource | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| requestBody | kotlin.collections.Map<kotlin.String, kotlin.Any> |
Return type
kotlin.collections.Map<kotlin.String, kotlin.Any>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json