Skip to main content
POST
/
sessions
/
{session_id}
/
rename
Rename Session
curl --request POST \
  --url https://api.example.com/sessions/{session_id}/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_name": "<string>"
}
'
{
  "user_id": "123",
  "agent_session_id": "6f6cfbfd-9643-479a-ae47-b8f32eb4d710",
  "session_id": "6f6cfbfd-9643-479a-ae47-b8f32eb4d710",
  "session_name": "What tools do you have?",
  "session_summary": {
    "summary": "The user and assistant engaged in a conversation about the tools the agent has available.",
    "updated_at": "2025-09-05T18:02:12.269392"
  },
  "session_state": {},
  "agent_id": "basic-agent",
  "total_tokens": 160,
  "agent_data": {
    "name": "Basic Agent",
    "agent_id": "basic-agent",
    "model": {
      "provider": "OpenAI",
      "name": "OpenAIChat",
      "id": "gpt-4o"
    }
  },
  "metrics": {
    "input_tokens": 134,
    "output_tokens": 26,
    "total_tokens": 160,
    "audio_input_tokens": 0,
    "audio_output_tokens": 0,
    "audio_total_tokens": 0,
    "cache_read_tokens": 0,
    "cache_write_tokens": 0,
    "reasoning_tokens": 0
  },
  "chat_history": [
    {
      "content": "<additional_information>\n- Use markdown to format your answers.\n- The current time is 2025-09-05 18:02:09.171627.\n</additional_information>\n\nYou have access to memories from previous interactions with the user that you can use:\n\n<memories_from_previous_interactions>\n- User really likes Digimon and Japan.\n- User really likes Japan.\n- User likes coffee.\n</memories_from_previous_interactions>\n\nNote: this information is from previous interactions and may be updated in this conversation. You should always prefer information from this conversation over the past memories.",
      "from_history": false,
      "stop_after_tool_call": false,
      "role": "system",
      "created_at": 1757088129
    },
    {
      "content": "What tools do you have?",
      "from_history": false,
      "stop_after_tool_call": false,
      "role": "user",
      "created_at": 1757088129
    },
    {
      "content": "I don't have access to external tools or the internet. However, I can assist you with a wide range of topics by providing information, answering questions, and offering suggestions based on the knowledge I've been trained on. If there's anything specific you need help with, feel free to ask!",
      "from_history": false,
      "stop_after_tool_call": false,
      "role": "assistant",
      "metrics": {
        "input_tokens": 134,
        "output_tokens": 26,
        "total_tokens": 160
      },
      "created_at": 1757088129
    }
  ],
  "created_at": "2025-09-05T16:02:09Z",
  "updated_at": "2025-09-05T16:02:09Z"
}

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 rename

Query Parameters

​
type
enum<string>
default:agent

Session type (agent, team, or workflow)

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

Database ID to use for rename operation

Body

application/json
​
session_name
string
required

New name for the session

Response

Session renamed successfully

​
user_id
string | null
required
​
agent_session_id
string
required
​
session_id
string
required
​
session_name
string
required
​
session_summary
Session Summary · object
required
​
session_state
Session State · object
required
​
agent_id
string | null
required
​
total_tokens
integer | null
required
​
agent_data
Agent Data · object
required
​
metrics
Metrics · object
required
​
metadata
Metadata · object
required
​
chat_history
Chat History · object[] | null
required
​
created_at
string<date-time> | null
required
​
updated_at
string<date-time> | null
required