Create Flow
curl --request POST \
--url https://api.example.com/flows/ \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"tags": [
"<string>"
],
"labels": {
"key": "value1",
"key2": 42
}
}
'import requests
url = "https://api.example.com/flows/"
payload = {
"name": "<string>",
"tags": ["<string>"],
"labels": {
"key": "value1",
"key2": 42
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', tags: ['<string>'], labels: {key: 'value1', key2: 42}})
};
fetch('https://api.example.com/flows/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/flows/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'tags' => [
'<string>'
],
'labels' => [
'key' => 'value1',
'key2' => 42
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/flows/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"labels\": {\n \"key\": \"value1\",\n \"key2\": 42\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/flows/")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"labels\": {\n \"key\": \"value1\",\n \"key2\": 42\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/flows/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"labels\": {\n \"key\": \"value1\",\n \"key2\": 42\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"tags": [
"<string>"
],
"labels": {
"key": "value1",
"key2": 42
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Flows
Create Flow
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/concepts/flows.
POST
/
flows
/
Create Flow
curl --request POST \
--url https://api.example.com/flows/ \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"tags": [
"<string>"
],
"labels": {
"key": "value1",
"key2": 42
}
}
'import requests
url = "https://api.example.com/flows/"
payload = {
"name": "<string>",
"tags": ["<string>"],
"labels": {
"key": "value1",
"key2": 42
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', tags: ['<string>'], labels: {key: 'value1', key2: 42}})
};
fetch('https://api.example.com/flows/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/flows/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'tags' => [
'<string>'
],
'labels' => [
'key' => 'value1',
'key2' => 42
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/flows/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"labels\": {\n \"key\": \"value1\",\n \"key2\": 42\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/flows/")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"labels\": {\n \"key\": \"value1\",\n \"key2\": 42\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/flows/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"labels\": {\n \"key\": \"value1\",\n \"key2\": 42\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"tags": [
"<string>"
],
"labels": {
"key": "value1",
"key2": 42
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
Data used by the Prefect REST API to create a flow.
The name of the flow
Pattern:
^[^/%&><]+$Example:
"my-flow"
A list of flow tags
Example:
["tag-1", "tag-2"]
A dictionary of key-value labels. Values can be strings, numbers, or booleans.
Show child attributes
Show child attributes
Example:
{ "key": "value1", "key2": 42 }
Response
Successful Response
An ORM representation of flow data.
The name of the flow
Pattern:
^[^/%&><]+$Example:
"my-flow"
A list of flow tags
Example:
["tag-1", "tag-2"]
A dictionary of key-value labels. Values can be strings, numbers, or booleans.
Show child attributes
Show child attributes
Example:
{ "key": "value1", "key2": 42 }
Was this page helpful?
⌘I