Agent

Update agent session

Update an agent session's name, persona, or settings.

put/api/v0/agent/sessions/{session_id}

Path parameters

session_idstring uuid required

Request body

namestring nullable

New name for the session.

persona_idstring uuid nullable

New persona ID for the session.

Response

Successful Response

idstring uuid required

The ID of the session.

persona_idstring uuid nullable

The ID of the persona used by this session. Null means default persona.

namestring nullable required

The name of the session.

statusstring required

The status of the session. Options: 'active', 'completed', 'error'.

message_countinteger required

The number of messages in the session.

is_roamingboolean

True iff this session's persona exposes any fs_* / fs_bash tool and therefore has a workspace directory the agent reads/writes.

created_atstring date-time required

When the session was created.

updated_atstring date-time required

When the session was last updated.

Changes

No recorded changes to this endpoint across all 1 revision of this API.