Get sessions

Get list of sessions with pagination and filtering. See Sessions.

GET /sessions

Get sessions

cURL

curl --request GET \
  --url https://api.galtea.ai/sessions \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "session_123",
    "customId": "custom_session_123",
    "versionId": "ver_123",
    "userId": "user_123",
    "testCaseId": "tc_123",
    "context": {
      "value": "Session context information"
    },
    "stoppingReason": "GOAL_ACHIEVED",
    "recordingUri": "s3://galtea-bucket/audio/org_123/session_abc-recording.mp3",
    "error": "External API responded with HTTP 422: Unprocessable Entity — {\"detail\":\"model not found\"}",
    "status": "PENDING",
    "isProduction": false,
    "metadata": {
      "key": "value"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization · string · header · required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Query Parameters

ids · string[]

Filter by session IDs

customIds · string[]

Filter by session custom IDs

productIds · string[]

Filter by product IDs

testIds · string[]

Filter by test IDs (include only). Use an empty string ("") to select sessions without a test

excludeTestIds · string[]

Omit sessions linked to the specified test IDs. Use an empty string ("") to omit sessions without a test

versionIds · string[]

Filter by version IDs

monitorIds · string[]

Filter by monitor IDs (returns only sessions scored by the given monitors)

specificationIds · string[]

Filter by the specifications a session relates to. A session relates to a specification in two ways, and either one matches: it runs a test case of a test linked to that specification, or it carries an evaluation whose metric is linked to that specification. Multiple values combine as OR.

testCaseIds · string[]

Filter by test case IDs

isProduction · boolean

Filter by the session's isProduction flag. Prefer this over the legacy testIds/excludeTestIds empty-string trick.

statuses · enum<string>[]

Filter by session statuses. Multiple values combine as OR.

Available options: PENDING, COMPLETED, FAILED

commentLabels · string[]

Filter by comment state. __any__ matches sessions with at least one comment, __none__ matches sessions with no comment, and any other value matches sessions with a comment carrying that label. All values combine as OR, so __none__ plus a label returns sessions that have no comment OR carry that label.

sort · string[]

Sort instructions (field and direction pairs)

limit · integer

Maximum number of results

offset · integer

Number of results to skip

fromCreatedAt · string<date-time>

Filter sessions created at or after this timestamp (ISO 8601 format)

toCreatedAt · string<date-time>

Filter sessions created at or before this timestamp (ISO 8601 format)

Response

200

application/json

Sessions retrieved successfully

id · string

Example:

"session_123"

customId · string | null

Example:

"custom_session_123"

versionId · string

Example:

"ver_123"

userId · string | null

Example:

"user_123"

testCaseId · string | null

Example:

"tc_123"

context · object | null

Structured context data. For plain text context, format is { value: "..." }

Example:

{ "value": "Session context information" }

stoppingReason · string | null

Example:

"GOAL_ACHIEVED"

recordingUri · string | null

Canonical storage URI of the full-call recording for a telephony-evaluation session. Null for non-telephony sessions or before the recording is processed. Resolve to a playable URL via GET /storage?uri=.

Example:

"s3://galtea-bucket/audio/org_123/session_abc-recording.mp3"

error · string | null

Example:

"External API responded with HTTP 422: Unprocessable Entity — {\"detail\":\"model not found\"}"

status · enum<string>

Available options: PENDING, COMPLETED, FAILED

Example:

"PENDING"

isProduction · boolean

True when the session represents real production traffic (no associated test case).

Example:

false

metadata · object | null

Example:

{ "key": "value" }

createdAt · string<date-time>

deletedAt · string<date-time> | null