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]>
6.6 KiB
BotsApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| visorBotAction | POST /v1/bots/{id}/{action} | Act on a bot (stop, pause, or message) |
| visorDeleteBot | DELETE /v1/bots/{id} | Terminate a bot (unbind agent + delete machine) |
| visorGetBot | GET /v1/bots/{id} | Get one bot by id |
| visorLaunchBot | POST /v1/bots/launch | Launch a bot (machine + agent binding), or dryRun for a quote |
| visorListBots | GET /v1/bots | List the org's bots |
visorBotAction
kotlin.Any visorBotAction(id, action, body)
Act on a bot (stop, pause, or message)
`stop` and `pause` both halt the bot's agent runtime (one honest capability). `message` runs the bot's bound agent via the agent runner and returns that run's output verbatim.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = BotsApi()
val id : kotlin.String = id_example // kotlin.String |
val action : kotlin.String = action_example // kotlin.String |
val body : kotlin.Any = Object // kotlin.Any |
try {
val result : kotlin.Any = apiInstance.visorBotAction(id, action, body)
println(result)
} catch (e: ClientException) {
println("4xx response calling BotsApi#visorBotAction")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling BotsApi#visorBotAction")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | | | action | kotlin.String| | [enum: stop, pause, message] |
| 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
visorDeleteBot
visorDeleteBot(id)
Terminate a bot (unbind agent + delete machine)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = BotsApi()
val id : kotlin.String = id_example // kotlin.String |
try {
apiInstance.visorDeleteBot(id)
} catch (e: ClientException) {
println("4xx response calling BotsApi#visorDeleteBot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling BotsApi#visorDeleteBot")
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
visorGetBot
VisorBotView visorGetBot(id)
Get one bot by id
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = BotsApi()
val id : kotlin.String = id_example // kotlin.String |
try {
val result : VisorBotView = apiInstance.visorGetBot(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling BotsApi#visorGetBot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling BotsApi#visorGetBot")
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
visorLaunchBot
kotlin.Any visorLaunchBot(visorBotLaunchRequest)
Launch a bot (machine + agent binding), or dryRun for a quote
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = BotsApi()
val visorBotLaunchRequest : VisorBotLaunchRequest = // VisorBotLaunchRequest |
try {
val result : kotlin.Any = apiInstance.visorLaunchBot(visorBotLaunchRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling BotsApi#visorLaunchBot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling BotsApi#visorLaunchBot")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| visorBotLaunchRequest | VisorBotLaunchRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
visorListBots
VisorListBots200Response visorListBots()
List the org's bots
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = BotsApi()
try {
val result : VisorListBots200Response = apiInstance.visorListBots()
println(result)
} catch (e: ClientException) {
println("4xx response calling BotsApi#visorListBots")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling BotsApi#visorListBots")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json