View as Markdown
Relevance AI icon

Relevance AI ACTION

Run Tool

Executes a specific tool within Relevance AI and waits for a response for up to 60 seconds. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Relevance AI account once, then configure and run Run Tool 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: "relevance_ai-run-tool",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    relevance_ai: { authProvisionId: "apn_xxxxxxx" },
    toolId: "Tool ID",
    parameters: "Parameters",
  },
})

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.

Run Tool inputs
Property Type Description
toolId Tool ID string
The ID of the tool to execute.
Required Dynamic
parameters Parameters object
The parameters for the tool execution.
Required
timeout Timeout integer
The time to wait for a response from the tool execution, in seconds.
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
relevance_ai-run-tool
Version
0.0.2
App
Relevance AI
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes