Roam Research icon

CONNECT APP

Build with Roam Research

A note-taking tool for networked thought.

Learning & Education

  • API key

MCP

Give your agent Roam Research tools

Every Roam Research action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Roam Research account for each tool call — you store no tokens.

// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": "{project_id}",
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "roamresearch",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Add Content To Daily Note Page:
const result = await mcp.callTool({
  name: "roamresearch-add-content-to-daily-note-page",
  arguments: {
    dailyNoteTitle: "Date For Daily Note",
    content: "Content",
  },
})

API PROXY

Call the Roam Research API directly

For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Roam Research API with the connected user's credentials attached. You store no tokens and write no refresh logic.

const resp = await pd.proxy.get({
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  accountId: "apn_xxxxxxx",
  url: "https://api.example.com/v1/me",
})

// Any allowed Roam Research endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.

SDK

Run Roam Research actions from your backend

Connect a user's Roam Research account once, then run Add Content To Daily Note Page on their behalf from your own code — TypeScript, Python, or plain HTTP.

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-add-content-to-daily-note-page",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    roamresearch: { authProvisionId: "apn_xxxxxxx" },
    dailyNoteTitle: "Date For Daily Note",
    content: "Content",
  },
})

MULTI-APP

Use Roam Research with other popular apps

Most products don't stop at one integration. Pair Roam Research with the other apps your users rely on, and ship use cases that span both.

REFERENCE

App details

Reference metadata for the Roam Research connector in the Pipedream registry.

App slug
roamresearch
Authentication
API key
Categories
Learning & Education
Actions
10
Triggers
1
API proxy
Available