View as Markdown
Faraday icon

Faraday ACTION

Predict

Returns a prediction about a single person. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Faraday account once, then configure and run Predict 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: "faraday-predict",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    faraday: { authProvisionId: "apn_xxxxxxx" },
    targetId: "Target ID",
    email: "Email",
  },
})

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.

Predict inputs
Property Type Description
targetId Target ID string
The ID of the target to use for the prediction
Required Dynamic
email Email string
The person's email address
Optional
phone Phone string
The person's phone number
Optional
firstName First Name string
The person's first name
Optional
lastName Last Name string
The person's last name
Optional
address Street Address string
The person's street address
Optional
city City string
The person's city
Optional
state State string
The person's state
Optional
postcode Postcode string
The person's postcode
Optional

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
faraday-predict
Version
0.0.2
App
Faraday
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes