TRtracecat
agent-sessions

List Sessions

List agent sessions for the current workspace with optional filtering.

Returns root sessions by default, including standalone history forks and legacy chats. Filter by spawned_by_session_id to find spawned children. Legacy chats have is_readonly=True.

get/workspaces/{workspace_id}/agent/sessions

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    • API key in cookie fastapiusersauth
    • or HTTP bearer

Path parameters

workspace_idstring uuid required

Query parameters

entity_type'case' | 'agent_preset' | 'agent_preset_builder' | 'copilot' | 'workflow' | 'approval' | 'external_channel'

The type of entity associated with an agent session.

Determines the context and behavior of the session:

  • CASE: Chat attached to a Case entity for investigation
  • AGENT_PRESET: Live chat testing a preset configuration
  • AGENT_PRESET_BUILDER: Builder chat for editing/configuring a preset
  • WORKSPACE_CHAT: Workspace-level chat assistant (wire value: copilot)
  • WORKFLOW: Workflow-initiated agent run (from action)
  • APPROVAL: Inbox approval continuation (hidden from main chat list)
  • EXTERNAL_CHANNEL: External channel session (e.g. Slack thread)

Filter by entity type

entity_idstring uuid nullable

Filter by entity ID

created_bystring uuid nullable

Filter by session creator. Omit to list the entire workspace.

exclude_entity_typesAgentSessionEntity[] nullable

Entity types to exclude from results

spawned_by_session_idstring uuid nullable

Filter by spawning parent session ID

include_childrenboolean

Include spawned children without a parent filter

limitinteger

Maximum number of sessions to return

forked_from_session_idstring uuid nullable

Filter by history source session ID

parent_session_idstring uuid nullable

Legacy alias for forked_from_session_id

Response

Successful Response

Changes

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