Skip to content
LogoLogo

Hire one curated Agent into a Workspace

Hire one curated Agent into a Workspace

POST/api/v1/workspaces/{workspace_id}/agents

Creates Core-owned desired state. It does not synchronously invoke the Knowledge runtime or imply that a run succeeded.

Path Parameters

workspace_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.

Idempotency-KeyRequired
string·min 16·max 200

Opaque client-generated key for safely retrying this operation.

Request Body

application/json
definition_idRequired
string <uuid>

Stable Assign-owned identifier for a curated Agent definition. Definition identifiers are not resource UUIDv7 identifiers and clients must treat them as opaque.

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
schedule_local_time
string
schedule_weekdays
integer[]·min 1·max 7
schedule_interval_minutes

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

Responses

Authentication · Conventions and errors · API guides · Resource reference