Skip to main content
POST
Error

Authorizations

X-Api-Key
string
header
required

LangSmith API key (lsv2_...).

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

Agent metadata, runtime, and optional file tree

name
string
required
backend
object
configurable
object

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

description
string
display
object
extras
object

Deprecated: metadata is fully typed via permissions and display. Caller-defined key/value tracking attached to the agent's metadata. Sunset tracked in AB-2553: https://linear.app/langchain/issue/AB-2553

files
object

Raw file map for paths the typed fields don't cover. Setting a typed field and the corresponding files entry returns 422.

model
object
options
object
permissions
object

Sharing settings. When omitted, the agent is private to its creator (identity personal, visibility user).

subagents
object[]

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

system_prompt
string

Agent system prompt. Written to AGENTS.md.

Example:

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

tools
object

Tool config. Written to tools.json.

Response

Created

access_level
enum<string>

The caller's access level on this agent.

Available options:
READ,
RUN,
WRITE
Example:

"WRITE"

backend
object
created_at
string<date-time>
Example:

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

description
string
Example:

"Researches topics and drafts summaries."

display
object
extras
object
files
object

Raw file map. Returned only when include_files=true.

id
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
name
string
Example:

"Research Assistant"

options
object
owner
object
owner_id
string<uuid>
Example:

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

permissions
object
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.

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.

updated_at
string<date-time>
Example:

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