Skip to main content
GET
/
v1
/
public
/
chat
/
sessions
List Chat Sessions
curl --request GET \
  --url https://prod.eigi.ai/v1/public/chat/sessions \
  --header 'X-API-Key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "chat.session",
      "created_at": 123,
      "updated_at": 123,
      "agent_id": "<string>",
      "conversation_name": "<string>",
      "message_count": 123,
      "metadata": {}
    }
  ],
  "has_more": true,
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

​
Overview

This endpoint returns all chat sessions created through your agents. Use it to monitor chat activity, review conversation history, and manage ongoing sessions.

​
Authentication

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

​
Query Parameters

​
page
integer
default:"1"
Page number to retrieve (minimum: 1)
​
page_size
integer
default:"10"
Number of items per page (minimum: 1, maximum: 100)
​
agent_id
string
Filter sessions by a specific agent ID. Example: 68ea2517dbb84c09bae1ba0a

​
Response

​
object
string
Always "list" for list responses.
​
data
array
Array of chat session objects.
​
has_more
boolean
Whether there are more results available beyond this page.
​
total
integer
Total number of sessions matching the query.
​
page
integer
Current page number.
​
page_size
integer
Number of items per page.
​
total_pages
integer
Total number of pages available.

​
Session Object

​
id
string
Unique identifier for the chat session.
​
object
string
Always "chat.session" for session objects.
​
created_at
integer
Unix timestamp when the session was created.
​
updated_at
integer
Unix timestamp when the session was last updated.
​
agent_id
string
ID of the agent handling this session.
​
conversation_name
string
Name or identifier for the conversation.
​
message_count
integer
Total number of messages in the session.
​
metadata
object
Custom metadata attached to the session.

​
Examples

​
List All Sessions

curl -X GET "https://prod.eigi.ai/v1/public/chat/sessions?page=1&page_size=10" \
  -H "X-API-Key: vk_your_api_key_here"

​
Filter by Agent

curl -X GET "https://prod.eigi.ai/v1/public/chat/sessions?agent_id=68ea2517dbb84c09bae1ba0a" \
  -H "X-API-Key: vk_your_api_key_here"

​
Response Example

{
  "object": "list",
  "data": [
    {
      "id": "58a6b549-ef07-4a31-86bc-0eb0e026840a",
      "object": "chat.session",
      "created_at": 1701792000,
      "updated_at": 1701792100,
      "agent_id": "68ea2517dbb84c09bae1ba0a",
      "conversation_name": "Support Chat",
      "message_count": 12,
      "metadata": {
        "user_id": "user_123",
        "source": "website"
      }
    },
    {
      "id": "a7c3d421-b89e-4f12-9c6a-1e2f3g4h5i6j",
      "object": "chat.session",
      "created_at": 1701788400,
      "updated_at": 1701789500,
      "agent_id": "68ea2517dbb84c09bae1ba0a",
      "conversation_name": "Product Inquiry",
      "message_count": 8,
      "metadata": {}
    }
  ],
  "has_more": true,
  "total": 45,
  "page": 1,
  "page_size": 10,
  "total_pages": 5
}

​
Error Responses

Status CodeDescription
401 UnauthorizedMissing, invalid, inactive, or expired API key
403 ForbiddenAPI key owner doesn’t have access to the specified agent
Example Error Response
{
  "detail": "Invalid API key"
}

​
Use Cases

Analytics Dashboard

Track chat volume, session counts, and engagement metrics

Customer Support

Monitor active chat sessions and review conversation history

Quality Assurance

Review chat interactions for training and improvement

CRM Integration

Sync chat sessions with your customer management system

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
page
integer
default:1

Page number (minimum: 1)

Required range: x >= 1
​
page_size
integer
default:10

Items per page (minimum: 1, maximum: 100)

Required range: 1 <= x <= 100
​
agent_id
string

Filter sessions by agent ID

Response

Successfully retrieved chat sessions

​
object
string
Example:

"list"

​
data
object[]
​
has_more
boolean
​
total
integer
​
page
integer
​
page_size
integer
​
total_pages
integer