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

27 KiB

AgentsApi

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

Method HTTP request Description
chatDeleteAgentsByid DELETE /v1/chat/agents/{id} Delete an agent
chatGetAgents GET /v1/chat/agents List agents
chatGetAgentsByid GET /v1/chat/agents/{id} Get an agent (basic info)
chatGetAgentsByidExpanded GET /v1/chat/agents/{id}/expanded Get agent with full configuration details
chatGetAgentsCategories GET /v1/chat/agents/categories Get agent categories with counts
chatGetAgentsChatActive GET /v1/chat/agents/chat/active Get active generation job IDs
chatGetAgentsChatStatusByconversationid GET /v1/chat/agents/chat/status/{conversationId} Check generation status for a conversation
chatGetAgentsChatStreamBystreamid GET /v1/chat/agents/chat/stream/{streamId} Subscribe to a generation stream
chatGetAgentsTools GET /v1/chat/agents/tools List available agent tools
chatGetAgentsToolsBytoolidAuth GET /v1/chat/agents/tools/{toolId}/auth Verify tool authentication
chatGetAgentsToolsCalls GET /v1/chat/agents/tools/calls Get tool call history
chatPatchAgentsByid PATCH /v1/chat/agents/{id} Update an agent
chatPostAgents POST /v1/chat/agents Create an agent
chatPostAgentsByidDuplicate POST /v1/chat/agents/{id}/duplicate Duplicate an agent
chatPostAgentsByidRevert POST /v1/chat/agents/{id}/revert Revert agent to a previous version
chatPostAgentsChat POST /v1/chat/agents/chat Chat with an agent
chatPostAgentsChatAbort POST /v1/chat/agents/chat/abort Abort an ongoing agent generation
chatPostAgentsChatByendpoint POST /v1/chat/agents/chat/{endpoint} Chat with an ephemeral agent
chatPostAgentsToolsBytoolidCall POST /v1/chat/agents/tools/{toolId}/call Execute a tool call

chatDeleteAgentsByid

kotlin.Any chatDeleteAgentsByid(id)

Delete an agent

Example

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

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

chatGetAgents

ChatAgentListResponse chatGetAgents(limit, after, sortBy, sortDirection)

List agents

Example

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

val apiInstance = AgentsApi()
val limit : kotlin.Int = 56 // kotlin.Int | 
val after : kotlin.String = after_example // kotlin.String | 
val sortBy : kotlin.String = sortBy_example // kotlin.String | 
val sortDirection : kotlin.String = sortDirection_example // kotlin.String | 
try {
    val result : ChatAgentListResponse = apiInstance.chatGetAgents(limit, after, sortBy, sortDirection)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatGetAgents")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatGetAgents")
    e.printStackTrace()
}

Parameters

| limit | kotlin.Int| | [optional] | | after | kotlin.String| | [optional] | | sortBy | kotlin.String| | [optional] |

Name Type Description Notes
sortDirection kotlin.String [optional]

Return type

ChatAgentListResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetAgentsByid

ChatAgent chatGetAgentsByid(id)

Get an agent (basic info)

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

ChatAgent

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetAgentsByidExpanded

ChatAgent chatGetAgentsByidExpanded(id)

Get agent with full configuration details

Returns complete agent data including sensitive config (EDIT permission required).

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

ChatAgent

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetAgentsCategories

kotlin.Any chatGetAgentsCategories()

Get agent categories with counts

Example

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

val apiInstance = AgentsApi()
try {
    val result : kotlin.Any = apiInstance.chatGetAgentsCategories()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatGetAgentsCategories")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatGetAgentsCategories")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

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

chatGetAgentsChatActive

ChatGetAgentsChatActive200Response chatGetAgentsChatActive()

Get active generation job IDs

Example

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

val apiInstance = AgentsApi()
try {
    val result : ChatGetAgentsChatActive200Response = apiInstance.chatGetAgentsChatActive()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatGetAgentsChatActive")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatGetAgentsChatActive")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

ChatGetAgentsChatActive200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetAgentsChatStatusByconversationid

ChatGetAgentsChatStatusByconversationid200Response chatGetAgentsChatStatusByconversationid(conversationId)

Check generation status for a conversation

Example

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

val apiInstance = AgentsApi()
val conversationId : kotlin.String = conversationId_example // kotlin.String | 
try {
    val result : ChatGetAgentsChatStatusByconversationid200Response = apiInstance.chatGetAgentsChatStatusByconversationid(conversationId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatGetAgentsChatStatusByconversationid")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatGetAgentsChatStatusByconversationid")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
conversationId kotlin.String

Return type

ChatGetAgentsChatStatusByconversationid200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetAgentsChatStreamBystreamid

kotlin.String chatGetAgentsChatStreamBystreamid(streamId, resume)

Subscribe to a generation stream

SSE endpoint for live or replay streaming of agent output.

Example

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

val apiInstance = AgentsApi()
val streamId : kotlin.String = streamId_example // kotlin.String | 
val resume : kotlin.String = resume_example // kotlin.String | 
try {
    val result : kotlin.String = apiInstance.chatGetAgentsChatStreamBystreamid(streamId, resume)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatGetAgentsChatStreamBystreamid")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatGetAgentsChatStreamBystreamid")
    e.printStackTrace()
}

Parameters

| streamId | kotlin.String| | |

Name Type Description Notes
resume kotlin.String [optional] [enum: true]

Return type

kotlin.String

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

chatGetAgentsTools

kotlin.collections.List<ChatTool> chatGetAgentsTools()

List available agent tools

Example

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

val apiInstance = AgentsApi()
try {
    val result : kotlin.collections.List<ChatTool> = apiInstance.chatGetAgentsTools()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatGetAgentsTools")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatGetAgentsTools")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<ChatTool>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetAgentsToolsBytoolidAuth

