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 Concurrence platform.

Overview

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

API Endpoints

Conversation Management

• Create: initialize new conversations with agents; the endpoint contract is embedded on the reference page

• Starters: generate contextual conversation starters

• Interact: send messages and receive AI responses through the embedded endpoint contract

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

• Lifecycle & Finish: 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 (WebSocket): bidirectional voice transport documented separately because WebSocket routes are not represented in the HTTP OpenAPI schema

• External Events & Multi-Stream (WebSocket): interleave external events with user text and audio on a single WebSocket connection

• Conversation History: retrieve conversations, messages, tags, and interaction insights

Key Features

• Contextual Memory: conversations keep context across multiple interactions.

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

• Real-time Streaming: NDJSON event streams 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 (the acting user is identified via the JWT)
const events = await amigo.conversations.createConversation(
  { service_id: "<SERVICE-ID>", service_version_set_name: "release" },
  { response_format: "text" }
);

// Events are delivered as the NDJSON stream returned by create/interact.
// Iterate the stream rather than subscribing to a separate events endpoint.
let conversationId;
for await (const event of events) {
  if (event.type === "conversation-created") {
    conversationId = event.conversation_id;
  }
  if (event.type === "new-message") {
    console.log("New message:", event.message);
  }
}

// Send a message and iterate the returned event stream until interaction-complete
const interactEvents = await amigo.conversations.interactWithConversation(
  conversationId,
  "Hello, I need help with my order",
  { request_format: "text", response_format: "text" }
);

for await (const event of interactEvents) {
  if (event.type === "new-message") {
    console.log("New message:", event.message);
  }
}

Related Documentation

• Authentication

• SDK Reference

• Conversation History