Kotlin SDK › MUXI Documentation

Idiomatic Kotlin access to your agents

Build Kotlin applications that interact with MUXI formations. Full support for chat, streaming with coroutines, and all Formation API operations.

GitHub: muxi-ai/muxi-kotlin
Maven Central: org.muxi:muxi-kotlin

Installation

Gradle (Kotlin DSL)

implementation("org.muxi:muxi-kotlin:0.20260212.0")

Gradle (Groovy)

implementation 'org.muxi:muxi-kotlin:0.20260212.0'

Quick Start

import org.muxi.sdk.FormationClient

val client = FormationClient(
    serverUrl = "http://localhost:7890",
    formationId = "my-assistant",
    clientKey = "your_client_key"
)

// Check health
println(client.health())

Chat (Streaming with Coroutines)

client.chatStream(ChatRequest(message = "Hello!"), userId = "user_123")
    .collect { event ->
        when (event.type) {
            "text" -> print(event.text)
            "done" -> return@collect
        }
    }

Chat (Non-Streaming)

val response = client.chat(ChatRequest(message = "Hello!"), userId = "user_123")
println(response.response)

Memory

// Get memories
val memories = client.getMemories("user_123")

// Add memory
client.addMemory("user_123", "preference", "User prefers Kotlin")

// Clear buffer
client.clearUserBuffer("user_123")

Sessions

// List sessions
val sessions = client.getSessions("user_123")

// Get session messages
val messages = client.getSessionMessages("sess_abc123", "user_123")

Server Client

For managing formations (deploy, start, stop):

import org.muxi.sdk.ServerClient

val server = ServerClient(
    url = "http://localhost:7890",
    keyId = "muxi_pk_...",
    secretKey = "muxi_sk_..."
)

// List formations
val formations = server.listFormations()

// Deploy
server.deployFormation("my-bot.tar.gz")

// Stop/start/restart
server.stopFormation("my-bot")
server.startFormation("my-bot")

Error Handling

import org.muxi.sdk.exceptions.*

try {
    val response = client.chat(ChatRequest(message = "Hello!"), userId = "user_123")
} catch (e: AuthenticationException) {
    println("Auth failed: ${e.message}")
} catch (e: RateLimitException) {
    println("Rate limited, retry after: ${e.retryAfter}s")
} catch (e: MuxiException) {
    println("Error: ${e.code} - ${e.message}")
}

We use cookies