🐉 Automate Browser-based workflows using LLMs and Computer Vision 🐉

Skyvern automates browser-based workflows using LLMs and computer vision. It provides a simple API endpoint to fully automate manual workflows on a large number of websites, replacing brittle or unreliable automation solutions.

Traditional approaches to browser automations required writing custom scripts for websites, often relying on DOM parsing and XPath-based interactions which would break whenever the website layouts changed.

Instead of only relying on code-defined XPath interactions, Skyvern relies on prompts in addition to computer vision and LLMs to the mix to parse items in the viewport in real-time, create a plan for interaction and interact with them.

This approach gives us a few advantages:

1. Skyvern can operate on websites it’s never seen before, as it’s able to map visual elements to actions necessary to complete a workflow, without any customized code
2. Skyvern is resistant to website layout changes, as there are no pre-determined XPaths or other selectors our system is looking for while trying to navigate
3. Skyvern is able to take a single workflow and apply it to a large number of websites, as it’s able to reason through the interactions necessary to complete the workflow
4. Skyvern leverages LLMs to reason through interactions to ensure we can cover complex situations. Examples include:
   1. If you wanted to get an auto insurance quote from Geico, the answer to a common question “Were you eligible to drive at 18?” could be inferred from the driver receiving their license at age 16
   2. If you were doing competitor analysis, it’s understanding that an Arnold Palmer 22 oz can at 7/11 is almost definitely the same product as a 23 oz can at Gopuff (even though the sizes are slightly different, which could be a rounding error!)

Want to see examples of Skyvern in action? Jump to #real-world-examples-of-skyvern

How it works

Skyvern was inspired by the Task-Driven autonomous agent design popularized by BabyAGI and AutoGPT -- with one major bonus: we give Skyvern the ability to interact with websites using browser automation libraries like Playwright.

Demo

Skyvern Cloud

We offer a managed cloud version of Skyvern that allows you to run Skyvern without having to manage the infrastructure. It allows to you run multiple Skyvern instances in parallel to automate your workflows at scale. In addition, Skyvern cloud comes bundled with anti-bot detection mechanisms, proxy network, and CAPTCHA solving to allow you to complete more complicated workflows.

If you'd like to try it out,

1. Navigate to app.skyvern.com
2. Create an account
3. Set up your credit card information to get $5 of credits on us
4. Kick off your first task and see Skyvern in action!

Here are some tips that may help you on your adventure:

1. Skyvern is really good at carrying out one task. If you give it too many instructions to do, it has a high likelihood of getting confused along the way.
2. Being really explicit about goals is very important. For example, if you're generating an insurance quote, let it know very clearly how it can identify it's accomplished its goals. Use words like "COMPLETE" or "TERMINATE" to indicate success and failure modes, respectively.
3. If you'd like to do more advanced things such as chaining multiple instructions together, or securely logging in, please feel free to book some time with me! I'm always happy to help

Quickstart

This quickstart guide will walk you through getting Skyvern up and running on your local machine.

Docker Compose setup (Recommended)

1. Make sure you have Docker Desktop installed and running on your machine
2. Make sure you don't have postgres running locally (Run docker ps to check)
3. Clone the repository and navigate to the root directory
4. Fill in the LLM provider key on the docker-compose.yml
5. Run the following command via the commandline:

   docker compose up -d

6. Navigate to http://localhost:8080 in your browser to start using the UI

Full Setup (Contributors) - Prerequisites

:warning: :warning: MAKE SURE YOU ARE USING PYTHON 3.11 :warning: :warning:

Before you begin, make sure you have the following installed:

