Create Flow

Gracefully creates a new flow from the provided schema. If a flow with the same name already exists, the existing flow is returned.

For more information, see https://docs.prefect.io/v3/develop/write-flows.

Headers

x-prefect-api-version

string

Body

application/json

Data used by the Prefect REST API to create a flow.

name

string

required

The name of the flow

Example:

"my-flow"

tags

string[]

A list of flow tags

Example:

["tag-1", "tag-2"]

labels

object | null

A dictionary of key-value labels. Values can be strings, numbers, or booleans.

Show child attributes

labels.{key}

Example:

{ "key": "value1", "key2": 42 }

Response

200

application/json

Successful Response

An ORM representation of flow data.

id

string

required

created

string | null

required

updated

string | null

required

name

string

required

The name of the flow

Example:

"my-flow"

tags

string[]

A list of flow tags

Example:

["tag-1", "tag-2"]

labels

object | null

A dictionary of key-value labels. Values can be strings, numbers, or booleans.

Show child attributes

labels.{key}

Example:

{ "key": "value1", "key2": 42 }