Quickstart

Skyvern Cloud

Sign up on https://app.skyvern.com/ to get $5 free credits.

Ask the Skyvern agent to run a task and see it in action! Here are some examples you can try:

• Navigate to the Hacker News homepage and get the top 3 posts.
• Go to google finance and find the "AAPL" stock price. COMPLETE when the search results for "AAPL" are displayed and the stock price is extracted.

Python SDK

Install Skyvern

$
pip install skyvern

Run Task On A Skyvern Service

Get your API key from Skyvern Cloud. Send the task to Skyvern Cloud:

1
from skyvern import Skyvern
2
3
skyvern = Skyvern(api_key="YOUR API KEY")
4
# OR pass the base_url to use any Skyvern service
5
# skyvern = Skyvern(base_url="http://localhost:8000", api_key="YOUR API KEY")
6
7
task = await skyvern.run_task(prompt="Find the top post on hackernews today")
8
print(task)

More API & SDK information can be found in the API Reference section.

Run Task Locally

You can also run browser tasks locally in your Python code, though it takes a bit more effort to set up the environment:

1. Configure Skyvern Run the setup wizard which will guide you through the configuration process, including Skyvern MCP integration. This will generate a .env as the configuration settings file.

   $
   skyvern init

2. Run Task In Python Code

   1
   from skyvern import Skyvern
   2
   3
   skyvern = Skyvern()
   4
   5
   task = await skyvern.run_task(prompt="Find the top post on hackernews today")
   6
   print(task.model_dump())

   A local browser will pop up. Skyvern will start executing the task in the browser and close the browser when the task is done.