Skip to content
LogoLogo

Update one Workspace Agent's bounded configuration

Update one Workspace Agent's bounded configuration

PATCH/api/v1/workspaces/{workspace_id}/agents/{agent_id}

Updates scope, supported trigger selection, additional instructions, or active/paused state. Definition, model, provider, prompt, skill, MCP, and raw capability controls are not accepted.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
agent_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

If-MatchRequired
string

Entity tag containing the resource version last observed by the client.

Request Body

application/json
statusRequired
string
Values
activepaused
scope_kindRequired
string
Values
workspaceprojects
project_idsRequired
string <uuid>[]·max 1000

Must be empty for Workspace scope and non-empty for selected-Projects scope.

enabled_trigger_typesRequired
string[]·min 1·max 3
Values
manualeventschedule
additional_instructionsRequired
string·max 2000
schedule_timezone
string·min 1·max 100

IANA timezone used for scheduled occurrences.

schedule_local_time
string

Minute-precision local wall time.

schedule_weekdays
integer[]·min 1·max 7

ISO weekdays where Monday is 1 and Sunday is 7.

schedule_interval_minutes

Fixed recurrence interval. Zero uses the local-time weekday schedule.

Responses

Authentication · Conventions and errors · API guides · Resource reference