Skip to main content
POST
Queue or wait for a manual task run

Path Parameters

task_id
string
required

Body

application/json

Queue a manual run, optionally waiting for terminal state.

query
string | null

Optional one-off query override for this run

wait
boolean
default:false

Wait for the run to reach a terminal status before returning

Response

Successful Response

agent_id
string
required
query_snapshot
string
required
session_id
string
required
task_id
string
required
trigger_type
enum<string>
required
Available options:
manual,
interval,
cron,
once
workspace_path
string
required
attempt
integer
default:0
cancel_requested_at
string<date-time> | null
claimed_at
string<date-time> | null
due_at
string<date-time> | null
error
string | null
finished_at
string<date-time> | null
heartbeat_at
string<date-time> | null
lease_expires_at
string<date-time> | null
lease_generation
integer
default:0
lease_owner
string | null
lease_token
string | null
max_attempts
integer
default:1
metadata
Metadata · object
occurrence_id
string | null
queued_at
string<date-time> | null
result_preview
string | null
run_id
string
started_at
string<date-time> | null
status
enum<string>
default:queued
Available options:
queued,
claimed,
running,
retrying,
completed,
failed,
cancelled,
timeout,
skipped,
awaiting_approval,
awaiting_budget
trigger_metadata
Trigger Metadata · object
triggered_at
string<date-time>