Get Conversation

Retrieves details about a specific conversation.

Endpoint

GET /v1/conversations/{conversation_id}

Parameters

Parameter
Type
Required
Description

conversation_id

string

Yes

Unique identifier of the conversation to retrieve

Authentication

Requires a valid API key or user authentication token.

Response

Returns the conversation object with its complete details.

Response Format

{
  "id": "string",
  "agent_id": "string",
  "title": "string",
  "created_at": "datetime",
  "updated_at": "datetime",
  "created_by": "string",
  "status": "string",
  "room_name": "string",
  "room_url": "string",
  "token": "string"
}

Response Fields

Field
Type
Description

id

string

Unique identifier for the conversation

agent_id

string

ID of the agent participating in the conversation

title

string

Title of the conversation

created_at

datetime

When the conversation was created

updated_at

datetime

When the conversation was last updated

created_by

string

ID of the user who created the conversation

status

string

Current status ("active", "completed")

room_name

string

LiveKit room identifier

room_url

string

WebSocket URL for LiveKit connection

token

string

Authentication token for the room

Example Request

Example Response

Error Responses

Status Code
Description

401

Unauthorized - Invalid or missing API key

403

Forbidden - Not authorized to access this conversation

404

Not Found - Conversation with the specified ID does not exist

500

Internal Server Error

Notes

  • Users can only retrieve conversations they have created

  • For active conversations, the LiveKit token is refreshed upon retrieval

  • Room connection details remain available even for completed conversations

  • The conversation status indicates whether the session is still active

Last updated