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

24 KiB

MessageAPIApi

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

Method HTTP request Description
cloudApiControllerAddMessage POST /v1/cloud/add-message Api Controller Add Message
cloudApiControllerDeleteMessage POST /v1/cloud/delete-message Api Controller Delete Message
cloudApiControllerGetAnswer GET /v1/cloud/get-answer Api Controller Get Answer
cloudApiControllerGetGlobalMessages GET /v1/cloud/get-global-messages Api Controller Get Global Messages
cloudApiControllerGetMessage GET /v1/cloud/get-message Api Controller Get Message
cloudApiControllerGetMessageAnswer GET /v1/cloud/get-message-answer Api Controller Get Message Answer
cloudApiControllerGetMessages GET /v1/cloud/get-Messages Api Controller Get Messages
cloudApiControllerUpdateMessage POST /v1/cloud/update-message Api Controller Update Message
nexusAddMessage POST /v1/nexus/add-message add Message
nexusDeleteMessage POST /v1/nexus/delete-message delete Message
nexusGetAnswer GET /v1/nexus/get-answer get Answer
nexusGetGlobalMessages GET /v1/nexus/get-global-messages get Global Messages
nexusGetMessage GET /v1/nexus/get-message get Message
nexusGetMessageAnswer GET /v1/nexus/get-message-answer get Message Answer
nexusGetMessages GET /v1/nexus/get-Messages get Messages
nexusUpdateMessage POST /v1/nexus/update-message update Message

cloudApiControllerAddMessage

CloudObjectChat cloudApiControllerAddMessage(cloudObjectMessage)

Api Controller Add Message

add message

Example

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

