Skip to main content
PATCH
/
sessions
/
{session_id}
{
  "summary": {
    "summary": "The user discussed project planning with the agent.",
    "updated_at": "2025-10-21T14:30:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
session_id
string
required

Session ID to update

Query Parameters

​
type
enum<string>

Session type (agent, team, or workflow)

Available options:
agent,
team,
workflow
​
user_id
string | null

User ID

​
db_id
string | null

Database ID to use for update operation

Body

application/json

Session update data

​
session_name
string | null

Updated session name

​
session_state
object | null

Updated session state

​
metadata
object | null

Updated metadata

​
summary
object | null

Session summary

Response

Session updated successfully

  • AgentSessionDetailSchema
  • TeamSessionDetailSchema
  • WorkflowSessionDetailSchema
​
agent_session_id
string
required

Unique agent session identifier

​
session_id
string
required

Session identifier

​
session_name
string
required

Human-readable session name

​
user_id
string | null

User ID associated with the session

​
session_summary
object | null

Summary of session interactions

​
session_state
object | null

Current state of the session

​
agent_id
string | null

Agent ID used in this session

​
total_tokens
integer | null

Total tokens used in this session

​
agent_data
object | null

Agent-specific data

​
metrics
object | null

Session metrics

​
metadata
object | null

Additional metadata

​
chat_history
Chat History · object[] | null

Complete chat history

​
created_at
string<date-time> | null

Session creation timestamp

​
updated_at
string<date-time> | null

Last update timestamp