Skip to main content
PATCH
Patch a background task

Path Parameters

task_id
string
required

Body

application/json

Patch mutable fields on a background task.

enabled
boolean | null
metadata
Metadata · object | null
overlap_policy
enum<string> | null
Available options:
skip_if_running,
queue_next,
cancel_previous,
allow_parallel
query
string | null
retry_policy
RetryPolicy · object | null
schedule
ScheduleSpec · object | null
session_policy
SessionPolicy · object | null
timeout_seconds
integer | null
workspace_policy
WorkspacePolicy · object | null

Response

Successful Response

agent_id
string
required
query
string
required
schedule
ScheduleSpec · object
required
task_id
string
required
created_at
string<date-time>
enabled
boolean
default:true
metadata
Metadata · object
overlap_policy
enum<string>
default:skip_if_running
Available options:
skip_if_running,
queue_next,
cancel_previous,
allow_parallel
retry_policy
RetryPolicy · object
session_policy
SessionPolicy · object
timeout_seconds
integer | null
updated_at
string<date-time>
workspace_policy
WorkspacePolicy · object