Skip to main content
PATCH
/
sessions
/
{id}
/
finish
Finish session
curl --request PATCH \
  --url https://api.galtea.ai/sessions/{id}/finish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stoppingReason": "GOAL_ACHIEVED",
  "error": "<string>"
}
'
{
  "id": "session_123",
  "customId": "custom_session_123",
  "versionId": "ver_123",
  "userId": "user_123",
  "testCaseId": "tc_123",
  "context": {
    "value": "Session context information"
  },
  "stoppingReason": "GOAL_ACHIEVED",
  "error": "External API responded with HTTP 422: Unprocessable Entity — {\"detail\":\"model not found\"}",
  "status": "PENDING",
  "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-....

Path Parameters

​
id
string
required

Session ID

Body

application/json
​
stoppingReason
string

Reason the session stopped (sets status to COMPLETED)

Example:

"GOAL_ACHIEVED"

​
error
string

Error message (sets status to FAILED)

Response

Session finished 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

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

Example:
{ "value": "Session context information" }
​
stoppingReason
string | null
Example:

"GOAL_ACHIEVED"

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

​
metadata
object
Example:
{ "key": "value" }
​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null