View as Markdown
Roam Research icon

Roam Research ACTION

Pull Many

Generic pull many 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 Pull Many 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-pull-many",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    roamresearch: { authProvisionId: "apn_xxxxxxx" },
    eids: "Entity IDs",
    selector: "Selector",
  },
})

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.

Pull Many inputs
Property Type Description
eids Entity IDs string
The entity IDs to pull. Eg. [[:block/uid "08-30-2022"] [:block/uid "08-31-2022"]].
Required
selector Selector string
The selector to pull. Eg. [:block/uid :node/title :block/string {:block/children [:block/uid :block/string]} {:block/refs [:node/title :block/string :block/uid]}].
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-pull-many
Version
0.0.3
App
Roam Research
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes