Update Session

Update session properties such as session_name, session_state, metadata, or summary. Use this endpoint to modify the session name, update state, add metadata, or update the session summary.

PATCH /sessions/{session_id}

Update Session

cURL

curl --request PATCH \
  --url https://api.example.com/sessions/{session_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_name": "<string>",
  "session_state": {},
  "metadata": {},
  "summary": {}
}
'

200

update_summary

{
  "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> · default: agent

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

table · string | null

Table to use for update operation

Body

application/json

Session update data

session_name · string | null

Updated session name

session_state · Session State · object

Updated session state

metadata · Metadata · object

Updated metadata

summary · Summary · object

Session summary

Response

200

application/json

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 · Session Summary · object

Summary of session interactions

session_state · Session State · object

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 · Agent Data · object

Agent-specific data

metrics · Metrics · object

Session metrics

metadata · Metadata · object

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