Error

A valid request URL is required to generate request examples

{
  "access_level": "WRITE",
  "backend": {
    "sandbox_config": {
      "delete_after_stop_seconds": 1200,
      "idle_ttl_seconds": 600,
      "policy_ids": [
        "<string>"
      ],
      "sandbox_id": "<string>",
      "scope": "thread",
      "snapshot_id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "type": "sandbox"
  },
  "created_at": "2026-01-15T09:30:00Z",
  "description": "Researches topics and drafts summaries.",
  "display": {
    "icon": "Rocket02",
    "icon_color": "blue"
  },
  "extras": {},
  "files": {},
  "id": "11111111-1111-1111-1111-111111111111",
  "instructions": "<string>",
  "is_owner": true,
  "model": {
    "id": "anthropic:claude-sonnet-4-6"
  },
  "name": "Research Assistant",
  "options": {
    "skip_memory_write_protection": true,
    "slack_oauth_provider_id": "<string>",
    "tools_url": "<string>",
    "trace_inputs_outputs": true,
    "triggers_paused": true,
    "user_timezone": "America/New_York"
  },
  "owner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Ada Lovelace"
  },
  "owner_id": "7f8e9d0c-1b2a-3948-5766-8594a3b2c1d0",
  "permissions": {
    "shared_users": {
      "read": [
        "<string>"
      ],
      "run": [
        "<string>"
      ],
      "update": [
        "<string>"
      ]
    }
  },
  "revision": "rev_3f9a2b1c",
  "subagents": [
    {
      "description": "Researches a topic and summarises findings.",
      "instructions": "<string>",
      "model": {
        "id": "anthropic:claude-sonnet-4-6"
      },
      "name": "researcher",
      "system_prompt": "You are a research assistant. Use the available tools to gather information.",
      "tools": {
        "interrupt_config": {},
        "tools": [
          {
            "display_name": "read_url_content",
            "mcp_server_name": "Fleet",
            "mcp_server_url": "https://tools.example.com",
            "name": "read_url_content"
          }
        ]
      }
    }
  ],
  "system_prompt": "You are a helpful research assistant.",
  "tools": {
    "interrupt_config": {},
    "tools": [
      {
        "display_name": "read_url_content",
        "mcp_server_name": "Fleet",
        "mcp_server_url": "https://tools.example.com",
        "name": "read_url_content"
      }
    ]
  },
  "updated_at": "2026-01-15T09:30:00Z"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

Update an agent

Updates the specified agent. All request fields are optional; omitted fields are left unchanged.

Merge semantics follow PATCH conventions:

Top-level scalars (name, description) merge field-by-field — sending one does not affect the other.
Nested objects (runtime, backend, permissions, display, options, tools, subagents, extras) are replaced in full when any of their fields is provided. To preserve existing nested values, include them in your PATCH.
Providing any of system_prompt, tools, subagents, files, or remove_file_paths triggers a new file tree commit.

Entries under files are created or replaced by path; paths in remove_file_paths are deleted. A path may not appear in both. Validation is atomic: if any entry fails validation, no changes are applied.

PATCH

fleet

agents

{agent_id}

Error

A valid request URL is required to generate request examples

{
  "access_level": "WRITE",
  "backend": {
    "sandbox_config": {
      "delete_after_stop_seconds": 1200,
      "idle_ttl_seconds": 600,
      "policy_ids": [
        "<string>"
      ],
      "sandbox_id": "<string>",
      "scope": "thread",
      "snapshot_id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "type": "sandbox"
  },
  "created_at": "2026-01-15T09:30:00Z",
  "description": "Researches topics and drafts summaries.",
  "display": {
    "icon": "Rocket02",
    "icon_color": "blue"
  },
  "extras": {},
  "files": {},
  "id": "11111111-1111-1111-1111-111111111111",
  "instructions": "<string>",
  "is_owner": true,
  "model": {
    "id": "anthropic:claude-sonnet-4-6"
  },
  "name": "Research Assistant",
  "options": {
    "skip_memory_write_protection": true,
    "slack_oauth_provider_id": "<string>",
    "tools_url": "<string>",
    "trace_inputs_outputs": true,
    "triggers_paused": true,
    "user_timezone": "America/New_York"
  },
  "owner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Ada Lovelace"
  },
  "owner_id": "7f8e9d0c-1b2a-3948-5766-8594a3b2c1d0",
  "permissions": {
    "shared_users": {
      "read": [
        "<string>"
      ],
      "run": [
        "<string>"
      ],
      "update": [
        "<string>"
      ]
    }
  },
  "revision": "rev_3f9a2b1c",
  "subagents": [
    {
      "description": "Researches a topic and summarises findings.",
      "instructions": "<string>",
      "model": {
        "id": "anthropic:claude-sonnet-4-6"
      },
      "name": "researcher",
      "system_prompt": "You are a research assistant. Use the available tools to gather information.",
      "tools": {
        "interrupt_config": {},
        "tools": [
          {
            "display_name": "read_url_content",
            "mcp_server_name": "Fleet",
            "mcp_server_url": "https://tools.example.com",
            "name": "read_url_content"
          }
        ]
      }
    }
  ],
  "system_prompt": "You are a helpful research assistant.",
  "tools": {
    "interrupt_config": {},
    "tools": [
      {
        "display_name": "read_url_content",
        "mcp_server_name": "Fleet",
        "mcp_server_url": "https://tools.example.com",
        "name": "read_url_content"
      }
    ]
  },
  "updated_at": "2026-01-15T09:30:00Z"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "type": "<string>"
}

Authorizations

X-Api-Key

string

header

required

LangSmith API key (lsv2_...).

Path Parameters

agent_id

string<uuid>

required

Agent ID

Query Parameters

include

enum<string>

Comma-separated relations to hydrate: owner (resolve owner_id into an owner object) and/or files (raw file map). The legacy include_files=true boolean is a deprecated alias for include=files.

Available options:

owner,

files

Body

application/json

Sparse update payload

backend

object

Show child attributes

configurable

object

Caller-defined key/value tracking merged into the agent's runtime configuration. Typed runtime fields win on key collision.

Show child attributes

description

string

display

object

Show child attributes

extras

object

Caller-defined key/value tracking attached to the agent's metadata.

Show child attributes

files

object

Raw file entries created or replaced by path. Triggers a new commit.

Show child attributes

model

object

Show child attributes

name

string

options

object

Show child attributes

permissions

object

Show child attributes

remove_file_paths

string[]

Paths to remove from the file tree. Relative paths only.

subagents

object[]

Subagents. Each entry is written to subagents/<name>/AGENTS.md and subagents/<name>/tools.json. Triggers a new commit.

Show child attributes

system_prompt

string

Agent system prompt. Written to AGENTS.md. Triggers a new commit.

Example:

"You are a helpful agent. Use the available tools to answer the user's question."

tools

object

Tool config. Written to tools.json. Triggers a new commit.

Show child attributes

Response

access_level

enum<string>

The caller's access level on this agent.

Available options:

READ,

RUN,

WRITE

Example:

"WRITE"

backend

object

Show child attributes

created_at

string<date-time>

Example:

"2026-01-15T09:30:00Z"

description

string

Example:

"Researches topics and drafts summaries."

display

object

Show child attributes

extras

object

Show child attributes

files

object

Raw file map. Returned only when include_files=true.

Show child attributes

string<uuid>

Example:

"11111111-1111-1111-1111-111111111111"

instructions

string

Deprecated: use system_prompt. Echoed alongside system_prompt with the same value for backwards compatibility.

is_owner

boolean

True when the caller owns this agent.

Example:

true

model

object

Show child attributes

name

string

Example:

"Research Assistant"

options

object

Show child attributes

owner

object

Show child attributes

owner_id

string<uuid>

Example:

"7f8e9d0c-1b2a-3948-5766-8594a3b2c1d0"

permissions

object

Show child attributes

revision

string

Opaque identifier for the agent's current revision.

Example:

"rev_3f9a2b1c"

subagents

object[]

Subagents parsed from subagents/<name>/AGENTS.md + subagents/<name>/tools.json.

Show child attributes

system_prompt

string

Agent system prompt parsed from AGENTS.md.

Example:

"You are a helpful research assistant."

tools

object

Tool config parsed from tools.json.

Show child attributes

updated_at

string<date-time>

Example:

"2026-01-15T09:30:00Z"

Delete an agent

Clone an agent