KrosAI Docs
DashboardGet Started
  • Getting Started
    • Introduction
    • Quickstart Guide
    • Authentication
  • OpenAI SDK Compatability
  • Endpoints
    • Completions API
      • Create Chat Completion
    • Translation API
    • Text Summarization API
    • Audio Transcription API
    • Sentiment Analysis API
  • AGENT
    • Agents API
      • Create Agent
      • List Agents
      • Get Agent
      • Update Agent
      • Delete Agent
      • Start Voice Session
    • Conversations API
      • Create Conversation
      • List Conversations
      • Get Conversation
      • Get Conversation Messages
    • Knowledge Base API
      • Create Knowledge Base
      • List Knowledge Base
      • Upload Document
      • List Document
  • Resources
    • AI Voice Agents
    • In-App Voice Assistants
    • Virtual Health Assistants
    • EdTech Language Tutors
  • SDKS
    • Node.JS SDK
    • React Native SDK
    • Flutter
Powered by GitBook
On this page
  • Endpoint
  • Parameters
  • Authentication
  • Response
  • Example Request
  • Example Response
  • Error Responses
  • Notes
  1. AGENT
  2. Conversations API

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

curl -X GET "https://api.krosai.com/v1/conversations/conv-b2c3d4e5-f6g7-8901-bcde-fg2345678901" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "id": "conv-b2c3d4e5-f6g7-8901-bcde-fg2345678901",
  "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "title": "Product Support Session",
  "created_at": "2023-07-10T15:30:00Z",
  "updated_at": "2023-07-10T15:30:00Z",
  "created_by": "user-12345",
  "status": "active",
  "room_name": "conv-b2c3d4e5-f6g7-8901-bcde-fg2345678901",
  "room_url": "wss://livekit.krosai.com/room/conv-b2c3d4e5-f6g7-8901-bcde-fg2345678901",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

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

PreviousList ConversationsNextGet Conversation Messages

Last updated 2 months ago