Skip to main content
POST
Create a session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required
Required string length: 8 - 128

Body

application/json
client_reference
string
Required string length: 1 - 128
max_turns
integer
Required range: 1 <= x <= 100
initial_history
object[]
Maximum array length: 100

Response

Successful response.

request_id
string
required
session_id
string
required
client_reference
string | null
required
status
enum<string>
required
Available options:
active,
completed,
stopped
turn_count
integer
required
Required range: x >= 0
max_turns
integer
required
Required range: x >= 1
turns_remaining
integer
required
Required range: x >= 0
question_state
object
required
targets
object
required
progress
object
required
pending_decision
object | null
required
degraded
boolean
required
versions
object
required