Skip to main content
PATCH
Update session
You are reading the docs of Galtea 5.12. Read this page in the latest version.

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-....

Path Parameters

id
string
required

Session ID

Body

application/json
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:
stoppingReason
string | null
Example:

"GOAL_ACHIEVED"

recordingUri
string | null

Storage URI of the full-call recording for a telephony-evaluation session, returned under STORAGE_PUBLIC_BASE_URL when the deployment configures one. Null for non-telephony sessions or before the recording is processed. Resolve to a playable URL via GET /storage?uri=.

Example:

"https://files.galtea.ai/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
any | null

Arbitrary metadata, returned as stored. Usually an object, but any JSON value is accepted.

Example:
runId
string | null

The run that created this session. Null for a session created outside a launch (production traffic, an imported trace). A session a run only scored names no run here; filter with involvedInRunIds to reach those too.

Example:

"run_123"

createdAt
string<date-time>
deletedAt
string<date-time> | null

Response

Session updated successfully

id
string
required
Example:

"session_123"

customId
string | null
required
Example:

"custom_session_123"

versionId
string
required
Example:

"ver_123"

userId
string | null
required
Example:

"user_123"

testCaseId
string | null
required
Example:

"tc_123"

context
object | null
required

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

Example:
stoppingReason
string | null
required
Example:

"GOAL_ACHIEVED"

recordingUri
string | null
required

Storage URI of the full-call recording for a telephony-evaluation session, returned under STORAGE_PUBLIC_BASE_URL when the deployment configures one. Null for non-telephony sessions or before the recording is processed. Resolve to a playable URL via GET /storage?uri=.

Example:

"https://files.galtea.ai/audio/org_123/session_abc-recording.mp3"

error
string | null
required
Example:

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

status
enum<string>
required
Available options:
PENDING,
COMPLETED,
FAILED
Example:

"PENDING"

isProduction
boolean
required

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

Example:

false

isSeed
boolean
required
read-only

True when the session holds the predefined conversation of a test case and is never executed. Server-managed and read-only.

Example:

false

runId
string | null
required

The run that created this session. Null for a session created outside a launch (production traffic, an imported trace). A session a run only scored names no run here; filter with involvedInRunIds to reach those too.

Example:

"run_123"

deletedAt
string<date-time> | null
required
metadata
any | null

Arbitrary metadata, returned as stored. Usually an object, but any JSON value is accepted.

Example:
createdAt
string<date-time>