Skip to content
Evershell Docs

Update an agent role

PATCH
/agent-roles/{id}
 
curl --request PATCH \
  --url https://your-org.evershell.ai/v1/agent-roles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "description": "example", "provider_id": "example", "model": "example", "capabilities": "example", "environment": "development", "environment_description": "example", "task_timeout_seconds": 1, "idle_timeout_seconds": 1, "thinking_effort": "high", "max_continuations": 1, "max_context_tokens": 1, "pool_policy": "", "pool_size": 1, "pool_max_size": 1, "pack_ids": [ "example" ] }'

Permissions: caps:write.

Body is a partial — only the present fields are applied. pack_ids replaces the full list when supplied; omit to leave attachments alone.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
display_name
string
description
string
provider_id
string
model
string
capabilities
string
environment
string
Allowed values: development staging production
environment_description
string
task_timeout_seconds
integer
idle_timeout_seconds
integer
thinking_effort
string
Allowed values: high medium low off
max_continuations
integer
max_context_tokens
integer
pool_policy
string
Allowed values: "" static dynamic
pool_size
integer
pool_max_size
integer
pack_ids
Array<string>

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
id
required
string
org_id
string
name
required
string
display_name
string
description
string
provider_id
required
string
model

Optional override for provider’s default_model

string
capabilities
string
environment
string
default: development
Allowed values: development staging production
environment_description

Free-text description of what the environment is — surfaced to the agent at task time so it knows what it’s running against.

string
task_timeout_seconds
integer
idle_timeout_seconds
integer
thinking_effort
string
Allowed values: high medium low off
max_continuations
integer
max_context_tokens
integer
pool_policy
string
Allowed values: "" static dynamic
pool_size
integer
pool_max_size
integer
pack_ids
Array<string>
created_at
string format: date-time
updated_at
string format: date-time
archived_at
string format: date-time
Example 
{
  "environment": "development",
  "thinking_effort": "high",
  "pool_policy": ""
}

400

Section titled “400 ”

Validation failure

Media type application/json
object
error
required
object
code
required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string
message
required

Human-readable summary

string
request_id
required

Server-generated request id for correlating logs

string
details

Optional structured context. Validation errors land at details.fields as a per-field map.

object
key
additional properties
any
Example 
{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

404

Section titled “404 ”

Resource not found in the caller’s org

Media type application/json
object
error
required
object
code
required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string
message
required

Human-readable summary

string
request_id
required

Server-generated request id for correlating logs

string
details

Optional structured context. Validation errors land at details.fields as a per-field map.

object
key
additional properties
any
Example 
{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

409

Section titled “409 ”

Role is archived (role_archived) — unarchive before editing.

Media type application/json
object
error
required
object
code
required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string
message
required

Human-readable summary

string
request_id
required

Server-generated request id for correlating logs

string
details

Optional structured context. Validation errors land at details.fields as a per-field map.

object
key
additional properties
any
Example 
{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

423

Section titled “423 ”

Tenant is past_due, decommissioning, or trial-expired

Media type application/json
object
error
required
object
code
required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string
message
required

Human-readable summary

string
request_id
required

Server-generated request id for correlating logs

string
details

Optional structured context. Validation errors land at details.fields as a per-field map.

object
key
additional properties
any
Example 
{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}