Skip to content

PATCH /v1/harnesses/{harness_id}

PATCH
/v1/harnesses/{harness_id}
harness_id
required
string

Harness ID (prefixed)

Request to update a harness. Only provided fields will be updated.

object
capabilities
array | null

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
default_model_id
string | null
description
string | null
display_name

Human-readable display name.

string | null
Example
Updated Research Harness
initial_files
array | null

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
mcpServers
One of:
null
name

Name, unique per org.

string | null
Example
updated-research
network_access
One of:
null
parent_harness_id
string | null
status
One of:
null
system_prompt
string | null
tags
array | null

Harness updated

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
archived_at

Timestamp when the harness was archived.

string | null format: date-time
capabilities

Capabilities enabled for this harness with per-harness configuration.

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 harness was created.

string format: date-time
default_model_id

Default LLM model ID for this harness. Lowest priority in chain: controls > session > agent > harness.

string | null
Example
model_01933b5a00007000800000000000001
deleted_at

Timestamp when the harness was deleted.

string | null format: date-time
description

Human-readable description of what the harness does.

string | null
display_name

Human-readable display name shown in UI.

string | null
id
required

Unique identifier for the harness (format: harness_{32-hex}).

string
Example
harness_01933b5a00007000800000000000001
initial_files

Starter files copied into each new session for this harness.

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_built_in

Whether this harness is built-in (system-managed, readonly). Built-in harnesses are provisioned during org initialization and cannot be modified or deleted via the API. Users can copy them.

boolean
mcpServers

Remote MCP servers scoped to this harness and inherited by descendant layers.

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
name
required

Name, unique per org (e.g. “generic”).

string
network_access
One of:
null
parent_harness_id

Optional parent harness that this harness inherits from.

string | null
Example
harness_01933b5a000070008000000000000602
status
required

Current lifecycle status of the harness.

string
Allowed values: active archived deleted
system_prompt
required

System prompt that defines the harness’s base behavior. Forms the foundation of the prompt stack.

string
tags

Tags for organizing and filtering harnesses.

Array<string>
updated_at
required

Timestamp when the harness was last updated.

string format: date-time
self_url
required

Full API endpoint URL for this resource.

string
view_url
required

Full UI URL for viewing this resource.

string

Invalid input

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string

Forbidden

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string

Harness not found

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string

Internal server error

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string