curl --request POST \
--url https://api.example.com/block_documents/ \
--header 'Content-Type: application/json' \
--data '
{
"block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"data": {},
"is_anonymous": false
}
'import requests
url = "https://api.example.com/block_documents/"
payload = {
"block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"data": {},
"is_anonymous": False
}
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({
block_schema_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
block_type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
data: {},
is_anonymous: false
})
};
fetch('https://api.example.com/block_documents/', 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/block_documents/",
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([
'block_schema_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'block_type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'data' => [
],
'is_anonymous' => false
]),
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/block_documents/"
payload := strings.NewReader("{\n \"block_schema_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"data\": {},\n \"is_anonymous\": false\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/block_documents/")
.header("Content-Type", "application/json")
.body("{\n \"block_schema_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"data\": {},\n \"is_anonymous\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/block_documents/")
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 \"block_schema_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"data\": {},\n \"is_anonymous\": false\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",
"block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"data": {},
"block_schema": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"checksum": "<string>",
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fields": {},
"block_type": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"documentation_url": "<string>",
"description": "<string>",
"code_example": "<string>",
"is_protected": false
},
"capabilities": [
"<string>"
],
"version": "non-versioned"
},
"block_type_name": "<string>",
"block_type": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"documentation_url": "<string>",
"description": "<string>",
"code_example": "<string>",
"is_protected": false
},
"block_document_references": {},
"is_anonymous": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Create Block Document
Create a new block document.
For more information, see https://docs.prefect.io/v3/concepts/blocks.
curl --request POST \
--url https://api.example.com/block_documents/ \
--header 'Content-Type: application/json' \
--data '
{
"block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"data": {},
"is_anonymous": false
}
'import requests
url = "https://api.example.com/block_documents/"
payload = {
"block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"data": {},
"is_anonymous": False
}
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({
block_schema_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
block_type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
data: {},
is_anonymous: false
})
};
fetch('https://api.example.com/block_documents/', 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/block_documents/",
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([
'block_schema_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'block_type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'data' => [
],
'is_anonymous' => false
]),
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/block_documents/"
payload := strings.NewReader("{\n \"block_schema_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"data\": {},\n \"is_anonymous\": false\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/block_documents/")
.header("Content-Type", "application/json")
.body("{\n \"block_schema_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"data\": {},\n \"is_anonymous\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/block_documents/")
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 \"block_schema_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"data\": {},\n \"is_anonymous\": false\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",
"block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"data": {},
"block_schema": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"checksum": "<string>",
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fields": {},
"block_type": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"documentation_url": "<string>",
"description": "<string>",
"code_example": "<string>",
"is_protected": false
},
"capabilities": [
"<string>"
],
"version": "non-versioned"
},
"block_type_name": "<string>",
"block_type": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"documentation_url": "<string>",
"description": "<string>",
"code_example": "<string>",
"is_protected": false
},
"block_document_references": {},
"is_anonymous": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
Data used by the Prefect REST API to create a block document.
A block schema ID
A block type ID
The block document's name. Not required for anonymous block documents.
^[^/%&><]+$The block document's data
Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)
Response
Successful Response
An ORM representation of a block document.
A block schema ID
A block type ID
The block document's name. Not required for anonymous block documents.
^[^/%&><]+$The block document's data
The associated block schema
Show child attributes
Show child attributes
The associated block type's name
The associated block type
Show child attributes
Show child attributes
Record of the block document's references
Show child attributes
Show child attributes
Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)
Was this page helpful?