val apiInstance = MessageAPIApi()
val cloudObjectMessage : CloudObjectMessage =  // CloudObjectMessage | The details of the message
try {
    val result : CloudObjectChat = apiInstance.cloudApiControllerAddMessage(cloudObjectMessage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#cloudApiControllerAddMessage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#cloudApiControllerAddMessage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectMessage CloudObjectMessage The details of the message

Return type

CloudObjectChat

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeleteMessage

CloudControllersResponse cloudApiControllerDeleteMessage(cloudObjectMessage)

Api Controller Delete Message

delete message

Example

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

val apiInstance = MessageAPIApi()
val cloudObjectMessage : CloudObjectMessage =  // CloudObjectMessage | The details of the message
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteMessage(cloudObjectMessage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#cloudApiControllerDeleteMessage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#cloudApiControllerDeleteMessage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectMessage CloudObjectMessage The details of the message

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetAnswer

kotlin.Any cloudApiControllerGetAnswer(provider, question, framework, video)

Api Controller Get Answer

get answer

Example

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

val apiInstance = MessageAPIApi()
val provider : kotlin.String = provider_example // kotlin.String | The provider
val question : kotlin.String = question_example // kotlin.String | The question of message
val framework : kotlin.String = framework_example // kotlin.String | The framework
val video : kotlin.String = video_example // kotlin.String | The video
try {
    val result : kotlin.Any = apiInstance.cloudApiControllerGetAnswer(provider, question, framework, video)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#cloudApiControllerGetAnswer")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#cloudApiControllerGetAnswer")
    e.printStackTrace()
}

Parameters

| provider | kotlin.String| The provider | | | question | kotlin.String| The question of message | | | framework | kotlin.String| The framework | |

Name Type Description Notes
video kotlin.String The video

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

cloudApiControllerGetGlobalMessages

kotlin.collections.List<CloudObjectMessage> cloudApiControllerGetGlobalMessages()

Api Controller Get Global Messages

get global messages

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<CloudObjectMessage>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetMessage

CloudObjectMessage cloudApiControllerGetMessage(id)

Api Controller Get Message

get message

Example

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

val apiInstance = MessageAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id of message
try {
    val result : CloudObjectMessage = apiInstance.cloudApiControllerGetMessage(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#cloudApiControllerGetMessage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#cloudApiControllerGetMessage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The id of message

Return type

CloudObjectMessage

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetMessageAnswer

kotlin.Any cloudApiControllerGetMessageAnswer(id)

Api Controller Get Message Answer

get message answer

Example

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

val apiInstance = MessageAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id of message
try {
    val result : kotlin.Any = apiInstance.cloudApiControllerGetMessageAnswer(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#cloudApiControllerGetMessageAnswer")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#cloudApiControllerGetMessageAnswer")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The id of message

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

cloudApiControllerGetMessages

kotlin.collections.List<CloudObjectMessage> cloudApiControllerGetMessages(user, chat)

Api Controller Get Messages

get Messages

Example

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

val apiInstance = MessageAPIApi()
val user : kotlin.String = user_example // kotlin.String | The user of message
val chat : kotlin.String = chat_example // kotlin.String | The chat of message
try {
    val result : kotlin.collections.List<CloudObjectMessage> = apiInstance.cloudApiControllerGetMessages(user, chat)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#cloudApiControllerGetMessages")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#cloudApiControllerGetMessages")
    e.printStackTrace()
}

Parameters

| user | kotlin.String| The user of message | |

Name Type Description Notes
chat kotlin.String The chat of message

Return type

kotlin.collections.List<CloudObjectMessage>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerUpdateMessage

CloudControllersResponse cloudApiControllerUpdateMessage(id, cloudObjectMessage)

Api Controller Update Message

update message

Example

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

val apiInstance = MessageAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the message
val cloudObjectMessage : CloudObjectMessage =  // CloudObjectMessage | The details of the message
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateMessage(id, cloudObjectMessage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#cloudApiControllerUpdateMessage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#cloudApiControllerUpdateMessage")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| The id (owner/name) of the message | |

Name Type Description Notes
cloudObjectMessage CloudObjectMessage The details of the message

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusAddMessage

CloudObjectChat nexusAddMessage(nexusMessage)

add Message

Add a message to a chat

Example

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

val apiInstance = MessageAPIApi()
val nexusMessage : NexusMessage =  // NexusMessage | The details of the message
try {
    val result : CloudObjectChat = apiInstance.nexusAddMessage(nexusMessage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#nexusAddMessage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#nexusAddMessage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
nexusMessage NexusMessage The details of the message

Return type

CloudObjectChat

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeleteMessage

NexusResponse nexusDeleteMessage(nexusMessage)

delete Message

Delete a message

Example

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

val apiInstance = MessageAPIApi()
val nexusMessage : NexusMessage =  // NexusMessage | The details of the message
try {
    val result : NexusResponse = apiInstance.nexusDeleteMessage(nexusMessage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#nexusDeleteMessage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#nexusDeleteMessage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
nexusMessage NexusMessage The details of the message

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetAnswer

kotlin.String nexusGetAnswer(provider, question, framework, video)

get Answer

Get an AI-generated answer

Example

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

val apiInstance = MessageAPIApi()
val provider : kotlin.String = provider_example // kotlin.String | The provider
val question : kotlin.String = question_example // kotlin.String | The question
val framework : kotlin.String = framework_example // kotlin.String | The framework
val video : kotlin.String = video_example // kotlin.String | The video
try {
    val result : kotlin.String = apiInstance.nexusGetAnswer(provider, question, framework, video)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#nexusGetAnswer")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#nexusGetAnswer")
    e.printStackTrace()
}

Parameters

| provider | kotlin.String| The provider | | | question | kotlin.String| The question | | | framework | kotlin.String| The framework | |

Name Type Description Notes
video kotlin.String The video

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

nexusGetGlobalMessages

kotlin.collections.List<NexusMessage> nexusGetGlobalMessages()

get Global Messages

Get global messages

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<NexusMessage>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetMessage

NexusMessage nexusGetMessage(id)

get Message

Get a message

Example

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

val apiInstance = MessageAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id of the message
try {
    val result : NexusMessage = apiInstance.nexusGetMessage(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#nexusGetMessage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#nexusGetMessage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The id of the message

Return type

NexusMessage

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetMessageAnswer

kotlin.String nexusGetMessageAnswer(id)

get Message Answer

Get a streamed AI answer for a message

Example

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

val apiInstance = MessageAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id of the message
try {
    val result : kotlin.String = apiInstance.nexusGetMessageAnswer(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#nexusGetMessageAnswer")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#nexusGetMessageAnswer")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The id of the message

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

nexusGetMessages

kotlin.collections.List<NexusMessage> nexusGetMessages(user, chat)

get Messages

Get messages for a chat

Example

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

val apiInstance = MessageAPIApi()
val user : kotlin.String = user_example // kotlin.String | The user of the messages
val chat : kotlin.String = chat_example // kotlin.String | The chat of the messages
try {
    val result : kotlin.collections.List<NexusMessage> = apiInstance.nexusGetMessages(user, chat)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#nexusGetMessages")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#nexusGetMessages")
    e.printStackTrace()
}

Parameters

| user | kotlin.String| The user of the messages | |

Name Type Description Notes
chat kotlin.String The chat of the messages

Return type

kotlin.collections.List<NexusMessage>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusUpdateMessage

NexusResponse nexusUpdateMessage(id, nexusMessage)

update Message

Update a message

Example

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

val apiInstance = MessageAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the message
val nexusMessage : NexusMessage =  // NexusMessage | The details of the message
try {
    val result : NexusResponse = apiInstance.nexusUpdateMessage(id, nexusMessage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MessageAPIApi#nexusUpdateMessage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MessageAPIApi#nexusUpdateMessage")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| The id (owner/name) of the message | |

Name Type Description Notes
nexusMessage NexusMessage The details of the message

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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