View as Markdown
Roam Research icon

Roam Research ACTION

Query

Generic query for Roam Research pages. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Roam Research account once, then configure and run Query from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "roamresearch-query",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    roamresearch: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    args: ["Arguments"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Query inputs
Property Type Description
query Query string
The query to run in Datalog language. Eg. [:find ?block-uid ?block-str :in $ ?search-string :where [?b :block/uid ?block-uid] [?b :block/string ?block-str] [(clojure.string/includes? ?block-str ?search-string)]].
Required
args Arguments string[]
The arguments to pass to the query. Eg. apple as the firs argument.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
roamresearch-query
Version
0.0.3
App
Roam Research
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes