Update Job Definition Api V1 Workstreams Jobs Job Id Patch
patch
/api/v1/workstreams/jobs/{job_id}Update job definition
Update a job definition (by ID or permakey).
Path parameters
job_idrequiredpath | β |
Request bodyapplication/json
| Field | Type | Description |
|---|---|---|
name | string | null | β |
description | string | null | β |
goal_template | string | null | β |
tools | string[] | null | β |
deliverables | object[] | null | β |
max_turns | integer | null | β |
max_cost_usd | number | null | β |
max_duration_minutes | integer | null | β |
target_selector | TargetSelector | null | β |
per_client_overrides | object | null | β |
default_context | object | null | β |
source_tracing | boolean | null | β |
human_checkpoints | string[] | null | β |
schedule | string | null | β |
schedule_timezone | string | null | β |
is_enabled | boolean | null | β |
status | string | null | β |
Responses
200Successful Response
| Field | Type | Description |
|---|---|---|
idrequired | string (uuid) | β |
permakey | string | null | Stable human-readable key for the batch/fan-out deep-link URL /workstreams/{ws}/cycles/{permakey}/β¦ (#173). Null on legacy rows. |
namerequired | string | β |
description | string | null | β |
domainrequired | string | β |
goal_templaterequired | string | β |
toolsrequired | string[] | β |
deliverablesrequired | object[] | βitem shapeEmpty object. |
max_turnsrequired | integer | β |
max_cost_usdrequired | number | β |
max_duration_minutesrequired | integer | β |
target_selectorrequired | object | βshow nestedEmpty object. |
per_client_overridesrequired | object | βshow nestedEmpty object. |
default_contextrequired | object | βshow nestedEmpty object. |
source_tracingrequired | boolean | β |
human_checkpointsrequired | string[] | β |
schedule | string | null | β |
schedule_timezonerequired | string | β |
is_enabledrequired | boolean | β |
next_run_at | any | null | β |
last_run_at | any | null | β |
statusrequired | string | β |
created_byrequired | string | β |
created_atrequired | any | β |
updated_atrequired | any | β |
current_version | integer | null | Latest version number in job_definition_version; null if no history yet. |
422Validation Error
| Field | Type | Description |
|---|---|---|
detail | ValidationError[] | βitem shape |
curl https://api.dev.arch.ie/api/v1/workstreams/jobs/<job_id> \
-X PATCH \
-H "Authorization: Bearer sk_..." \
-H "Content-Type: application/json" \
-d '{
"name": null,
"description": null,
"goal_template": null,
"tools": null,
"deliverables": null,
"max_turns": null,
"max_cost_usd": null,
"max_duration_minutes": null,
"target_selector": null,
"per_client_overrides": null,
"default_context": null,
"source_tracing": null,
"human_checkpoints": null,
"schedule": null,
"schedule_timezone": null,
"is_enabled": null,
"status": null
}'