Skip to main content
GET
Error

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
workspace_id
string<uuid>
required

Query Parameters

​
entity_type
enum<string> | null

Filter by entity type 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)
Available options:
case,
agent_preset,
agent_preset_builder,
copilot,
workflow,
approval,
external_channel
​
entity_id
string<uuid> | null

Filter by entity ID

​
created_by
string<uuid> | null

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

​
exclude_entity_types
enum<string>[] | null

Entity types to exclude from results

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)
Available options:
case,
agent_preset,
agent_preset_builder,
copilot,
workflow,
approval,
external_channel
​
parent_session_id
string<uuid> | null

Filter by parent session ID (for finding forked sessions)

​
limit
integer
default:50

Maximum number of sessions to return

Required range: 1 <= x <= 200

Response

Successful Response

Response schema for agent session.

​
id
string<uuid>
required
​
workspace_id
string<uuid>
required
​
title
string
required
​
created_by
string<uuid> | null
required
​
entity_type
enum<string>
required

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)
Available options:
case,
agent_preset,
agent_preset_builder,
copilot,
workflow,
approval,
external_channel
​
entity_id
string<uuid>
required
​
channel_context
Channel Context · object | null
required
​
tools
string[] | null
required
​
mcp_integrations
string[] | null
required
​
agent_preset_id
string<uuid> | null
required
​
agent_preset_version_id
string<uuid> | null
required
​
harness_type
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
is_readonly
boolean
default:false

Whether the requesting actor can modify this session

​
agents_binding
ResolvedAgentsConfig · object | null

Persisted agents toggle with immutable resolved child refs.

​
last_error
string | null
​
last_stream_id
string | null
​
artifacts
(CaseArtifact · object | WorkflowArtifact · object | RunArtifact · object | TableArtifact · object | AgentArtifact · object | AlertArtifact · object | IntegrationArtifact · object | SecretArtifact · object | GenericArtifact · object)[]

Case artifact shown in artifact-capable chat surfaces.

​
parent_session_id
string<uuid> | null