Skip to main content
POST
Create a background task

Body

application/json

Create a background task.

query
string
required

Instruction executed for each run

schedule
ScheduleSpec · object
required

Manual, once, interval, or cron

task_id
string
required

Stable task identifier

agent_id
string | null

Agent id. Defaults to OmniServe background_agent_id.

enabled
boolean
default:true

Whether the scheduler may run it

metadata
Metadata · object
overlap_policy
enum<string>
default:skip_if_running
Available options:
skip_if_running,
queue_next,
cancel_previous,
allow_parallel
replace
boolean
default:false

Replace an existing task

retry_policy
RetryPolicy · object
session_policy
SessionPolicy · object
timeout_seconds
integer | null

Per-run timeout

workspace_policy
WorkspacePolicy · object

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