Skip to main content
POST
/
sessions
{
  "user_id": "user-123",
  "agent_session_id": "new-session-id",
  "session_id": "new-session-id",
  "session_name": "New Session",
  "session_state": {
    "key": "value"
  },
  "metadata": {
    "key": "value"
  },
  "agent_id": "agent-1",
  "created_at": "2025-10-21T12:00:00Z",
  "updated_at": "2025-10-21T12:00:00Z"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

type
enum<string>

Type of session to create (agent, team, or workflow)

Available options:
agent,
team,
workflow
db_id
string | null

Database ID to create session in

Body

application/json

Session configuration data

session_id
string | null
session_name
string | null
session_state
object | null
metadata
object | null
user_id
string | null
agent_id
string | null
team_id
string | null
workflow_id
string | null

Response

Session created successfully

  • AgentSessionDetailSchema
  • TeamSessionDetailSchema
  • WorkflowSessionDetailSchema
user_id
string | null
required
agent_session_id
string
required
session_id
string
required
session_name
string
required
session_summary
object | null
required
session_state
object | null
required
agent_id
string | null
required
total_tokens
integer | null
required
agent_data
object | null
required
metrics
object | null
required
metadata
object | null
required
chat_history
Chat History · object[] | null
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
I