Skip to main content
GET
/
v1
/
public
/
conversations
/
{conversation_id}
curl -X GET "https://api.eigi.ai/v1/public/conversations/a28e7071-508e-4d45-8887-085531aafaba" \
  -H "X-API-Key: vk_your_api_key_here"

{
  "agent_id": "68ea2517dbb84c09bae1ba0a",
  "conversation_id": "a28e7071-508e-4d45-8887-085531aafaba",
  "conversation_type": "CHAT",
  "conversation_analysis": null,
  "conversation_status": "IN_PROGRESS",
  "notes": null,
  "conversation_transcript": [
    {
      "role": "user",
      "content": "hi",
      "timestamp": "2025-12-03T14:14:23.735228+00:00"
    },
    {
      "role": "assistant",
      "content": "Hi there! How can I help you today?",
      "timestamp": "2025-12-03T14:14:23.738544+00:00"
    },
    {
      "role": "user",
      "content": "who are you ?",
      "timestamp": "2025-12-03T14:14:46.605904+00:00"
    },
    {
      "role": "assistant",
      "content": "I am a large language model, trained by Google.",
      "timestamp": "2025-12-03T14:14:46.610178+00:00"
    }
  ],
  "created_by": null,
  "conversation_metadata": {
    "last_activity": "2025-12-03T14:15:20.985321+00:00",
    "session_status": "active"
  },
  "created_at": "2025-12-03T14:14:22.719000",
  "updated_at": "2025-12-03T14:15:20.985000",
  "id": "69316c7d6519e8d49433e40b"
}

​
Overview

This endpoint retrieves comprehensive details about a conversation, including status, transcript, analysis, and metadata. Use this to fetch conversation data after a call has been completed or while it’s in progress.

​
Authentication

​
X-API-Key
string
required
Your eigi.ai API key. Must be prefixed with vk_.

​
Path Parameters

​
conversation_id
string
required
The unique identifier (UUID format) of the conversation to retrieve.Example: 35d33a43-176c-405c-92bf-db972035df28

​
Response

​
agent_id
string
ID of the agent that handled this conversation
​
conversation_id
string
Unique identifier (UUID) for the conversation
​
conversation_type
string
Type of conversation: DAILY, TELEPHONY, WHATSAPP, or CHAT
​
conversation_analysis
array | null
AI-generated analysis of the conversation. Returns null if analysis hasn’t been performed yet.
​
conversation_status
string
Current status: IN_PROGRESS, COMPLETED, DISCONNECTED, or FAILED
​
notes
string | null
Additional notes or annotations for the conversation
​
conversation_transcript
array | null
Array of conversation messages. Each message contains: - role: user or assistant - content: The message text - timestamp: ISO 8601 timestamp
​
created_by
string | null
User ID who created/initiated the conversation
​
conversation_metadata
object
Metadata associated with the conversation. For CHAT type includes last_activity and session_status. For TELEPHONY includes to_mobile_number, from_mobile_number, calling_type, telephony_provider, conversation_recording_url, and conversation_duration.
​
created_at
datetime
Timestamp when the conversation was created
​
updated_at
datetime
Timestamp of the last update to the conversation
​
id
string
Internal MongoDB document ID
curl -X GET "https://api.eigi.ai/v1/public/conversations/a28e7071-508e-4d45-8887-085531aafaba" \
  -H "X-API-Key: vk_your_api_key_here"

{
  "agent_id": "68ea2517dbb84c09bae1ba0a",
  "conversation_id": "a28e7071-508e-4d45-8887-085531aafaba",
  "conversation_type": "CHAT",
  "conversation_analysis": null,
  "conversation_status": "IN_PROGRESS",
  "notes": null,
  "conversation_transcript": [
    {
      "role": "user",
      "content": "hi",
      "timestamp": "2025-12-03T14:14:23.735228+00:00"
    },
    {
      "role": "assistant",
      "content": "Hi there! How can I help you today?",
      "timestamp": "2025-12-03T14:14:23.738544+00:00"
    },
    {
      "role": "user",
      "content": "who are you ?",
      "timestamp": "2025-12-03T14:14:46.605904+00:00"
    },
    {
      "role": "assistant",
      "content": "I am a large language model, trained by Google.",
      "timestamp": "2025-12-03T14:14:46.610178+00:00"
    }
  ],
  "created_by": null,
  "conversation_metadata": {
    "last_activity": "2025-12-03T14:15:20.985321+00:00",
    "session_status": "active"
  },
  "created_at": "2025-12-03T14:14:22.719000",
  "updated_at": "2025-12-03T14:15:20.985000",
  "id": "69316c7d6519e8d49433e40b"
}

​
Error Responses

​
Status Codes

Status CodeDescription
200Successfully retrieved conversation
401Missing, invalid, inactive, or expired API key
403API key owner doesn’t have access to this conversation
404Conversation not found
500Internal server error

​
Use Cases

After initiating an outbound call, use this endpoint to fetch the complete transcript, analysis, and outcome of the conversation.
Check the status and real-time transcript of ongoing conversations to monitor agent performance.
Pull conversation data for analytics, reporting, or integration with CRM systems.
Review conversation transcripts and analysis for quality assurance and agent training purposes.

​
Notes

  • Only conversations associated with agents owned by the API key holder can be accessed
  • Conversation data is retained for 90 days by default (configurable in settings)
  • Real-time transcripts are available for ongoing conversations
  • Analysis data is generated automatically after conversation completion

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get your API key from the eigi.ai Dashboard under Settings → API Keys.

Path Parameters

​
conversation_id
string
required

The unique identifier (UUID format) of the conversation to retrieve

Response

Successfully retrieved conversation

​
conversation_id
string

Unique identifier for the conversation

​
agent_id
string

ID of the agent that handled this conversation

​
conversation_type
enum<string>

Type of conversation

Available options:
DAILY,
TELEPHONY,
WHATSAPP,
CHAT
​
conversation_status
enum<string>

Current status of the conversation

Available options:
IN_PROGRESS,
COMPLETED,
DISCONNECTED,
FAILED
​
calling_type
enum<string>

Direction of the call

Available options:
INBOUND,
OUTBOUND
​
mobile_number
string

Phone number involved in the conversation

​
duration
number

Total duration of the conversation in seconds

​
created_at
string<date-time>

Timestamp when the conversation was created

​
updated_at
string<date-time>

Timestamp of the last update

​
transcript
object[]

Array of conversation messages

​
analysis
object

AI-generated analysis of the conversation

​
metadata
object

Custom metadata