rocketkind
Productivity

Roam Research

Roam Research is a networked note-taking tool where everything is a block — a line of text with its own id that can be linked, nested and referenced from anywhere else.

Authentication

  • Graph API token

Actions

Generic API request. Call any Roam backend API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill — and the path must carry the graph name itself, as api/graph/<graph>/write.

  • Create a blockWrite a block of text into the connected Roam graph, under a page or under another block.
  • Create a pageCreate a new top-level page in the connected Roam graph.
  • Delete a blockDestructiveDelete a block from the connected Roam graph, together with every block nested under it.
  • Delete a pageDestructiveDelete a page from the connected Roam graph, together with every block on it.
  • Find blocks containing textSearch the text of every block in the connected Roam graph for a piece of text, and get each hit's uid plus the page it lives on.
  • Find pages by titleFind pages in the connected Roam graph whose title contains a piece of text, and get each one's uid back.
  • Move a blockDestructiveMove an existing block to a new parent or a new position among its siblings.
  • Pull an entityDestructiveRead one page or block out of the connected Roam graph, with a pull pattern saying which attributes to fetch and how far down its children to follow.
  • Pull several entitiesDestructiveRead several pages or blocks in one call, applying the same pull pattern to each.
  • Run a Datalog queryAsk the connected Roam graph an arbitrary question in Datalog — Roam's read API is a query endpoint, not a set of REST resources, so this is how you find anything the shipped search actions do not already cover: blocks by attribute, pages by their references, todos, links between two pages.
  • Update a blockDestructiveRewrite a block's text in the connected Roam graph, or change how it renders.
  • Update a pageDestructiveRename a page in the connected Roam graph, or change how its blocks are displayed.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.