Update Agent Key

PATCH

/api/agents/{agent_id}

curl --request PATCH \
  --url https://example.com/api/agents/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "enabled": true, "is_admin": true, "allowed_characters": [ "example" ], "allowed_workflows": [ "example" ], "max_concurrent_jobs": 1 }'

Change an agent’s name, scope, admin flag, or revoke/re-enable its key. Admin keys only.

Authorizations

• bearerAuth

Parameters

Path Parameters

agent_id

required

Agent Id

string

Request Body^required

Media typeapplication/json

AgentUpdateRequest

Only the fields sent change.

object

name

Any of:

string

string

>= 1 characters <= 100 characters

null

null

enabled

Any of:

boolean

boolean

null

null

is_admin

Any of:

boolean

boolean

null

null

allowed_characters

Any of:

Array<string>

Array<string>

null

null

allowed_workflows

Any of:

Array<string>

Array<string>

null

null

max_concurrent_jobs

Any of:

integer

integer

>= 1

null

null

Example^generated

{
  "name": "example",
  "enabled": true,
  "is_admin": true,
  "allowed_characters": [
    "example"
  ],
  "allowed_workflows": [
    "example"
  ],
  "max_concurrent_jobs": 1
}

Responses

200

Successful Response

Media typeapplication/json

AgentRecord

An API key’s identity and scope. The key itself is never stored or returned again.

object

id

required

Id

string

name

required

Name

string

enabled

required

Enabled

boolean

is_admin

required

Is Admin

boolean

allowed_characters

required

Allowed Characters

Array<string>

allowed_workflows

required

Allowed Workflows

Array<string>

max_concurrent_jobs

required

Any of:

integer

integer

null

null

created_at

required

Created At

string format: date-time

last_used_at

required

Any of:

string

string format: date-time

null

null

avatar

Any of:

string

string

null

null

bio

Any of:

string

string

null

null

Example^generated

{
  "id": "example",
  "name": "example",
  "enabled": true,
  "is_admin": true,
  "allowed_characters": [
    "example"
  ],
  "allowed_workflows": [
    "example"
  ],
  "max_concurrent_jobs": 1,
  "created_at": "2026-04-15T12:00:00Z",
  "last_used_at": "2026-04-15T12:00:00Z",
  "avatar": "example",
  "bio": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}