Create a new chat session with multi-tenant isolation
POST /api/v3/organizations/{organisation}/ai/sessions
POST
/api/v3/organizations/{organisation}/ai/sessions
Creates an AI session with automatic expiration (60 min default, 24h max). Sessions are isolated by organization. Use userId to identify the user creating the session. Use sessionGroup for logical grouping. Use metadata for additional custom data. Filter sessions by userId or sessionGroup when listing.
Authorizations
Parameters
Path Parameters
organisation
required
string
The organisation ID
Request Body required
object
userId
required
User identifier for this session
string
user-12345 sessionGroup
Optional user-defined grouping identifier (e.g., app name, environment, tenant). Use any format that makes sense for your application.
string
drupal-production metadata
Optional custom metadata for additional context
object
key
additional properties
any
{ "feature": "chat-assistant", "source": "web-app"} expirationMinutes
Session expiration in minutes
integer
initialMessages
Initial conversation messages (e.g., system prompt)
Array<object>
object
role
string
content
string
Responses
201
Session created successfully
object
sessionId
string format: uuid
status
string
expiresAt
string format: date-time
createdAt
string format: date-time
400
Invalid request (missing userId or invalid parameters)
500
Failed to create session