Introduction

Overview

The Conversations API allows you to access conversation history for your company's customer users. This is useful for analytics, support tools, conversation exports, and integrations.

What are Conversations?

Conversations are chat sessions between customer users and AI agents. Each conversation contains:

• Title: Auto-generated from first message
• Customer User: The user who started the conversation
• Messages: All messages exchanged in the conversation
• Timestamps: When conversation was created and last updated

Common Use Cases

Analytics

Analyze conversation patterns and user engagement:

const conversations = await listConversations()
console.log(`Total conversations: ${conversations.pagination.total}`)

Export Data

Export conversations for compliance or backup:

const fullConversation = await exportConversationWithMessages(convId)

Support Dashboard

Build custom support tools with conversation data:

const recent = await listConversations(1, 10)

Available Endpoints

• List Conversations - Get all conversations
• Get Conversation - Get conversation details
• Get Messages - Get conversation messages
• Examples - Code examples and use cases

Authentication

All conversation endpoints require API Key authentication:

{
  "keyId": "your-key-id",
  "keySecret": "your-key-secret"
}

Pagination

All list endpoints support pagination:

Next Steps

• Learn how to list conversations
• Learn how to get messages
• See code examples for common use cases