ChatGetAgentsToolsBytoolidAuth200Response chatGetAgentsToolsBytoolidAuth(toolId)

Verify tool authentication

Example

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

val apiInstance = AgentsApi()
val toolId : kotlin.String = toolId_example // kotlin.String | 
try {
    val result : ChatGetAgentsToolsBytoolidAuth200Response = apiInstance.chatGetAgentsToolsBytoolidAuth(toolId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatGetAgentsToolsBytoolidAuth")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatGetAgentsToolsBytoolidAuth")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
toolId kotlin.String

Return type

ChatGetAgentsToolsBytoolidAuth200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetAgentsToolsCalls

kotlin.Any chatGetAgentsToolsCalls()

Get tool call history

Example

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

val apiInstance = AgentsApi()
try {
    val result : kotlin.Any = apiInstance.chatGetAgentsToolsCalls()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatGetAgentsToolsCalls")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatGetAgentsToolsCalls")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

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

chatPatchAgentsByid

ChatAgent chatPatchAgentsByid(id, chatAgentCreateParams)

Update an agent

Example

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

val apiInstance = AgentsApi()
val id : kotlin.String = id_example // kotlin.String | 
val chatAgentCreateParams : ChatAgentCreateParams =  // ChatAgentCreateParams | 
try {
    val result : ChatAgent = apiInstance.chatPatchAgentsByid(id, chatAgentCreateParams)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatPatchAgentsByid")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatPatchAgentsByid")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
chatAgentCreateParams ChatAgentCreateParams

Return type

ChatAgent

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostAgents

ChatAgent chatPostAgents(chatAgentCreateParams)

Create an agent

Example

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

val apiInstance = AgentsApi()
val chatAgentCreateParams : ChatAgentCreateParams =  // ChatAgentCreateParams | 
try {
    val result : ChatAgent = apiInstance.chatPostAgents(chatAgentCreateParams)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatPostAgents")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatPostAgents")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
chatAgentCreateParams ChatAgentCreateParams

Return type

ChatAgent

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostAgentsByidDuplicate

ChatAgent chatPostAgentsByidDuplicate(id)

Duplicate an agent

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

ChatAgent

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostAgentsByidRevert

kotlin.Any chatPostAgentsByidRevert(id, chatPostAgentsByidRevertRequest)

Revert agent to a previous version

Example

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

val apiInstance = AgentsApi()
val id : kotlin.String = id_example // kotlin.String | 
val chatPostAgentsByidRevertRequest : ChatPostAgentsByidRevertRequest =  // ChatPostAgentsByidRevertRequest | 
try {
    val result : kotlin.Any = apiInstance.chatPostAgentsByidRevert(id, chatPostAgentsByidRevertRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatPostAgentsByidRevert")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatPostAgentsByidRevert")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
chatPostAgentsByidRevertRequest ChatPostAgentsByidRevertRequest

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

chatPostAgentsChat

kotlin.String chatPostAgentsChat(chatAgentChatRequest)

Chat with an agent

Send a message to an agent and receive a streaming SSE response.

Example

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

val apiInstance = AgentsApi()
val chatAgentChatRequest : ChatAgentChatRequest =  // ChatAgentChatRequest | 
try {
    val result : kotlin.String = apiInstance.chatPostAgentsChat(chatAgentChatRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatPostAgentsChat")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatPostAgentsChat")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
chatAgentChatRequest ChatAgentChatRequest

Return type

kotlin.String

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostAgentsChatAbort

ChatPostAgentsChatAbort200Response chatPostAgentsChatAbort(chatPostAgentsChatAbortRequest)

Abort an ongoing agent generation

Example

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

val apiInstance = AgentsApi()
val chatPostAgentsChatAbortRequest : ChatPostAgentsChatAbortRequest =  // ChatPostAgentsChatAbortRequest | 
try {
    val result : ChatPostAgentsChatAbort200Response = apiInstance.chatPostAgentsChatAbort(chatPostAgentsChatAbortRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatPostAgentsChatAbort")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatPostAgentsChatAbort")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
chatPostAgentsChatAbortRequest ChatPostAgentsChatAbortRequest

Return type

ChatPostAgentsChatAbort200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostAgentsChatByendpoint

kotlin.String chatPostAgentsChatByendpoint(endpoint, chatAgentChatRequest)

Chat with an ephemeral agent

Example

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

val apiInstance = AgentsApi()
val endpoint : kotlin.String = endpoint_example // kotlin.String | 
val chatAgentChatRequest : ChatAgentChatRequest =  // ChatAgentChatRequest | 
try {
    val result : kotlin.String = apiInstance.chatPostAgentsChatByendpoint(endpoint, chatAgentChatRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatPostAgentsChatByendpoint")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatPostAgentsChatByendpoint")
    e.printStackTrace()
}

Parameters

| endpoint | kotlin.String| | |

Name Type Description Notes
chatAgentChatRequest ChatAgentChatRequest

Return type

kotlin.String

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostAgentsToolsBytoolidCall

kotlin.Any chatPostAgentsToolsBytoolidCall(toolId, body)

Execute a tool call

Example

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

val apiInstance = AgentsApi()
val toolId : kotlin.String = toolId_example // kotlin.String | 
val body : kotlin.Any = Object // kotlin.Any | 
try {
    val result : kotlin.Any = apiInstance.chatPostAgentsToolsBytoolidCall(toolId, body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AgentsApi#chatPostAgentsToolsBytoolidCall")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AgentsApi#chatPostAgentsToolsBytoolidCall")
    e.printStackTrace()
}

Parameters

| toolId | kotlin.String| | |

Name Type Description Notes
body kotlin.Any

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