Create Session

Create a new conversation session with an agent with configurable timeout and renewal policies

The Sessions API provides a simplified way to manage conversations without dealing with servers and channels. Sessions automatically handle timeout management, renewal, and expiration.

Request Body

agentId · string · required

UUID of the agent to create a session with

userId · string · required

UUID of the user initiating the session

metadata · object

Optional metadata to attach to the session

timeoutConfig · object

Optional timeout configuration for the session

Show Timeout Configuration Properties

timeoutMinutes · number

Inactivity timeout in minutes (5-1440). Default: 30

autoRenew · boolean

Whether to automatically renew on activity. Default: true

maxDurationMinutes · number

Maximum total session duration in minutes. Default: 720 (12 hours)

warningThresholdMinutes · number

Minutes before expiration to trigger warning. Default: 5

Response

sessionId · string

Unique identifier for the created session

agentId · string

UUID of the agent

userId · string

UUID of the user

createdAt · string

ISO timestamp of session creation

expiresAt · string

ISO timestamp when the session will expire

timeoutConfig · object

The active timeout configuration for this session

metadata · object

Any metadata attached to the session