Conversations

Core conversation API for creating, interacting with, and managing AI-powered conversations.

The Conversations API is the core interface for managing AI-powered interactions on the Amigo platform.

Overview

Conversations are the primary way users interact with Amigo agents. Each conversation maintains context, manages state, and handles the flow of messages between users and the AI.

API Endpoints

Conversation Management

• Create: POST /v1/{organization}/conversation/, initialize new conversations with agents

• Starters: POST /conversation/conversation_starter, generate contextual conversation starters

• Interact: POST /v1/{organization}/conversation/{conversation_id}/interact, send messages and receive AI responses

• Events: events are delivered as the NDJSON stream returned by the Create and Interact endpoints

• Lifecycle: POST /v1/{organization}/conversation/{conversation_id}/finish/ (204 No Content), manage conversation states and completion

• Voice: text-channel voice uses the Interact endpoint with request_format=voice rather than a separate /voice path

• Real-time Voice: WSS /conversation/converse_realtime, WebSocket endpoint for real-time voice conversations

Key Features

• Contextual Memory: conversations keep context across multiple interactions.

• Multi-modal Support: text, voice, and structured data inputs.

• Real-time Streaming: server-sent events for live updates.

• WebSocket Support: low-latency bidirectional communication for real-time voice.

• Voice Activity Detection: automatic speech detection in real-time mode.

• State Management: track and control conversation flow.

• Voice Integration: voice-to-text and text-to-voice.

• Automatic Audio Fillers: handles perceived latency during voice interactions.

Common Use Cases

1. Customer Support: automated support conversations with context awareness.

2. Virtual Assistants: personal AI assistants with memory and learning.

3. Interactive Workflows: guide users through complex processes.

4. Voice Interfaces: natural language voice interactions.

Quick Start

// Create a new conversation
const conversation = await amigo.conversations.create({
  agent_id: "agent_123",
  user_id: "user_456"
});

// Send a message
const response = await amigo.conversations.interact(conversation.id, {
  message: "Hello, I need help with my order"
});

// Listen for events
const events = amigo.conversations.events(conversation.id);
events.on('message', (data) => {
  console.log('New message:', data);
});

Related Documentation

• Authentication

• SDK Reference

• Conversation History