Skip to main content
PUT
Update Task by ID

Path Parameters

task_id
string
required

Body

application/json
task_metadata
If provided, replaces task_metadata with this value · object | null
merge_params
Optional shallow-merge patch applied to the task's params column. Top-level keys overwrite; pass full nested objects to change subfields. · object | null

Response

Successful Response

id
string
required
name
string | null
status
enum<string> | null
Available options:
CANCELED,
COMPLETED,
FAILED,
RUNNING,
TERMINATED,
TIMED_OUT,
DELETED
status_reason
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
cleaned_at
string<date-time> | null
params
Task parameters · object | null
task_metadata
Task metadata · object | null