Skip to main content
PATCH
Change an outbound agent

Authorizations

X-API-Key
string
header
required

Path Parameters

agent_id
string<uuid>
required

Body

application/json

A change to an agent, sent whole against the version it was read at.

The configuration travels as one object rather than as fifteen optional fields: the Agent tab reads the agent, edits it and sends it back, and expected_version makes two people editing at once a 409 rather than a silent overwrite.

expected_version
integer
required

The version the editor was opened at.

Required range: x >= 1
config
OutboundAgentConfig · object | null

The whole configuration; omitted leaves it as it is.

model_key
string | null

The model it writes with: swift, core or deep.

research
boolean | null

Whether the first message may research the person on the web.

Response

Successful Response

One sequence's outbound agent: what it writes with, and how.

config
OutboundAgentConfig · object
required

The versioned configuration one outbound agent carries, stored as JSON on its row.

Everything a person sets on the Agent tab that is not already a column of the saved-agent row (model_key and the research switch live there). message_prompts is keyed by an opaque slot key the caller mints (the step id); the agent never learns what a slot means.

created_at
string<date-time>
required
id
string<uuid>
required
model_key
string
required
name
string
required
research
boolean
required
updated_at
string<date-time>
required
version
integer
required