View as Markdown
Apify (OAuth) icon

Apify (OAuth) ACTION

Run Actor

Performs an execution of a selected Actor in Apify. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Apify (OAuth) account once, then configure and run Run Actor 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: "apify_oauth-run-actor",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    apify_oauth: { authProvisionId: "apn_xxxxxxx" },
    actorSource: "Search Actors from",
    actorId: "Actor",
  },
})

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 Actor inputs
Property Type Description
actorSource Search Actors from string
Where to search for Actors. Valid options are Store and Recently used Actors.
Required
actorId Actor string
Select the Actor, enter the Actor ID, or use a tilde-separated combination of the owner's username and the Actor name.
Required Dynamic
buildTag Build string
Specifies the Actor build to run. The accepted value is the build tag. If not provided, the default build will be used.
Optional Dynamic
runAsynchronously Run Asynchronously boolean
Set to true to run the Actor asynchronously
Required
timeout Timeout (seconds) string
Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the Actor.
Optional
memory Memory (MB) string
Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the Actor.
Optional
maxItems Max Items string
The maximum number of items that the Actor run should return. This is useful for pay-per-result Actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your Actor by using the ACTOR_MAX_PAID_DATASET_ITEMS environment variable.
Optional
maxTotalChargeUsd Max Total Charge USD string
Specifies the maximum cost of the Actor run. This parameter is useful for pay-per-event Actors, as it allows you to limit the amount charged to your subscription. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.
Optional
webhook Webhook URL string
Specifies optional webhook associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed.
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
apify_oauth-run-actor
Version
0.0.3
App
Apify (OAuth)
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes