CONNECT APP
Build with Roam Research
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",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"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",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add Content To Daily Note Page:
result = await session.call_tool("roamresearch-add-content-to-daily-note-page", {
"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.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"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",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="roamresearch-add-content-to-daily-note-page",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"roamresearch": {"authProvisionId": "apn_xxxxxxx"},
"dailyNoteTitle": "Date For Daily Note",
"content": "Content",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "roamresearch-add-content-to-daily-note-page",
"configured_props": {
"roamresearch": { "authProvisionId": "apn_xxxxxxx" },
"dailyNoteTitle": "Date For Daily Note",
"content": "Content"
}
}'TOOLS
Roam Research actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Content To Daily Note Page
actionAdds content as a child block to a daily note page in Roam Research (access to encrypted and non encrypted graphs). See the documentation.Writev0.0.4 -
Add Content To Page
actionAdd content as a child block to an existing or new page in Roam Research (access to encrypted and non encrypted graphs). See the documentation.Writev0.0.3 -
Add Content Underneath Block
actionAdd content underneath an existing block in your Roam Research graph (access to encrypted and non encrypted graphs). See the documentationWritev0.0.3 -
Append Blocks
actionGeneric append blocks for Roam Research pages. See the documentation.Writev0.0.2 -
Get Page Or Block Data
actionGet the data for a page or block in Roam Research (access only to non ecrypted graphs). See the documentation.Read-onlyv0.0.3 -
Pull
actionGeneric pull for Roam Research pages. See the documentation.Writev0.0.3 -
Pull Many
actionGeneric pull many for Roam Research pages. See the documentation.Writev0.0.3 -
Query
actionGeneric query for Roam Research pages. See the documentation.Writev0.0.3 -
Search Title
actionSearch for a title in Roam Research pages (access only to non ecrypted graphs). See the documentation.Read-onlyv0.0.3 -
Write
actionGeneric write for Roam Research pages. See the documentation.Writev0.0.2
EVENTS
Roam Research triggers
Event sources your backend can deploy for users and receive through a webhook.
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.
- App slug
- roamresearch
- Authentication
- API key
- Categories
- Learning & Education
- Actions
- 10
- Triggers
- 1
- API proxy
- Available