Update Session API

Overview

Chat API & Session Management covers creating a session and using it to maintain context across chat requests, but not changing a session after it's created. This page fills that gap: the endpoint for updating a session's name, status, expiration, and message history.

Endpoint

PATCH https://api.sulus.ai/session/{id}

Parameter	Location	Required	Description
`id`	path	Yes	The unique identifier of the session to update.
`Authorization`	header	Yes	`Bearer <YOUR_API_KEY>`

UpdateSessionDTO Fields

Field	Type	Description
`name`	string	New name for the session. Maximum length is 40 characters.
`status`	string (enum)	New status for the session. Valid values: `active`, `completed`.
`expirationSeconds`	number	Session expiration time in seconds. Defaults to 86400 (24 hours) if not set.
`messages`	array	Updated array of chat messages for the session.

Worked Example: Marking a Session Completed

Once a conversation is finished, update the session's status so it's no longer treated as an active, ongoing thread:

curl -X PATCH https://api.sulus.ai/session/session_xyz789 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "completed"
  }'

The response is the full, updated Session object. You can combine multiple fields in a single request — for example, updating status and expirationSeconds together.

On this page

Update Session API