← Skyvern

Create and Run Task with Skyvern API

Pipedream makes it easy to connect APIs for Skyvern and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create and Run Task with the Skyvern API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create and Run Task with the Skyvern API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create and Run Task action
    1. Connect your Skyvern account
    2. Configure URL
    3. Optional- Configure Navigation Goal
    4. Optional- Configure Data Extraction Goal
    5. Optional- Configure Navigation Payload
    6. Optional- Configure Webhook Callback URL
    7. Optional- Configure Extracted Information Schema
    8. Optional- Configure TOTP Verification URL
    9. Optional- Configure TOTP Identifier
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create and Run Task with Skyvern API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Skyvern
 
Try it
Create and Run Task with Skyvern API on New Submission from Typeform API
Typeform + Skyvern
 
Try it
Create and Run Task with Skyvern API on New Submission (Instant) from Jotform API
Jotform + Skyvern
 
Try it
Create and Run Task with Skyvern API on New Scheduled Tasks from Pipedream API
Pipedream + Skyvern
 
Try it
Create and Run Task with Skyvern API on New Download Counts from npm API
npm + Skyvern
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create and Run Task on Skyvern
Description:Create a new task and run it instantly in Skyvern. Useful for one-off automations. [See the documentation](https://docs.skyvern.com/)
Version:0.0.1
Key:skyvern-create-run-task

Code

import { parseObject } from "../../common/utils.mjs";
import skyvern from "../../skyvern.app.mjs";

export default {
  key: "skyvern-create-run-task",
  name: "Create and Run Task",
  description: "Create a new task and run it instantly in Skyvern. Useful for one-off automations. [See the documentation](https://docs.skyvern.com/)",
  version: "0.0.1",
  type: "action",
  props: {
    skyvern,
    url: {
      type: "string",
      label: "URL",
      description: "It must be a http or https URL.",
    },
    navigationGoal: {
      type: "string",
      label: "Navigation Goal",
      description: "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: true,
    },
    dataExtractionGoal: {
      type: "string",
      label: "Data Extraction Goal",
      description: "The prompt that instructs the agent to extract information once the agent has achieved its **User Goal**.",
      optional: true,
    },
    navigationPayload: {
      type: "object",
      label: "Navigation Payload",
      description: "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: true,
    },
    webhookCallbackUrl: {
      propDefinition: [
        skyvern,
        "webhookCallbackUrl",
      ],
      description: "The callback URL once our system is finished processing this async task.",
      optional: true,
    },
    extractedInformationSchema: {
      type: "object",
      label: "Extracted Information Schema",
      description: "Used to enforce a JSON schema spec to be enforced in the data_extraction_goal. Similar to [https://json-schema.org/](https://json-schema.org/) definition.",
      optional: true,
    },
    totpVerificationUrl: {
      type: "string",
      label: "TOTP Verification URL",
      description: "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: true,
    },
    totpIdentifier: {
      type: "string",
      label: "TOTP Identifier",
      description: "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](https://docs.skyvern.com/running-tasks/advanced-features#push-code-to-skyvern).",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.skyvern.createAndRunTask({
      $,
      data: {
        url: this.url,
        navigation_goal: this.navigationGoal,
        data_extraction_goal: this.dataExtractionGoal,
        navigation_payload: parseObject(this.navigationPayload),
        webhook_callback_url: this.webhookCallbackUrl,
        proxyLocation: "RESIDENTIAL",
        extracted_information_schema: parseObject(this.extractedInformationSchema),
        totp_verification_url: this.totpVerificationUrl,
        totp_identifier: this.totpIdentifier,
      },
    });
    $.export("$summary", `Created and ran task with ID ${response.task_id}`);
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
SkyvernskyvernappThis component uses the Skyvern app.
URLurlstring

It must be a http or https URL.

Navigation GoalnavigationGoalstring

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.

Data Extraction GoaldataExtractionGoalstring

The prompt that instructs the agent to extract information once the agent has achieved its User Goal.

Navigation PayloadnavigationPayloadobject

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.

Webhook Callback URLwebhookCallbackUrlstring

The callback URL once our system is finished processing this async task.

Extracted Information SchemaextractedInformationSchemaobject

Used to enforce a JSON schema spec to be enforced in the data_extraction_goal. Similar to https://json-schema.org/ definition.

TOTP Verification URLtotpVerificationUrlstring

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.

TOTP IdentifiertotpIdentifierstring

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.

Authentication

Skyvern uses API keys for authentication. When you connect your Skyvern account, Pipedream securely stores the keys so you can easily authenticate to Skyvern APIs in both code and no-code steps.

About Skyvern

Automate Browser-Based Workflows with AI

More Ways to Use Skyvern

Triggers

New or Updated Workflow from the Skyvern API

Emit new event when a workflow is created or updated in Skyvern.

 
Try it

Actions

Get Workflow Run Details with the Skyvern API

Retrieve details of runs of a specific Skyvern workflow. Useful for checking the status and result of a run. See the documentation

 
Try it
Run Workflow with the Skyvern API

Trigger a predefined workflow in Skyvern, allowing the execution of complex routines from Pipedream. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.