Skip to main content
PATCH
Update an agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string<uuid>
required

Body

application/json
expectedUpdatedAt
string<date-time>

Value of updatedAt from the last retrieved agent. A concurrent change causes a conflict instead of overwriting newer changes.

name
string
Required string length: 1 - 200
key
string | null
Required string length: 1 - 200
instructions
object

Instructions for the agent as a rich-text document. Mentions can reference integrations used by the agent.

Example:
mcpServers
string[]
Maximum array length: 100
Required string length: 1 - 200
agent
string | null
Required string length: 1 - 200
agentOptions
object

Execution settings for the selected agent runtime, including provider-specific options.

userState
object

User-defined state keyed by name. Values may be any JSON value, including nested objects and arrays. No application-specific keys are required.

sandboxSize
enum<string> · null · null
Available options:
nano,
micro,
small,
medium,
large,
xl,
xxl,
ultra,
null,
null
projectId
templateId
string | null
Maximum string length: 200
script
string | null
Maximum string length: 100000
artifactType
enum<string> · null · null
Available options:
PullRequest,
ToolCall,
Plan,
Response,
File,
Service,
Source,
null,
null
autoDetectRepositories
boolean
repositoryIds
string<uuid>[]
Maximum array length: 250
enabled
boolean
archived
boolean

Response

Update an agent

id
string<uuid>
required
name
string
required
key
string | null
required
sandboxSize
enum<string> | null
required
Available options:
nano,
micro,
small,
medium,
large,
xl,
xxl,
ultra,
null
projectId
string | null
required
templateId
string | null
required
script
string | null
required
artifactType
enum<string> | null
required
Available options:
PullRequest,
ToolCall,
Plan,
Response,
File,
Service,
Source,
null
autoDetectRepositories
boolean
default:true
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
archivedAt
string<date-time> | null
required
enabledAt
string<date-time> | null
required
organizationId
string | null
required
Required string length: 1 - 255
organizationName
string | null
required
createdBy
string | null
required
instructions
object
required

Instructions for the agent as a rich-text document. Mentions can reference integrations used by the agent.

Example:
agent
string | null
required

Runtime and model selection key; not the ID of an agent resource.

agentOptions
object
required

Execution settings for the selected agent runtime, including provider-specific options.

mcpServers
string[]
required

Selected MCP server identifiers, including built-in server keys.

Maximum array length: 100
Required string length: 1 - 200
userState
object | null
required

User-defined state keyed by name. Values may be any JSON value, including nested objects and arrays. No application-specific keys are required.

codeRepositories
object[]
required
Maximum array length: 250
lastRun
object | null
required
runCount
integer
required
Required range: x >= 0
scheduleCount
integer
required
Required range: x >= 0
triggerCount
integer
required
Required range: x >= 0
hasPausedSchedule
boolean
required
hasPausedTrigger
boolean
required
integrationIds
string<uuid>[]
required
integrationTypes
string[]
required