Get Session Summary

client.beta.chat.getSummary(, ?, ?): ChatGetSummaryResponse { last_updated_at, session_id, generated_title, 2 more }

GET/api/v1/chat/{session_id}/summary

Retrieve a session summary by ID.

ParametersExpand Collapse

sessionID: string

query: ChatGetSummaryParams { organization_id, project_id }

organization_id?: string | null

project_id?: string | null

ReturnsExpand Collapse

ChatGetSummaryResponse { last_updated_at, session_id, generated_title, 2 more }

Summary of a chat session, including its title and last run metadata.

last_updated_at: string

ISO-format timestamp showing when the session was last updated.

session_id: string

Unique session identifier.

generated_title?: string | null

Auto-generated title derived from the first user message.

index_ids?: Array<string> | null

Indexes this session is bound to. Null on unbound sessions.

job_metadata?: JobMetadata | null

Token usage and status from the most recent run. Null if the session has not been run yet.

duration_ms?: number

error?: string | null

export_config_ids?: Array<string> | null

is_error?: boolean

total_input_tokens?: number | null

total_output_tokens?: number | null

turns?: number

Get Session Summary

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.beta.chat.getSummary('session_id');

console.log(response.session_id);

{
  "last_updated_at": "2026-04-22T12:34:41.342245",
  "session_id": "ses-abc123",
  "generated_title": "What were the main findings in Q3?...",
  "index_ids": [
    "idx-abc123",
    "idx-def456"
  ],
  "job_metadata": {
    "duration_ms": 0,
    "error": "error",
    "export_config_ids": [
      "string"
    ],
    "is_error": true,
    "total_input_tokens": 0,
    "total_output_tokens": 0,
    "turns": 0
  }
}

Returns Examples

{
  "last_updated_at": "2026-04-22T12:34:41.342245",
  "session_id": "ses-abc123",
  "generated_title": "What were the main findings in Q3?...",
  "index_ids": [
    "idx-abc123",
    "idx-def456"
  ],
  "job_metadata": {
    "duration_ms": 0,
    "error": "error",
    "export_config_ids": [
      "string"
    ],
    "is_error": true,
    "total_input_tokens": 0,
    "total_output_tokens": 0,
    "turns": 0
  }
}