POST
/
api
/
task_runs
/

Headers

x-prefect-api-version
string

Body

application/json

Data used by the Prefect REST API to create a task run

id
string | null

The ID to assign to the task run. If not provided, a random UUID will be generated.

state
object | null

The state of the task run to create

name
string
flow_run_id
string | null

The flow run id of the task run.

task_key
string
required

A unique identifier for the task being run.

dynamic_key
string
required

A dynamic key used to differentiate between multiple runs of the same task within the same flow run.

cache_key
string | null

An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run.

cache_expiration
string | null

Specifies when the cached state should expire.

task_version
string | null

The version of the task being run.

empirical_policy
object

Defines of how a task run should retry.

tags
string[]

A list of tags for the task run.

task_inputs
object

The inputs to the task run.

Response

200 - application/json

An ORM representation of task run data.

id
string
created
string | null
updated
string | null
name
string
flow_run_id
string | null

The flow run id of the task run.

task_key
string
required

A unique identifier for the task being run.

dynamic_key
string
required

A dynamic key used to differentiate between multiple runs of the same task within the same flow run.

cache_key
string | null

An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run.

cache_expiration
string | null

Specifies when the cached state should expire.

task_version
string | null

The version of the task being run.

empirical_policy
object

Defines of how a task run should retry.

tags
string[]

A list of tags for the task run.

state_id
string | null

The id of the current task run state.

task_inputs
object

Tracks the source of inputs to a task run. Used for internal bookkeeping.

state_type
enum<string> | null

The type of the current task run state.

Available options:
SCHEDULED,
PENDING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
CRASHED,
PAUSED,
CANCELLING
state_name
string | null

The name of the current task run state.

run_count
integer
default: 0

The number of times the task run has been executed.

flow_run_run_count
integer
default: 0

If the parent flow has retried, this indicates the flow retry this run is associated with.

expected_start_time
string | null

The task run's expected start time.

next_scheduled_start_time
string | null

The next time the task run is scheduled to start.

start_time
string | null

The actual start time.

end_time
string | null

The actual end time.

total_run_time
number
default: 0

Total run time. If the task run was executed multiple times, the time of each run will be summed.

estimated_run_time
number
default: 0

A real-time estimate of total run time.

estimated_start_time_delta
number
default: 0

The difference between actual and expected start time.

state
object | null

The current task run state.

Was this page helpful?

Count Task Runs By Flow RunRead Task Run