• Brew (if you're on a Mac)
• Poetry
  • brew install poetry
• node
• Docker

Note: Our setup script does these two for you, but they are here for reference.

• Python 3.11
  • poetry env use 3.11
• PostgreSQL 14 (if you're on a Mac, setup script will install it for you if you have homebrew installed)
  • brew install postgresql

Setup (Contributors)

1. Clone the repository and navigate to the root directory
2. Open Docker Desktop (Works for Windows, macOS, and Linux) or run Docker Daemon
3. Run the setup script to install the necessary dependencies and setup your environment

   ./setup.sh

4. Start the server

   ./run_skyvern.sh

5. You can start sending requests to the server, but we built a simple UI to help you get started. To start the UI, run the following command:

   ./run_ui.sh

6. Navigate to http://localhost:8080 in your browser to start using the UI

Additional Setup for Contributors

If you're looking to contribute to Skyvern, you'll need to install the pre-commit hooks to ensure code quality and consistency. You can do this by running the following command:

pre-commit install

Running your first automation

Executing tasks (UI)

Once you have the UI running, you can start an automation by filling out the fields shown in the UI and clicking "Execute"

Executing tasks (cURL)

curl -X POST -H 'Content-Type: application/json' -H 'x-api-key: {Your local API key}' -d '{
    "url": "https://www.geico.com",
    "webhook_callback_url": "",
    "navigation_goal": "Navigate through the website until you generate an auto insurance quote. Do not generate a home insurance quote. If this page contains an auto insurance quote, consider the goal achieved",
    "data_extraction_goal": "Extract all quote information in JSON format including the premium amount, the timeframe for the quote.",
    "navigation_payload": "{Your data here}",
    "proxy_location": "NONE"
}' http://0.0.0.0:8000/api/v1/tasks

Debugging Skyvern

Skyvern's visualizer allows you to debug every interaction Skyvern takes on the web.

Tasks, Steps, and Actions

Each API request you sent to Skyvern is called a "task". Each task is made up of "steps" which are the individual actions Skyvern takes to complete the task. Each step is made up of "actions" which are the individual interactions Skyvern takes on a particular website.

Every time you call the API, you will be given a task_id you can use to find a task within the visualizer. Within each task, you'll be able to interact with each step, and see the specific actions Skyvern took to complete the task.

In the screenshot below, we're navigating to finditparts.com and searching for a truck part. You'll see each action it took listed there, alongside the reasoning behind each action.

In addition to the actions suggested by the LLM in text form, Skyvern's visualizer also shows the state of the screen at the time of the action, with a 1:1 action to screenshot mapping. This allows you to see exactly what Skyvern saw when it made a decision, and debug any issues that may have arisen.

Real-world examples of Skyvern

We love to see how Skyvern is being used in the wild. Here are some examples of how Skyvern is being used to automate workflows in the real world. Please open PRs to add your own examples!

You'll need to have Skyvern running locally if you want to try these examples out. Please run the following command after going through the quickstart guide:

./run_skyvern.sh

Invoice Downloading on many different websites

Reach out to us ([email protected]) to see this live

Automate the job application process

💡 See it in action at app.skyvern.com

Automate materials procurement for a manufacturing company

💡 See it in action

./run_ui.sh finditparts

Navigating to government websites to register accounts or fill out forms

💡 See it in action

./run_ui.sh california_edd 

Retrieving insurance quotes from insurance providers in any language

💡 See it in action

./run_ui.sh bci_seguros

💡 See it in action

./run_ui.sh geico

Frequently Asked Questions (FAQs)

What gets us excited about Skyvern?

Our focus is bringing stability to browser-based workflows. We leverage LLMs to create an AI Agent capable of interacting with websites like you or I would — all via a simple API call.

Skyvern Configurations

Skyvern Agent

Supported LLMs

Provider	Supported Models
OpenAI	gpt4-turbo, gpt-4o, gpt-4o-mini
Anthropic	Claude 3 (Haiku, Sonnet, Opus), Claude 3.5 (Sonnet)
Azure OpenAI	Any GPT models. Better performance with a multimodal llm (azure/gpt4-o)
AWS Bedrock	Anthropic Claude 3 (Haiku, Sonnet, Opus), Claude 3.5 (Sonnet)

Environment Variables

Variable	Description	Type	Sample Value
ENABLE_OPENAI	Register OpenAI models	Boolean	true, false
ENABLE_ANTHROPIC	Register Anthropic models	Boolean	true, false
ENABLE_AZURE	Register Azure OpenAI models	Boolean	true, false
ENABLE_BEDROCK	Register AWS Bedrock models	Boolean	true, false
LLM_KEY	The name of the model you want to use	String	Currently supported llm keys: OPENAI_GPT4_TURBO, OPENAI_GPT4V, OPENAI_GPT4O, OPENAI_GPT4O_MINI, ANTHROPIC_CLAUDE3, ANTHROPIC_CLAUDE3_OPUS, ANTHROPIC_CLAUDE3_SONNET, ANTHROPIC_CLAUDE3_HAIKU, ANTHROPIC_CLAUDE3.5_SONNET, BEDROCK_ANTHROPIC_CLAUDE3_OPUS, BEDROCK_ANTHROPIC_CLAUDE3_SONNET, BEDROCK_ANTHROPIC_CLAUDE3_HAIKU, BEDROCK_ANTHROPIC_CLAUDE3.5_SONNET, AZURE_OPENAI
OPENAI_API_KEY	OpenAI API Key	String	sk-1234567890
OPENAI_API_BASE	OpenAI API Base, optional	String	https://openai.api.base
OPENAI_ORGANIZATION	OpenAI Organization ID, optional	String	your-org-id
ANTHROPIC_API_KEY	Anthropic API key	String	sk-1234567890
AZURE_API_KEY	Azure deployment API key	String	sk-1234567890
AZURE_DEPLOYMENT	Azure OpenAI Deployment Name	String	skyvern-deployment
AZURE_API_BASE	Azure deployment api base url	String	https://skyvern-deployment.openai.azure.com/
AZURE_API_VERSION	Azure API Version	String	2024-02-01

Skyvern UI

Feature Roadmap

This is our planned roadmap for the next few months. If you have any suggestions or would like to see a feature added, please don't hesitate to reach out to us via email or discord.

• [x] Open Source - Open Source Skyvern's core codebase
• [x] [BETA] Workflow support - Allow support to chain multiple Skyvern calls together
• [ ] Improved context - Improve Skyvern's ability to understand content around interactable elements by introducing feeding relevant label context through the text prompt
• [ ] Cost Savings - Improve Skyvern's stability and reduce the cost of running Skyvern by optimizing the context tree passed into Skyvern
• [ ] Self-serve UI - Deprecate the Streamlit UI in favour of a React-based UI component that allows users to kick off new jobs in Skyvern
• [ ] Prompt Caching - Introduce a caching layer to the LLM calls to dramatically reduce the cost of running Skyvern (memorize past actions and repeat them!)
• [ ] Chrome Viewport streaming - Introduce a way to live-stream the Chrome viewport to the user's browser (as a part of the self-serve UI)
• [ ] Past Runs UI - Deprecate the Streamlit UI in favour of a React-based UI that allows you to visualize past runs and their results
• [ ] Integrate LLM Observability tools - Integrate LLM Observability tools to allow back-testing prompt changes with specific data sets + visualize the performance of Skyvern over time
• [ ] Integrate public datasets - Integrate Skyvern with public benchmark tests to track the quality our models over time
• [ ] Workflow UI Builder - Introduce a UI to allow users to build and analyze workflows visually
• [ ] Langchain Integration - Create langchain integration in langchain_community to use Skyvern as a "tool".

Contributing

We welcome PRs and suggestions! Don't hesitate to open a PR/issue or to reach out to us via email or discord. Please have a look at our contribution guide and "Help Wanted" issues to get started!

If you want to chat with the skyvern repository to get a high level overview of how it is structured, how to build off it, and how to resolve usage questions, check out Code Sage.

Telemetry

By Default, Skyvern collects basic usage statistics to help us understand how Skyvern is being used. If you would like to opt-out of telemetry, please set the SKYVERN_TELEMETRY environment variable to false.

License

Skyvern's open source repository is supported via a managed cloud. All of the core logic powering Skyvern is available in this open source repository licensed under the AGPL-3.0 License, with the exception of anti-bot measures available in our managed cloud offering.

If you have any questions or concerns around licensing, please contact us and we would be happy to help.

Star History