Skip to content

Update agent

PUT
/api/v1/agents/{id}
curl --request PUT \
--url https://example.com/api/v1/agents/example \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "description": "example", "modelProvider": "example", "supportedModels": [ "example" ], "defaultModel": "example", "available": true, "capabilities": { "supportsReasoningEffort": true, "supportsMcpServers": true, "supportsSkills": true, "supportsExtensions": true } }'
id
required
string
Media type application/json
object
name
string
description
string
modelProvider
string
supportedModels
Array<string>
defaultModel
string
available
boolean
capabilities
object
supportsReasoningEffort
boolean
supportsMcpServers
boolean
supportsSkills
boolean
supportsExtensions
boolean
Example generated
{
"name": "example",
"description": "example",
"modelProvider": "example",
"supportedModels": [
"example"
],
"defaultModel": "example",
"available": true,
"capabilities": {
"supportsReasoningEffort": true,
"supportsMcpServers": true,
"supportsSkills": true,
"supportsExtensions": true
}
}

Success

Media type application/json
object
_id
required
string
name
required
string
description
string
modelProvider
string
supportedModels
required
Array<string>
defaultModel
string
available
boolean
capabilities
object
supportsReasoningEffort
boolean
supportsMcpServers
boolean
supportsSkills
boolean
supportsExtensions
boolean
versions
Array<object>
object
agentVersion
required
string
>= 1 characters
workerVersion
required
string
>= 1 characters
components
required
object
key
additional properties
string
gitCommit
required
string
>= 1 characters
buildTime
required
string
>= 1 characters
imageTag
required
string
>= 1 characters
queueName
string
status
required
string
Allowed values: active retired
createdAt
required
string | null format: date-time
createdAt
required
string | null format: date-time
updatedAt
string | null format: date-time
deletedAt
string | null format: date-time
Example
{
"versions": [
{
"status": "active"
}
]
}

Validation error

Agent not found