View as Markdown
Apify (OAuth) icon

Apify (OAuth) ACTION

Run Task Synchronously

Run a specific task and return its dataset items. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Apify (OAuth) account once, then configure and run Run Task Synchronously 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-task-synchronously",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    apify_oauth: { authProvisionId: "apn_xxxxxxx" },
    taskId: "Task ID",
    timeout: 10,
  },
})

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 Task Synchronously inputs
Property Type Description
taskId Task ID string
The ID of the task to run
Required Dynamic
timeout Timeout integer
Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the task settings.
Optional
memory Memory integer
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 task settings.
Optional
build Build string
Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).
Optional
clean Clean boolean
Return only non-empty items and skips hidden fields (i.e. fields starting with the # character)
Optional
fields Fields string[]
An array of fields which should be picked from the items, only these fields will remain in the resulting record objects.
Optional
omit Omit string[]
An array of fields which should be omitted from the items
Optional
flatten Flatten string[]
An array of fields which should transform nested objects into flat structures. For example, with flatten="foo" the object {"foo":{"bar": "hello"}} is turned into {"foo.bar": "hello"}
Optional
limit Limit integer
The maximum number of items to return
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-task-synchronously
Version
0.0.3
App
Apify (OAuth)
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes