Skip to content

create-session.mdx

Latest commit

 

History

History
75 lines (57 loc) · 2.14 KB

create-session.mdx

File metadata and controls

75 lines (57 loc) · 2.14 KB
title description openapi
Create Session
Create a new conversation session with an agent with configurable timeout and renewal policies
post /api/messaging/sessions
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

UUID of the agent to create a session with UUID of the user initiating the session Optional metadata to attach to the session Optional timeout configuration for the session Inactivity timeout in minutes (5-1440). Default: 30 
<ParamField body="autoRenew" type="boolean">
  Whether to automatically renew on activity. Default: true
</ParamField>

<ParamField body="maxDurationMinutes" type="number">
  Maximum total session duration in minutes. Default: 720 (12 hours)
</ParamField>

<ParamField body="warningThresholdMinutes" type="number">
  Minutes before expiration to trigger warning. Default: 5
</ParamField>

Response

Unique identifier for the created session UUID of the agent UUID of the user ISO timestamp of session creation ISO timestamp when the session will expire The active timeout configuration for this session Any metadata attached to the session