Roam Research
App · 12 actions
Read, add and reorganise the pages and blocks of a Roam Research graph, and run Datalog queries over it.
Actions
| Action | What it does |
|---|---|
| Create block | Add a block of text under a page or another block, at the position you choose. |
| Create page | Add a page with a title. |
| Delete block | Delete a block and the blocks nested under it. |
| Delete page | Delete a page and all of its blocks. |
| List blocks | List every block in your graph. |
| List pages | List every page in your graph. |
| Move block | Move a block to a new parent or position. |
| Pull | Get one page or block by its UID, with the attributes you choose. |
| Pull many | Get several pages or blocks by their UIDs, with the attributes you choose. |
| Query | Run a Datalog query over your graph and get the results. |
| Update block | Change a block's text, heading level or whether it is expanded. |
| Update page | Rename a page. |
Create block
Add a block of text under a page or another block, at the position you choose.
Inputs
- Parent uid
parent_uidtextRequired - Parent uid.
- Order
ordernumberRequired - Order.At least 0.
- Text
texttextRequired - Text.
- Uid
uidtext - Leave empty to generate a unique ID.
- Open
opentrue/false - Open.
- Heading
headingnumber - Heading.One of:
0,1,2,3.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"accepted": false,
"uid": "example"
},
"next_cursor": ""
}Create page
Add a page with a title.
Inputs
- Title
titletextRequired - Title.
- Uid
uidtext - Leave empty to generate a unique ID.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"accepted": false,
"uid": "example"
},
"next_cursor": ""
}Delete block
Delete a block and the blocks nested under it.
Inputs
- Uid
uidtextRequired - Uid.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"accepted": false,
"uid": "example"
},
"next_cursor": ""
}Delete page
Delete a page and all of its blocks.
Inputs
- Uid
uidtextRequired - Uid.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"accepted": false,
"uid": "example"
},
"next_cursor": ""
}List blocks
List every block in your graph.
Inputs
None.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"result": []
},
"next_cursor": ""
}List pages
List every page in your graph.
Inputs
None.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"result": []
},
"next_cursor": ""
}Move block
Move a block to a new parent or position.
Inputs
- Uid
uidtextRequired - Uid.
- Parent uid
parent_uidtextRequired - Parent uid.
- Order
ordernumberRequired - Order.At least 0.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"accepted": false,
"uid": "example"
},
"next_cursor": ""
}Pull
Get one page or block by its UID, with the attributes you choose.
Inputs
- Page or block
uidtextRequired - Pick a page or enter a page or block UID.
- Selector
selectortext - Roam pull pattern. Leave empty to retrieve every attribute.Default:
[*].
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"result": {}
},
"next_cursor": ""
}Pull many
Get several pages or blocks by their UIDs, with the attributes you choose.
Inputs
- Pages or blocks
uidslistRequired - Pick pages or enter page or block UIDs.
- Selector
selectortext - Roam pull pattern. Leave empty to retrieve every attribute.Default:
[*].
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"result": {}
},
"next_cursor": ""
}Query
Run a Datalog query over your graph and get the results.
Inputs
- Query
querytextRequired - Query.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"result": {}
},
"next_cursor": ""
}Update block
Change a block's text, heading level or whether it is expanded.
Inputs
- Uid
uidtextRequired - Uid.
- Text
texttext - Text.
- Open
opentrue/false - Open.
- Heading
headingnumber - Heading.One of:
0,1,2,3.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"accepted": false,
"uid": "example"
},
"next_cursor": ""
}Update page
Rename a page.
Inputs
- Uid
uidtextRequired - Uid.
- Title
titletext - Title.
Outputs
dataobject- Response.
next_cursortext- Continuation token, when returned by the service.
Example output
{
"data": {
"accepted": false,
"uid": "example"
},
"next_cursor": ""
}