Conversations API

The Conversations API enables you to manage voice and text interactions between users and AI agents. It provides endpoints for creating, retrieving, and managing conversation sessions

Features

• Persistent Sessions: Create and manage long-running conversations with agents

• Message History: Store and retrieve complete conversation transcripts

• Real-time Voice: Start voice conversations with LiveKit integration

• Conversation Status: Track active, completed, or archived conversations

• Message Types: Support for system messages, user inputs, and agent responses

• Metadata Storage: Track creation time, participants, and conversation context

Use Cases

• Customer Support: Track customer interactions with support agents

• Training Sessions: Record educational conversations for review

• Voice Assistants: Manage ongoing dialogues with voice-enabled agents

• Documentation: Keep records of important conversations

• Analytics: Analyze conversation patterns and agent performance

Conversations can be created, retrieved, and managed through simple API calls, allowing you to build sophisticated applications with persistent dialogue history and real-time voice capabilities.

Key Concepts

• Conversation: A session between a user and an agent

• Messages: Individual exchanges within a conversation

• Room: LiveKit room for real-time voice interaction

• Status: Current state of the conversation (active/completed)

• Transcript: Complete record of all messages in a conversation

The API provides a robust foundation for building applications that require sophisticated dialogue management and voice interaction capabilities.