View as Markdown
Skyvern icon

Skyvern ACTION

Create and Run Task

Create a new task and run it instantly in Skyvern. Useful for one-off automations. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Skyvern account once, then configure and run Create and 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: "skyvern-create-run-task",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    skyvern: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    navigationGoal: "Navigation Goal",
  },
})

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.

Create and Run Task inputs
Property Type Description
url URL string
It must be a http or https URL.
Required
navigationGoal Navigation Goal string
The prompt that tells the agent what the user-facing goal is. This is the guiding light for the LLM as it navigates a particular website / sitemap to achieve this specified goal.
Optional
dataExtractionGoal Data Extraction Goal string
The prompt that instructs the agent to extract information once the agent has achieved its User Goal.
Optional
navigationPayload Navigation Payload object
JSON-formatted payload with any "facts" or information that would help the agent perform its job. In the case of navigating an insurance quote, this payload would include any user information to help fill out the insurance flow such as date of birth, or age they got their license, and so on. This can include nested information, and the formatting isn't validated.
Optional
webhookCallbackUrl Webhook Callback URL string
The callback URL once our system is finished processing this async task.
Optional
extractedInformationSchema Extracted Information Schema object
Used to enforce a JSON schema spec to be enforced in the data_extraction_goal. Similar to https://json-schema.org/ definition.
Optional
totpVerificationUrl TOTP Verification URL string
The URL of your TOTP endpoint. If this field is provided, Skyvern will call the URL to fetch the TOTP/2FA/MFA code when needed.
Optional
totpIdentifier TOTP Identifier string
The email address or the phone number which receives the TOTP/2FA/MFA code. If this field is provided, Skyvern will fetch the code that is pushed to Skyvern's TOTP API.
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
skyvern-create-run-task
Version
0.0.3
App
Skyvern
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes