Create Flow Run
Create a flow run. If a flow run with the same flow_id and idempotency key already exists, the existing flow run will be returned.
If no state is provided, the flow run will be created in a PENDING state.
Headers
Body
Data used by the Prefect REST API to create a flow run.
The id of the flow being run.
The state of the flow run to create
The name of the flow run. Defaults to a random slug if not specified.
The version of the flow being run.
The context of the flow run.
The empirical policy for the flow run.
A list of tags for the flow run.
A dictionary of key-value labels. Values can be strings, numbers, or booleans.
An optional idempotency key. If a flow run with the same idempotency key has already been created, the existing flow run will be returned.
DEPRECATED: The id of the deployment associated with this flow run, if available.
Response
The id of the flow being run.
The name of the flow run. Defaults to a random slug if not specified.
The id of the flow run's current state.
The id of the deployment associated with this flow run, if available.
The version of the deployment associated with this flow run.
The id of the run's work pool queue.
The work queue that handled this flow run.
The version of the flow executed in this flow run.
Parameters for the flow run.
An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times.
Additional context for the flow run.
Defines of how a flow run should retry.
A list of tags on the flow run
A dictionary of key-value labels. Values can be strings, numbers, or booleans.
If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state.
The type of the current flow run state.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING The name of the current flow run state.
The number of times the flow run was executed.
The flow run's expected start time.
The next time the flow run is scheduled to start.
The actual start time.
The actual end time.
Total run time. If the flow run was executed multiple times, the time of each run will be summed.
A real-time estimate of the total run time.
The difference between actual and expected start time.
Whether or not the flow run was automatically scheduled.
The block document defining infrastructure to use this flow run.
The id of the flow run as returned by an infrastructure block.
Optional information about the creator of this flow run.
The id of the flow run's work pool.
The name of the flow run's work pool.
The current state of the flow run.
Variables used as overrides in the base job template
Was this page helpful?