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

ActionWhat it does
Create blockAdd a block of text under a page or another block, at the position you choose.
Create pageAdd a page with a title.
Delete blockDelete a block and the blocks nested under it.
Delete pageDelete a page and all of its blocks.
List blocksList every block in your graph.
List pagesList every page in your graph.
Move blockMove a block to a new parent or position.
PullGet one page or block by its UID, with the attributes you choose.
Pull manyGet several pages or blocks by their UIDs, with the attributes you choose.
QueryRun a Datalog query over your graph and get the results.
Update blockChange a block's text, heading level or whether it is expanded.
Update pageRename a page.

Create block

Add a block of text under a page or another block, at the position you choose.

Inputs

Parent uidparent_uidtextRequired
Parent uid.
OrderordernumberRequired
Order.At least 0.
TexttexttextRequired
Text.
Uiduidtext
Leave empty to generate a unique ID.
Openopentrue/false
Open.
Headingheadingnumber
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

TitletitletextRequired
Title.
Uiduidtext
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

UiduidtextRequired
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

UiduidtextRequired
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

UiduidtextRequired
Uid.
Parent uidparent_uidtextRequired
Parent uid.
OrderordernumberRequired
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 blockuidtextRequired
Pick a page or enter a page or block UID.
Selectorselectortext
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 blocksuidslistRequired
Pick pages or enter page or block UIDs.
Selectorselectortext
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

QueryquerytextRequired
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

UiduidtextRequired
Uid.
Texttexttext
Text.
Openopentrue/false
Open.
Headingheadingnumber
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

UiduidtextRequired
Uid.
Titletitletext
Title.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "accepted": false,
    "uid": "example"
  },
  "next_cursor": ""
}

On this page