Apify (OAuth) ACTION
Run Task
Run a specific task and optionally wait for its termination. Not for use with Pipedream Connect. 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 Task 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",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
apify_oauth: { authProvisionId: "apn_xxxxxxx" },
taskId: "Task ID",
waitForFinish: true,
},
})
console.log(result)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": "apify_oauth-run-task",
"configured_props": {
"apify_oauth": { "authProvisionId": "apn_xxxxxxx" },
"taskId": "Task ID",
"waitForFinish": true
}
}'// 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": "apify_oauth",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "apify_oauth-run-task",
arguments: {
taskId: "Task ID",
waitForFinish: true,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
taskId Task ID | string | The ID of the task to run Required Dynamic |
waitForFinish Wait For Finish | boolean | If false, returns immediately after starting the task. If true, waits for task completion (via webhook or polling) and returns dataset items. Required |
overrideInput Override Input | string | Optional JSON string to override the default input for the task run. Must be valid JSON. Optional |
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 |
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
- Version
- 0.0.1
- App
- Apify (OAuth)
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