voxta-client 0.1.1

A Python client library for interacting with the Voxta conversational AI platform via SignalR.

Voxta Client

A core library for interacting with the Voxta conversational AI platform using Python. This client enables real-time communication with Voxta characters using the SignalR protocol.

Documentation

Full documentation is available at dion-labs.github.io/voxta-client.

Compatibility

• Voxta Server: Designed for and tested with v1.2.1.
• Python: Supports 3.9+.

Features

• Real-time Interaction: Full support for Voxta's SignalR/WebSockets protocol.
• Event-Driven: Simple callback system for handling server events (messages, state changes, etc.).
• Session Management: Easy handling of chat sessions, character selection, and context updates.
• Lightweight: Minimal dependencies, built for performance and reliability.

Protocol Support Matrix

This client implements the Voxta SignalR protocol. Below is the current support status compared to the full server capabilities.

Category	Feature	Protocol Method	Status
Core	Authentication	authenticate	✅ Supported
	App Registration	registerApp	✅ Supported
	Chat Subscription	subscribeToChat	✅ Supported
Messaging	Start Chat	startChat	✅ Supported
	Resume Chat	resumeChat	✅ Supported
	Send Message	send	✅ Supported
	Character Speech Req	characterSpeechRequest	✅ Supported
Control	Interrupt	interrupt	✅ Supported
	Pause	pause	✅ Supported
	Inspect Session	inspect	✅ Supported
Context	Update Context	updateContext	✅ Supported
	Actions/Events	updateContext	✅ Supported
	Role Management	enableRoles	✅ Supported
Media	Playback Sync	speechPlaybackStart/Complete	✅ Supported
	Audio Streaming	WebSocketStream (PCM)	❌ Not Planned
	Vision / Images	visionCapture	❌ Not Planned

Installation

pip install voxta-client

Quick Start

import asyncio
from voxta_client import VoxtaClient

async def main():
    # 1. Initialize the client
    client = VoxtaClient("http://localhost:5384")
    
    # Set up event listeners
    @client.on("message")
    async def on_message(payload):
        if payload.get("senderType") == "Character":
            print(f"\nCharacter: {payload.get('text')}")

    # 2. Negotiate authentication
    print("Negotiating connection...")
    token, cookies = client.negotiate()
    
    # 3. Connect (runs the message loop in the background)
    connection_task = asyncio.create_task(client.connect(token, cookies))
    
    # Wait for the client to be ready (connected and session pinned)
    # The 'ready' event is triggered once a sessionId is acquired
    ready_event = asyncio.Event()
    client.on("ready", lambda _: ready_event.set())
    
    print("Connecting to Voxta...")
    await ready_event.wait()
    print(f"Connected! Session ID: {client.session_id}")

    # 4. Send a message
    print("Sending message...")
    await client.send_message("Hello! Tell me a short story.")
    
    # Wait for response
    await asyncio.sleep(10)
    
    # Clean up
    await client.close()
    await connection_task

if __name__ == "__main__":
    asyncio.run(main())

Development

This project uses uv for dependency management and Ruff for linting.

Setup

# Clone the repository
git clone https://github.com/dion-labs/voxta-client.git
cd voxta-client

# Install dependencies and setup venv
uv sync --all-extras

# Install pre-commit hooks
uv run pre-commit install

License

This project is licensed under the MIT License - see the LICENSE file for details.