Skip to main content
GET
Get a chat session
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/chat/getSession?id=<sessionId> returns one session in a channel you may read (see row visibility). A session with restricted participants is visible only to the key or External App that started it. A missing, malformed or unreadable session is 404 resource_missing.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

sessionId
string
required

Response

Session detail

data
object
required

A session in a channel the caller may use. Participants, the agent thread and any linked entity are not exposed.

meta
object
required