CONNECT APP
Build with Relevance AI
Artificial Intelligence (AI)
- API key
MCP
Give your agent Relevance AI tools
Every Relevance AI 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 Relevance AI 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": "relevance_ai",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run List Tool ID Options:
const result = await mcp.callTool({
name: "relevance_ai-list-tool-id-options",
arguments: {
page: 10,
},
})# 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": "relevance_ai",
}
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 List Tool ID Options:
result = await session.call_tool("relevance_ai-list-tool-id-options", {
"page": 10,
})API PROXY
Call the Relevance AI API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Relevance AI 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 Relevance AI 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 Relevance AI actions from your backend
Connect a user's Relevance AI account once, then run List Tool ID Options 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: "relevance_ai-list-tool-id-options",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
relevance_ai: { authProvisionId: "apn_xxxxxxx" },
page: 10,
},
})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="relevance_ai-list-tool-id-options",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"relevance_ai": {"authProvisionId": "apn_xxxxxxx"},
"page": 10,
},
)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": "relevance_ai-list-tool-id-options",
"configured_props": {
"relevance_ai": { "authProvisionId": "apn_xxxxxxx" },
"page": 10
}
}'TOOLS
Relevance AI actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
List Tool ID Options
actionRetrieves available options for the Tool ID field.Read-onlyv0.0.1 -
Run Tool
actionExecutes a specific tool within Relevance AI and waits for a response for up to 60 seconds. See the documentationWritev0.0.2 -
Send Message to Agent
actionSends a message directly to an agent in Relevance AI. This action doesn't wait for an agent response.Writev0.0.2
EVENTS
Relevance AI triggers
Event sources your backend can deploy for users and receive through a webhook.
No Relevance AI triggers are available yet.
- App slug
- relevance_ai
- Authentication
- API key
- Categories
- Artificial Intelligence (AI)
- Actions
- 3
- Triggers
- 0
- API proxy
- Available