Models
Get Started
Integrations
cURL
Copy
curl --request POST \
--url http://localhost:8000/api/v1/documentation/{parent_id}/blocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": [
{
"block_type": "bookmark",
"content": [
{
"annotations": {
"bold": "<string>",
"italic": "<string>",
"strikethrough": "<string>",
"underline": "<string>",
"code": "<string>",
"color": "<string>"
},
"plain_text": "<string>",
"href": "<string>"
}
]
}
]
}
'Copy
{
"data": {
"block_type": "bookmark",
"id": "<string>",
"content": [
{
"annotations": {
"bold": "<string>",
"italic": "<string>",
"strikethrough": "<string>",
"underline": "<string>",
"code": "<string>",
"color": "<string>"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"parent_id": "<string>"
},
"meta": {}
}Block
Create Block
POST
/
v1
/
documentation
/
{parent_id}
/
blocks
cURL
Copy
curl --request POST \
--url http://localhost:8000/api/v1/documentation/{parent_id}/blocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": [
{
"block_type": "bookmark",
"content": [
{
"annotations": {
"bold": "<string>",
"italic": "<string>",
"strikethrough": "<string>",
"underline": "<string>",
"code": "<string>",
"color": "<string>"
},
"plain_text": "<string>",
"href": "<string>"
}
]
}
]
}
'Copy
{
"data": {
"block_type": "bookmark",
"id": "<string>",
"content": [
{
"annotations": {
"bold": "<string>",
"italic": "<string>",
"strikethrough": "<string>",
"underline": "<string>",
"code": "<string>",
"color": "<string>"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"parent_id": "<string>"
},
"meta": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
This will be parent id of the block you want to create
Query Parameters
Include raw response. When you want more data from the source
Body
application/json
Show child attributes
Show child attributes
Type of the block
Available options:
bookmark, breadcrumb, bulleted_list_item, callout, child_database, child_page, column, column_list, divider, embed, equation, file, heading_1, heading_2, heading_3, image, link_preview, link_to_page, numbered_list_item, paragraph, pdf, quote, synced_block, table, table_of_contents, table_row, template, to_do, toggle, unsupported, video Content of the block
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Text for the block
Link for the block. Example blocks: Youtube, Bookmarks
Response
Show child attributes
Show child attributes
Type of the block
Available options:
bookmark, breadcrumb, bulleted_list_item, callout, child_database, child_page, column, column_list, divider, embed, equation, file, heading_1, heading_2, heading_3, image, link_preview, link_to_page, numbered_list_item, paragraph, pdf, quote, synced_block, table, table_of_contents, table_row, template, to_do, toggle, unsupported, video A unique identifier for the block.
Content of the block
Show child attributes
Show child attributes
The text in the block
All the properties about the text
Id of the parent block
⌘I