API Reference

Beta

Chat

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Session Summary

ChatGetSummaryResponse Beta.Chat.GetSummary(ChatGetSummaryParamsparameters, CancellationTokencancellationToken = default)

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

Retrieve a session summary by ID.

ParametersExpand Collapse

ChatGetSummaryParams parameters

required string sessionID

string? organizationID

string? projectID

ReturnsExpand Collapse

class ChatGetSummaryResponse:

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

required string LastUpdatedAt

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

required string SessionID

Unique session identifier.

string? GeneratedTitle

Auto-generated title derived from the first user message.

IReadOnlyList<string>? IndexIds

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

JobMetadata? JobMetadata

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

Double DurationMs

string? Error

IReadOnlyList<string>? ExportConfigIds

Boolean IsError

Long? TotalInputTokens

Long? TotalOutputTokens

Long Turns

Get Session Summary

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

ChatGetSummaryParams parameters = new() { SessionID = "session_id" };

var response = await client.Beta.Chat.GetSummary(parameters);

Console.WriteLine(response);

200 example

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

200 example

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