Command Palette

Search for a command to run...

Session API

Manage and retrieve chat sessions.

Overview

The Session API provides endpoints for managing the lifecycle of chat sessions, retrieving conversation history, and analyzing user interactions.

Endpoints

GET/v1/sessions

Retrieves a list of all sessions in a workspace.

Query Parameters

  • agent_id (optional): Filter sessions by agent ID.
  • user_id (optional): Filter sessions by user ID.
  • status (optional): Filter sessions by status (e.g., active, closed).

GET/v1/sessions/{session_id}

Retrieves details about a specific session, including its message history.

POST/v1/sessions

Creates a new session. This is useful for initializing a conversation before sending the first message.

Request Body

{
  "agent_id": "string",
  "user_id": "string", // Optional
  "metadata": { // Optional custom data
    "source": "web_widget"
  }
}

DELETE/v1/sessions/{session_id}

Deletes a session and its associated message history.

PreviousChat APINextWebhook API