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]>
21 KiB
MessagesApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| chatDeleteMessagesByconversationidBymessageid | DELETE /v1/chat/messages/{conversationId}/{messageId} | Delete a message |
| chatGetMessages | GET /v1/chat/messages | Query messages |
| chatGetMessagesByconversationid | GET /v1/chat/messages/{conversationId} | Get all messages in a conversation |
| chatGetMessagesByconversationidBymessageid | GET /v1/chat/messages/{conversationId}/{messageId} | Get a specific message |
| chatPostMessagesArtifactBymessageid | POST /v1/chat/messages/artifact/{messageId} | Edit artifact content in a message |
| chatPostMessagesBranch | POST /v1/chat/messages/branch | Create a branch message |
| chatPostMessagesByconversationid | POST /v1/chat/messages/{conversationId} | Save a message to a conversation |
| chatPutMessagesByconversationidBymessageid | PUT /v1/chat/messages/{conversationId}/{messageId} | Update a message |
| chatPutMessagesByconversationidBymessageidFeedback | PUT /v1/chat/messages/{conversationId}/{messageId}/feedback | Update message feedback |
| streamConsumeMessages | GET /v1/stream/topics/{topic}/messages | Consume messages |
| streamProduceMessages | POST /v1/stream/topics/{topic}/messages | Produce messages |
chatDeleteMessagesByconversationidBymessageid
chatDeleteMessagesByconversationidBymessageid(conversationId, messageId)
Delete a message
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val conversationId : kotlin.String = conversationId_example // kotlin.String |
val messageId : kotlin.String = messageId_example // kotlin.String |
try {
apiInstance.chatDeleteMessagesByconversationidBymessageid(conversationId, messageId)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatDeleteMessagesByconversationidBymessageid")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatDeleteMessagesByconversationidBymessageid")
e.printStackTrace()
}
Parameters
| conversationId | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| messageId | 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: Not defined
chatGetMessages
ChatGetMessages200Response chatGetMessages(conversationId, messageId, search, cursor, pageSize, sortBy, sortDirection)
Query messages
Search messages or retrieve by conversation/message ID.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val conversationId : kotlin.String = conversationId_example // kotlin.String |
val messageId : kotlin.String = messageId_example // kotlin.String |
val search : kotlin.String = search_example // kotlin.String |
val cursor : kotlin.String = cursor_example // kotlin.String |
val pageSize : kotlin.Int = 56 // kotlin.Int |
val sortBy : kotlin.String = sortBy_example // kotlin.String |
val sortDirection : kotlin.String = sortDirection_example // kotlin.String |
try {
val result : ChatGetMessages200Response = apiInstance.chatGetMessages(conversationId, messageId, search, cursor, pageSize, sortBy, sortDirection)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatGetMessages")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatGetMessages")
e.printStackTrace()
}
Parameters
| conversationId | kotlin.String| | [optional] | | messageId | kotlin.String| | [optional] | | search | kotlin.String| | [optional] | | cursor | kotlin.String| | [optional] | | pageSize | kotlin.Int| | [optional] [default to 25] | | sortBy | kotlin.String| | [optional] [default to "createdAt"] |
| Name | Type | Description | Notes |
|---|---|---|---|
| sortDirection | kotlin.String | [optional] [default to "desc"] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
chatGetMessagesByconversationid
kotlin.collections.List<ChatMessage> chatGetMessagesByconversationid(conversationId)
Get all messages in a conversation
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val conversationId : kotlin.String = conversationId_example // kotlin.String |
try {
val result : kotlin.collections.List<ChatMessage> = apiInstance.chatGetMessagesByconversationid(conversationId)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatGetMessagesByconversationid")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatGetMessagesByconversationid")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| conversationId | kotlin.String |
Return type
kotlin.collections.List<ChatMessage>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
chatGetMessagesByconversationidBymessageid
ChatMessage chatGetMessagesByconversationidBymessageid(conversationId, messageId)
Get a specific message
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val conversationId : kotlin.String = conversationId_example // kotlin.String |
val messageId : kotlin.String = messageId_example // kotlin.String |
try {
val result : ChatMessage = apiInstance.chatGetMessagesByconversationidBymessageid(conversationId, messageId)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatGetMessagesByconversationidBymessageid")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatGetMessagesByconversationidBymessageid")
e.printStackTrace()
}
Parameters
| conversationId | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| messageId | 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
chatPostMessagesArtifactBymessageid
ChatPostMessagesArtifactBymessageid200Response chatPostMessagesArtifactBymessageid(messageId, chatPostMessagesArtifactBymessageidRequest)
Edit artifact content in a message
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val messageId : kotlin.String = messageId_example // kotlin.String |
val chatPostMessagesArtifactBymessageidRequest : ChatPostMessagesArtifactBymessageidRequest = // ChatPostMessagesArtifactBymessageidRequest |
try {
val result : ChatPostMessagesArtifactBymessageid200Response = apiInstance.chatPostMessagesArtifactBymessageid(messageId, chatPostMessagesArtifactBymessageidRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatPostMessagesArtifactBymessageid")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatPostMessagesArtifactBymessageid")
e.printStackTrace()
}
Parameters
| messageId | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| chatPostMessagesArtifactBymessageidRequest | ChatPostMessagesArtifactBymessageidRequest |
Return type
ChatPostMessagesArtifactBymessageid200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
chatPostMessagesBranch
ChatMessage chatPostMessagesBranch(chatPostMessagesBranchRequest)
Create a branch message
Branch a specific agent's content from a parallel response message.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val chatPostMessagesBranchRequest : ChatPostMessagesBranchRequest = // ChatPostMessagesBranchRequest |
try {
val result : ChatMessage = apiInstance.chatPostMessagesBranch(chatPostMessagesBranchRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatPostMessagesBranch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatPostMessagesBranch")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| chatPostMessagesBranchRequest | ChatPostMessagesBranchRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
chatPostMessagesByconversationid
ChatMessage chatPostMessagesByconversationid(conversationId, chatMessage)
Save a message to a conversation
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val conversationId : kotlin.String = conversationId_example // kotlin.String |
val chatMessage : ChatMessage = // ChatMessage |
try {
val result : ChatMessage = apiInstance.chatPostMessagesByconversationid(conversationId, chatMessage)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatPostMessagesByconversationid")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatPostMessagesByconversationid")
e.printStackTrace()
}
Parameters
| conversationId | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| chatMessage | ChatMessage |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
chatPutMessagesByconversationidBymessageid
kotlin.Any chatPutMessagesByconversationidBymessageid(conversationId, messageId, chatPutMessagesByconversationidBymessageidRequest)
Update a message
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val conversationId : kotlin.String = conversationId_example // kotlin.String |
val messageId : kotlin.String = messageId_example // kotlin.String |
val chatPutMessagesByconversationidBymessageidRequest : ChatPutMessagesByconversationidBymessageidRequest = // ChatPutMessagesByconversationidBymessageidRequest |
try {
val result : kotlin.Any = apiInstance.chatPutMessagesByconversationidBymessageid(conversationId, messageId, chatPutMessagesByconversationidBymessageidRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatPutMessagesByconversationidBymessageid")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatPutMessagesByconversationidBymessageid")
e.printStackTrace()
}
Parameters
| conversationId | kotlin.String| | | | messageId | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| chatPutMessagesByconversationidBymessageidRequest | ChatPutMessagesByconversationidBymessageidRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
chatPutMessagesByconversationidBymessageidFeedback
ChatPutMessagesByconversationidBymessageidFeedback200Response chatPutMessagesByconversationidBymessageidFeedback(conversationId, messageId, chatPutMessagesByconversationidBymessageidFeedbackRequest)
Update message feedback
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val conversationId : kotlin.String = conversationId_example // kotlin.String |
val messageId : kotlin.String = messageId_example // kotlin.String |
val chatPutMessagesByconversationidBymessageidFeedbackRequest : ChatPutMessagesByconversationidBymessageidFeedbackRequest = // ChatPutMessagesByconversationidBymessageidFeedbackRequest |
try {
val result : ChatPutMessagesByconversationidBymessageidFeedback200Response = apiInstance.chatPutMessagesByconversationidBymessageidFeedback(conversationId, messageId, chatPutMessagesByconversationidBymessageidFeedbackRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#chatPutMessagesByconversationidBymessageidFeedback")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#chatPutMessagesByconversationidBymessageidFeedback")
e.printStackTrace()
}
Parameters
| conversationId | kotlin.String| | | | messageId | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| chatPutMessagesByconversationidBymessageidFeedbackRequest | ChatPutMessagesByconversationidBymessageidFeedbackRequest |
Return type
ChatPutMessagesByconversationidBymessageidFeedback200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
streamConsumeMessages
StreamConsumeMessages200Response streamConsumeMessages(topic, partition, offset, limit, timeout)
Consume messages
Consume messages from a topic partition via REST API. For persistent consumption, use the Kafka wire protocol with consumer groups.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val topic : kotlin.String = topic_example // kotlin.String |
val partition : kotlin.Int = 56 // kotlin.Int | Partition to consume from
val offset : kotlin.String = offset_example // kotlin.String | Starting offset (earliest, latest, or numeric offset)
val limit : kotlin.Int = 56 // kotlin.Int | Maximum records to return
val timeout : kotlin.Int = 56 // kotlin.Int | Long-poll timeout in milliseconds
try {
val result : StreamConsumeMessages200Response = apiInstance.streamConsumeMessages(topic, partition, offset, limit, timeout)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#streamConsumeMessages")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#streamConsumeMessages")
e.printStackTrace()
}
Parameters
| topic | kotlin.String| | | | partition | kotlin.Int| Partition to consume from | [optional] [default to 0] | | offset | kotlin.String| Starting offset (earliest, latest, or numeric offset) | [optional] [default to "latest"] | | limit | kotlin.Int| Maximum records to return | [optional] [default to 100] |
| Name | Type | Description | Notes |
|---|---|---|---|
| timeout | kotlin.Int | Long-poll timeout in milliseconds | [optional] [default to 5000] |
Return type
StreamConsumeMessages200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
streamProduceMessages
StreamProduceResponse streamProduceMessages(topic, streamProduceRequest)
Produce messages
Produce one or more messages to a topic via REST API. For high throughput, use the Kafka wire protocol on port 9092.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = MessagesApi()
val topic : kotlin.String = topic_example // kotlin.String |
val streamProduceRequest : StreamProduceRequest = {"records":[{"value":"{\"event\":\"user.signup\",\"user_id\":\"usr_123\"}"}]} // StreamProduceRequest |
try {
val result : StreamProduceResponse = apiInstance.streamProduceMessages(topic, streamProduceRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling MessagesApi#streamProduceMessages")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MessagesApi#streamProduceMessages")
e.printStackTrace()
}
Parameters
| topic | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| streamProduceRequest | StreamProduceRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json