Skip to content

Get session

GET
/v1/sessions/{session_id}
session_id
required
string

Session ID (prefixed, e.g., session_…)

Session found

Session - instance of agentic loop execution. A session represents a single conversation with an agent.

object
active_schedule_count

Number of active (enabled) schedules for this session. Populated when the session is fetched for API responses.

integer | null format: int32
agent_id

ID of the agent working in this session (format: agent_{32-hex}). Optional.

string | null
Example
agent_01933b5a00007000800000000000001
capabilities

Session-level capabilities (additive to agent capabilities). Applied after agent capabilities when building RuntimeAgent.

Array<object>

Per-agent capability configuration

Associates a capability with an agent, including optional per-agent configuration. The config field allows the same capability to behave differently per-agent.

object
config

Per-agent configuration for this capability (capability-specific)

ref
required

Reference to the capability ID

string
created_at
required

Timestamp when the session was created.

string format: date-time
features

Aggregated UI features from all active capabilities (harness + agent + session). Computed at read time from the capability registry. Known features: “file_system”, “schedules”, “secrets”, “key_value”, “sql_database”.

Array<string>
finished_at

Timestamp when the session finished (completed or failed).

string | null format: date-time
harness_id
required

ID of the harness for this session (format: harness_{32-hex}).

string
Example
harness_01933b5a00007000800000000000001
id
required

Unique identifier for the session (format: session_{32-hex}).

string
Example
session_01933b5a00007000800000000000001
is_pinned

Whether this session is pinned by the current user. Only populated when the request has an authenticated user context.

boolean | null
model_id

LLM model ID to use for this session (format: model_{32-hex}). Overrides the agent’s default model if set.

string | null
Example
model_01933b5a00007000800000000000001
organization_id
required

Organization this session belongs to (format: org_{32-hex}).

string
Example
org_00000000000000000000000000000001
output_preview

Preview text from the last assistant response (truncated).

string | null
preview

Preview text from the first user message (truncated).

string | null
started_at

Timestamp when the session started executing.

string | null format: date-time
status
required

Current execution status of the session.

string
Allowed values: started active idle waitingfortoolresults
tags

Tags for organizing and filtering sessions.

Array<string>
title

Human-readable title for the session.

string | null
tools

Client-side tools for this session (additive to agent tools).

Array
One of:

Built-in tool - executed by the worker via ToolRegistry

object
description
required

Tool description for LLM

string
display_name

Human-readable display name for UI rendering (e.g., “Get Current Time” for get_current_time)

string | null
name
required

Tool name (used by LLM and for registry lookup)

string
parameters
required

JSON schema for tool parameters

policy

Tool policy (auto or requires_approval)

string
Allowed values: auto requires_approval client_side
type
required
string
Allowed values: builtin
updated_at
required

Timestamp when the session was last updated.

string format: date-time
usage
One of:
null

Invalid session ID

Session not found

Internal server error