List Chat Sessions

curl --request GET \
  --url https://api.eigi.ai/v1/public/chat/sessions \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.eigi.ai/v1/public/chat/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eigi.ai/v1/public/chat/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eigi.ai/v1/public/chat/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.eigi.ai/v1/public/chat/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

public

chat

sessions

List Chat Sessions

curl --request GET \
  --url https://api.eigi.ai/v1/public/chat/sessions \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.eigi.ai/v1/public/chat/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eigi.ai/v1/public/chat/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eigi.ai/v1/public/chat/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.eigi.ai/v1/public/chat/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

string

required

Your eigi.ai API key. Must be prefixed with vk_.

Query Parameters

integer

default:"1"

Page number to retrieve (minimum: 1)

integer

default:"10"

Number of items per page (minimum: 1, maximum: 100)

string

Filter sessions by a specific agent ID. Example: 68ea2517dbb84c09bae1ba0a

Response

string

Always "list" for list responses.

array

Array of chat session objects.

boolean

Whether there are more results available beyond this page.

integer

Total number of sessions matching the query.

integer

Current page number.

integer

Number of items per page.

integer

Total number of pages available.

Session Object

string

Unique identifier for the chat session.

string

Always "chat.session" for session objects.

integer

Unix timestamp when the session was created.

integer

Unix timestamp when the session was last updated.

string

ID of the agent handling this session.

string

Name or identifier for the conversation.

integer

Total number of messages in the session.

object

Custom metadata attached to the session.

Examples

List All Sessions

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

import requests

response = requests.get(
    "https://api.eigi.ai/v1/public/chat/sessions",
    headers={"X-API-Key": "vk_your_api_key_here"},
    params={"page": 1, "page_size": 10}
)

data = response.json()
for session in data["data"]:
    print(f"Session: {session['id']} - Messages: {session['message_count']}")

const response = await fetch(
  "https://api.eigi.ai/v1/public/chat/sessions?page=1&page_size=10",
  {
    headers: {
      "X-API-Key": "vk_your_api_key_here",
    },
  }
);

const data = await response.json();
data.data.forEach((session) => {
  console.log(`Session: ${session.id} - Messages: ${session.message_count}`);
});

Filter by Agent

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

import requests

response = requests.get(
    "https://api.eigi.ai/v1/public/chat/sessions",
    headers={"X-API-Key": "vk_your_api_key_here"},
    params={"agent_id": "68ea2517dbb84c09bae1ba0a"}
)

data = response.json()
print(f"Found {data['total']} sessions for this agent")

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 Code	Description
401 Unauthorized	Missing, invalid, inactive, or expired API key
403 Forbidden	API 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[]

Show child attributes

has_more

boolean

total

integer

page

integer

page_size

integer

total_pages

integer

Send Chat Message Get Chat Session

Overview

Conversations

Chat

Prompts

Agents

Utilities

List Chat Sessions

Overview

Authentication

Query Parameters

Response

Session Object

Examples

List All Sessions

Filter by Agent

Response Example

Error Responses

Use Cases

Analytics Dashboard

Customer Support

Quality Assurance

CRM Integration

Authorizations

Query Parameters

Response

​Overview

​Authentication

​Query Parameters

​Response

​Session Object

​Examples

​List All Sessions

​Filter by Agent

​Response Example

​Error Responses

​Use Cases

Analytics Dashboard

Customer Support

Quality Assurance

CRM Integration

Authorizations

Query Parameters

Response

Overview

Authentication

Query Parameters

Response

Session Object

Examples

List All Sessions

Filter by Agent

Response Example

Error Responses

Use Cases