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

15 KiB

ConversationsApi

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

Method HTTP request Description
chatDeleteConvos DELETE /v1/chat/convos Delete a conversation
chatDeleteConvosAll DELETE /v1/chat/convos/all Delete all conversations
chatGetConvos GET /v1/chat/convos List conversations
chatGetConvosByconversationid GET /v1/chat/convos/{conversationId} Get a conversation
chatGetConvosGenTitleByconversationid GET /v1/chat/convos/gen_title/{conversationId} Get generated title for conversation
chatPostConvosArchive POST /v1/chat/convos/archive Archive or unarchive a conversation
chatPostConvosDuplicate POST /v1/chat/convos/duplicate Duplicate a conversation
chatPostConvosFork POST /v1/chat/convos/fork Fork a conversation
chatPostConvosImport POST /v1/chat/convos/import Import conversations from JSON file
chatPostConvosUpdate POST /v1/chat/convos/update Update a conversation title

chatDeleteConvos

kotlin.Any chatDeleteConvos(chatDeleteConvosRequest)

Delete a conversation

Example

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

val apiInstance = ConversationsApi()
val chatDeleteConvosRequest : ChatDeleteConvosRequest =  // ChatDeleteConvosRequest | 
try {
    val result : kotlin.Any = apiInstance.chatDeleteConvos(chatDeleteConvosRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConversationsApi#chatDeleteConvos")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConversationsApi#chatDeleteConvos")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
chatDeleteConvosRequest ChatDeleteConvosRequest

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

chatDeleteConvosAll

kotlin.Any chatDeleteConvosAll()

Delete all conversations

Example

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

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

chatGetConvos

ChatConversationListResponse chatGetConvos(limit, cursor, isArchived, tags, search, sortBy, sortDirection)

List conversations

Example

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

val apiInstance = ConversationsApi()
val limit : kotlin.Int = 56 // kotlin.Int | 
val cursor : kotlin.String = cursor_example // kotlin.String | 
val isArchived : kotlin.String = isArchived_example // kotlin.String | 
val tags : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | 
val search : kotlin.String = search_example // kotlin.String | 
val sortBy : kotlin.String = sortBy_example // kotlin.String | 
val sortDirection : kotlin.String = sortDirection_example // kotlin.String | 
try {
    val result : ChatConversationListResponse = apiInstance.chatGetConvos(limit, cursor, isArchived, tags, search, sortBy, sortDirection)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConversationsApi#chatGetConvos")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConversationsApi#chatGetConvos")
    e.printStackTrace()
}

Parameters

| limit | kotlin.Int| | [optional] [default to 25] | | cursor | kotlin.String| | [optional] | | isArchived | kotlin.String| | [optional] | | tags | kotlin.collections.List<kotlin.String>| | [optional] | | search | kotlin.String| | [optional] | | sortBy | kotlin.String| | [optional] [default to "updatedAt"] |

Name Type Description Notes
sortDirection kotlin.String [optional] [default to "desc"]

Return type

ChatConversationListResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetConvosByconversationid

ChatConversation chatGetConvosByconversationid(conversationId)

Get a conversation

Example

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

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

Parameters

Name Type Description Notes
conversationId kotlin.String

Return type

ChatConversation

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetConvosGenTitleByconversationid

ChatGetConvosGenTitleByconversationid200Response chatGetConvosGenTitleByconversationid(conversationId)

Get generated title for conversation

Polls for an AI-generated title. Uses exponential backoff.

Example

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

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

Parameters

Name Type Description Notes
conversationId kotlin.String

Return type

ChatGetConvosGenTitleByconversationid200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostConvosArchive

ChatConversation chatPostConvosArchive(chatPostConvosArchiveRequest)

Archive or unarchive a conversation

Example

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

val apiInstance = ConversationsApi()
val chatPostConvosArchiveRequest : ChatPostConvosArchiveRequest =  // ChatPostConvosArchiveRequest | 
try {
    val result : ChatConversation = apiInstance.chatPostConvosArchive(chatPostConvosArchiveRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConversationsApi#chatPostConvosArchive")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConversationsApi#chatPostConvosArchive")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
chatPostConvosArchiveRequest ChatPostConvosArchiveRequest

Return type

ChatConversation

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostConvosDuplicate

kotlin.Any chatPostConvosDuplicate(chatPostConvosDuplicateRequest)

Duplicate a conversation

Example

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

val apiInstance = ConversationsApi()
val chatPostConvosDuplicateRequest : ChatPostConvosDuplicateRequest =  // ChatPostConvosDuplicateRequest | 
try {
    val result : kotlin.Any = apiInstance.chatPostConvosDuplicate(chatPostConvosDuplicateRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConversationsApi#chatPostConvosDuplicate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConversationsApi#chatPostConvosDuplicate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
chatPostConvosDuplicateRequest ChatPostConvosDuplicateRequest

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

chatPostConvosFork

ChatPostConvosFork200Response chatPostConvosFork(chatPostConvosForkRequest)

Fork a conversation

Example

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

val apiInstance = ConversationsApi()
val chatPostConvosForkRequest : ChatPostConvosForkRequest =  // ChatPostConvosForkRequest | 
try {
    val result : ChatPostConvosFork200Response = apiInstance.chatPostConvosFork(chatPostConvosForkRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConversationsApi#chatPostConvosFork")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConversationsApi#chatPostConvosFork")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
chatPostConvosForkRequest ChatPostConvosForkRequest

Return type

ChatPostConvosFork200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPostConvosImport

kotlin.Any chatPostConvosImport(file)

Import conversations from JSON file

Example

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

val apiInstance = ConversationsApi()
val file : java.io.File = BINARY_DATA_HERE // java.io.File | 
try {
    val result : kotlin.Any = apiInstance.chatPostConvosImport(file)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConversationsApi#chatPostConvosImport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConversationsApi#chatPostConvosImport")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
file java.io.File [optional]

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

chatPostConvosUpdate

kotlin.Any chatPostConvosUpdate(chatPostConvosUpdateRequest)

Update a conversation title

Example

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

val apiInstance = ConversationsApi()
val chatPostConvosUpdateRequest : ChatPostConvosUpdateRequest =  // ChatPostConvosUpdateRequest | 
try {
    val result : kotlin.Any = apiInstance.chatPostConvosUpdate(chatPostConvosUpdateRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConversationsApi#chatPostConvosUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConversationsApi#chatPostConvosUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
chatPostConvosUpdateRequest ChatPostConvosUpdateRequest

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