Skip to main content
POST
/
sessions
Create session
curl --request POST \
  --url https://api.galtea.ai/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "versionId": "ver_123",
  "testCaseId": "tc_123",
  "customId": "my-session-1",
  "isProduction": false,
  "metadata": {
    "key": "value"
  },
  "status": "COMPLETED"
}
'
{
  "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-....

Body

application/json

Session creation input. For non-production sessions, testCaseId is required and context is not allowed. For production sessions (isProduction=true), testCaseId must be omitted and context is allowed.

​
versionId
string
required

Version ID to create the session for

Example:

"ver_123"

​
testCaseId
string
required

Test case to link this session to. Required for non-production sessions.

Example:

"tc_123"

​
customId
string

Optional caller-defined identifier for the session

Example:

"my-session-1"

​
isProduction
enum<boolean>
default:false

When false (default), creates a non-production session linked to a test case.

Available options:
false
​
metadata
object

Arbitrary key-value metadata

Example:
{ "key": "value" }
​
status
enum<string>
default:COMPLETED

Initial session status

Available options:
PENDING,
COMPLETED,
FAILED

Response

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