Skip to content

List sessions in organization

GET
/v1/sessions
agent_id
string | null

Filter sessions by agent ID.

Example
agent_01933b5a00007000800000000000001
search
string | null

Search by title (case-insensitive substring match).

offset
integer | null format: int32
0

Number of items to skip (for pagination).

limit
integer | null format: int32
default: 20 >= 1 <= 100

Maximum number of items to return (for pagination).

Paginated list of sessions

Response wrapper for paginated list endpoints. Includes pagination metadata along with the data array.

object
data
required

Array of items returned by the list operation.

Array

Wrapper that adds self_url and view_url to a serialized resource.

Uses self_url (not url) for the API link to avoid collision with resources that already have a url field (e.g. McpServer).

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
agent_identity_id

Optional resident agent identity for unattended/background execution.

string | null
Example
identity_01933b5a00007000800000000000001
blueprint_config

Validated config passed by host at blueprint spawn time.

blueprint_id

Blueprint ID. When set, reason_activity and act_activity build RuntimeAgent from the blueprint definition instead of from harness_id/agent_id.

string | null
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
effective_owner
One of:
null
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”, “leased_resources”.

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
hints

Session-level client hints — arbitrary key-value pairs declared by the client at session creation time. These are defaults for every turn; per-message controls.hints override these key-by-key (shallow merge).

Examples: {"setup_connection": true, "rich_media": true}

object | null
id
required

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

string
Example
session_01933b5a00007000800000000000001
initial_files

Session-level initial files (additive to agent initial_files). Files with matching paths override agent/harness files; new paths are appended.

Array<object>

Starter file copied into a new session from an agent or harness.

object
content
required

File content: plain text or base64-encoded binary.

string
encoding

Content encoding: text or base64.

string
is_readonly

Prevent session-side edits or deletes when true.

boolean
path
required

Absolute path within the session workspace. /workspace prefix is accepted.

string
is_pinned

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

boolean | null
locale

Locale for localized agent behavior and formatting (BCP 47, e.g. uk-UA).

string | null
max_iterations

Maximum number of LLM iterations per turn for this session.

integer | null
mcpServers

Remote MCP servers scoped to this session only.

object
key
additional properties

Session-, agent-, or harness-scoped remote MCP server configuration.

This intentionally mirrors the mcpServers object shape used by common MCP client config files while staying within Everruns’ current remote-HTTP-only support.

object
auth_mode

Authentication mode used when executing tools from this scoped server.

string
Allowed values: none api_key o_auth
headers

Additional HTTP headers sent on MCP requests.

object
key
additional properties
string
oauth_provider_id

Provider id used to resolve a user-scoped bearer token.

string | null
tool_discovery

Whether to discover tool definitions live from this server.

boolean
type

MCP transport type. Only remote HTTP is supported today.

string
Allowed values: http
url
required

URL of the remote MCP server endpoint.

string
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
network_access
One of:
null
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
owner
One of:
null
owner_principal_id
required

Owning principal for this session.

string
Example
principal_01933b5a000070008000000000000001
parent_session_id

Parent session that spawned this subagent. NULL for top-level sessions.

string | null
preview

Preview text from the first user message (truncated).

string | null
resolved_owner_user_id

Denormalized effective human owner of the owning principal lineage.

string | null format: uuid
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 paused
subagent_name

Human-readable subagent name (“Test Runner”), unique per parent.

string | null
subagent_status
One of:
null
subagent_task

Original task description given to this subagent.

string | null
system_prompt

Session-level system prompt override. Prepended to the agent’s system prompt when building RuntimeAgent.

string | null
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
category

Category for tool_search namespace grouping (from parent capability)

string | null
deferrable

Whether this tool’s schema can be deferred via tool_search

string
Allowed values: never automatic always
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
hints

Semantic hints describing the tool’s behavioral properties

object
destructive

Tool may irreversibly destroy or delete data. Subset of non-readonly — a tool can be non-readonly (writes) without being destructive (e.g., create/update operations).

boolean | null
idempotent

Calling the tool repeatedly with the same arguments produces the same effect. Safe to retry on transient failures.

boolean | null
long_running

Tool may take significant time to complete (> ~5s typical). Useful for clients to show progress indicators and set timeouts.

boolean | null
narration_noun

Entity noun for operation-based narration (e.g. “agent”, “harness”). When set, the narration system reads the operation argument and produces verb-based narration like “Created agent: Neon Cartographer” instead of the generic “Ran Manage Agents”.

string | null
open_world

Tool interacts with external entities beyond the local system (network calls, third-party APIs, cloud services).

boolean | null
persist_output

Tool output should be persisted to session VFS before truncation. When set, the tool_output_persistence capability (EVE-222, EVE-245) writes stdout to /.outputs/{tool_call_id}.stdout and stderr to /.outputs/{tool_call_id}.stderr, injecting full_output, total_lines, and output_files into the result.

boolean | null
readonly

Tool does not modify any state (read-only queries, lookups). When true: safe to call speculatively, result can be cached.

boolean | null
requires_secrets

Tool requires API keys, credentials, or other secrets to function. Useful for UI to show connection prompts and for LLMs to anticipate authentication failures.

boolean | null
supports_background

Tool supports detached background execution via spawn_background. When true, the tool may be executed asynchronously outside the current foreground tool call and report status back later.

boolean | 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
self_url
required

Full API endpoint URL for this resource.

string
view_url
required

Full UI URL for viewing this resource.

string
limit
required

Maximum number of items per page.

integer format: int32
offset
required

Current offset (starting position).

integer format: int32
total
required

Total number of items matching the query (across all pages).

integer format: int32

Internal server error