同步完整源码 - 2026-05-24
This commit is contained in:
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: API Key
|
||||
subtitle: Authenticate programmatic access to Skyvern
|
||||
description: Find, copy, and use your Skyvern API key from the Cloud UI Settings page to authenticate REST API and SDK requests.
|
||||
slug: cloud/account-settings/api-keys
|
||||
keywords:
|
||||
- API key
|
||||
- x-api-key
|
||||
- authentication
|
||||
- settings
|
||||
- copy
|
||||
- regenerate
|
||||
---
|
||||
|
||||
Every API call to Skyvern requires an API key. The key identifies your organization and determines billing.
|
||||
|
||||
## Finding your API key
|
||||
|
||||
Open **Settings** in the sidebar. Your API key is shown in a masked field. Click the **eye icon** to reveal the full value, or the **copy icon** to copy it to your clipboard.
|
||||
|
||||
<img src="/images/cloud/settings-api-key.png" alt="API key display with reveal and copy buttons" />
|
||||
|
||||
<Warning>
|
||||
Treat your API key like a password. Anyone with this key can create runs, read results, and manage workflows on behalf of your organization.
|
||||
</Warning>
|
||||
|
||||
## Using your key
|
||||
|
||||
Every Skyvern API request requires the `x-api-key` header:
|
||||
|
||||
```bash
|
||||
curl -X POST "https://api.skyvern.com/v1/run/tasks" \
|
||||
-H "x-api-key: YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{ "url": "https://example.com", "prompt": "Extract the pricing table" }'
|
||||
```
|
||||
|
||||
With the Python SDK:
|
||||
|
||||
```python
|
||||
from skyvern import Skyvern
|
||||
|
||||
client = Skyvern(api_key="YOUR_API_KEY")
|
||||
```
|
||||
|
||||
<Tip>
|
||||
Store the key in an environment variable (`SKYVERN_API_KEY`) rather than hardcoding it. In production, use your platform's secrets management (AWS Secrets Manager, Vault, etc.).
|
||||
</Tip>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="API Reference"
|
||||
icon="code"
|
||||
href="/api-reference"
|
||||
>
|
||||
Full endpoint documentation with interactive playground
|
||||
</Card>
|
||||
<Card
|
||||
title="Billing & Usage"
|
||||
icon="receipt"
|
||||
href="/cloud/account-settings/billing-usage"
|
||||
>
|
||||
Understand how runs are metered and billed
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,146 @@
|
||||
---
|
||||
title: Billing & Usage
|
||||
subtitle: Understand what you're paying for and manage your plan
|
||||
description: Understand Skyvern's credit-based billing model, compare Free, Hobby, Pro, and Enterprise plans, and manage your subscription from the Cloud UI Billing page.
|
||||
slug: cloud/account-settings/billing-usage
|
||||
keywords:
|
||||
- billing
|
||||
- credits
|
||||
- plan
|
||||
- pricing
|
||||
- Free
|
||||
- Hobby
|
||||
- Pro
|
||||
- Enterprise
|
||||
- usage
|
||||
---
|
||||
|
||||
Skyvern bills per **credit**: each browser action the AI takes during a run consumes credits. You pay for real work, not for workflows created or credentials stored.
|
||||
|
||||
## Plans
|
||||
|
||||
Open **Billing** in the sidebar to see available plans and your current balance.
|
||||
|
||||
<img src="/images/cloud/settings-billing-overview.png" alt="Billing page showing plan options and current balance" />
|
||||
|
||||
| Plan | Price | Credits/month | Estimated actions | Concurrent runs |
|
||||
|------|-------|---------------|-------------------|-----------------|
|
||||
| **Free** | $0 | 1,000 | ~170 | 1 |
|
||||
| **Hobby** | $29/month | 30,000 | ~1,200 | 10 |
|
||||
| **Pro** | $149/month | 150,000 | ~6,200 | 25 |
|
||||
| **Enterprise** | Custom | Unlimited | Unlimited | Unlimited |
|
||||
|
||||
**Free** is available to all new accounts with zero commitment. **Hobby** and **Pro** are monthly subscriptions. Click **Switch to Hobby** or **Switch to Pro** to change plans. Your remaining dollar balance is applied as a credit toward your first subscription payment.
|
||||
|
||||
<Note>
|
||||
Need HIPAA compliance, SOC-2 reports, custom code blocks, or dedicated support? Use the **Book a call** link at the bottom of the Billing page to discuss **Enterprise**, or visit [skyvern.com/pricing](https://skyvern.com/pricing) for a complete feature comparison.
|
||||
</Note>
|
||||
|
||||
### What's included in each plan
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Free: Try Skyvern with zero commitment">
|
||||
**1,000 credits/month** (~170 actions)
|
||||
|
||||
Perfect for evaluating Skyvern and prototyping automations.
|
||||
|
||||
- 1 concurrent run
|
||||
- Webhooks
|
||||
- Country geo-targeting
|
||||
- Community support
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Hobby: For side projects and small automations">
|
||||
**30,000 credits/month** (~1,200 actions) • **$29/month**
|
||||
|
||||
- 10 concurrent runs
|
||||
- Basic CAPTCHA solver
|
||||
- Webhooks
|
||||
- Stored credentials
|
||||
- Country geo-targeting
|
||||
- Email support
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Pro: For teams shipping production automations">
|
||||
**150,000 credits/month** (~6,200 actions) • **$149/month**
|
||||
|
||||
Everything in Hobby, plus:
|
||||
|
||||
- 25 concurrent runs
|
||||
- Advanced CAPTCHA solver
|
||||
- Team workspaces
|
||||
- 2FA / TOTP support
|
||||
- 1Password integration
|
||||
- Residential proxy
|
||||
- City-level geo-targeting
|
||||
- Priority support
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Enterprise: For regulated industries and large-scale operations">
|
||||
**Unlimited credits** • **Custom pricing**
|
||||
|
||||
Everything in Pro, plus:
|
||||
|
||||
- Unlimited concurrent runs
|
||||
- HIPAA compliant infrastructure
|
||||
- SOC-2 Type II Report
|
||||
- Dedicated Slack channel
|
||||
- Azure Key Vault integration
|
||||
- Bitwarden integration
|
||||
- Custom code blocks
|
||||
- Human-in-the-loop workflows
|
||||
|
||||
[Contact sales](https://skyvern.com/contact) to discuss Enterprise.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## How credits are consumed
|
||||
|
||||
A credit maps to one discrete browser action: clicking a button, typing into a field, selecting a dropdown, or extracting data from a page. Navigation counts too.
|
||||
|
||||
| Example | Approximate credits |
|
||||
|---------|---------------------|
|
||||
| Login flow (email, password, submit) | ~3 |
|
||||
| Form fill (10 fields + submit) | ~11 |
|
||||
| Multi-page extraction (5 pages) | ~15–25 |
|
||||
|
||||
Credits consumed by a run are visible on the [Run Details](/cloud/viewing-results/run-details) page. The **Actions** counter at the top of the Overview timeline shows exactly how many actions the AI took.
|
||||
|
||||
<Tip>
|
||||
Reduce credit usage by being specific in your prompts. "Find information about pricing" causes the AI to explore multiple pages. "Extract the monthly price from the pricing table on /pricing" gets there directly.
|
||||
</Tip>
|
||||
|
||||
## Your current balance
|
||||
|
||||
The **Your Current Balance** section shows your remaining dollar balance. Credits are deducted as runs execute in real time. If your balance reaches zero, new runs won't start until you add credits or switch to a subscription plan.
|
||||
|
||||
## FAQ
|
||||
|
||||
<Accordion title="How do credits work?">
|
||||
Each browser action the AI takes (clicking, typing, navigating, extracting) costs one credit. Credits are deducted in real time as runs execute. Your plan includes a monthly credit allowance that resets each billing cycle. Unused credits don't roll over.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I buy more credits?">
|
||||
Yes. If you exhaust your monthly allowance, you can purchase additional credits from the Billing page. You can also upgrade to a higher plan for a larger monthly allowance.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Can I cancel anytime?">
|
||||
Yes. Downgrade or cancel your subscription from the Billing page. The change takes effect at the end of your current billing cycle, and you keep access to your credits until then.
|
||||
</Accordion>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="API Keys"
|
||||
icon="key"
|
||||
href="/cloud/account-settings/api-keys"
|
||||
>
|
||||
Manage API keys for programmatic access
|
||||
</Card>
|
||||
<Card
|
||||
title="Organization Settings"
|
||||
icon="building"
|
||||
href="/cloud/account-settings/organization-settings"
|
||||
>
|
||||
Manage your team and organization details
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: Organization Settings
|
||||
subtitle: Manage your organization name and team access
|
||||
description: Manage your organization name, invite and remove team members, and configure access settings from the Skyvern Cloud UI Settings page.
|
||||
slug: cloud/account-settings/organization-settings
|
||||
keywords:
|
||||
- organization
|
||||
- team
|
||||
- invite
|
||||
- members
|
||||
- access
|
||||
- permissions
|
||||
---
|
||||
|
||||
Everything in Skyvern (workflows, credentials, runs, API keys) belongs to an **organization**. One is created automatically when you sign up.
|
||||
|
||||
## Organization details
|
||||
|
||||
Open **Settings** in the sidebar. The Settings page shows your organization name and current plan. The organization name appears throughout the UI and in API responses.
|
||||
|
||||
To rename your organization, update the **Organization Name** field and click **Save**.
|
||||
|
||||
## Team members
|
||||
|
||||
Plans that support multiple users (Pro and Enterprise) show a **Members** section below the organization details.
|
||||
|
||||
### Inviting members
|
||||
|
||||
Click **Invite Member**, enter their email address, and send the invitation. They'll receive an email with a link to join your organization. Once they accept, they appear in the members list with full access to workflows, runs, credentials, and API keys.
|
||||
|
||||
### Removing members
|
||||
|
||||
Click the **remove icon** next to a member's name to revoke their access. They lose access to all organization resources immediately.
|
||||
|
||||
<Warning>
|
||||
When removing a team member, also review your [API keys](/cloud/account-settings/api-keys); they may have copied keys that remain active.
|
||||
</Warning>
|
||||
|
||||
<Note>
|
||||
Role-based access control (restricting what individual members can do) is available on **Enterprise** plans. On other plans, all members have full access to the organization's resources.
|
||||
</Note>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Profile Settings"
|
||||
icon="user"
|
||||
href="/cloud/account-settings/profile-settings"
|
||||
>
|
||||
Manage your personal account settings
|
||||
</Card>
|
||||
<Card
|
||||
title="API Keys"
|
||||
icon="key"
|
||||
href="/cloud/account-settings/api-keys"
|
||||
>
|
||||
View and manage API keys for your organization
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
title: Profile Settings
|
||||
subtitle: Manage your personal account and security
|
||||
description: Update your display name, change your password, and review active sessions from the Skyvern Cloud UI Account page.
|
||||
slug: cloud/account-settings/profile-settings
|
||||
keywords:
|
||||
- profile
|
||||
- display name
|
||||
- password
|
||||
- active sessions
|
||||
- account security
|
||||
---
|
||||
|
||||
Click your avatar at the bottom of the sidebar to open the **Account** page. It has two tabs: **Profile** and **Security**.
|
||||
|
||||
## Profile
|
||||
|
||||
The **Profile** tab shows your display name and email address. Update your display name and click **Save** to apply.
|
||||
|
||||
## Security
|
||||
|
||||
The **Security** tab is where you manage your password and review active sessions.
|
||||
|
||||
<img src="/images/cloud/change-password.png" alt="Account Security tab showing password fields and active devices" />
|
||||
|
||||
Under **Set password**, enter your new password and confirm it. A green checkmark appears when the password meets requirements and both fields match. Check **Sign out of all other devices** if you want to invalidate existing sessions, recommended if you suspect unauthorized access.
|
||||
|
||||
Click **Save** to apply.
|
||||
|
||||
**Active devices** lists every device currently signed into your account, showing the browser, IP address, and last access time. Use this to verify that all sessions are yours.
|
||||
|
||||
<Note>
|
||||
If you signed up with Google or another SSO provider, password management is handled by the external provider and this section may not appear.
|
||||
</Note>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Organization Settings"
|
||||
icon="building"
|
||||
href="/cloud/account-settings/organization-settings"
|
||||
>
|
||||
Manage your team and organization details
|
||||
</Card>
|
||||
<Card
|
||||
title="API Keys"
|
||||
icon="key"
|
||||
href="/cloud/account-settings/api-keys"
|
||||
>
|
||||
View and manage API keys
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,118 @@
|
||||
---
|
||||
title: Browser Profiles
|
||||
subtitle: Save and reuse login state across sessions
|
||||
description: Save and reuse browser state snapshots in the Skyvern Cloud UI to skip login flows by restoring cookies and session data from a previously authenticated browser session.
|
||||
slug: cloud/browser-management/browser-profiles
|
||||
keywords:
|
||||
- state snapshot
|
||||
- cookies
|
||||
- session restore
|
||||
- skip login
|
||||
- authenticated state
|
||||
- reuse
|
||||
---
|
||||
|
||||
A **browser profile** is a saved snapshot of browser state: cookies, localStorage, and session files. Load a profile into a new [browser session](/cloud/browser-management/browser-sessions) and the browser starts with that saved state restored, skipping login flows you've already completed.
|
||||
|
||||
Profiles are ideal when you:
|
||||
|
||||
- Run the same automation repeatedly with the same account (daily reports, scheduled data extraction)
|
||||
- Want to skip login steps that consume credits and time
|
||||
- Need multiple workflows to share the same authenticated state
|
||||
|
||||
<Note>
|
||||
Looking to manage profiles from code? See the [API & SDK guide](/developers/optimization/browser-profiles) instead.
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## How profiles are created
|
||||
|
||||
Browser profiles are created automatically when you test a password credential with the **Save browser session** option enabled. There is no standalone "create profile" button; the profile is a byproduct of a successful login test.
|
||||
|
||||
### Creating a profile from a credential
|
||||
|
||||
<Steps>
|
||||
<Step title="Go to the Credentials page">
|
||||
Click **Credentials** in the left sidebar under **General**.
|
||||
</Step>
|
||||
<Step title="Create or edit a password credential">
|
||||
Click **+ Add → Password** to create a new credential, or click the **pencil icon** on an existing one. Enter the username and password. See [Password Credentials](/cloud/managing-credentials/password-credentials) for details.
|
||||
|
||||
<img src="/images/cloud/credential-add-password-form.png" alt="Add password credential dialog with name, username, and password fields" />
|
||||
</Step>
|
||||
<Step title="Enable Save browser session">
|
||||
Below the password fields, enable the **Save browser session** option. Enter the **login URL** for the site (e.g., `https://app.example.com/login`). You can also add optional context to help the AI navigate the login flow.
|
||||
</Step>
|
||||
<Step title="Test the credential">
|
||||
Click **Test**. Skyvern opens a browser, navigates to the login URL, signs in with the credential, and, if the login succeeds, saves the browser state as a profile. The profile is linked to this credential automatically.
|
||||
</Step>
|
||||
<Step title="Confirm the profile was saved">
|
||||
When the test completes, the credential row shows a **saved-profile** badge with the site hostname. This means the browser profile is ready to use.
|
||||
|
||||
<img src="/images/cloud/credential-save-profile.png" alt="Credential listed with a profile badge" />
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Tip>
|
||||
The **Save browser session** flow is the easiest way to create a profile. It handles the full lifecycle: open browser, log in, save state. No workflows or API calls required.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## When to refresh profiles
|
||||
|
||||
Cookies and session tokens expire. A profile that worked last week may not work today if the site's authentication tokens have a short lifespan.
|
||||
|
||||
**Signs a profile needs refreshing:**
|
||||
|
||||
- Tasks that use the profile start failing with login-related errors
|
||||
- The browser loads a login page instead of the authenticated dashboard
|
||||
- The site forces re-authentication after a set period
|
||||
|
||||
**To refresh:** go back to the credential, click **Test** again with **Save browser session** enabled. The new profile replaces the old one.
|
||||
|
||||
<Tip>
|
||||
For sites with short-lived sessions (banks, healthcare portals), refresh profiles before each batch of runs. For sites with long-lived cookies (most SaaS apps), weekly or monthly refreshes are usually sufficient.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## Sessions vs profiles
|
||||
|
||||
| | Browser Session | Browser Profile |
|
||||
|---|----------------|-----------------|
|
||||
| **What it is** | Live browser instance | Saved snapshot of browser state |
|
||||
| **Lifetime** | Minutes to hours | Days to months |
|
||||
| **State** | Current page, cookies, open connections | Cookies, localStorage, session files |
|
||||
| **Billing** | Charged while open | No cost when not in use |
|
||||
| **Best for** | Back-to-back tasks, human-in-the-loop | Repeated logins, scheduled workflows |
|
||||
|
||||
---
|
||||
|
||||
## What's next
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="Browser Sessions"
|
||||
icon="browser"
|
||||
href="/cloud/browser-management/browser-sessions"
|
||||
>
|
||||
Keep a browser open across multiple tasks
|
||||
</Card>
|
||||
<Card
|
||||
title="Password Credentials"
|
||||
icon="key"
|
||||
href="/cloud/managing-credentials/password-credentials"
|
||||
>
|
||||
Store the login details that profiles are built from
|
||||
</Card>
|
||||
<Card
|
||||
title="Browser Profiles (API)"
|
||||
icon="code"
|
||||
href="/developers/optimization/browser-profiles"
|
||||
>
|
||||
Create and manage profiles programmatically
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,181 @@
|
||||
---
|
||||
title: Browser Sessions
|
||||
subtitle: Keep a browser open across multiple tasks
|
||||
description: Create and manage persistent browser sessions in the Skyvern Cloud UI to preserve cookies, login state, and page context across multiple tasks and workflows.
|
||||
slug: cloud/browser-management/browser-sessions
|
||||
keywords:
|
||||
- persistent browser
|
||||
- cookies
|
||||
- local storage
|
||||
- page context
|
||||
- timeout
|
||||
- live session
|
||||
---
|
||||
|
||||
A **browser session** is a live browser instance that stays open between runs. Cookies, login state, cart contents, and page context all persist, like keeping a browser tab open. Use sessions when you need back-to-back tasks to share state, or when you want to interact with the browser yourself between automated steps.
|
||||
|
||||
<Note>
|
||||
Looking to use browser sessions from code? See the [API & SDK guide](/developers/optimization/browser-sessions) instead.
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## The Browsers page
|
||||
|
||||
Click **Browsers** in the left sidebar to open the Browsers page. It lists all browser sessions in your organization.
|
||||
|
||||
<img src="/images/cloud/browsers-page-overview.png" alt="Browsers page with the sessions table showing columns for ID, open status, occupied status, started time, timeout, and CDP URL" />
|
||||
|
||||
Each row shows:
|
||||
|
||||
| Column | What it shows |
|
||||
|--------|--------------|
|
||||
| **ID** | Session identifier (starts with `pbs_`) |
|
||||
| **Open** | Whether the browser is currently running |
|
||||
| **Occupied** | Whether a task or workflow is actively using the session |
|
||||
| **Started** | When the session launched |
|
||||
| **Timeout** | How long the session stays open before auto-closing |
|
||||
| **CDP URL** | Chrome DevTools Protocol address for direct connection |
|
||||
|
||||
---
|
||||
|
||||
## Creating a session
|
||||
|
||||
Click the **Create Browser Session** button at the top of the Browsers page. A panel opens with the following settings:
|
||||
|
||||
<Frame>
|
||||
<img src="/images/cloud/create-session-drawer.png" alt="Create Browser Session panel showing fields for timeout, proxy location, browser type, extensions, and browser profile" width="300" />
|
||||
</Frame>
|
||||
|
||||
| Setting | What it does |
|
||||
|---------|-------------|
|
||||
| **Timeout** | How long the session stays open, in minutes. Min: 5, max: 1440 (24 hours). Default: 60. |
|
||||
| **Proxy Location** | Route the browser through a residential proxy in a specific country. Default: US. |
|
||||
| **Browser Type** | Chrome (default, widest compatibility) or Microsoft Edge. |
|
||||
| **Extensions** | Optional add-ons: **Ad Blocker** (removes overlay ads that interfere with clicks) and **Captcha Solver** (auto-solves CAPTCHAs). |
|
||||
| **Browser Profile** | Load a saved [browser profile](/cloud/browser-management/browser-profiles) to restore cookies and login state from a previous session. |
|
||||
|
||||
Click **Create** to launch the session. It appears in the table within a few seconds.
|
||||
|
||||
<Warning>
|
||||
Sessions bill while open, even when idle. Set the timeout to match your use case and close sessions when you're done.
|
||||
</Warning>
|
||||
|
||||
---
|
||||
|
||||
## Viewing a live session
|
||||
|
||||
Click any session row in the table to open its detail page. The detail page has three tabs:
|
||||
|
||||
### Stream
|
||||
|
||||
A live view of the browser. You can watch pages load and actions fire in real time.
|
||||
|
||||
Click on <kbd>Take Control</kbd> to interact with the browser yourself. Use this to log in, dismiss a popup, solve a CAPTCHA.
|
||||
|
||||
<img src="/images/cloud/session-detail-stream.png" alt="Browser session detail page with the Stream tab active, showing a live browser view and session controls" />
|
||||
|
||||
### Recordings
|
||||
|
||||
Video recordings of activity in the session. Each recording captures what happened during a task or workflow that ran inside this session.
|
||||
|
||||
### Downloads
|
||||
|
||||
Files downloaded by the browser during the session. Click any file to save it locally.
|
||||
|
||||
<img src="/images/cloud/browser-session-downloads.png" alt="Browser session download page with the preview or download links for anything downloaded during the session" />
|
||||
|
||||
---
|
||||
|
||||
## Using a session with a task
|
||||
|
||||
Once you have a running session, you can run tasks inside it from the [Discover page](/cloud/getting-started/run-a-task):
|
||||
|
||||
1. Copy the session ID (`pbs_...`) from the Browsers page
|
||||
2. Go to the **Discover** page
|
||||
3. Click the **gear icon** to open Advanced Settings
|
||||
4. Paste the ID into the **Browser Session ID** field
|
||||
5. Write your prompt and run
|
||||
|
||||
The task executes inside your existing session. Cookies, login state, and page context from previous tasks are still there.
|
||||
|
||||
<img src="/images/cloud/discover-session-id-field.png" alt="Advanced settings panel on the Discover page with a pbs_ session ID entered in the Browser Session ID field" />
|
||||
|
||||
---
|
||||
|
||||
## Using a session with a workflow
|
||||
|
||||
You can also run workflows inside an existing session:
|
||||
|
||||
1. Copy the session ID from the Browsers page
|
||||
2. Go to **Workflows** and click **Run** on your workflow
|
||||
3. On the parameters page, scroll to **Run Settings**
|
||||
4. Paste the ID into the **Browser Session ID** field
|
||||
5. Click **Run Workflow**
|
||||
|
||||
The workflow picks up where the browser left off: same page, same cookies, same form data.
|
||||
|
||||
<img src="/images/cloud/workflow-run-session-id-field.png" alt="Workflow run settings panel with a pbs_ session ID entered in the Browser Session ID field" />
|
||||
|
||||
---
|
||||
|
||||
## Closing a session
|
||||
|
||||
From the session detail page, click **Stop**. A confirmation dialog appears. The browser shuts down immediately and the session moves to `closed` status.
|
||||
|
||||
<img src="/images/cloud/session-stop-confirmation.png" alt="Stop browser session confirmation dialog with Cancel and Stop buttons" />
|
||||
|
||||
Sessions also close automatically when their timeout expires, **even if a task is still running**. Set timeouts with enough margin for your longest expected task.
|
||||
|
||||
<Warning>
|
||||
Closed sessions cannot be reopened. If you need the same login state later, create a [browser profile](/cloud/browser-management/browser-profiles) before closing.
|
||||
</Warning>
|
||||
|
||||
---
|
||||
|
||||
## When to use sessions vs workflows
|
||||
|
||||
If your steps run back-to-back with no pauses between them, a [workflow](/cloud/building-workflows/build-a-workflow) is more efficient. Workflow blocks share one browser instance with no inter-step startup cost.
|
||||
|
||||
Sessions are the right choice when you need:
|
||||
|
||||
- **Pauses between steps**: review results, get approval, or wait for external input before continuing
|
||||
- **Human-in-the-loop**: interact with the browser yourself between automated steps
|
||||
- **Ad-hoc sequences**: run different tasks one after another without pre-building a workflow
|
||||
|
||||
---
|
||||
|
||||
## Sessions vs profiles
|
||||
|
||||
| | Browser Session | Browser Profile |
|
||||
|---|----------------|-----------------|
|
||||
| **What it is** | Live browser instance | Saved snapshot of browser state |
|
||||
| **Lifetime** | Minutes to hours | Days to months |
|
||||
| **State** | Current page, cookies, open connections | Cookies, localStorage, session files |
|
||||
| **Billing** | Charged while open | No cost when not in use |
|
||||
| **Best for** | Back-to-back tasks, human-in-the-loop | Repeated logins, scheduled workflows |
|
||||
|
||||
<Tip>
|
||||
Use a session when you need a live browser right now. Use a [profile](/cloud/browser-management/browser-profiles) when you want to save login state and reuse it later.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## What's next
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Browser Profiles"
|
||||
icon="floppy-disk"
|
||||
href="/cloud/browser-management/browser-profiles"
|
||||
>
|
||||
Save login state and reuse it across sessions
|
||||
</Card>
|
||||
<Card
|
||||
title="Browser Sessions (API)"
|
||||
icon="code"
|
||||
href="/developers/optimization/browser-sessions"
|
||||
>
|
||||
Create and manage sessions programmatically
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,164 @@
|
||||
---
|
||||
title: Workflow Parameters
|
||||
subtitle: Pass dynamic values into your workflows at runtime
|
||||
description: Define input and credential parameters in the Skyvern Cloud UI workflow editor to pass dynamic values like URLs, JSON data, and vault credentials into workflows at runtime.
|
||||
slug: cloud/add-parameters
|
||||
keywords:
|
||||
- input parameter
|
||||
- credential parameter
|
||||
- runtime value
|
||||
- Bitwarden
|
||||
- 1Password
|
||||
- Azure Key Vault
|
||||
- JSON
|
||||
---
|
||||
|
||||
Parameters let you create reusable workflows that accept different input values each time they run. Instead of hardcoding a URL or search term into a block, you reference a parameter and fill in the value when you run the workflow.
|
||||
|
||||
This page covers parameters in the Cloud UI workflow editor. If you're building automations in code, parameters are just function arguments. See [Browser Automation](/developers/browser-automations/overview) for the code-first approach.
|
||||
|
||||
---
|
||||
|
||||
## Opening the parameters panel
|
||||
|
||||
In the [workflow editor](/cloud/building-workflows/build-a-workflow), click the **Parameters** button in the header bar. A panel appears below the header showing all defined parameters and controls to add new ones.
|
||||
|
||||
<img src="/images/cloud/parameters-panel-open.png" alt="Parameters panel" />
|
||||
|
||||
---
|
||||
|
||||
## Adding a parameter
|
||||
|
||||
Click **Add Parameter** in the panel. Two types are available:
|
||||
|
||||
| Type | Use for |
|
||||
|------|---------|
|
||||
| **Input Parameter** | Values the user provides when running the workflow (text, numbers, JSON, etc.) |
|
||||
| **Credential Parameter** | Securely inject login credentials from a vault (Bitwarden, 1Password, Azure, AWS, or Skyvern) |
|
||||
|
||||
Each parameter requires a unique **key**. This is the name you use to reference it in blocks. Keys cannot contain spaces and cannot use [reserved names](#reserved-variables).
|
||||
|
||||
You can also add an optional **description** (shown as help text when running) and a **default value**.
|
||||
|
||||
---
|
||||
|
||||
## Parameter value types
|
||||
|
||||
Input parameters support these value types:
|
||||
|
||||
| Type | Input control | Example |
|
||||
|------|---------------|---------|
|
||||
| **String** | Text field | `"https://example.com"` |
|
||||
| **Integer** | Number field | `10` |
|
||||
| **Float** | Number field | `19.99` |
|
||||
| **Boolean** | Toggle switch | `true` |
|
||||
| **JSON** | Code editor | `{"key": "value"}` |
|
||||
| **File URL** | Text field (paste a URL) | `"https://example.com/data.csv"` |
|
||||
| **Credential ID** | Dropdown selector (shown at runtime) | Selected from stored credentials |
|
||||
|
||||
---
|
||||
|
||||
## Referencing parameters in blocks
|
||||
|
||||
Use Jinja2 double-brace syntax to reference parameters inside block fields like prompts, URLs, and data schemas.
|
||||
|
||||
**Basic reference:**
|
||||
```
|
||||
{{ url }}
|
||||
```
|
||||
|
||||
**Nested field access** (for JSON parameters):
|
||||
```
|
||||
{{ config.search_term }}
|
||||
```
|
||||
|
||||
**Convert to JSON string:**
|
||||
```
|
||||
{{ my_data | tojson }}
|
||||
```
|
||||
|
||||
**Example in a Navigation block prompt:**
|
||||
```
|
||||
Navigate to {{ url }} and search for {{ search_term }}
|
||||
```
|
||||
|
||||
Any block field that accepts text supports parameter references.
|
||||
|
||||
---
|
||||
|
||||
## Credential parameters
|
||||
|
||||
Credential parameters securely inject login credentials into blocks without exposing them in prompts or logs.
|
||||
|
||||
| Source | What it provides |
|
||||
|--------|-----------------|
|
||||
| **Skyvern Credential** | Username and password stored on the Skyvern Credentials page |
|
||||
| **Bitwarden Login** | Username, password, and optional TOTP from your Bitwarden vault |
|
||||
| **Bitwarden Credit Card** | Card number, holder name, expiry, and CVV from Bitwarden |
|
||||
| **Bitwarden Sensitive Information** | Sensitive data fields from Bitwarden |
|
||||
| **1Password** | Username, password, card data, or TOTP from 1Password |
|
||||
| **Azure Key Vault** | Secrets stored in Azure Key Vault |
|
||||
| **AWS Secret** | Secrets stored in AWS Secrets Manager |
|
||||
| **Azure Secret** | Secrets stored in Azure Secret |
|
||||
|
||||
When you add a credential parameter, you configure the source and connection details (collection ID, vault ID, etc.). At runtime, Skyvern fetches the real credentials from the vault and injects them into the workflow. Credential values are masked in logs and outputs.
|
||||
|
||||
---
|
||||
|
||||
## Output parameters
|
||||
|
||||
Every block automatically produces an **output parameter** containing its results. You can reference a previous block's output in any downstream block.
|
||||
|
||||
The syntax uses the block's label (lowercased, spaces replaced with underscores) followed by `_output`:
|
||||
|
||||
```
|
||||
{{ extraction_block_output.extracted_information }}
|
||||
```
|
||||
|
||||
```
|
||||
{{ login_output.success }}
|
||||
```
|
||||
|
||||
This is how you chain data between blocks. Extract data in one block, then use it in the next.
|
||||
|
||||
---
|
||||
|
||||
## Reserved variables
|
||||
|
||||
These variable names are built-in and cannot be used as parameter keys:
|
||||
|
||||
| Variable | Available in | Description |
|
||||
|----------|-------------|-------------|
|
||||
| `current_value` | Loop blocks | The current item being iterated |
|
||||
| `current_item` | Loop blocks | Alias for `current_value` |
|
||||
| `current_index` | Loop and While Loop blocks | Zero-based index of the current iteration |
|
||||
| `workflow_run_id` | All blocks | Unique ID of the current run |
|
||||
| `workflow_id` | All blocks | The workflow's ID |
|
||||
| `workflow_permanent_id` | All blocks | The workflow's permanent ID |
|
||||
| `workflow_title` | All blocks | The workflow's title |
|
||||
|
||||
**Example in a loop:**
|
||||
```
|
||||
Process item {{ current_index }}: {{ current_value.name }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## What's next
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Block Reference"
|
||||
icon="cube"
|
||||
href="/cloud/building-workflows/configure-blocks"
|
||||
>
|
||||
Configuration fields for every block type
|
||||
</Card>
|
||||
<Card
|
||||
title="Run Your Workflow"
|
||||
icon="play"
|
||||
href="/cloud/building-workflows/run-a-workflow"
|
||||
>
|
||||
Execute workflows and fill in parameter values
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,327 @@
|
||||
---
|
||||
title: Build a Workflow
|
||||
subtitle: Create multi-step automations with the visual workflow editor
|
||||
description: Create multi-step browser automations in the Skyvern Cloud UI using the visual workflow editor with blocks for navigation, extraction, loops, conditionals, and email.
|
||||
slug: cloud/build-a-workflow
|
||||
keywords:
|
||||
- workflow editor
|
||||
- drag and drop
|
||||
- navigation block
|
||||
- extract block
|
||||
- loop block
|
||||
- action block
|
||||
- parameter
|
||||
- visual builder
|
||||
---
|
||||
|
||||
Workflows are multi-step automations built visually in the Cloud UI. You drag blocks onto a canvas, wire them together, configure each one, and run the whole sequence with a click. No code required. Workflows can be versioned, shared across your team, scheduled on a cron, and run with different parameters each time.
|
||||
|
||||
If you prefer writing automation code in Python or TypeScript, see [Browser Automation](/developers/browser-automations/overview) in the developer docs. Both approaches handle multi-step work across pages. Workflows are the visual path, browser automations are the code path.
|
||||
|
||||
<Info>
|
||||
**Workflows vs. Browser Automation:** Workflows are defined in this visual editor and run from the Cloud UI (or [triggered from code](/cloud/building-workflows/run-from-code)). Browser automations are written in Python/TypeScript using Page, Agent, and Browser. Choose based on whether your team prefers a visual editor or a code editor.
|
||||
</Info>
|
||||
|
||||
This page explains how workflows work, walks you through building one from scratch, and covers the editor's features.
|
||||
|
||||
## How workflows work
|
||||
|
||||
A workflow is a sequence of **blocks** that run one after another. Each block does one thing: navigate to a page, extract data, send an email, run custom code, loop, or branch. You connect blocks on a visual canvas, pass data between them, and run the whole chain with one click.
|
||||
|
||||
```
|
||||
[Browser Task] → [Extraction] → [Loop] → [Send Email]
|
||||
↓ ↓ ↓ ↓
|
||||
opens the page JSON output per-item digest sent
|
||||
processing
|
||||
```
|
||||
|
||||
### How data flows between blocks
|
||||
|
||||
Every block produces an output. Downstream blocks reference it using the pattern `{{ block_label_output }}`.
|
||||
|
||||
For example, an Extraction block labeled `scrape_listings` produces output that later blocks access as `{{ scrape_listings_output }}`. The label is lowercased with spaces replaced by underscores, then `_output` is appended. This is how you chain steps together. One block's output becomes the next block's input.
|
||||
|
||||
### Block categories
|
||||
|
||||
| Category | What it does | Examples |
|
||||
|----------|-------------|----------|
|
||||
| **Browser Automation** | Interact with web pages using AI | Browser Task, Browser Action, Extraction, Login, Go to URL, Print Page |
|
||||
| **Data and Extraction** | Transform data without a browser | Text Prompt, File Parser |
|
||||
| **Control Flow** | Branch, loop, validate, or pause | Loop, While Loop, Conditional, AI Validation, Code, Wait |
|
||||
| **Files** | Download and upload files | File Download, Cloud Storage Upload |
|
||||
| **Communication** | Send data to external services or humans | Send Email, HTTP Request, Human Interaction |
|
||||
|
||||
See [Block Reference](/cloud/building-workflows/configure-blocks) for every block type and its configuration fields.
|
||||
|
||||
<Tip>
|
||||
If your block needs a browser, pick a browser automation block. If it just needs to process data, use Text Prompt or Code. If you need to repeat or branch, use control flow.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## Tutorial: Build a job listing tracker
|
||||
|
||||
Let's build a real workflow. You'll create an automation that finds the top 5 job listings from Hacker News's monthly "Who is Hiring" thread, summarizes each one, and emails you a digest.
|
||||
|
||||
This uses 5 blocks across 3 categories: browser automation, data and extraction, and communication.
|
||||
|
||||
<Steps>
|
||||
<Step title="Create a new workflow">
|
||||
|
||||
Go to **Workflows** in the left sidebar and click **Create → Blank Workflow**.
|
||||
|
||||
<img src="/images/cloud/create-workflow-dropdown.png" alt="Create workflow dropdown showing Blank Workflow and From Template options" />
|
||||
|
||||
The editor opens with an empty canvas showing a single start node. Click the workflow title at the top left and rename it to **HN Job Tracker**.
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Add a Browser Task block">
|
||||
|
||||
Hover over the **+** button on the edge below the start node and select **Add Block**. A searchable block library opens on the right. Find and select **Browser Task Block**.
|
||||
|
||||
The block appears on the canvas with a configuration panel on the right. Fill in:
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Label** | `find_hiring_thread` |
|
||||
| **URL** | `https://news.ycombinator.com` |
|
||||
| **Prompt** | `Find and open the latest monthly "Ask HN: Who is hiring?" thread. The task is complete when the thread is open and job listing comments are visible.` |
|
||||
|
||||
The Browser Task block uses AI to navigate the page and accomplish the goal described in your prompt. Include your success criteria directly in the prompt so the AI knows when it's done.
|
||||
|
||||
<img src="/images/cloud/tutorial-browser-task.png" alt="Browser Task block configured with find_hiring_thread label, URL, and prompt" />
|
||||
|
||||
<Accordion title="Why Browser Task instead of Go to URL?">
|
||||
The URL for the latest hiring thread changes every month. The Browser Task block uses AI to find the right link on the page. Use Go to URL when you know the exact destination URL upfront.
|
||||
</Accordion>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Add an Extraction block">
|
||||
|
||||
Hover over the **+** on the edge after `find_hiring_thread`, select **Add Block**, then choose **Extraction Block**.
|
||||
|
||||
Configure:
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Label** | `scrape_listings` |
|
||||
| **Data Extraction Goal** | `Extract the top 5 job listings. For each listing, get the company name, role title, and a brief description of the position.` |
|
||||
|
||||
Now enable the **Data Schema** checkbox to reveal the JSON editor, and paste:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"listings": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"company": { "type": "string" },
|
||||
"role": { "type": "string" },
|
||||
"description": { "type": "string" }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The schema tells Skyvern exactly what structure to return. Without it, the AI picks its own format. You can also click **Generate with AI** next to the schema field to have Skyvern suggest a schema based on your extraction goal.
|
||||
|
||||
<img src="/images/cloud/tutorial-extraction.png" alt="Extraction block configured with scrape_listings label, extraction goal, Data Schema checkbox enabled, and JSON schema" />
|
||||
|
||||
<Tip>
|
||||
Label your blocks descriptively. The label determines the output variable name. `scrape_listings` means downstream blocks reference its data as `{{ scrape_listings_output }}`.
|
||||
</Tip>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Add a Loop with a Text Prompt inside">
|
||||
|
||||
Hover over the **+** after `scrape_listings`, select **Add Block**, then choose **Loop Block**.
|
||||
|
||||
Configure the loop:
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Label** | `process_each` |
|
||||
| **Loop Value** | `{{ scrape_listings_output.listings }}` |
|
||||
|
||||
This iterates over the 5 listings extracted in the previous step. Now add a block *inside* the loop. Hover over the **+** inside the loop body, select **Add Block**, and choose **Text Prompt Block**.
|
||||
|
||||
Configure the Text Prompt:
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Label** | `summarize` |
|
||||
| **Prompt** | `Summarize this job listing in one sentence. Company: {{ current_value.company }}, Role: {{ current_value.role }}, Description: {{ current_value.description }}` |
|
||||
|
||||
Enable the **Data Schema** checkbox and paste:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"summary": { "type": "string" }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The Text Prompt block sends text to the LLM without opening a browser. It processes data only. Each iteration produces a one-line summary of that job listing.
|
||||
|
||||
<img src="/images/cloud/tutorial-loop-text-prompt.png" alt="Loop block with process_each label containing a summarize Text Prompt block inside" />
|
||||
|
||||
<Accordion title="What are current_value and current_index?">
|
||||
Inside a loop, two reserved variables are available:
|
||||
|
||||
- `{{ current_value }}`: the current item from the list being iterated
|
||||
- `{{ current_index }}`: the item's position, starting from 0
|
||||
|
||||
These only exist inside loop blocks. In this example, `{{ current_value.company }}` gives you the company name for the current listing.
|
||||
</Accordion>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Add a Send Email block">
|
||||
|
||||
Hover over the **+** on the edge *after* the loop (back on the main flow, not inside it), select **Add Block**, then choose **Send Email Block**.
|
||||
|
||||
Configure:
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Label** | `send_digest` |
|
||||
| **Recipients** | Your email address |
|
||||
| **Subject** | `HN Job Digest - Top 5 Listings` |
|
||||
| **Body** | `Here are today's top job listings from Hacker News:\n\n{{ process_each_output }}` |
|
||||
|
||||
The `{{ process_each_output }}` reference pulls in the collected summaries from every loop iteration.
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Save and run">
|
||||
|
||||
<Warning>
|
||||
Workflows are **not** auto-saved. Click the **Save** button (disk icon) in the header bar before navigating away or you'll lose your work.
|
||||
</Warning>
|
||||
|
||||
Click **Save**, then click **Run** in the top right. A parameters page opens where you can review and confirm the workflow's settings. Click **Run Workflow** to start execution.
|
||||
|
||||
The [live execution view](/cloud/getting-started/monitor-a-run) opens. Watch as Skyvern navigates Hacker News, extracts listings, summarizes each one, and sends your email.
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### What you built
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A["find_hiring_thread<br/>Browser Task"] --> B["scrape_listings<br/>Extraction"]
|
||||
B --> C["process_each<br/>Loop"]
|
||||
C --> D["summarize<br/>Text Prompt"]
|
||||
D --> E["send_digest<br/>Send Email"]
|
||||
```
|
||||
|
||||
Five blocks, three categories, zero code. You can now re-run this workflow anytime, tweak the extraction schema to pull different fields, swap the email for an HTTP Request to post to Slack, or add a Conditional block to only email when listings match certain criteria.
|
||||
|
||||
---
|
||||
|
||||
## Editor reference
|
||||
|
||||
### Layout
|
||||
|
||||
<img src="/images/cloud/workflow-editor-overview.png" alt="Workflow editor overview" />
|
||||
|
||||
| Area | What it shows |
|
||||
|------|---------------|
|
||||
| **Header bar** (top) | Workflow title (click to rename), Parameters button, Save button, Template toggle, History button, Run button |
|
||||
| **Canvas** (center) | Visual graph of blocks connected in sequence. Zoom with the scroll wheel, pan by dragging the background. |
|
||||
| **Configuration panel** (right) | Opens when you click a block. Shows that block's settings form. |
|
||||
|
||||
### Adding blocks
|
||||
|
||||
Hover over the **+** button on any edge (the connecting line between blocks) to reveal the menu. Select **Add Block** to open the block library, a searchable list of all available block types. Click a block to insert it at that position.
|
||||
|
||||
The menu also offers **Record Browser** (record actions in a live browser to generate blocks) and **Upload SOP** (upload a PDF procedure to auto-generate a workflow).
|
||||
|
||||
When you create a blank workflow, hover over the **+** on the start edge to add your first block.
|
||||
|
||||
<img src="/images/cloud/add-block-panel.png" alt="Add block panel" />
|
||||
|
||||
### Configuring blocks
|
||||
|
||||
Click any block on the canvas to open its configuration panel on the right. Each block has a **Label** field (which determines its output variable name) and block-specific settings. Browser-based blocks share additional fields like URL, Engine, and Max Retries.
|
||||
|
||||
See [Block Reference](/cloud/building-workflows/configure-blocks) for the full list of fields on each block type.
|
||||
|
||||
### Connecting and reordering blocks
|
||||
|
||||
Blocks auto-connect when you insert them via the **+** button. They execute top to bottom in the order shown on the canvas.
|
||||
|
||||
**Conditional blocks** create branches. Each branch connects to a different sequence of blocks and merges back at a common point.
|
||||
|
||||
**Loop blocks** contain child blocks that repeat for each item in the loop's list. **While Loop blocks** contain child blocks that repeat while their condition remains true.
|
||||
|
||||
To reorder blocks, delete the block you want to move and re-add it at the desired position using the **+** button.
|
||||
|
||||
### Deleting blocks
|
||||
|
||||
Click the **three-dot menu** on a block's header and select **Delete Block**. Downstream blocks reconnect to the previous block automatically.
|
||||
|
||||
### Saving
|
||||
|
||||
<Warning>
|
||||
Workflows are **not** auto-saved. Click the **Save** button (disk icon) in the header bar to persist your changes. The editor warns you if you try to navigate away with unsaved work.
|
||||
</Warning>
|
||||
|
||||
The **Run** button also saves before starting execution.
|
||||
|
||||
### Header bar actions
|
||||
|
||||
| Button | Description |
|
||||
|--------|-------------|
|
||||
| **Save** (disk icon) | Save the current workflow definition |
|
||||
| **Template** (bookmark icon) | Toggle whether this workflow is saved as an organization template |
|
||||
| **History** (clock icon) | View past runs of this workflow |
|
||||
| **Schedule** (clock icon) | Create or manage recurring schedules for this workflow (see [Create a Schedule](/cloud/building-workflows/scheduling)) |
|
||||
| **Parameters** | Open the parameters panel (see [Workflow Parameters](/cloud/building-workflows/add-parameters)) |
|
||||
| **Run** (play icon) | Save and start a new execution (see [Running Workflows](/cloud/building-workflows/run-a-workflow)) |
|
||||
|
||||
---
|
||||
|
||||
## What's next
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="Block Reference"
|
||||
icon="cube"
|
||||
href="/cloud/building-workflows/configure-blocks"
|
||||
>
|
||||
Configuration fields for every block type
|
||||
</Card>
|
||||
<Card
|
||||
title="Add Parameters"
|
||||
icon="sliders"
|
||||
href="/cloud/building-workflows/add-parameters"
|
||||
>
|
||||
Pass dynamic values into your workflows
|
||||
</Card>
|
||||
<Card
|
||||
title="Run Your Workflow"
|
||||
icon="play"
|
||||
href="/cloud/building-workflows/run-a-workflow"
|
||||
>
|
||||
Execute workflows and track results
|
||||
</Card>
|
||||
<Card
|
||||
title="Schedule This Workflow"
|
||||
icon="calendar"
|
||||
href="/cloud/building-workflows/scheduling"
|
||||
>
|
||||
Set up recurring cron-based execution
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,459 @@
|
||||
---
|
||||
title: Block Types and Configuration
|
||||
subtitle: Reference for every block available in the workflow editor
|
||||
description: Reference guide for every workflow block type in the Skyvern Cloud UI, including Browser Task, Extraction, Login, Loop, While Loop, Conditional, Code, HTTP Request, and more.
|
||||
slug: cloud/configure-blocks
|
||||
keywords:
|
||||
- navigation block
|
||||
- action block
|
||||
- extract block
|
||||
- loop block
|
||||
- while loop block
|
||||
- code block
|
||||
- HTTP request block
|
||||
- text prompt block
|
||||
- login block
|
||||
- validation block
|
||||
- file download block
|
||||
- conditional block
|
||||
---
|
||||
|
||||
Workflows are built from blocks. Each block performs one specific operation: navigating a page, extracting data, making an API call, or branching logic. This page covers every block type available in the Cloud UI [workflow editor](/cloud/building-workflows/build-a-workflow), grouped by category.
|
||||
|
||||
If you're writing automations in code instead, the equivalent operations are Page and Agent methods. See the [Actions Reference](/developers/browser-automations/actions-reference) for the code-first counterparts to these blocks.
|
||||
|
||||
<Frame caption="To add a block in your workflow, click the **+** button, click on Add block, then select the block type from the menu.">
|
||||
<img src="/images/cloud/add-block-ui.png" alt="how to add a block to a workflow in Skyvern" />
|
||||
</Frame>
|
||||
|
||||
## Quick reference
|
||||
|
||||
| Category | Blocks |
|
||||
|----------|--------|
|
||||
| [Browser Automation](#browser-automation) | Browser Task, Browser Action, Extraction, Login, Go to URL, Print Page |
|
||||
| [Data and Extraction](#data-and-extraction) | Text Prompt, File Parser |
|
||||
| [Control Flow](#control-flow) | Loop, While Loop, Conditional, AI Validation, Code, Wait |
|
||||
| [Files](#files) | File Download, Cloud Storage Upload |
|
||||
| [Communication](#communication) | Send Email, HTTP Request, Human Interaction |
|
||||
|
||||
---
|
||||
|
||||
## Common fields
|
||||
|
||||
These fields appear on most blocks:
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **Label** | Display name on the canvas. Also determines how downstream blocks reference this block's output (`{{ label_output }}`). |
|
||||
| **Continue on Failure** | Allow the workflow to continue if this block fails |
|
||||
| **Next Loop on Failure** | Only inside loops. Skip to the next iteration on failure. |
|
||||
| **Model** | Override the default LLM model for this block (Advanced Settings on most blocks) |
|
||||
|
||||
Browser-based blocks (Browser Task, Browser Action, Extraction, Login, File Download) share these additional fields:
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **URL** | Starting URL. Leave blank to continue from the previous block's page. |
|
||||
| **Engine** | AI engine: Skyvern 1.0 or Skyvern 2.0 |
|
||||
| **Max Steps Override** | Cap the number of AI reasoning steps |
|
||||
| **Disable Cache** | Skip cached script execution |
|
||||
| **TOTP Identifier** | Link TOTP credentials for 2FA handling |
|
||||
| **TOTP Verification URL** | Endpoint for fetching TOTP codes |
|
||||
| **Error Code Mapping** | Map error conditions to custom error codes (JSON) |
|
||||
|
||||
---
|
||||
|
||||
## Browser Automation
|
||||
|
||||
### Browser Task
|
||||
|
||||
The primary block for browser automation. Accepts a natural-language prompt and autonomously navigates the browser to accomplish the goal.
|
||||
|
||||
The block has two engine modes, selected via the **Engine** dropdown. The fields shown change depending on which engine you choose.
|
||||
|
||||
**Skyvern 2.0** (recommended):
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **URL** | text | Starting URL (optional) |
|
||||
| **Prompt** | text | Natural language instructions for the AI |
|
||||
| **Max Steps** | number | Maximum AI steps |
|
||||
| **Disable Cache** | boolean | Skip cached script execution |
|
||||
|
||||
**Skyvern 1.0:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **URL** | text | Starting URL (optional) |
|
||||
| **Prompt** | text | Natural language instructions for the AI |
|
||||
|
||||
Additional fields in **Advanced Settings** (Skyvern 1.0 only):
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Complete if...** | text | Condition that signals the block is done |
|
||||
| **Include Action History in Verification** | boolean | Include prior actions when verifying completion |
|
||||
| **Complete on Download** | switch | Mark the block as complete when a file download occurs |
|
||||
| **File Name** | text | Custom filename for downloaded files |
|
||||
|
||||
*Plus [common browser fields](#common-fields).*
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/br_task_block.png" alt="Browser Task block configuration with URL and prompt fields" />
|
||||
</Frame>
|
||||
|
||||
<Tip>
|
||||
Browser Task is the recommended block for most browser automation. Use it for anything from form filling to multi-page navigation. Include your success criteria directly in the prompt so the AI knows when it's done.
|
||||
</Tip>
|
||||
|
||||
### Browser Action
|
||||
|
||||
Execute a single browser action. Best for precise, one-step operations like clicking a specific button or entering text in a field.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **URL** | text | Starting URL (optional) |
|
||||
| **Action Instruction** | text | Specify the single action to perform |
|
||||
|
||||
Additional fields in **Advanced Settings:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Complete on Download** | switch | Mark the block as complete when a file download occurs |
|
||||
| **File Name** | text | Custom filename for downloaded files |
|
||||
|
||||
*Plus [common browser fields](#common-fields).*
|
||||
|
||||
### Extraction
|
||||
|
||||
Extract structured data from the current page using AI.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Data Extraction Goal** | text | What data to extract |
|
||||
| **Data Schema** | JSON | [JSON Schema](https://json-schema.org/) defining the output format. Enable the checkbox to reveal the editor. Click **Generate with AI** to auto-suggest a schema from your extraction goal. |
|
||||
|
||||
*Plus [common browser fields](#common-fields).*
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/extract_block.png" alt="Extraction block configuration with Data Extraction Goal and Data Schema fields" />
|
||||
</Frame>
|
||||
|
||||
### Login
|
||||
|
||||
Authenticate to a website using stored credentials. Pre-filled with a default login goal that handles common login flows including 2FA.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **URL** | text | Login page URL |
|
||||
| **Login Goal** | text | Login instructions (pre-filled with a comprehensive default) |
|
||||
| **Credential** | selector | Select stored credentials for authentication |
|
||||
|
||||
Additional fields in **Advanced Settings:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Complete if...** | text | How to know login succeeded |
|
||||
|
||||
*Plus [common browser fields](#common-fields).*
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/login_block.png" alt="Login block configuration with URL, Login Goal, and Credential fields" />
|
||||
</Frame>
|
||||
|
||||
### Go to URL
|
||||
|
||||
Navigate the browser directly to a specific URL without AI interaction.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **URL** | text | **(Required)** The URL to navigate to. Supports [parameter references](/cloud/building-workflows/add-parameters#referencing-parameters-in-blocks). |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/url_block.png" alt="Go to URL block configuration with URL field" />
|
||||
</Frame>
|
||||
|
||||
### Print Page
|
||||
|
||||
Print the current browser page to a PDF file. The PDF is saved as a downloadable artifact.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Page Format** | select | Paper size: A4, Letter, Legal, or Tabloid |
|
||||
| **Print Background** | boolean | Include CSS background colors and images in the PDF |
|
||||
| **Headers & Footers** | boolean | Add date, title, URL, and page numbers to the PDF |
|
||||
|
||||
Additional fields in **Advanced Settings:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Custom Filename** | text | Custom name for the generated PDF |
|
||||
| **Landscape** | boolean | Use landscape orientation |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/print_block.png" alt="Print Page block configuration with page format, print background, and headers & footers options" />
|
||||
</Frame>
|
||||
|
||||
---
|
||||
|
||||
## Data and Extraction
|
||||
|
||||
### Text Prompt
|
||||
|
||||
Send text to the LLM for processing without browser interaction. Useful for summarizing, transforming, or analyzing data between browser steps.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Prompt** | text | The text prompt to send to the LLM |
|
||||
| **Model** | selector | Which LLM model to use |
|
||||
| **Data Schema** | JSON | Expected output structure. Enable the checkbox to reveal the editor. Click **Generate with AI** to auto-suggest a schema. |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/text_block.png" alt="Text Prompt block configuration with Prompt, Model, and Data Schema fields" />
|
||||
</Frame>
|
||||
|
||||
### File Parser
|
||||
|
||||
Parse PDFs, CSVs, Excel files, and images to extract structured data.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **File URL** | text | URL or parameter reference to the file |
|
||||
| **Data Schema** | JSON | Schema for the extracted output. Enable the checkbox to reveal the editor. |
|
||||
| **Model** | selector | Which LLM model to use |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/file_parse_block.png" alt="File Parser block configuration with File URL, Data Schema, and Model fields" />
|
||||
</Frame>
|
||||
|
||||
---
|
||||
|
||||
## Control Flow
|
||||
|
||||
### Loop
|
||||
|
||||
Repeat a sequence of blocks for each item in a list. Child blocks are placed inside the loop on the canvas.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Loop Value** | text | The list to iterate over. Use a parameter reference (e.g., `{{ my_list }}`) or a natural language description (e.g., "Extract links of the top 5 posts") which triggers automatic extraction. |
|
||||
| **Continue if Empty** | boolean | Mark the loop as complete if the list is empty |
|
||||
|
||||
Inside loop blocks, use these [reserved variables](/cloud/building-workflows/add-parameters#reserved-variables):
|
||||
- `{{ current_value }}`: the current item
|
||||
- `{{ current_index }}`: the iteration number (0-based)
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/block-loop-config.png" alt="Loop block configuration" />
|
||||
</Frame>
|
||||
|
||||
Use Loop when the item list is already known before the loop starts, such as rows extracted from a table, files uploaded by a user, or URLs passed as workflow parameters.
|
||||
|
||||
### While Loop
|
||||
|
||||
Repeat a sequence of blocks while a condition remains true. Child blocks are placed inside the loop on the canvas.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Condition** | expression | Jinja2 template or natural-language prompt evaluated before each iteration |
|
||||
|
||||
Inside while-loop blocks, use these [reserved variables](/cloud/building-workflows/add-parameters#reserved-variables):
|
||||
- `{{ current_index }}`: the iteration number (0-based)
|
||||
|
||||
Use While Loop for flows where the number of iterations is discovered during the run, such as pagination, polling, or retrying until a recoverable page state clears. For pagination, a common pattern is to extract a `has_next_page` boolean inside the loop, click Next, and let the next condition check decide whether to continue.
|
||||
|
||||
### Conditional
|
||||
|
||||
Branch the workflow based on conditions. The UI shows branches as tabs (A, B, C, etc.). Each branch has an expression that determines when it executes. Expressions can be Jinja2 templates or natural language prompts.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Branches** | tabs | One or more conditions. Each branch has an **Expression** field. Click **+** to add branches. |
|
||||
| **Else branch** | auto | Automatically added. Executes when no other condition matches. |
|
||||
|
||||
**Example Jinja2 expression:**
|
||||
```
|
||||
{{ extraction_output.price > 100 }}
|
||||
```
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/conditional_block.png" alt="Conditional block configuration with branch expressions" />
|
||||
</Frame>
|
||||
|
||||
### AI Validation
|
||||
|
||||
Assert conditions using AI and halt the workflow on failure. Useful for checking that a previous block produced expected results before continuing.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Complete if...** | text | Condition that means validation passed |
|
||||
| **Terminate if...** | text | Condition that means validation failed |
|
||||
|
||||
Additional fields in **Advanced Settings:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Error Code Mapping** | JSON | Custom error codes for failure reasons |
|
||||
| **Input Parameters** | select | Parameters to evaluate |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/ai_val_block.png" alt="AI Validation block configuration with Complete if and Terminate if fields" />
|
||||
</Frame>
|
||||
|
||||
### Code
|
||||
|
||||
Execute custom Python code. Input parameters are available as global variables. Top-level variables in your code become the block's output.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Code** | code editor | Python code to execute |
|
||||
| **Input Parameters** | select | Parameters available as globals in the code |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/code_block.png" alt="Code block configuration with Python code editor and Input Parameters field" />
|
||||
</Frame>
|
||||
|
||||
### Wait
|
||||
|
||||
Pause workflow execution for a specified duration.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Wait in Seconds** | number | Seconds to wait (0–300) |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/wait_block.png" alt="Wait block configuration with Wait in Seconds field" />
|
||||
</Frame>
|
||||
|
||||
---
|
||||
|
||||
## Files
|
||||
|
||||
### File Download
|
||||
|
||||
Navigate the browser to download a file.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **URL** | text | Starting URL (optional) |
|
||||
| **Download Goal** | text | Instructions for finding and downloading the file |
|
||||
| **Download Timeout (sec)** | number | Seconds to wait for the download to complete |
|
||||
|
||||
Additional fields in **Advanced Settings:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **File Name** | text | Custom filename for the download |
|
||||
|
||||
*Plus [common browser fields](#common-fields).*
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/download_block.png" alt="File Download block configuration with URL, Download Goal, and Download Timeout fields" />
|
||||
</Frame>
|
||||
|
||||
### Cloud Storage Upload
|
||||
|
||||
Upload downloaded files to S3 or Azure Blob Storage.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Storage Type** | select | `Amazon S3` or `Azure Blob Storage` |
|
||||
| **Folder Path** | text | Upload path/prefix (optional) |
|
||||
|
||||
<Accordion title="S3 fields">
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **S3 Bucket** | Bucket name |
|
||||
| **AWS Access Key ID** | AWS credential |
|
||||
| **AWS Secret Access Key** | AWS credential |
|
||||
| **Region Name** | AWS region |
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Azure fields">
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **Storage Account Name** | Storage account name |
|
||||
| **Storage Account Key** | Storage account key |
|
||||
| **Blob Container Name** | Container name |
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/cloud_block.png" alt="Cloud Storage Upload block configuration with Storage Type and Folder Path fields" />
|
||||
</Frame>
|
||||
|
||||
---
|
||||
|
||||
## Communication
|
||||
|
||||
### Send Email
|
||||
|
||||
Send an email notification, optionally with file attachments from previous blocks.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Recipients** | text | Comma-separated email addresses |
|
||||
| **Subject** | text | Email subject line |
|
||||
| **Body** | text | Email body. Supports [parameter references](/cloud/building-workflows/add-parameters#referencing-parameters-in-blocks). |
|
||||
| **File Attachments** | text | Path to files to attach |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/email_block.png" alt="Send Email block configuration with Recipients, Subject, Body, and File Attachments fields" />
|
||||
</Frame>
|
||||
|
||||
### HTTP Request
|
||||
|
||||
Make an API call to an external service. Click **Import cURL** in the block header to populate fields from a cURL command.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Method** | select | GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS |
|
||||
| **URL** | text | Request URL. Supports parameter references. |
|
||||
| **Headers** | JSON | HTTP headers. Use **Quick Headers** to add common headers. |
|
||||
| **Body** | JSON | Request body (POST/PUT/PATCH only) |
|
||||
| **Files** | JSON | File uploads (POST/PUT/PATCH only) |
|
||||
|
||||
Additional fields in **Advanced Settings:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Timeout** | number | Request timeout in seconds (1–300, default: 30) |
|
||||
| **Follow Redirects** | boolean | Automatically follow HTTP redirects (default: true) |
|
||||
| **Continue on Failure** | boolean | Continue workflow if the request fails |
|
||||
| **Save Response as File** | boolean | Save the response body as a downloadable file |
|
||||
| **Download Filename** | text | Filename for the saved response (shown when Save Response as File is enabled) |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/http_block.png" alt="HTTP Request block configuration with Method, URL, Headers, and Body fields" />
|
||||
</Frame>
|
||||
|
||||
### Human Interaction
|
||||
|
||||
Pause the workflow and request human input. Optionally sends an email notification to reviewers.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Instructions For Human** | text | Instructions displayed to the reviewer |
|
||||
| **Timeout (minutes)** | number | Minutes to wait before auto-continuing (default: 120 minutes / 2 hours) |
|
||||
|
||||
**Email notification fields:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Recipients** | text | Email addresses to notify (comma-separated) |
|
||||
| **Subject** | text | Notification email subject |
|
||||
| **Body** | text | Notification email body |
|
||||
|
||||
Additional fields in **Advanced Settings:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| **Positive Button Label** | text | Label for the approval action (default: "Approve") |
|
||||
| **Negative Button Label** | text | Label for the rejection action (default: "Reject") |
|
||||
|
||||
<Frame>
|
||||
<img width="400" src="/images/cloud/human_block.png" alt="Human Interaction block configuration with Instructions For Human and Timeout fields" />
|
||||
</Frame>
|
||||
@@ -0,0 +1,117 @@
|
||||
---
|
||||
title: Managing Workflows
|
||||
subtitle: Create, organize, clone, import, and export reusable automations
|
||||
description: Organize, clone, import, export, and delete workflows in the Skyvern Cloud UI, including folder management and template sharing across your organization.
|
||||
slug: cloud/manage-workflows
|
||||
keywords:
|
||||
- clone
|
||||
- import
|
||||
- export
|
||||
- delete
|
||||
- folder
|
||||
- template
|
||||
- organize
|
||||
---
|
||||
|
||||
Workflows are multi-step automations built visually in the Cloud UI. Once you've [built a workflow](/cloud/building-workflows/build-a-workflow), the **Workflows** page is where you organize, share, and manage them. Each workflow is a reusable sequence of blocks that you can run with different inputs each time.
|
||||
|
||||
If you're building automations in code instead, see the [Browser Automation](/developers/browser-automations/overview) developer docs.
|
||||
|
||||
Click **Workflows** in the left sidebar to open it.
|
||||
|
||||
<img src="/images/cloud/workflows-page-overview.png" alt="Workflows page overview" />
|
||||
|
||||
---
|
||||
|
||||
## The workflows table
|
||||
|
||||
The table lists all workflows in your organization with the following columns:
|
||||
|
||||
| Column | Description |
|
||||
|--------|-------------|
|
||||
| **ID** | Unique workflow identifier |
|
||||
| **Title** | Display name (click to open in the editor) |
|
||||
| **Folder** | Folder assignment, if any |
|
||||
| **Created At** | When the workflow was created |
|
||||
| **Actions** | Inline buttons and three-dot menu |
|
||||
|
||||
Each row also has inline action buttons: folder assignment, parameter toggle, open in editor (pencil icon), run (play icon), and a three-dot menu for additional actions.
|
||||
|
||||
---
|
||||
|
||||
## Organizing with folders
|
||||
|
||||
The top of the page shows your recent folders as cards. Use folders to group related workflows.
|
||||
|
||||
- Click **+ New folder** to create one
|
||||
- Click a folder card to filter the table to that folder's workflows
|
||||
- Assign a workflow to a folder using the folder icon in the table row
|
||||
- Click **View all** to see all folders when you have more than five
|
||||
|
||||
<img src="/images/cloud/workflow-folders.png" alt="Workflow folders" />
|
||||
|
||||
---
|
||||
|
||||
## Searching and filtering
|
||||
|
||||
Use the search bar above the table to filter workflows by title or parameter. The results highlight matching text and auto-expand parameter rows when a parameter matches.
|
||||
|
||||
The items-per-page selector at the bottom lets you choose 5, 10, 20, or 50 rows per page.
|
||||
|
||||
---
|
||||
|
||||
## Workflow actions
|
||||
|
||||
Click the **three-dot menu** on any workflow row to access these actions:
|
||||
|
||||
| Action | What it does |
|
||||
|--------|-------------|
|
||||
| **Clone Workflow** | Creates a copy named "Copy of ..." with the original title |
|
||||
| **Save as Template** | Makes this workflow available in the organization template gallery. A bookmark icon appears next to the title. |
|
||||
| **Remove from Templates** | Removes the workflow from the template gallery (appears instead of "Save as Template" for templates) |
|
||||
| **Export as... > YAML** | Downloads the workflow definition as a `.yaml` file |
|
||||
| **Export as... > JSON** | Downloads the workflow definition as a `.json` file |
|
||||
| **Delete Workflow** | Opens a confirmation dialog, then permanently deletes the workflow |
|
||||
|
||||
<img src="/images/cloud/workflow-actions-menu.png" alt="Workflow actions menu" />
|
||||
|
||||
<Warning>
|
||||
Deleting a workflow is permanent. Clone it first if you want to keep a backup.
|
||||
</Warning>
|
||||
|
||||
---
|
||||
|
||||
## Importing workflows
|
||||
|
||||
Click the **Import** button to upload workflow files.
|
||||
|
||||
| Format | Behavior |
|
||||
|--------|----------|
|
||||
| `.yaml` / `.yml` | Parsed and created as a new workflow |
|
||||
| `.json` | Converted to YAML internally, then created |
|
||||
| `.pdf` | Sent to the AI to generate a workflow from a Standard Operating Procedure document |
|
||||
|
||||
<Tip>
|
||||
Upload a PDF of your Standard Operating Procedure and Skyvern generates a workflow from it automatically.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## What's next
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Open the Editor"
|
||||
icon="pen-to-square"
|
||||
href="/cloud/building-workflows/build-a-workflow"
|
||||
>
|
||||
Build automations visually with the workflow editor
|
||||
</Card>
|
||||
<Card
|
||||
title="Add Parameters"
|
||||
icon="sliders"
|
||||
href="/cloud/building-workflows/add-parameters"
|
||||
>
|
||||
Make workflows reusable with dynamic input values
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,137 @@
|
||||
---
|
||||
title: Running Workflows
|
||||
subtitle: Execute workflows, fill parameters, and track status
|
||||
description: Execute workflows from the Skyvern Cloud UI editor or workflows list, fill in runtime parameters, configure run settings like proxy and webhook, and monitor live execution.
|
||||
slug: cloud/run-a-workflow
|
||||
keywords:
|
||||
- execute
|
||||
- fill parameters
|
||||
- run settings
|
||||
- proxy
|
||||
- webhook
|
||||
- cancel
|
||||
- retry
|
||||
- live execution
|
||||
---
|
||||
|
||||
Once you've built and saved a workflow in the Cloud UI, you can run it from the editor or the workflows list. Each run creates an independent execution with its own status, logs, and output.
|
||||
|
||||
You can also trigger workflows programmatically from your code. See [Run from Code](/cloud/building-workflows/run-from-code) for the SDK and API approach.
|
||||
|
||||
## Starting a run
|
||||
|
||||
Two ways to start:
|
||||
|
||||
1. **From the editor**: Click the **Run** button (play icon) in the header bar. The editor saves your workflow first.
|
||||
|
||||
<img src="/images/cloud/run-wf-1.png" alt="Workflow editor with the Run button highlighted in the header bar" />
|
||||
|
||||
2. **From the workflows list**: Click the **play icon** on the workflow's row.
|
||||
|
||||
<img src="/images/cloud/run-wf-2.png" alt="Workflows list page with play icon to start a run from the list" />
|
||||
|
||||
Both take you to the parameters page where you fill in runtime values before the run starts.
|
||||
|
||||
|
||||
## Filling in parameters
|
||||
|
||||
The parameters page shows all [workflow parameters](/cloud/building-workflows/add-parameters) defined in the editor. Fill in a value for each one, or leave them at their defaults. Parameters without defaults must be filled in before running.
|
||||
|
||||
<img src="/images/cloud/run-wf-3.png" alt="Parameters page showing input fields and settings before starting a workflow run" />
|
||||
|
||||
## Run settings
|
||||
|
||||
Below the parameters, you can configure settings for this specific run:
|
||||
|
||||
| Setting | Description |
|
||||
|---------|-------------|
|
||||
| **Proxy Location** | Route browser traffic through a proxy in a specific country. Default: US Residential. |
|
||||
| **Webhook Callback URL** | URL that receives a POST request when the run completes |
|
||||
| **Max Screenshot Scrolls** | Override screenshot scroll depth for this run |
|
||||
| **Extra HTTP Headers** | Custom headers included in all browser requests (JSON) |
|
||||
| **CDP Address** | Connect to your own browser for local development |
|
||||
|
||||
<Frame>
|
||||
<img src="/images/cloud/run-wf-6.png" alt="Run settings showing webhook callback URL, proxy location, and AI fallback options" />
|
||||
</Frame>
|
||||
<br/>
|
||||
<Frame>
|
||||
<img src="/images/cloud/run-wf-7.png" alt="Advanced run settings showing browser session ID, browser address, extra HTTP headers, and max screenshot scrolls" />
|
||||
</Frame>
|
||||
---
|
||||
|
||||
## Monitoring a run
|
||||
|
||||
After clicking **Run**, you're taken to the live execution view, the same interface described in [Watching Live Execution](/cloud/getting-started/monitor-a-run).
|
||||
|
||||
For workflows, the left panel also shows a **block timeline**: a list of all blocks in the workflow. Completed blocks show a checkmark. The currently executing block is highlighted.
|
||||
|
||||
<img src="/images/cloud/workflow-run-timeline.png" alt="Workflow run block timeline" />
|
||||
|
||||
---
|
||||
|
||||
## Run statuses
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| `created` | Run initialized |
|
||||
| `queued` | Waiting for an available browser |
|
||||
| `running` | Blocks are executing |
|
||||
| `completed` | All blocks finished successfully |
|
||||
| `failed` | A block failed and the workflow stopped |
|
||||
| `canceled` | You canceled the run |
|
||||
| `timed_out` | The run exceeded its time limit |
|
||||
| `terminated` | The run was terminated by the system |
|
||||
|
||||
---
|
||||
|
||||
## Viewing results
|
||||
|
||||
After a run completes, open it from **Runs** in the sidebar. The run detail page shows:
|
||||
|
||||
- **Block-by-block results**: Each block's output, status, and execution time
|
||||
- **Recording**: Full video replay of the browser session
|
||||
- **Parameters**: The values you submitted for this run
|
||||
|
||||
<img src="/images/cloud/run-wf-8.png" alt="Completed workflow run showing extracted data, output tabs, and block timeline" />
|
||||
|
||||
See [Reviewing results](/cloud/getting-started/monitor-a-run#reviewing-results) for details on the Actions, Recording, Parameters, and Diagnostics tabs.
|
||||
|
||||
---
|
||||
|
||||
## Canceling a run
|
||||
|
||||
Click the **Cancel** button during execution. A confirmation dialog appears. The run moves to `canceled` status and any configured webhook fires.
|
||||
|
||||
---
|
||||
|
||||
## Run history
|
||||
|
||||
Access past runs from two places:
|
||||
|
||||
1. **Runs** in the left sidebar: shows all runs across all workflows
|
||||
<img src="/images/cloud/run-wf-4.png" alt="Run History page in the sidebar showing all past runs with status and duration" />
|
||||
2. Go to the **History** button (clock icon) in the workflow editor: shows runs for this specific workflow
|
||||
<img src="/images/cloud/run-wf-5.png" alt="Past Runs view for a specific workflow showing run statuses and timestamps" />
|
||||
|
||||
|
||||
---
|
||||
|
||||
## What's next
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Build a Workflow"
|
||||
icon="pen-to-square"
|
||||
href="/cloud/building-workflows/build-a-workflow"
|
||||
>
|
||||
Create and edit workflows in the visual editor
|
||||
</Card>
|
||||
<Card
|
||||
title="Block Reference"
|
||||
icon="cube"
|
||||
href="/cloud/building-workflows/configure-blocks"
|
||||
>
|
||||
Configuration fields for every block type
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,397 @@
|
||||
---
|
||||
title: Run from Code
|
||||
subtitle: Execute and schedule workflows via the API or SDK
|
||||
description: Run workflows programmatically, pass parameters, poll for results, and create recurring schedules using the Python SDK, TypeScript SDK, or REST API.
|
||||
slug: cloud/building-workflows/run-from-code
|
||||
keywords:
|
||||
- run_workflow
|
||||
- get_run
|
||||
- get_workflows
|
||||
- schedule
|
||||
- cron
|
||||
- polling
|
||||
- webhook
|
||||
- SDK
|
||||
- API
|
||||
---
|
||||
|
||||
If you've built a workflow in the Cloud UI and want to trigger it from your codebase, this page shows how. You can run workflows on demand, poll for results, and set up recurring schedules using the Python SDK, TypeScript SDK, or REST API.
|
||||
|
||||
This is for workflows defined in the visual editor. If you're writing your entire automation in code (no workflow editor involved), see [Browser Automation](/developers/browser-automations/overview) instead.
|
||||
|
||||
---
|
||||
|
||||
## Run a workflow
|
||||
|
||||
Pass values for the workflow's input parameters. The call returns immediately with a `run_id` -- the workflow runs asynchronously in the background.
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
import os
|
||||
import asyncio
|
||||
from skyvern import Skyvern
|
||||
|
||||
async def main():
|
||||
client = Skyvern(api_key=os.getenv("SKYVERN_API_KEY"))
|
||||
|
||||
run = await client.run_workflow(
|
||||
workflow_id="wpid_123456789",
|
||||
parameters={
|
||||
"resume": "https://example.com/resume.pdf",
|
||||
"job_url": "https://jobs.lever.co/company/position"
|
||||
}
|
||||
)
|
||||
|
||||
print(f"Run ID: {run.run_id}")
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
import { SkyvernClient } from "@skyvern/client";
|
||||
|
||||
async function main() {
|
||||
const client = new SkyvernClient({
|
||||
apiKey: process.env.SKYVERN_API_KEY,
|
||||
});
|
||||
|
||||
const run = await client.runWorkflow({
|
||||
body: {
|
||||
workflow_id: "wpid_123456789",
|
||||
parameters: {
|
||||
resume: "https://example.com/resume.pdf",
|
||||
job_url: "https://jobs.lever.co/company/position",
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
console.log(`Run ID: ${run.run_id}`);
|
||||
}
|
||||
|
||||
main();
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
curl -X POST "https://api.skyvern.com/v1/run/workflows" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"workflow_id": "wpid_123456789",
|
||||
"parameters": {
|
||||
"resume": "https://example.com/resume.pdf",
|
||||
"job_url": "https://jobs.lever.co/company/position"
|
||||
}
|
||||
}'
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**Example response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"run_id": "wr_486305187432193510",
|
||||
"status": "created"
|
||||
}
|
||||
```
|
||||
|
||||
### Run parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| `workflow_id` | string | Yes | The `workflow_permanent_id` returned when creating the workflow |
|
||||
| `parameters` | object | No | Values for the workflow's input parameters. Keys must match the `key` field in the workflow's parameter definitions |
|
||||
| `title` | string | No | Display name for this specific run |
|
||||
| `proxy_location` | string or object | No | Override the workflow's default proxy location |
|
||||
| `webhook_url` | string | No | URL to receive a POST request when the workflow completes |
|
||||
| `browser_session_id` | string | No | Reuse a persistent browser session (prefix `pbs_`) |
|
||||
| `browser_profile_id` | string | No | Reuse a browser profile with saved cookies and storage (prefix `bp_`) |
|
||||
|
||||
---
|
||||
|
||||
## Get results
|
||||
|
||||
Workflows run asynchronously, so you need to check back for results. You have two options: poll the API, or receive a webhook when the workflow completes.
|
||||
|
||||
### Option 1: Polling
|
||||
|
||||
Poll `get_run` until the status reaches a terminal state.
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
run_id = run.run_id
|
||||
|
||||
while True:
|
||||
result = await client.get_run(run_id)
|
||||
|
||||
if result.status in ["completed", "failed", "terminated", "timed_out", "canceled"]:
|
||||
break
|
||||
|
||||
await asyncio.sleep(5)
|
||||
|
||||
print(f"Status: {result.status}")
|
||||
print(f"Output: {result.output}")
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
const runId = run.run_id;
|
||||
|
||||
while (true) {
|
||||
const result = await client.getRun(runId);
|
||||
|
||||
if (["completed", "failed", "terminated", "timed_out", "canceled"].includes(result.status)) {
|
||||
console.log(`Status: ${result.status}`);
|
||||
console.log(`Output: ${JSON.stringify(result.output)}`);
|
||||
break;
|
||||
}
|
||||
|
||||
await new Promise((resolve) => setTimeout(resolve, 5000));
|
||||
}
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
#!/bin/bash
|
||||
RUN_ID="wr_486305187432193510"
|
||||
|
||||
while true; do
|
||||
RESPONSE=$(curl -s -X GET "https://api.skyvern.com/v1/runs/$RUN_ID" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY")
|
||||
|
||||
STATUS=$(echo "$RESPONSE" | jq -r '.status')
|
||||
echo "Status: $STATUS"
|
||||
|
||||
if [[ "$STATUS" == "completed" || "$STATUS" == "failed" || "$STATUS" == "terminated" || "$STATUS" == "timed_out" || "$STATUS" == "canceled" ]]; then
|
||||
echo "$RESPONSE" | jq '.output'
|
||||
break
|
||||
fi
|
||||
|
||||
sleep 5
|
||||
done
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Option 2: Webhooks
|
||||
|
||||
Pass a `webhook_url` when running the workflow. Skyvern sends a POST request to your URL when the workflow reaches a terminal state.
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
run = await client.run_workflow(
|
||||
workflow_id="wpid_123456789",
|
||||
parameters={
|
||||
"resume": "https://example.com/resume.pdf",
|
||||
"job_url": "https://jobs.lever.co/company/position"
|
||||
},
|
||||
webhook_url="https://your-server.com/webhook"
|
||||
)
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
const run = await client.runWorkflow({
|
||||
body: {
|
||||
workflow_id: "wpid_123456789",
|
||||
parameters: {
|
||||
resume: "https://example.com/resume.pdf",
|
||||
job_url: "https://jobs.lever.co/company/position",
|
||||
},
|
||||
webhook_url: "https://your-server.com/webhook",
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
curl -X POST "https://api.skyvern.com/v1/run/workflows" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"workflow_id": "wpid_123456789",
|
||||
"parameters": {
|
||||
"resume": "https://example.com/resume.pdf",
|
||||
"job_url": "https://jobs.lever.co/company/position"
|
||||
},
|
||||
"webhook_url": "https://your-server.com/webhook"
|
||||
}'
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
The webhook payload contains the same data as the polling response. See [Webhooks](/developers/going-to-production/webhooks) for authentication and retry options.
|
||||
|
||||
### Response fields
|
||||
|
||||
```json
|
||||
{
|
||||
"run_id": "wr_486305187432193510",
|
||||
"run_type": "workflow_run",
|
||||
"status": "completed",
|
||||
"output": {
|
||||
"parse_resume_output": {
|
||||
"name": "John Smith",
|
||||
"email": "john@example.com",
|
||||
"work_experience": [...]
|
||||
},
|
||||
"apply_to_job_output": {
|
||||
"task_id": "tsk_123456",
|
||||
"status": "completed",
|
||||
"extracted_information": null
|
||||
}
|
||||
},
|
||||
"screenshot_urls": [
|
||||
"https://skyvern-artifacts.s3.amazonaws.com/.../screenshot_final.png"
|
||||
],
|
||||
"recording_url": "https://skyvern-artifacts.s3.amazonaws.com/.../recording.webm",
|
||||
"failure_reason": null,
|
||||
"created_at": "2026-01-20T12:00:00.000000",
|
||||
"modified_at": "2026-01-20T12:05:00.000000"
|
||||
}
|
||||
```
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `run_id` | string | Unique identifier for this run (format: `wr_*`) |
|
||||
| `run_type` | string | Always `"workflow_run"` for workflow runs |
|
||||
| `status` | string | Current status: `created`, `queued`, `running`, `completed`, `failed`, `terminated`, `timed_out`, `canceled` |
|
||||
| `output` | object | Output from each block, keyed by `{label}_output` |
|
||||
| `screenshot_urls` | array | Final screenshots from the last blocks |
|
||||
| `recording_url` | string | Video recording of the browser session |
|
||||
| `failure_reason` | string \| null | Error description if the run failed |
|
||||
| `downloaded_files` | array | Files downloaded during the run |
|
||||
| `app_url` | string \| null | Link to view this run in the Skyvern UI |
|
||||
| `created_at` | datetime | When the run started |
|
||||
| `modified_at` | datetime | When the run was last updated |
|
||||
| `started_at` | datetime \| null | When execution started |
|
||||
| `finished_at` | datetime \| null | When execution finished |
|
||||
|
||||
---
|
||||
|
||||
## Schedule a workflow
|
||||
|
||||
Schedules let you run any workflow automatically on a recurring basis. Define a cron expression and timezone, and Skyvern triggers the workflow at each interval.
|
||||
|
||||
### Create a schedule
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
import os
|
||||
import asyncio
|
||||
from skyvern import Skyvern
|
||||
|
||||
async def main():
|
||||
client = Skyvern(api_key=os.getenv("SKYVERN_API_KEY"))
|
||||
|
||||
result = await client.agent.create_workflow_schedule(
|
||||
workflow_permanent_id="wpid_123456789",
|
||||
cron_expression="0 9 * * 1-5",
|
||||
timezone="America/New_York",
|
||||
name="Weekday morning report",
|
||||
description="Runs the data extraction workflow every weekday at 9 AM ET",
|
||||
parameters={
|
||||
"url": "https://example.com/dashboard",
|
||||
"output_format": "csv"
|
||||
}
|
||||
)
|
||||
|
||||
print(f"Schedule ID: {result.schedule.workflow_schedule_id}")
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
curl -X POST "https://api.skyvern.com/api/v1/workflows/wpid_123456789/schedules" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"cron_expression": "0 9 * * 1-5",
|
||||
"timezone": "America/New_York",
|
||||
"name": "Weekday morning report",
|
||||
"description": "Runs the data extraction workflow every weekday at 9 AM ET",
|
||||
"parameters": {
|
||||
"url": "https://example.com/dashboard",
|
||||
"output_format": "csv"
|
||||
}
|
||||
}'
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**Schedule parameters:**
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|-------|------|----------|-------------|
|
||||
| `cron_expression` | string | Yes | 5-field cron expression (minimum 5-minute interval) |
|
||||
| `timezone` | string | Yes | IANA timezone identifier (e.g., `America/New_York`) |
|
||||
| `name` | string | No | Human-readable name for the schedule |
|
||||
| `description` | string | No | Description of what this schedule does |
|
||||
| `parameters` | object | No | Workflow parameters to pass on each run |
|
||||
| `enabled` | boolean | No | Whether the schedule is active. Defaults to `true` |
|
||||
|
||||
### Enable and disable a schedule
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
# Disable
|
||||
await client.agent.disable_workflow_schedule(
|
||||
workflow_permanent_id="wpid_123456789",
|
||||
workflow_schedule_id="wfs_abc123"
|
||||
)
|
||||
|
||||
# Re-enable
|
||||
await client.agent.enable_workflow_schedule(
|
||||
workflow_permanent_id="wpid_123456789",
|
||||
workflow_schedule_id="wfs_abc123"
|
||||
)
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
# Disable
|
||||
curl -X POST "https://api.skyvern.com/api/v1/workflows/wpid_123456789/schedules/wfs_abc123/disable" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY"
|
||||
|
||||
# Re-enable
|
||||
curl -X POST "https://api.skyvern.com/api/v1/workflows/wpid_123456789/schedules/wfs_abc123/enable" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY"
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Delete a schedule
|
||||
|
||||
Permanently remove a schedule. This cannot be undone. Runs that were already triggered by this schedule are not affected.
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
await client.agent.delete_workflow_schedule_route(
|
||||
workflow_permanent_id="wpid_123456789",
|
||||
workflow_schedule_id="wfs_abc123"
|
||||
)
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
curl -X DELETE "https://api.skyvern.com/api/v1/workflows/wpid_123456789/schedules/wfs_abc123" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY"
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
---
|
||||
|
||||
## List workflows
|
||||
|
||||
Retrieve all workflows in your organization.
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
workflows = await client.get_workflows()
|
||||
|
||||
for workflow in workflows:
|
||||
print(f"{workflow.workflow_permanent_id}: {workflow.title}")
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
const workflows = await client.getWorkflows();
|
||||
|
||||
for (const workflow of workflows) {
|
||||
console.log(`${workflow.workflow_permanent_id}: ${workflow.title}`);
|
||||
}
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
curl -X GET "https://api.skyvern.com/v1/workflows" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY"
|
||||
```
|
||||
</CodeGroup>
|
||||
@@ -0,0 +1,146 @@
|
||||
---
|
||||
title: Schedule a Workflow
|
||||
subtitle: Set up recurring cron-based execution from the UI
|
||||
description: Set up recurring cron-based workflow schedules in the Skyvern Cloud UI, including creating, editing, pausing, and deleting schedules with timezone support.
|
||||
slug: cloud/scheduling
|
||||
keywords:
|
||||
- schedule
|
||||
- cron
|
||||
- recurring
|
||||
- timezone
|
||||
- pause
|
||||
- resume
|
||||
- enable
|
||||
- disable
|
||||
---
|
||||
|
||||
You can schedule any workflow built in the Cloud UI to run automatically on a recurring basis. Schedules are configured with a cron expression and timezone, and Skyvern triggers the workflow at each interval.
|
||||
|
||||
This page covers scheduling through the Cloud UI. You can also create schedules programmatically via the SDK or API. See [Run from Code](/cloud/building-workflows/run-from-code) for the code approach.
|
||||
|
||||
Schedules are created as **active** by default: they start triggering runs immediately after creation.
|
||||
|
||||
When creating a schedule you'll fill in these fields:
|
||||
|
||||
- **Workflow** (required): The workflow to run. When creating from the workflow editor this is pre-selected.
|
||||
- **Cron Expression** (required): A standard 5-field cron expression that defines how often the workflow runs (e.g., `0 9 * * 1-5` for every weekday at 9 AM). The UI validates the expression in real time and shows a human-readable translation. Quick presets are available for common patterns like hourly, daily, and weekly.
|
||||
- **Timezone** (required): The IANA timezone the cron expression is evaluated in (e.g., `America/New_York`). Defaults to your browser's local timezone. The dropdown is searchable by city name.
|
||||
- **Name**: A human-readable label to identify this schedule in the table and run history.
|
||||
- **Description**: Optional notes about what this schedule does or why it exists.
|
||||
|
||||
<Warning>
|
||||
The minimum interval between runs is **5 minutes**. Expressions that resolve to shorter intervals are rejected.
|
||||
</Warning>
|
||||
|
||||
---
|
||||
|
||||
## Creating a schedule
|
||||
|
||||
<Tabs>
|
||||
<Tab title="From the Schedules page">
|
||||
<Steps>
|
||||
<Step title="Open the Schedules page">
|
||||
Click [**Schedules**](https://app.skyvern.com/schedules/) (calendar icon) in the left sidebar.
|
||||
</Step>
|
||||
<Step title="Click Create Schedule">
|
||||
Click <kbd>Create Schedule</kbd> in the top right corner.
|
||||
<img src="/images/cloud/create-schedule-button.png" alt="Schedules page with Create Schedule button in the top right corner" />
|
||||
</Step>
|
||||
<Step title="Select a workflow and configure the schedule">
|
||||
Choose the workflow you want to schedule from the dropdown. Only saved workflows appear in this list. Then fill in the cron expression, timezone, and optionally a name and description. Check the **Next Scheduled Runs** preview to verify the upcoming execution times match your expectations.
|
||||
<Frame>
|
||||
<img src="/images/cloud/create-sched-form.png" alt="Schedule creation form with workflow dropdown, cron expression, timezone, name, and description fields" width="300" />
|
||||
</Frame>
|
||||
</Step>
|
||||
<Step title="Create">
|
||||
Click **Create Schedule**. The schedule starts in an **Active** state and triggers at the next scheduled time.
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
<Tab title="From the workflow editor">
|
||||
<Steps>
|
||||
<Step title="Open the workflow">
|
||||
Navigate to [**Workflows**](https://app.skyvern.com/workflows/) in the sidebar and click the workflow you want to schedule.
|
||||
</Step>
|
||||
<Step title="Click the Schedule button">
|
||||
In the editor header bar, click the <kbd>Schedule</kbd> button (clock icon).
|
||||
<img src="/images/cloud/wf-page-sched.png" alt="Workflow editor page with Schedule button (clock icon) in the header bar" />
|
||||
</Step>
|
||||
<Step title="Click Add and configure the schedule">
|
||||
A panel opens showing any existing schedules for this workflow. Click <kbd>Add</kbd> to create a new one. Fill in the cron expression, timezone, and optionally a name and description. The workflow is already selected.
|
||||
<Frame>
|
||||
<img src="/images/cloud/create-sched-form.png" alt="Schedule creation form with cron expression, timezone, name, and description fields" width="300" />
|
||||
</Frame>
|
||||
</Step>
|
||||
<Step title="Create">
|
||||
Click **Create Schedule**. The schedule appears in the panel and starts immediately.
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
---
|
||||
|
||||
## The Schedules page
|
||||
|
||||
Click **Schedules** in the left sidebar to see every schedule across all workflows.
|
||||
|
||||
Each row shows:
|
||||
|
||||
| Column | What it shows |
|
||||
|--------|--------------|
|
||||
| **Workflow** | The workflow this schedule triggers |
|
||||
| **Name** | Schedule name |
|
||||
| **Schedule** | Human-readable cron description (e.g., "Every weekday at 9:00 AM") |
|
||||
| **Next Run** | Next execution time in your local timezone |
|
||||
| **Status** | **Active** (green) or **Paused** (gray) |
|
||||
|
||||
Use the search bar to filter by schedule name or workflow title. The status filter narrows to Active or Paused schedules.
|
||||
|
||||
---
|
||||
|
||||
## Editing a schedule
|
||||
|
||||
Click a schedule row to open its detail page.
|
||||
|
||||
<img src="/images/cloud/sched-page.png" alt="Schedule detail page showing configuration, details, and upcoming runs sections" />
|
||||
|
||||
On this page, you can:
|
||||
|
||||
- **Edit the schedule configuration**: Click the **Edit** button to change the frequency, timezone, cron expression, name, and description. Changes take effect immediately and the **Upcoming Runs** preview updates to reflect the new configuration.
|
||||
- **View schedule details**: See when the schedule was created and last modified.
|
||||
- **Preview upcoming runs**: Check the next 5 scheduled execution times in the **Upcoming Runs** section.
|
||||
- **Pause or resume**: Toggle the **Status** switch to pause the schedule. Paused schedules keep their configuration and can be resumed at any time: no runs are triggered while paused.
|
||||
- **Delete the schedule**: Use the delete button (trash icon) in the header. Deletion is permanent. Runs already triggered by the schedule are not affected.
|
||||
|
||||
<Info>
|
||||
To change which workflow a schedule runs, delete the schedule and create a new one for the target workflow.
|
||||
</Info>
|
||||
|
||||
---
|
||||
|
||||
## What's next
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="Scheduling API"
|
||||
icon="code"
|
||||
href="/cloud/building-workflows/run-from-code#create-a-schedule"
|
||||
>
|
||||
Create and manage schedules programmatically
|
||||
</Card>
|
||||
<Card
|
||||
title="Run History"
|
||||
icon="clock-rotate-left"
|
||||
href="/cloud/viewing-results/run-history"
|
||||
>
|
||||
View and filter results from scheduled runs
|
||||
</Card>
|
||||
<Card
|
||||
title="Cost Control"
|
||||
icon="gauge"
|
||||
href="/developers/optimization/cost-control"
|
||||
>
|
||||
Manage costs for recurring automations
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: AI Agents Quickstart
|
||||
subtitle: Give your AI coding assistant full browser automation in one command
|
||||
description: Set up Skyvern's MCP server so Claude, Cursor, Windsurf, or any AI coding assistant can automate browsers with a single command.
|
||||
slug: cloud/getting-started/ai-agents-quickstart
|
||||
---
|
||||
|
||||
import AIAgentsQuickstartContent from "/snippets/ai-agents-quickstart-content.mdx";
|
||||
|
||||
<AIAgentsQuickstartContent />
|
||||
@@ -0,0 +1,247 @@
|
||||
---
|
||||
title: Core Concepts
|
||||
subtitle: The building blocks of every automation in the Skyvern dashboard
|
||||
description: Understand tasks, workflows, blocks, runs, browser sessions, browser profiles, and credentials in the Skyvern Cloud UI — what each is, where to find it, and how it fits together.
|
||||
slug: cloud/getting-started/core-concepts
|
||||
keywords:
|
||||
- task
|
||||
- workflow
|
||||
- block
|
||||
- browser session
|
||||
- browser profile
|
||||
- credential
|
||||
- run
|
||||
- schedule
|
||||
- engine
|
||||
---
|
||||
|
||||
Every automation you build in Skyvern Cloud is composed of the same nine building blocks. This page is a quick tour of each one — what it is, where you find it in the dashboard, and when to reach for it.
|
||||
|
||||
If you've already poked around the dashboard, this map will tie what you've seen to the underlying concepts.
|
||||
|
||||
---
|
||||
|
||||
## Tasks
|
||||
|
||||
A **Task** is a single automation job. You describe what you want, Skyvern opens a browser and does it.
|
||||
|
||||
You create tasks from the **Discover** page. Type your prompt and target URL into the input bar, pick an engine, and hit send.
|
||||
|
||||
<img src="/images/cloud/discover-page-overview.png" alt="Discover page where you create one-off tasks" />
|
||||
|
||||
Tasks are the right starting point for one-off automations, ad-hoc data extraction, or quickly testing whether an idea is feasible before turning it into a workflow.
|
||||
|
||||
When you outgrow a single task — you need parameters, branching, loops, or to run the same flow on a schedule — graduate to a Workflow.
|
||||
|
||||
<Card title="Run a task →" icon="play" href="/cloud/getting-started/run-a-task">
|
||||
Walkthrough of every option on the Discover page.
|
||||
</Card>
|
||||
|
||||
---
|
||||
|
||||
## Workflows
|
||||
|
||||
A **Workflow** is a reusable automation built by chaining blocks together on a visual canvas. Workflows are versioned, parameterized, and shareable across your team.
|
||||
|
||||
You build them on the **Workflows** page. Click any workflow to open the editor, where blocks appear as connected nodes you can drag and configure.
|
||||
|
||||
<img src="/images/cloud/workflow-editor-overview.png" alt="Workflow editor with blocks chained together" />
|
||||
|
||||
Use a workflow when:
|
||||
|
||||
- The same flow needs to run repeatedly with different inputs
|
||||
- You need to loop over a list, branch on a condition, or pass data between steps
|
||||
- You want to schedule the automation to run on a cadence
|
||||
- You want a teammate to be able to re-run it without re-deriving the logic
|
||||
|
||||
<Card title="Build a workflow →" icon="diagram-project" href="/cloud/building-workflows/build-a-workflow">
|
||||
Tutorial covering blocks, parameters, branching, and execution.
|
||||
</Card>
|
||||
|
||||
---
|
||||
|
||||
## Blocks
|
||||
|
||||
**Blocks** are the units a workflow is built from. Each block performs one thing — navigate, log in, extract data, branch on a condition, send an email — and passes its output to the next block.
|
||||
|
||||
In the workflow editor, click the **+** button on any node to insert a new block. The picker groups every available block by category.
|
||||
|
||||
<img src="/images/cloud/add-block-panel.png" alt="Block picker with categories and block types" />
|
||||
|
||||
There are 20+ block types organized into:
|
||||
|
||||
- **Browser automation** — Browser Task, Browser Action, Login, Extraction, Go to URL, Print Page
|
||||
- **Data and extraction** — Text Prompt, File Parser
|
||||
- **Control flow** — Loop, Conditional, AI Validation, Code, Wait
|
||||
- **Files** — File Download, Cloud Storage Upload
|
||||
- **Communication** — Send Email, HTTP Request, Human Interaction
|
||||
|
||||
Each block has its own configuration panel. The full reference, with every field for every block, lives at [Workflow Blocks](/cloud/building-workflows/configure-blocks).
|
||||
|
||||
---
|
||||
|
||||
## Runs
|
||||
|
||||
Every time a task or workflow executes, Skyvern creates a **Run** — a record of what happened, with a video, screenshots, action log, and any extracted data.
|
||||
|
||||
The **Runs** page is your history. Filter by status, search by run ID, click any row to drill in.
|
||||
|
||||
<img src="/images/cloud/run-history-overview.png" alt="Runs page showing execution history with statuses" />
|
||||
|
||||
Inside a run detail page you'll find:
|
||||
|
||||
- **Live viewer / recording** — full video of the browser as it executed
|
||||
- **Actions** — every step the agent took, with the LLM's reasoning
|
||||
- **Output** — the structured data extracted (matches the schema you defined)
|
||||
- **Code** — auto-generated Python/TypeScript/cURL to reproduce this run via API
|
||||
- **Downloaded files** — anything Skyvern saved, with signed URLs and checksums
|
||||
|
||||
A run can be `queued`, `running`, `completed`, `failed`, `terminated`, `timed_out`, or `canceled`. You're billed per **step** — one screenshot + LLM decision + browser action.
|
||||
|
||||
<Card title="Read run details →" icon="list-check" href="/cloud/viewing-results/run-details">
|
||||
How to interpret the actions tab, recordings, and output.
|
||||
</Card>
|
||||
|
||||
---
|
||||
|
||||
## Browser sessions
|
||||
|
||||
A **browser session** is a live browser instance you keep open across multiple runs. Sessions preserve everything that lives in the browser — cookies, login state, cached pages, the current tab — so a follow-up task picks up exactly where the previous one left off.
|
||||
|
||||
You manage sessions on the **Browsers** page. Create a session, run tasks against it, then close it when you're done.
|
||||
|
||||
<img src="/images/cloud/browsers-page-overview.png" alt="Browsers page with active session and details" />
|
||||
|
||||
Sessions are perfect when you want to:
|
||||
|
||||
- Log in once, then run a sequence of tasks behind that login
|
||||
- Hand off a partially-completed flow between an agent and a human (Take Control)
|
||||
- Keep a long-running automation warm without re-authenticating each step
|
||||
|
||||
Sessions live for 5 minutes to 24 hours (default 60 minutes). When the timer ends or you close it manually, the browser is destroyed and its state goes with it.
|
||||
|
||||
<Card title="Browser sessions →" icon="window" href="/cloud/browser-management/browser-sessions">
|
||||
Create, attach, and reuse sessions across runs.
|
||||
</Card>
|
||||
|
||||
---
|
||||
|
||||
## Browser profiles
|
||||
|
||||
A **browser profile** is the persistent counterpart to a session. Where a session is a live browser that times out, a profile is a saved snapshot — cookies, auth tokens, local storage — that you can reload weeks later to skip the login flow entirely.
|
||||
|
||||
Profiles are listed on the **Browsers** page under the Profiles tab. You create one from any completed run, then attach it to future runs to start in an already-authenticated state.
|
||||
|
||||
| | Browser session | Browser profile |
|
||||
|---|---|---|
|
||||
| **Live or saved?** | Live, in-memory browser | Saved snapshot of state |
|
||||
| **Lifetime** | 5 min – 24 hr | Indefinite |
|
||||
| **Best for** | Chaining tasks in real time | Skipping login on repeat runs |
|
||||
|
||||
<Card title="Browser profiles →" icon="floppy-disk" href="/cloud/browser-management/browser-profiles">
|
||||
Save and reuse authenticated state across days or weeks.
|
||||
</Card>
|
||||
|
||||
---
|
||||
|
||||
## Credentials
|
||||
|
||||
A **credential** is a stored login, credit card, or 2FA secret that Skyvern injects directly into the browser at runtime. Credentials are encrypted at rest and **never sent to the LLM** — the agent decides where the password field is, and the value is filled in via the browser layer.
|
||||
|
||||
The **Credentials** page is where you manage them.
|
||||
|
||||
<img src="/images/cloud/credentials-overview.png" alt="Credentials page with password and credit card credentials" />
|
||||
|
||||
Three credential types are supported:
|
||||
|
||||
- **Password** — username + password, optionally with a TOTP secret or email/SMS 2FA
|
||||
- **Credit card** — card number, expiry, CVC, billing address
|
||||
- **Secret** — any single value you want to keep out of the LLM context
|
||||
|
||||
You can also sync credentials from **Bitwarden**, **1Password**, or **Azure Key Vault** instead of storing them in Skyvern.
|
||||
|
||||
<Card title="Credentials overview →" icon="lock" href="/cloud/managing-credentials/credentials-overview">
|
||||
Security model, supported types, and external vault integration.
|
||||
</Card>
|
||||
|
||||
---
|
||||
|
||||
## Schedules
|
||||
|
||||
A **schedule** runs a workflow automatically on a recurring cadence. You set a cron expression and timezone, and Skyvern fires the workflow at every interval — no manual trigger needed.
|
||||
|
||||
Schedules are configured per workflow. Open any workflow's actions menu and choose **Schedule**.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/cloud/create-sched-form.png" alt="Schedule form with cron expression and timezone" width="300" />
|
||||
</Frame>
|
||||
|
||||
Use schedules for daily reports, hourly monitoring, periodic data syncs, or anything that should "just keep running" without you remembering to click Run.
|
||||
|
||||
<Card title="Scheduling →" icon="calendar" href="/cloud/building-workflows/scheduling">
|
||||
Cron syntax, timezones, and managing scheduled runs.
|
||||
</Card>
|
||||
|
||||
---
|
||||
|
||||
## Engines
|
||||
|
||||
An **engine** is the AI model Skyvern uses to drive the browser. Different engines have different strengths — speed, accuracy on complex pages, cost — and you can pick one per task or per block.
|
||||
|
||||
The engine picker appears on the Discover page (for tasks) and on every browser-driven block in the workflow editor.
|
||||
|
||||
| Engine | When to use |
|
||||
|--------|-------------|
|
||||
| **Skyvern 2.0** | Default. Best balance of accuracy and speed for most automations. |
|
||||
| **Skyvern 1.0** | Lighter and faster for simple, single-page interactions. |
|
||||
| **OpenAI CUA** | OpenAI's Computer Use Agent. Good for visual reasoning. |
|
||||
| **Anthropic CUA** | Anthropic's Claude Computer Use. Strong at multi-step planning. |
|
||||
| **UI-TARS** | Lightweight CUA model option. |
|
||||
|
||||
If you're not sure, leave it on the default. Switch engines if you hit accuracy issues on a specific site.
|
||||
|
||||
---
|
||||
|
||||
## How they fit together
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A[Task] -->|Single job, one prompt| R1[Run]
|
||||
W[Workflow] -->|Reusable, multi-step| R2[Run]
|
||||
W -->|Composed of| B[Blocks]
|
||||
S[Schedule] -->|Triggers| W
|
||||
R1 & R2 -->|Optionally use| BS[Browser Session]
|
||||
BS -->|Snapshot to| BP[Browser Profile]
|
||||
BP -->|Restored by| R1
|
||||
BP -->|Restored by| R2
|
||||
R1 & R2 -->|Inject at runtime| C[Credentials]
|
||||
R1 & R2 -->|Driven by| E[Engine]
|
||||
```
|
||||
|
||||
A typical day in the dashboard:
|
||||
|
||||
1. **Prototype** with a Task on the Discover page. Iterate on the prompt until it works.
|
||||
2. **Productionize** by turning the prompt into a Workflow with Blocks, Parameters, and a Schedule.
|
||||
3. **Persist state** by saving a Browser Profile after the first authenticated run, so future runs skip login.
|
||||
4. **Audit** every execution on the Runs page — recording, actions, output, downloaded files.
|
||||
|
||||
---
|
||||
|
||||
## Next steps
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Run Your First Task"
|
||||
icon="play"
|
||||
href="/cloud/getting-started/run-your-first-task"
|
||||
>
|
||||
Hands-on tutorial — go from prompt to extracted data in a few minutes.
|
||||
</Card>
|
||||
<Card
|
||||
title="Build a Workflow"
|
||||
icon="diagram-project"
|
||||
href="/cloud/building-workflows/build-a-workflow"
|
||||
>
|
||||
Wire blocks together into a reusable, parameterized automation.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: What is Skyvern?
|
||||
subtitle: AI-powered browser automation for any website
|
||||
description: Learn what Skyvern is and how it uses AI and computer vision to automate browser interactions on any website through the Cloud UI.
|
||||
slug: cloud/getting-started/introduction
|
||||
keywords:
|
||||
- browser automation
|
||||
- AI agent
|
||||
- computer vision
|
||||
- LLM
|
||||
- natural language
|
||||
- visual reasoning
|
||||
---
|
||||
|
||||
import IntroductionContent from "/snippets/introduction-content.mdx";
|
||||
|
||||
<IntroductionContent />
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: MCP Server
|
||||
subtitle: Connect AI assistants to browser automation via Model Context Protocol
|
||||
description: Install and configure Skyvern's MCP server so Claude Desktop, Claude Code, Cursor, Windsurf, Codex, Hermes, OpenClaw, and other AI tools can run browser automations from the Skyvern Cloud dashboard over OAuth or API key.
|
||||
slug: cloud/getting-started/mcp
|
||||
keywords:
|
||||
- MCP
|
||||
- Model Context Protocol
|
||||
- OAuth
|
||||
- Claude Desktop
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- Windsurf
|
||||
- Codex
|
||||
- Hermes
|
||||
- OpenClaw
|
||||
- MCPorter
|
||||
- AI assistant
|
||||
- tools
|
||||
- streamable-http
|
||||
---
|
||||
|
||||
import McpContent from "/snippets/mcp-content.mdx";
|
||||
|
||||
<McpContent />
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: Watching Live Execution
|
||||
subtitle: Monitor, interact with, and control running tasks
|
||||
description: Monitor running tasks in real time in the Skyvern Cloud UI, view the live browser stream and agent reasoning logs, and take manual control of the browser mid-task.
|
||||
slug: cloud/monitor-a-run
|
||||
keywords:
|
||||
- live viewer
|
||||
- real-time
|
||||
- agent reasoning
|
||||
- take control
|
||||
- manual control
|
||||
- step timeline
|
||||
---
|
||||
|
||||
When you run a task from the [Discover page](/cloud/getting-started/run-a-task), you're taken to the live execution screen where you can watch the browser in real time.
|
||||
|
||||
<img src="/images/cloud/live-execution-overview.png" alt="Live execution screen" />
|
||||
|
||||
---
|
||||
|
||||
## The execution screen
|
||||
|
||||
The execution view has three panels:
|
||||
|
||||
| Panel | What it shows |
|
||||
|-------|---------------|
|
||||
| **Left: Task configuration** | The block being executed, its URL, and prompt. A status badge shows the current state. |
|
||||
| **Center: Live browser** | Real-time view of the browser. You see pages load, forms fill, and buttons click. |
|
||||
| **Right: Agent logs** | Real-time LLM reasoning and action decisions. Shows why the AI made each choice. |
|
||||
|
||||
---
|
||||
|
||||
## When the live view is available
|
||||
|
||||
The live browser stream is active while the task is still in progress:
|
||||
|
||||
| Status | Live view |
|
||||
|--------|-----------|
|
||||
| `created` | Waiting to start |
|
||||
| `queued` | Waiting for a browser |
|
||||
| `running` | **Active**: the browser is navigating |
|
||||
| `completed` | Stream closed. View the recording instead. |
|
||||
| `failed` | Stream closed. View the recording instead. |
|
||||
| `terminated` | Stream closed. View the recording instead. |
|
||||
| `timed_out` | Stream closed. View the recording instead. |
|
||||
| `canceled` | Stream closed. View the recording instead. |
|
||||
|
||||
Once a task reaches a final state, the live stream closes. Open the run from **Runs** in the sidebar to access the full recording, screenshots, and action history.
|
||||
|
||||
---
|
||||
|
||||
## Taking control of the browser
|
||||
|
||||
While a task is running, you can take over the browser and interact with the page directly, just like you would in your own Chrome window.
|
||||
|
||||
### How it works
|
||||
|
||||
1. Click the **Take Control** button in the live browser panel.
|
||||
2. The AI agent pauses and you get full mouse and keyboard control of the browser.
|
||||
3. Interact with the page: type into fields, click buttons, solve CAPTCHAs, dismiss popups.
|
||||
4. Click **Release Control** to hand the browser back to the AI. It picks up from the current page state and continues the task.
|
||||
|
||||
### When to use it
|
||||
|
||||
- **CAPTCHAs**: solve a CAPTCHA the AI can't get past, then release control
|
||||
- **Unusual login flows**: complete a multi-factor or SSO login that the agent doesn't handle
|
||||
- **Unexpected popups or modals**: dismiss cookie banners, age gates, or promotional overlays
|
||||
- **Mid-task corrections**: navigate to the right page or fix a form field before letting the agent continue
|
||||
|
||||
<Warning>
|
||||
Taking control pauses the AI agent. The task timer keeps running, so release control promptly to avoid timeouts.
|
||||
</Warning>
|
||||
|
||||
<Tip>
|
||||
You can take and release control multiple times during a single run. Each time, the agent resumes from whatever state you left the browser in.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## Stopping a running task
|
||||
|
||||
You can cancel a task at any time while it's running or queued. Click the **Cancel** button in the task header. A confirmation dialog appears before the task is stopped. The task transitions to `canceled` and any configured webhook fires with the canceled status.
|
||||
|
||||
<Note>
|
||||
Credits for actions already taken are still consumed. Canceling stops future actions but does not refund past ones.
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## Reviewing results
|
||||
|
||||
Once a task finishes, open it from **Runs** to see the full results. The run detail page has five tabs:
|
||||
|
||||
- **Overview**: The AI's reasoning timeline alongside browser screenshots. Each Thought, Block, and Action card shows what the agent saw and why it acted.
|
||||
- **Output**: The complete JSON output and any downloaded files.
|
||||
- **Parameters**: The configuration you submitted: URL, prompt, engine, proxy location, webhook URL, data schema, and other settings.
|
||||
- **Recording**: Full video replay of the browser session. Every task is recorded automatically.
|
||||
- **Code**: Auto-generated Python code to reproduce this task via the API or SDK (when code generation is enabled).
|
||||
|
||||
For a full walkthrough of each tab, see [Run Details](/cloud/viewing-results/run-details).
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: UI Overview
|
||||
slug: cloud/overview
|
||||
subtitle: Navigate the Skyvern Cloud dashboard
|
||||
description: Tour the Skyvern Cloud dashboard
|
||||
keywords:
|
||||
- dashboard
|
||||
- navigation
|
||||
- sidebar
|
||||
- settings
|
||||
- runs page
|
||||
- workflows page
|
||||
- run
|
||||
---
|
||||
|
||||
Skyvern Cloud ([app.skyvern.com](https://app.skyvern.com)) lets you automate any website from your browser. Describe what you want in plain English, watch an AI-powered browser do it live, and get structured results back. No code required.
|
||||
|
||||
<Tip>
|
||||
New to Skyvern? The [homepage](/) covers how Skyvern works under the hood, built-in capabilities, and the eight core concepts behind every automation.
|
||||
</Tip>
|
||||
|
||||
<Note>
|
||||
Looking to integrate Skyvern into your own app? See the [Quickstart](/developers/getting-started/quickstart) instead.
|
||||
</Note>
|
||||
|
||||
## The dashboard
|
||||
|
||||
Sign in and you'll land on the **Discover** page, the starting point for running automations.
|
||||
|
||||
<img src="/images/cloud/skyvern-cloud-discover.png" alt="Skyvern Cloud dashboard showing the Discover page" />
|
||||
|
||||
The left sidebar is your navigation hub. Here's what each section does:
|
||||
|
||||
### Build
|
||||
|
||||
Where you create and monitor automations.
|
||||
|
||||
| Page | Purpose |
|
||||
|------|---------|
|
||||
| **Discover** | Run one-off tasks. Type your instructions and target URL into a single prompt, pick an engine, and hit send. |
|
||||
| **Workflows** | Build multi-step automations with the visual workflow editor. Add loops, conditionals, and data passing between steps. |
|
||||
| **Runs** | Execution history for every task and workflow. Filter by status, drill into any run to see actions, recordings, and extracted data. |
|
||||
| **Browsers** | Active [browser sessions](/cloud/browser-management/browser-sessions). Keep a browser open across multiple tasks to preserve login state, cookies, and page context. Load a [browser profile](/cloud/browser-management/browser-profiles) to restore previously saved state. |
|
||||
|
||||
### Agents
|
||||
|
||||
Ready-made automation templates. Each agent is preconfigured with a prompt, target URL, and settings. Pick one to see it work or use it as a starting point for your own task.
|
||||
|
||||
### General
|
||||
|
||||
| Page | Purpose |
|
||||
|------|---------|
|
||||
| **Billing** | Usage, remaining credits, and plan management. |
|
||||
| **Credentials** | Store website logins, credit card details, and secret values securely. Skyvern uses these to authenticate automatically, fill payment forms, and inject secrets into workflows. |
|
||||
| **Settings** | API key, account preferences, and organization management. |
|
||||
|
||||
## How it works
|
||||
|
||||
Every automation in Skyvern Cloud follows the same pattern:
|
||||
|
||||
<Steps>
|
||||
<Step title="Describe your task">
|
||||
Type what you want into the prompt bar. Include the target URL and your instructions in one go. Something like "Get the top post from https://news.ycombinator.com" or "Fill out the contact form at https://example.com/contact with my details."
|
||||
</Step>
|
||||
<Step title="Watch it happen">
|
||||
A cloud browser opens and you see it navigate in real time. Pages load, elements highlight, actions fire. An agent log streams the AI's reasoning (what it sees on the page, what it plans to do, and why) so you can follow along. If the AI gets stuck, hit **Take Control** to jump in and help.
|
||||
</Step>
|
||||
<Step title="Get your results">
|
||||
Extracted data appears as structured JSON on the run detail page. Every run also includes an output view, full recording, the parameters you submitted, and auto-generated code to reproduce the task via API.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
That's it. The next guide walks you through this flow with a real example.
|
||||
|
||||
---
|
||||
|
||||
## Next steps
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Run Your First Task"
|
||||
icon="play"
|
||||
href="/cloud/getting-started/run-your-first-task"
|
||||
>
|
||||
Follow along with a real example to see Skyvern Cloud in action
|
||||
</Card>
|
||||
<Card
|
||||
title="Core Concepts"
|
||||
icon="book"
|
||||
href="/developers/getting-started/core-concepts"
|
||||
>
|
||||
Understand tasks, workflows, and other foundational concepts
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,195 @@
|
||||
---
|
||||
title: The Discover Page
|
||||
subtitle: Run ad-hoc browser automations with natural language
|
||||
description: Use the Discover page in the Skyvern Cloud UI to run ad-hoc browser automation tasks with natural language prompts, choose an engine, and configure advanced settings like proxies and webhooks.
|
||||
slug: cloud/run-a-task
|
||||
keywords:
|
||||
- discover page
|
||||
- prompt
|
||||
- engine
|
||||
- proxy
|
||||
- webhook
|
||||
- data extraction
|
||||
- advanced settings
|
||||
- 2FA
|
||||
---
|
||||
|
||||
The **Discover** page is where you run one-off browser automations. Type what you want done in plain language, and Skyvern opens a browser and does it for you.
|
||||
|
||||
<img src="/images/cloud/discover-page-overview.png" alt="Discover page overview" />
|
||||
|
||||
---
|
||||
|
||||
## The prompt box
|
||||
|
||||
Type a natural language instruction describing what you want automated. Be specific about the goal and any data you want extracted.
|
||||
|
||||
**Examples:**
|
||||
- "Go to amazon.com and find the price of the MacBook Air M4"
|
||||
- "Fill out the contact form at example.com/contact with name John Doe and email john@example.com"
|
||||
- "Get an insurance quote from geico.com for a 2020 Toyota Camry"
|
||||
|
||||
<img src="/images/cloud/prompt-box-filled.png" alt="Prompt box with a sample prompt" />
|
||||
|
||||
Click the **send button** or press **Enter** to start.
|
||||
|
||||
Below the prompt box, **quick-action buttons** offer pre-built examples like "Add a product to cart" or "Get an insurance quote." Click one to run it immediately or use it as a starting point.
|
||||
|
||||
---
|
||||
|
||||
## Choosing an engine
|
||||
|
||||
The dropdown next to the send button controls which engine runs the task.
|
||||
|
||||
| Engine | Best for |
|
||||
|--------|----------|
|
||||
| **Skyvern 2.0 with Code** | Complex, multi-step tasks. Generates reusable scripts. **(Default)** |
|
||||
| **Skyvern 2.0** | Complex tasks without script generation |
|
||||
| **Skyvern 1.0** | Simple, single-objective tasks. Faster and cheaper. |
|
||||
|
||||
<Tip>
|
||||
Start with the default. Switch to Skyvern 1.0 when you have a straightforward, single-page task and want faster execution.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## Advanced settings
|
||||
|
||||
Click the **gear icon** next to the prompt box to expand the settings panel.
|
||||
|
||||
<img src="/images/cloud/advanced-settings-panel.png" alt="Advanced settings panel" />
|
||||
|
||||
| Setting | What it does |
|
||||
|---------|-------------|
|
||||
| **Proxy Location** | Route the browser through a residential proxy in a specific country. Default is `RESIDENTIAL` (US). Set to `NONE` to disable. Available: US, UK, Germany, France, Spain, Ireland, India, Japan, Australia, Canada, Brazil, Mexico, Argentina, New Zealand, South Africa, Italy, Netherlands, Philippines, Turkey. |
|
||||
| **Webhook URL** | URL that receives a POST request when the task finishes. The payload includes status, extracted data, screenshots, and recording URL. |
|
||||
| **Browser Session ID** | Run inside an existing persistent browser session (`pbs_xxx`). Preserves cookies and login state across multiple tasks. |
|
||||
| **CDP Address** | Connect to your own browser via Chrome DevTools Protocol (e.g., `http://127.0.0.1:9222`). For local development. |
|
||||
| **2FA Identifier** | Links your TOTP credentials to this task. Skyvern uses it to retrieve the correct code when a 2FA prompt appears. |
|
||||
| **Extra HTTP Headers** | Custom headers sent with every browser request, as JSON (e.g., `{"Authorization": "Bearer token"}`). |
|
||||
| **Publish Workflow** | Save a reusable workflow alongside the task run. Re-run the same automation later from the Workflows page. |
|
||||
| **Max Steps Override** | Cap the number of AI reasoning steps. Each step = one screenshot-analyze-act cycle. Useful for controlling cost during development. |
|
||||
| **Max Screenshot Scrolls** | Number of scrolls for post-action screenshots. Increase for pages with lazy-loaded content. `0` = viewport only. |
|
||||
|
||||
---
|
||||
|
||||
## Data extraction schema
|
||||
|
||||
The **Data Schema** field in advanced settings lets you define the structure of extracted output as [JSON Schema](https://json-schema.org/).
|
||||
|
||||
Without a schema, the AI returns data in whatever format it chooses. With a schema, output conforms to your structure, making it predictable for downstream use.
|
||||
|
||||
<img src="/images/cloud/data-schema-field.png" alt="Data schema field with JSON" />
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"product_name": {
|
||||
"type": "string",
|
||||
"description": "The name of the product"
|
||||
},
|
||||
"price": {
|
||||
"type": "number",
|
||||
"description": "The price in USD"
|
||||
},
|
||||
"in_stock": {
|
||||
"type": "boolean",
|
||||
"description": "Whether the product is in stock"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Use the `description` field on each property to guide the AI on what to extract.
|
||||
|
||||
<Accordion title="Example: Extracting a list of items">
|
||||
```json
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"quotes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"premium_amount": {
|
||||
"type": "string",
|
||||
"description": "Total premium in USD (e.g., '$321.57')"
|
||||
},
|
||||
"coverage_type": {
|
||||
"type": "string",
|
||||
"description": "Type of coverage (e.g., 'Full Coverage')"
|
||||
},
|
||||
"deductible": {
|
||||
"type": "string",
|
||||
"description": "Deductible amount"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
---
|
||||
|
||||
## Workflow templates
|
||||
|
||||
Below the prompt box, the Discover page shows a gallery of **workflow templates**: pre-built automations for common use cases.
|
||||
|
||||
<img src="/images/cloud/workflow-templates.png" alt="Workflow template gallery" />
|
||||
|
||||
Click any template to launch it with pre-filled configuration, or use it as a starting point and customize.
|
||||
|
||||
---
|
||||
|
||||
## Tips for better results
|
||||
|
||||
**Write specific prompts.** Include the exact goal, target fields, and what "done" looks like.
|
||||
|
||||
| Instead of | Write |
|
||||
|-----------|-------|
|
||||
| "Get some data from this site" | "Extract the product name, price, and availability from the first 5 results on amazon.com/s?k=wireless+mouse" |
|
||||
| "Fill out the form" | "Fill the contact form at example.com/contact with name 'Jane Doe', email 'jane@example.com', and message 'Demo request'" |
|
||||
|
||||
**Control cost with Max Steps.** Set **Max Steps Override** to a reasonable limit (e.g., 10–20 for simple tasks) during development. Each step consumes one credit. Remove the cap once you've confirmed the task works.
|
||||
|
||||
**Debug failures in order.** If a task fails or produces wrong results:
|
||||
|
||||
1. Check the **Failure Reason** at the top of the run detail page
|
||||
2. Read the **Thought cards** in the Overview timeline to find where the AI went off track
|
||||
3. Watch the **Recording** to see what actually happened on screen
|
||||
4. Review **Parameters** to confirm the inputs were correct
|
||||
|
||||
---
|
||||
|
||||
## What happens next
|
||||
|
||||
1. Your prompt is sent to Skyvern
|
||||
2. A cloud browser opens and navigates to the target URL (or finds one from your prompt)
|
||||
3. The AI analyzes the page, plans actions, and executes them step by step
|
||||
4. You're taken to the [live execution view](/cloud/getting-started/monitor-a-run) where you can watch it happen in real time
|
||||
5. When complete, results appear on the run detail page under **Runs**
|
||||
|
||||
---
|
||||
|
||||
## Next steps
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Watching Live Execution"
|
||||
icon="eye"
|
||||
href="/cloud/getting-started/monitor-a-run"
|
||||
>
|
||||
Monitor runs, take control of the browser, and review results
|
||||
</Card>
|
||||
<Card
|
||||
title="Build a Workflow"
|
||||
icon="diagram-project"
|
||||
href="/cloud/building-workflows/build-a-workflow"
|
||||
>
|
||||
Turn a successful task into a reusable multi-step workflow
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,357 @@
|
||||
---
|
||||
title: Run from Code
|
||||
subtitle: Execute tasks and retrieve results via the API or SDK
|
||||
description: Run browser automation tasks programmatically using the Python SDK, TypeScript SDK, or REST API. Poll for results, use webhooks, or wait for completion.
|
||||
slug: cloud/getting-started/run-from-code
|
||||
keywords:
|
||||
- run_task
|
||||
- get_run
|
||||
- polling
|
||||
- wait_for_completion
|
||||
- webhook
|
||||
- SDK
|
||||
- API
|
||||
---
|
||||
|
||||
Run tasks programmatically using the Python SDK, TypeScript SDK, or REST API.
|
||||
|
||||
---
|
||||
|
||||
## Run a task
|
||||
|
||||
A task has one required parameter and one commonly used optional parameter:
|
||||
|
||||
- **`prompt`** (required): Natural language instructions describing what the AI should do
|
||||
- **`url`** (optional): The starting page for the automation
|
||||
|
||||
When you call `run_task`, Skyvern spins up a cloud browser, navigates to the URL, and executes your prompt. A typical task takes 30-90 seconds depending on complexity.
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
import os
|
||||
import asyncio
|
||||
from skyvern import Skyvern
|
||||
|
||||
async def main():
|
||||
client = Skyvern(api_key=os.getenv("SKYVERN_API_KEY"))
|
||||
|
||||
result = await client.run_task(
|
||||
prompt="Get the title of the top post",
|
||||
url="https://news.ycombinator.com",
|
||||
)
|
||||
|
||||
print(f"Run ID: {result.run_id}")
|
||||
print(f"Status: {result.status}")
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
import { SkyvernClient } from "@skyvern/client";
|
||||
|
||||
async function main() {
|
||||
const client = new SkyvernClient({
|
||||
apiKey: process.env.SKYVERN_API_KEY,
|
||||
});
|
||||
|
||||
const result = await client.runTask({
|
||||
body: {
|
||||
prompt: "Get the title of the top post",
|
||||
url: "https://news.ycombinator.com",
|
||||
},
|
||||
});
|
||||
|
||||
console.log(`Run ID: ${result.run_id}`);
|
||||
console.log(`Status: ${result.status}`);
|
||||
}
|
||||
|
||||
main();
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
curl -X POST "https://api.skyvern.com/v1/run/tasks" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"prompt": "Get the title of the top post",
|
||||
"url": "https://news.ycombinator.com"
|
||||
}'
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**Example response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"run_id": "tsk_v2_486305187432193504",
|
||||
"status": "queued",
|
||||
"output": null,
|
||||
"downloaded_files": null,
|
||||
"recording_url": null,
|
||||
"screenshot_urls": null,
|
||||
"failure_reason": null,
|
||||
"created_at": "2026-01-20T11:52:29.276851",
|
||||
"modified_at": "2026-01-20T11:52:29.484284",
|
||||
"app_url": "https://app.skyvern.com/runs/wr_486305187432193510",
|
||||
"run_type": "task_v2"
|
||||
}
|
||||
```
|
||||
|
||||
The response includes a `run_id`. Use this ID to check status, fetch results, and retrieve artifacts.
|
||||
|
||||
<Warning>
|
||||
`run_task` returns immediately -- the task is queued, not finished. Always poll or use webhooks to get results.
|
||||
</Warning>
|
||||
|
||||
---
|
||||
|
||||
## Get results
|
||||
|
||||
The `run_task` call queues the task and returns immediately.
|
||||
|
||||
Use the `run_id` to fetch results once the task reaches a terminal state.
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| `created` | Task initialized, not yet queued |
|
||||
| `queued` | Waiting for an available browser |
|
||||
| `running` | AI is navigating and executing |
|
||||
| `completed` | Task finished successfully -- check `output` for results |
|
||||
| `failed` | Task encountered an error -- check `failure_reason` and retry or adjust your prompt |
|
||||
| `terminated` | Task was manually stopped |
|
||||
| `timed_out` | Task exceeded time limit -- increase `max_steps` or simplify the task |
|
||||
| `canceled` | Task was canceled before starting |
|
||||
|
||||
You have three options for retrieving results:
|
||||
|
||||
### Option 1: Polling
|
||||
|
||||
Poll `get_run` until status is terminal (`completed`, `failed`, `terminated`, `timed_out`, or `canceled`).
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
run_id = result.run_id
|
||||
|
||||
while True:
|
||||
run = await client.get_run(run_id)
|
||||
|
||||
if run.status in ["completed", "failed", "terminated", "timed_out", "canceled"]:
|
||||
break
|
||||
|
||||
await asyncio.sleep(5)
|
||||
|
||||
print(f"Output: {run.output}")
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
const runId = result.run_id;
|
||||
|
||||
while (true) {
|
||||
const run = await client.getRun(runId);
|
||||
|
||||
if (["completed", "failed", "terminated", "timed_out", "canceled"].includes(run.status)) {
|
||||
console.log(`Output: ${JSON.stringify(run.output)}`);
|
||||
break;
|
||||
}
|
||||
|
||||
await new Promise((resolve) => setTimeout(resolve, 5000));
|
||||
}
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
#!/bin/bash
|
||||
RUN_ID="YOUR_RUN_ID"
|
||||
|
||||
while true; do
|
||||
RESPONSE=$(curl -s -X GET "https://api.skyvern.com/v1/runs/$RUN_ID" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY")
|
||||
|
||||
STATUS=$(echo "$RESPONSE" | jq -r '.status')
|
||||
echo "Status: $STATUS"
|
||||
|
||||
if [[ "$STATUS" == "completed" || "$STATUS" == "failed" || "$STATUS" == "terminated" || "$STATUS" == "timed_out" || "$STATUS" == "canceled" ]]; then
|
||||
echo "$RESPONSE" | jq '.output'
|
||||
break
|
||||
fi
|
||||
|
||||
sleep 5
|
||||
done
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
<Warning>
|
||||
Your polling loop must check **all** terminal states: `completed`, `failed`, `terminated`, `timed_out`, `canceled`. Missing one causes infinite loops.
|
||||
</Warning>
|
||||
|
||||
### Option 2: Webhooks
|
||||
|
||||
Pass a `webhook_url` when creating the task. Skyvern sends a POST request to your URL when the task completes.
|
||||
|
||||
<CodeGroup>
|
||||
```python Python
|
||||
result = await client.run_task(
|
||||
prompt="Get the title of the top post",
|
||||
url="https://news.ycombinator.com",
|
||||
webhook_url="https://your-server.com/webhook",
|
||||
)
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
const result = await client.runTask({
|
||||
body: {
|
||||
prompt: "Get the title of the top post",
|
||||
url: "https://news.ycombinator.com",
|
||||
webhook_url: "https://your-server.com/webhook",
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
```bash cURL
|
||||
curl -X POST "https://api.skyvern.com/v1/run/tasks" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"prompt": "Get the title of the top post",
|
||||
"url": "https://news.ycombinator.com",
|
||||
"webhook_url": "https://your-server.com/webhook"
|
||||
}'
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
Skyvern sends a POST request with the full run data when the task completes or fails.
|
||||
|
||||
### Option 3: Wait for completion (Python only)
|
||||
|
||||
Block until the task finishes instead of polling manually.
|
||||
|
||||
```python Python
|
||||
result = await client.run_task(
|
||||
prompt="Get the title of the top post",
|
||||
url="https://news.ycombinator.com",
|
||||
wait_for_completion=True,
|
||||
)
|
||||
print(result.output)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Understand the response
|
||||
|
||||
The response from polling (`get_run`) and webhooks have slightly different structures. Both contain the core task data, but webhooks include additional metadata.
|
||||
|
||||
<CodeGroup>
|
||||
```json Polling Response
|
||||
{
|
||||
"run_id": "tsk_v2_486305187432193504",
|
||||
"status": "completed",
|
||||
"output": {
|
||||
"top_post_title": "Linux kernel framework for PCIe device emulation, in userspace"
|
||||
},
|
||||
"downloaded_files": [],
|
||||
"recording_url": "https://skyvern-artifacts.s3.amazonaws.com/v1/production/.../recording.webm?...",
|
||||
"screenshot_urls": ["https://skyvern-artifacts.s3.amazonaws.com/.../screenshot_final.png?..."],
|
||||
"failure_reason": null,
|
||||
"errors": [],
|
||||
"step_count": 2,
|
||||
"run_type": "task_v2",
|
||||
"app_url": "https://app.skyvern.com/runs/wr_486305187432193510",
|
||||
"browser_session_id": null,
|
||||
"browser_profile_id": null,
|
||||
"created_at": "2026-01-20T11:52:29.276851",
|
||||
"modified_at": "2026-01-20T11:54:08.822807",
|
||||
"queued_at": "2026-01-20T11:52:29.483922",
|
||||
"started_at": "2026-01-20T11:52:31.835337",
|
||||
"finished_at": "2026-01-20T11:54:08.821985",
|
||||
"run_request": {
|
||||
"prompt": "Get the title of the top post",
|
||||
"url": "https://news.ycombinator.com/",
|
||||
"engine": "skyvern-2.0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```json Webhook Payload
|
||||
{
|
||||
"task_id": "tsk_v2_486306851394503256",
|
||||
"run_id": "tsk_v2_486306851394503256",
|
||||
"status": "completed",
|
||||
"output": {
|
||||
"top_post_title": "Linux kernel framework for PCIe device emulation, in userspace"
|
||||
},
|
||||
"summary": "I have successfully navigated to Hacker News and extracted the title of the top post.",
|
||||
"prompt": "Get the title of the top post",
|
||||
"url": "https://news.ycombinator.com/",
|
||||
"downloaded_files": [],
|
||||
"recording_url": "https://skyvern-artifacts.s3.amazonaws.com/v1/production/.../recording.webm?...",
|
||||
"screenshot_urls": ["https://skyvern-artifacts.s3.amazonaws.com/.../screenshot_final.png?..."],
|
||||
"failure_reason": null,
|
||||
"errors": [],
|
||||
"step_count": 2,
|
||||
"run_type": "task_v2",
|
||||
"app_url": "https://app.skyvern.com/runs/wr_486306851394503262",
|
||||
"organization_id": "o_485917350850524254",
|
||||
"workflow_run_id": "wr_486306851394503262",
|
||||
"proxy_location": "RESIDENTIAL",
|
||||
"webhook_callback_url": "https://your-server.com/webhook",
|
||||
"created_at": "2026-01-20T11:58:57.414123",
|
||||
"modified_at": "2026-01-20T12:00:31.513449",
|
||||
"queued_at": "2026-01-20T11:58:57.607233",
|
||||
"started_at": "2026-01-20T11:58:59.395028",
|
||||
"finished_at": "2026-01-20T12:00:31.512692"
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**Common fields (both polling and webhook):**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `run_id` | string | Unique identifier for this run |
|
||||
| `status` | string | Current status: `queued`, `running`, `completed`, `failed`, `terminated`, `timed_out`, `canceled` |
|
||||
| `output` | object \| null | Extracted data from the task |
|
||||
| `downloaded_files` | array | Files downloaded during execution |
|
||||
| `recording_url` | string \| null | Video recording of the browser session |
|
||||
| `screenshot_urls` | array \| null | Screenshots captured (latest first) |
|
||||
| `failure_reason` | string \| null | Error message if the run failed |
|
||||
| `errors` | array | List of errors encountered |
|
||||
| `step_count` | integer \| null | Number of steps executed |
|
||||
| `run_type` | string | Type of run: `task_v2`, `openai_cua`, `anthropic_cua` |
|
||||
| `app_url` | string | Link to view this run in Skyvern Cloud |
|
||||
| `created_at` | datetime | When the run was created |
|
||||
| `modified_at` | datetime | When the run was last updated |
|
||||
| `queued_at` | datetime \| null | When the run entered the queue |
|
||||
| `started_at` | datetime \| null | When execution began |
|
||||
| `finished_at` | datetime \| null | When execution completed |
|
||||
|
||||
**Polling-only fields:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `run_request` | object | Original request parameters (prompt, url, engine, etc.) |
|
||||
| `browser_session_id` | string \| null | ID of the browser session used |
|
||||
| `browser_profile_id` | string \| null | ID of the browser profile used |
|
||||
| `max_screenshot_scrolls` | integer \| null | Number of scrolls for screenshots |
|
||||
| `script_run` | object \| null | Script run result if AI fallback triggered |
|
||||
|
||||
**Webhook-only fields:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `task_id` | string | Same as `run_id` |
|
||||
| `summary` | string | AI-generated description of what was done |
|
||||
| `prompt` | string | The prompt from the original request |
|
||||
| `url` | string | The URL from the original request |
|
||||
| `organization_id` | string | Your organization ID |
|
||||
| `workflow_run_id` | string | Associated workflow run ID |
|
||||
| `proxy_location` | string | Proxy location used (e.g., `RESIDENTIAL`) |
|
||||
| `webhook_callback_url` | string | The webhook URL that received this payload |
|
||||
|
||||
### Artifacts
|
||||
|
||||
Every run captures recordings, screenshots, and logs. See [Using Artifacts](/developers/debugging/using-artifacts) for retrieval and the full artifact type reference.
|
||||
|
||||
---
|
||||
|
||||
<Note>
|
||||
For multi-step automations that chain multiple actions, see [Browser Automation](/developers/browser-automations/overview).
|
||||
</Note>
|
||||
@@ -0,0 +1,141 @@
|
||||
---
|
||||
title: Your First Task
|
||||
slug: cloud/run-your-first-task
|
||||
subtitle: Run a browser automation from start to finish
|
||||
description: Follow a step-by-step tutorial to run your first browser automation task in the Skyvern Cloud UI, from writing a prompt to viewing extracted results.
|
||||
keywords:
|
||||
- first task
|
||||
- tutorial
|
||||
- discover page
|
||||
- prompt
|
||||
- extracted data
|
||||
- live viewer
|
||||
---
|
||||
|
||||
Let's run a real automation. You'll tell Skyvern to visit a website, extract data, and return it as JSON. Then watch the entire thing happen live.
|
||||
|
||||
## Step 1: Write your prompt
|
||||
|
||||
Open [app.skyvern.com](https://app.skyvern.com) and you'll land on the **Discover** page.
|
||||
|
||||
<img src="/images/cloud/skyvern-cloud-discover.png" alt="Discover page with a prompt entered" />
|
||||
|
||||
The Discover page has a single input field. Type your instructions and include the target URL in the same prompt. For this example, enter:
|
||||
|
||||
```
|
||||
Get the title of the #1 post on the front page for https://news.ycombinator.com
|
||||
```
|
||||
|
||||
That's it. Skyvern parses the URL and figures out how to navigate the page and extract the data.
|
||||
|
||||
Below the input, you'll see quick-action chips like "Add a product to cart" and "What's the top post on hackernews". Click any of these to try a pre-filled example instead.
|
||||
|
||||
<Tip>
|
||||
The more specific your prompt, the better. "Get the title of the #1 post" works much better than "get some data." Include the exact fields you want, what success looks like, and any constraints.
|
||||
</Tip>
|
||||
|
||||
## Step 2: Pick an engine and run
|
||||
|
||||
Next to your prompt, you'll see an engine selector. Click it to switch engines:
|
||||
|
||||
| Engine | When to use it |
|
||||
|--------|---------------|
|
||||
| **Skyvern 1.0** | Tasks with a simple, single goal: filling a form, searching for information on Google, reading content from a page |
|
||||
| **Skyvern 2.0** | Complex, multi-step tasks. Scores state-of-the-art 85.85% on the WebVoyager benchmark |
|
||||
| **Skyvern 2.0 with Code** | The default engine. Same capabilities as Skyvern 2.0, plus auto-generates reusable code and a workflow from the run |
|
||||
|
||||
For this example, keep the default **Skyvern 2.0 with Code** selected.
|
||||
|
||||
Click the **send button** (arrow icon to the right of the input). Skyvern generates a workflow from your prompt and opens it in the workflow editor. Click **Run** in the top right, confirm the parameters, then click **Run workflow** to start execution.
|
||||
|
||||
<Accordion title="Optional: Advanced settings">
|
||||
Click the **gear icon** next to send to configure additional options before running:
|
||||
|
||||
| Setting | What it does |
|
||||
|---------|-------------|
|
||||
| **Webhook Callback URL** | Endpoint to receive the extracted data when the run completes |
|
||||
| **Proxy Location** | Route Skyvern through one of the available proxies |
|
||||
| **Browser Session ID** | Reuse a persistent browser session to keep login state |
|
||||
| **CDP Address** | Connect to your own browser via Chrome DevTools Protocol |
|
||||
| **2FA Identifier** | Identifier for a 2FA code to handle two-factor auth automatically |
|
||||
| **Extra HTTP Headers** | Custom HTTP request headers (dict format) |
|
||||
| **Generate Script** | Auto-generate reusable scripts from a successful run |
|
||||
| **Publish Workflow** | Create a workflow alongside this task run |
|
||||
| **Max Steps Override** | Cap the number of steps the AI can take |
|
||||
| **Data Schema** | Define structured JSON output format |
|
||||
| **Max Screenshot Scrolls** | Limit scrolls for post-action screenshots (default: 3) |
|
||||
|
||||
These are all optional. The defaults work for most tasks.
|
||||
</Accordion>
|
||||
|
||||
## Step 3: Watch the live browser
|
||||
|
||||
This is where it gets interesting. Once the task starts, you'll see the run detail page with a live view of the browser:
|
||||
|
||||
<img src="/images/cloud/discover-prompt-in-process.png" alt="Run detail page showing a live browser navigating Hacker News" />
|
||||
|
||||
On the left, a **live browser view**. You'll see pages load, elements highlight, and actions fire.
|
||||
|
||||
On the right, the **agent log**. A running stream of the AI's Thoughts, Decisions, and block executions. If something goes wrong, this is where you'll figure out why.
|
||||
|
||||
## Step 4: Review the results
|
||||
|
||||
When the task finishes, the status badge flips to **completed** and the extracted data appears at the top of the page.
|
||||
|
||||
<img src="/images/cloud/discover-workflow-completed.png" alt="Completed run showing extracted data and result tabs" />
|
||||
|
||||
### Extracted data
|
||||
|
||||
The **Extracted Information** block shows your results as structured JSON:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"top_post_title": "Don't rent the cloud, own instead"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
Your result will differ, since the #1 post changes constantly. The structure is what matters.
|
||||
|
||||
The agent log on the right confirms what happened. You'll see a final Thought summarizing the result.
|
||||
|
||||
### Tabs
|
||||
|
||||
Below the extracted data, five tabs give you different views of the run:
|
||||
|
||||
- **Overview**: The AI's reasoning timeline alongside browser screenshots. Each Thought, Block, and Action card shows what the agent saw and why it acted.
|
||||
- **Output**: The complete JSON output and any downloaded files.
|
||||
- **Parameters**: The exact configuration that was submitted (URL, prompt, engine, schema). Useful for reproducing or tweaking the run.
|
||||
- **Recording**: Full video replay of the browser session, start to finish.
|
||||
- **Code**: Auto-generated Python code to reproduce this task via the API or SDK.
|
||||
|
||||
## Try something bigger
|
||||
|
||||
Now that you've seen the basic flow, here are a few ideas to try next:
|
||||
|
||||
- **Fill a form**: Point Skyvern at a contact form and tell it what to enter in each field
|
||||
- **Compare prices**: Extract product names and prices from an e-commerce page using a data schema
|
||||
- **Navigate a flow**: Use Skyvern 2.0 to walk through a multi-page checkout or signup process
|
||||
- **Use an Agent template**: Check the **Agents** section in the sidebar for pre-built automations you can run instantly
|
||||
|
||||
---
|
||||
|
||||
## Next steps
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Run a Task via API"
|
||||
icon="code"
|
||||
href="/running-automations/run-a-task"
|
||||
>
|
||||
Trigger automations programmatically with the Skyvern API
|
||||
</Card>
|
||||
<Card
|
||||
title="Core Concepts"
|
||||
icon="book"
|
||||
href="/developers/getting-started/core-concepts"
|
||||
>
|
||||
Understand tasks, workflows, and other building blocks
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,138 @@
|
||||
---
|
||||
title: Credentials Overview
|
||||
subtitle: Securely store login details, payment info, and secrets for your automations
|
||||
description: Securely store passwords, credit cards, and secrets in the Skyvern Cloud UI Credentials page, with encrypted-at-rest vault storage and just-in-time injection during browser automation.
|
||||
slug: cloud/managing-credentials/credentials-overview
|
||||
keywords:
|
||||
- vault
|
||||
- encrypted
|
||||
- password
|
||||
- credit card
|
||||
- secret
|
||||
- Bitwarden
|
||||
- 1Password
|
||||
- Azure Key Vault
|
||||
---
|
||||
|
||||
The **Credentials** page stores sensitive values (passwords, payment cards, and secrets) so your workflows can use them without embedding secrets in prompts or parameters. Skyvern stores credentials by default with no external service required.
|
||||
|
||||
<img src="/images/cloud/credentials-overview.png" alt="Credentials page overview" />
|
||||
|
||||
## How Skyvern keeps credentials secure
|
||||
|
||||
Sensitive credential data never reaches the LLM, logs, or API responses.
|
||||
|
||||
<Steps>
|
||||
<Step title="Encrypted at rest">
|
||||
When you save a credential, the sensitive data (passwords, card numbers, CVVs, and TOTP secrets) is sent to a secure vault that provides encryption at rest. Skyvern supports multiple vault backends: Bitwarden, 1Password, Azure Key Vault, and custom webhook providers. Skyvern's own database stores only non-sensitive metadata: credential name, username, card last four digits, card brand, TOTP method, and similar identifiers. Passwords, full card numbers, CVVs, and TOTP secrets are stored exclusively in the vault.
|
||||
</Step>
|
||||
<Step title="Placeholders during execution">
|
||||
When a workflow runs, the LLM receives only placeholder IDs like `placeholder_Xk9m_password`. The AI decides *where* to type on the page, but never sees the real values. No third party, including the LLM provider, ever accesses your actual credentials.
|
||||
</Step>
|
||||
<Step title="Just-in-time injection">
|
||||
At the browser level, the automation layer resolves placeholders to real values and types them directly into the page. After execution, credential values that appear in HTTP Request block responses, block context snapshots, and conditional evaluation outputs are automatically masked before storage.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to the Credentials page">
|
||||
Click **Credentials** in the left sidebar under **General**.
|
||||
<img src="/images/cloud/credentials-sidebar-nav.png" alt="Credentials option in the left sidebar under General" />
|
||||
</Step>
|
||||
<Step title="Click + Add">
|
||||
Choose the credential type: **Password**, **Credit Card**, or **Secret**.
|
||||
<img src="/images/cloud/credentials-add-dropdown.png" alt="Add dropdown showing Password, Credit Card, and Secret options" />
|
||||
</Step>
|
||||
<Step title="Fill in the details and save">
|
||||
Enter the required fields and click **Save**. The credential is immediately available for use in workflows.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
---
|
||||
|
||||
## What you can store
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="Password Credentials"
|
||||
icon="key"
|
||||
href="/cloud/managing-credentials/password-credentials"
|
||||
>
|
||||
Username, password, and optional 2FA configuration for automated logins
|
||||
</Card>
|
||||
<Card
|
||||
title="Credit Card Credentials"
|
||||
icon="credit-card"
|
||||
href="/cloud/managing-credentials/credit-card-credentials"
|
||||
>
|
||||
Payment card details for purchase and checkout workflows
|
||||
</Card>
|
||||
<Card
|
||||
title="Secret Credentials"
|
||||
icon="file-shield"
|
||||
href="#secret-credentials"
|
||||
>
|
||||
A single sensitive string such as an API key, bearer token, or any value you don't want hardcoded
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
Password and Credit Card credentials have their own pages. Secrets are simpler and documented here.
|
||||
|
||||
### Secret credentials
|
||||
|
||||
Secrets store a single sensitive value (an API key, bearer token, or similar). Create one from **+ Add → Secret**, give it a name and value, then reference it in HTTP Request, Code, or Workflow Trigger blocks using the credential parameter's key:
|
||||
|
||||
```
|
||||
{{ parameter_key.secret_value }}
|
||||
```
|
||||
|
||||
Replace `parameter_key` with the **key** assigned to the credential parameter in the workflow editor (e.g., `credentials`, `credentials_1`).
|
||||
|
||||
---
|
||||
|
||||
## Using credentials in workflows
|
||||
|
||||
The most common pattern is a **Login block**. A Login block is a workflow step that signs into a website using stored credentials. Select a credential from the dropdown, and Skyvern fills in the username, password, and 2FA code (if configured) automatically. See [Block Reference](/cloud/building-workflows/configure-blocks) for details.
|
||||
|
||||
For workflows that need different credentials at runtime, add a **Credential parameter** (type: `credential_id`). When someone runs the workflow, they pick which credential to use from a dropdown. See [Workflow Parameters](/cloud/building-workflows/add-parameters) for setup.
|
||||
|
||||
---
|
||||
|
||||
## Deleting credentials
|
||||
|
||||
Click the **trash icon** on any credential row. Deletion is permanent and cannot be undone. If a workflow references a deleted credential, the run will fail during initialization until you assign a replacement.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Password Credentials"
|
||||
icon="key"
|
||||
href="/cloud/managing-credentials/password-credentials"
|
||||
>
|
||||
Store logins with optional 2FA
|
||||
</Card>
|
||||
<Card
|
||||
title="Credit Card Credentials"
|
||||
icon="credit-card"
|
||||
href="/cloud/managing-credentials/credit-card-credentials"
|
||||
>
|
||||
Store payment details for checkout workflows
|
||||
</Card>
|
||||
<Card
|
||||
title="2FA / TOTP Setup"
|
||||
icon="shield-halved"
|
||||
href="/cloud/managing-credentials/totp-setup"
|
||||
>
|
||||
Configure and manage two-factor authentication
|
||||
</Card>
|
||||
<Card
|
||||
title="External Providers"
|
||||
icon="vault"
|
||||
href="/cloud/managing-credentials/external-providers"
|
||||
>
|
||||
Connect Bitwarden, 1Password, Azure Key Vault, or a custom API
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: Credit Card Credentials
|
||||
subtitle: Store payment details for purchase and checkout workflows
|
||||
description: Store credit card details securely in the Skyvern Cloud UI for automated checkout and purchase workflows, with encrypted storage and browser-level injection.
|
||||
slug: cloud/managing-credentials/credit-card-credentials
|
||||
keywords:
|
||||
- credit card
|
||||
- payment
|
||||
- checkout
|
||||
- card number
|
||||
- expiry
|
||||
- CVV
|
||||
---
|
||||
|
||||
Credit card credentials store payment details so the AI can fill checkout forms without you embedding card numbers in prompts or parameters. Like all credentials, card numbers never reach the LLM. They are injected directly at the browser level.
|
||||
|
||||
## Creating a credit card credential
|
||||
|
||||
<Steps>
|
||||
<Step title="Open the Add dialog">
|
||||
Click **+ Add → Credit Card** from the Credentials page.
|
||||
</Step>
|
||||
<Step title="Fill in the card details">
|
||||
Provide all required fields:
|
||||
|
||||
| Field | Description |
|
||||
|-------|------------|
|
||||
| **Name** | A label like "Corporate Visa" to identify it later |
|
||||
| **Cardholder Name** | Name printed on the card |
|
||||
| **Number** | Full card number (spaces added automatically as you type) |
|
||||
| **Brand** | Card network: Visa, Mastercard, American Express, Discover, JCB, Diners Club, Maestro, UnionPay, RuPay, or Other |
|
||||
| **Expiration** | Month and year in `MM/YY` format (slash inserted automatically) |
|
||||
| **CVV** | 3 or 4 digit security code |
|
||||
</Step>
|
||||
<Step title="Save">
|
||||
Click **Save**. After saving, the card number is masked and only the last four digits are ever shown again.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<img src="/images/cloud/credentials-add-credit-card.png" alt="Add Credit Card credential modal" />
|
||||
|
||||
<img src="/images/cloud/credentials-credit-card-detail.png" alt="Saved credit card credential showing masked card number" />
|
||||
|
||||
## Using credit cards in workflows
|
||||
|
||||
Credit cards work with [**Browser Task** and **Browser Action**](/cloud/building-workflows/configure-blocks) blocks that interact with checkout pages. The AI automatically recognizes standard checkout forms and fills card number, name, expiration, and CVV fields with the stored details. No field mapping is required.
|
||||
|
||||
For workflows that need different cards at runtime, add a **Credential parameter** (type: `credential_id`) in the [workflow editor](/cloud/building-workflows/add-parameters). When someone runs the workflow, they select which card to use from a dropdown. This lets the same checkout workflow work with different payment methods.
|
||||
|
||||
<Note>
|
||||
If you use 1Password as a credential provider, credit cards require a custom text field named **"Expire Date"**, **"Expiry Date"**, or **"Expiration Date"** in `MM/YYYY` or `MM/YY` format. 1Password does not expose the native expiration field through its API, so Skyvern reads this custom text field instead. See [External Providers](/cloud/managing-credentials/external-providers#1password) for full setup details.
|
||||
</Note>
|
||||
|
||||
## Editing and deleting
|
||||
|
||||
<Note>
|
||||
To edit a credential, click the **pencil icon** on its row. For security, saved card details are never retrieved, so you must re-enter all fields when updating.
|
||||
</Note>
|
||||
|
||||
Click the **trash icon** on any credential row to delete it. Deletion is permanent and cannot be undone.
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="Password Credentials"
|
||||
icon="key"
|
||||
href="/cloud/managing-credentials/password-credentials"
|
||||
>
|
||||
Store login details with optional 2FA
|
||||
</Card>
|
||||
<Card
|
||||
title="External Providers"
|
||||
icon="vault"
|
||||
href="/cloud/managing-credentials/external-providers"
|
||||
>
|
||||
Connect Bitwarden, 1Password, Azure Key Vault, or a custom API
|
||||
</Card>
|
||||
<Card
|
||||
title="Credentials Overview"
|
||||
icon="lock"
|
||||
href="/cloud/managing-credentials/credentials-overview"
|
||||
>
|
||||
Security model, quick start, and all credential types
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,392 @@
|
||||
---
|
||||
title: External Credential Providers
|
||||
subtitle: Connect Bitwarden, 1Password, Azure Key Vault, or your own vault API
|
||||
description: Connect external credential vaults like Bitwarden, 1Password, Azure Key Vault, or a custom webhook API to the Skyvern Cloud UI so workflows can pull secrets at runtime.
|
||||
slug: cloud/managing-credentials/external-providers
|
||||
keywords:
|
||||
- Bitwarden
|
||||
- 1Password
|
||||
- Azure Key Vault
|
||||
- custom webhook
|
||||
- vault API
|
||||
- external provider
|
||||
- runtime secrets
|
||||
---
|
||||
|
||||
Instead of copying secrets into Skyvern, you can point Skyvern at your existing vault and it pulls credentials at runtime. If your organization already manages secrets in a dedicated vault, connect it as a credential source and reference items directly from workflow parameters.
|
||||
|
||||
<Note>
|
||||
External providers are configured per-organization. Once connected, any workflow in the organization can reference credentials from that provider.
|
||||
</Note>
|
||||
|
||||
## Choosing a provider
|
||||
|
||||
| Source | Credential types | Setup | Best for |
|
||||
|--------|-----------------|-------|----------|
|
||||
| **Skyvern** (default) | Password, Credit Card, Secret | None (built in) | Most users, fastest setup |
|
||||
| **Bitwarden** | Password, Credit Card, Identity | Credential parameter config | Teams already using Bitwarden (enterprise) |
|
||||
| **1Password** | Password, Credit Card | Settings page setup | Teams with 1Password service accounts |
|
||||
| **Azure Key Vault** | Password (with optional TOTP) | Settings page setup | Enterprise Azure environments |
|
||||
| **Webhook (Custom API)** | Password, Credit Card | Settings page setup | Organizations with custom vaults |
|
||||
|
||||
You can mix sources within the same workflow. For example, one Login block can use Skyvern-stored credentials while another uses Azure Key Vault.
|
||||
|
||||
---
|
||||
|
||||
## Bitwarden
|
||||
|
||||
<Note>
|
||||
Bitwarden integration is available on the **enterprise plan**. Contact [sales@skyvern.com](mailto:sales@skyvern.com) for access.
|
||||
</Note>
|
||||
|
||||
Works with hosted Bitwarden and the self-hosted [Vaultwarden](https://github.com/dani-garcia/vaultwarden) fork. Supports passwords, credit cards, and identity data (SSN, address, phone numbers).
|
||||
|
||||
<Warning>
|
||||
Make sure your Bitwarden account is on `bitwarden.com`, not `bitwarden.eu`. The EU instance uses a different API that Skyvern does not currently support.
|
||||
</Warning>
|
||||
|
||||
### Cloud setup
|
||||
|
||||
<Steps>
|
||||
<Step title="Create a Bitwarden Organization">
|
||||
Log into Bitwarden, navigate to **Admin Console**, and ensure you have an organization created.
|
||||
</Step>
|
||||
<Step title="Create a collection to share with Skyvern">
|
||||
In your organization, click **New → Create a collection**. Name it something identifiable (e.g., "Skyvern Credentials"). Skip this step if you already have a collection ready.
|
||||
</Step>
|
||||
<Step title="Configure access with the Skyvern team">
|
||||
Go to the **Access** tab on your collection. This step requires coordination with the Skyvern enterprise team, who will configure access on their end. Contact [sales@skyvern.com](mailto:sales@skyvern.com) to get started.
|
||||
</Step>
|
||||
<Step title="Grab your Collection ID">
|
||||
Click into the collection and find the collection UUID in the URL bar.
|
||||
</Step>
|
||||
<Step title="Add to a workflow">
|
||||
In the Skyvern workflow editor, click **Parameters → Add Parameter → Credential Parameter** and select the **Bitwarden** tab. Enter your **Collection ID** and optionally an **Item ID** to target a specific vault item.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### Configuration options
|
||||
|
||||
| Field | Description |
|
||||
|-------|------------|
|
||||
| **Collection ID** | The UUID of your Bitwarden collection (found in the URL when viewing the collection) |
|
||||
| **Item ID** | Target a specific vault item. Leave blank to use URL matching instead. |
|
||||
| **URL Parameter Key** | Match credentials by the target URL. Useful when the same workflow runs against different sites. |
|
||||
|
||||
### Identity data
|
||||
|
||||
For identity fields (SSN, address, phone numbers), specify an **Identity Key** and a comma-separated list of **Identity Fields** (e.g., `ssn, address, phone`) in the Credential Parameter configuration panel.
|
||||
|
||||
<Accordion title="Self-hosted Bitwarden (Vaultwarden)">
|
||||
Skyvern integrates with self-hosted Bitwarden-compatible services like Vaultwarden using the Bitwarden CLI server as a bridge:
|
||||
|
||||
```text
|
||||
Skyvern → bw serve (CLI Server) → Vaultwarden
|
||||
```
|
||||
|
||||
**Environment variables:**
|
||||
|
||||
```bash
|
||||
# Skyvern Bitwarden Configuration
|
||||
SKYVERN_AUTH_BITWARDEN_ORGANIZATION_ID=your-org-id-here
|
||||
SKYVERN_AUTH_BITWARDEN_MASTER_PASSWORD=your-master-password-here
|
||||
SKYVERN_AUTH_BITWARDEN_CLIENT_ID=user.your-client-id-here
|
||||
SKYVERN_AUTH_BITWARDEN_CLIENT_SECRET=your-client-secret-here
|
||||
|
||||
# Vaultwarden Configuration
|
||||
BW_HOST=https://your-vaultwarden-server.com
|
||||
BW_CLIENTID=${SKYVERN_AUTH_BITWARDEN_CLIENT_ID}
|
||||
BW_CLIENTSECRET=${SKYVERN_AUTH_BITWARDEN_CLIENT_SECRET}
|
||||
BW_PASSWORD=${SKYVERN_AUTH_BITWARDEN_MASTER_PASSWORD}
|
||||
|
||||
# CLI Server Configuration
|
||||
BITWARDEN_SERVER=http://localhost
|
||||
BITWARDEN_SERVER_PORT=8002
|
||||
```
|
||||
|
||||
Start the CLI server with Docker Compose:
|
||||
|
||||
```bash
|
||||
docker-compose up -d bitwarden-cli
|
||||
```
|
||||
|
||||
Verify it's running:
|
||||
|
||||
```bash
|
||||
curl http://localhost:8002/status
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
---
|
||||
|
||||
## 1Password
|
||||
|
||||
Connects via a [service account token](https://developer.1password.com/docs/service-accounts/get-started/). A service account is an API-only identity that accesses vault items without a human login. Supports passwords and credit cards.
|
||||
|
||||
### One-time setup
|
||||
|
||||
<Steps>
|
||||
<Step title="Create a service account">
|
||||
In your 1Password admin console, go to **Developer > Service Accounts** and create a new service account. Grant it access to the vault that contains the credentials Skyvern needs.
|
||||
</Step>
|
||||
<Step title="Open Settings">
|
||||
In Skyvern, go to **Settings** and find the **1Password** card.
|
||||
</Step>
|
||||
<Step title="Enter your service account token">
|
||||
Paste the service account token from the previous step.
|
||||
</Step>
|
||||
<Step title="Save and verify">
|
||||
Click **Update**. The status indicator turns **Active** once the token is validated.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Tip>
|
||||
If the status does not turn Active, verify that your service account token has access to the target vault and has not expired.
|
||||
</Tip>
|
||||
|
||||
### Using in a workflow
|
||||
|
||||
In the workflow editor, add a **Credential Parameter** and select **1Password** as the source. Provide the **Vault ID** and **Item ID**. You can find both IDs in the URL when viewing an item in the 1Password web app.
|
||||
|
||||
<Warning>
|
||||
Credit cards from 1Password need a custom text field named **"Expire Date"**, **"Expiry Date"**, or **"Expiration Date"** in `MM/YYYY` or `MM/YY` format. 1Password does not expose the native expiration field through its API, so Skyvern reads this custom text field instead.
|
||||
</Warning>
|
||||
|
||||
---
|
||||
|
||||
## Azure Key Vault
|
||||
|
||||
Pulls credentials stored as Azure secrets. Supports passwords with optional TOTP.
|
||||
|
||||
### One-time setup
|
||||
|
||||
<Steps>
|
||||
<Step title="Open Settings">
|
||||
Go to **Settings** and find the **Azure** card.
|
||||
</Step>
|
||||
<Step title="Enter your Azure credentials">
|
||||
Provide your **Tenant ID**, **Client ID**, and **Client Secret**.
|
||||
</Step>
|
||||
<Step title="Save">
|
||||
Click **Update**. Skyvern will use these credentials to access your vault.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### Using in a workflow
|
||||
|
||||
In the workflow editor, add a **Credential Parameter** and select **Azure Key Vault** as the source. Provide the vault name and the **secret names** that store the username, password, and optionally a TOTP secret. Enter the secret names, not the values themselves.
|
||||
|
||||
For example, if your vault stores secrets named `salesforce-username`, `salesforce-password`, and `salesforce-totp`, enter those three names in the corresponding fields.
|
||||
|
||||
---
|
||||
|
||||
## Webhook (Custom API)
|
||||
|
||||
Connect your own HTTP API as a credential backend. Skyvern calls your API to create, retrieve, and delete credentials, so sensitive data stays in your infrastructure.
|
||||
|
||||
### API contract
|
||||
|
||||
Your service must implement three endpoints. All requests include an `Authorization: Bearer {API_TOKEN}` header.
|
||||
|
||||
**Create credential**
|
||||
```http
|
||||
POST {API_BASE_URL}
|
||||
Authorization: Bearer {API_TOKEN}
|
||||
Content-Type: application/json
|
||||
```
|
||||
|
||||
The request body depends on the credential type. Your API must handle all three:
|
||||
|
||||
<Accordion title="Password request body">
|
||||
```json
|
||||
{
|
||||
"name": "Salesforce Login",
|
||||
"type": "password",
|
||||
"username": "user@example.com",
|
||||
"password": "secure_password",
|
||||
"totp": "JBSWY3DPEHPK3PXP",
|
||||
"totp_type": "authenticator"
|
||||
}
|
||||
```
|
||||
The `totp` and `totp_type` fields are optional. `totp_type` can be `"authenticator"`, `"email"`, `"text_message"`, or `"none"`.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Credit card request body">
|
||||
```json
|
||||
{
|
||||
"name": "Corporate Visa",
|
||||
"type": "credit_card",
|
||||
"card_holder_name": "Jane Doe",
|
||||
"card_number": "4111111111111111",
|
||||
"card_exp_month": "12",
|
||||
"card_exp_year": "2025",
|
||||
"card_cvv": "123",
|
||||
"card_brand": "visa"
|
||||
}
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Secret request body">
|
||||
```json
|
||||
{
|
||||
"name": "Stripe API Key",
|
||||
"type": "secret",
|
||||
"secret_value": "sk_live_abc123",
|
||||
"secret_label": "api-key"
|
||||
}
|
||||
```
|
||||
The `secret_label` field is optional.
|
||||
</Accordion>
|
||||
|
||||
Response (all types):
|
||||
```json
|
||||
{
|
||||
"id": "cred_123456"
|
||||
}
|
||||
```
|
||||
|
||||
**Get credential**
|
||||
```http
|
||||
GET {API_BASE_URL}/{credential_id}
|
||||
Authorization: Bearer {API_TOKEN}
|
||||
```
|
||||
|
||||
Return the same fields that were sent during creation (minus `name`). Include `type` so Skyvern knows how to parse the response.
|
||||
|
||||
**Delete credential**
|
||||
```http
|
||||
DELETE {API_BASE_URL}/{credential_id}
|
||||
Authorization: Bearer {API_TOKEN}
|
||||
```
|
||||
|
||||
Response: HTTP 200
|
||||
|
||||
### Setup
|
||||
|
||||
<Steps>
|
||||
<Step title="Open Settings">
|
||||
Go to **Settings** and find the **Custom Credential Service** card.
|
||||
</Step>
|
||||
<Step title="Enter your API details">
|
||||
Provide the **API Base URL** and **API Token** for your credential service.
|
||||
</Step>
|
||||
<Step title="Save">
|
||||
Click **Update Configuration**. The status indicator turns **Active** once the configuration is saved.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Accordion title="Example: minimal FastAPI implementation">
|
||||
```python
|
||||
from fastapi import FastAPI, HTTPException, Depends, Header
|
||||
from pydantic import BaseModel
|
||||
from typing import Optional
|
||||
import uuid
|
||||
|
||||
app = FastAPI()
|
||||
credentials_store = {}
|
||||
|
||||
class CreateCredentialRequest(BaseModel):
|
||||
name: str
|
||||
type: str # "password", "credit_card", or "secret"
|
||||
# Password fields
|
||||
username: Optional[str] = None
|
||||
password: Optional[str] = None
|
||||
totp: Optional[str] = None
|
||||
totp_type: Optional[str] = None
|
||||
# Credit card fields
|
||||
card_holder_name: Optional[str] = None
|
||||
card_number: Optional[str] = None
|
||||
card_exp_month: Optional[str] = None
|
||||
card_exp_year: Optional[str] = None
|
||||
card_cvv: Optional[str] = None
|
||||
card_brand: Optional[str] = None
|
||||
# Secret fields
|
||||
secret_value: Optional[str] = None
|
||||
secret_label: Optional[str] = None
|
||||
|
||||
class CredentialResponse(BaseModel):
|
||||
id: str
|
||||
|
||||
def verify_token(authorization: str = Header(...)):
|
||||
if not authorization.startswith("Bearer "):
|
||||
raise HTTPException(401, "Invalid authorization header")
|
||||
token = authorization.split("Bearer ")[1]
|
||||
if token != "your_expected_api_token":
|
||||
raise HTTPException(401, "Invalid API token")
|
||||
|
||||
@app.post("/api/v1/credentials", response_model=CredentialResponse)
|
||||
async def create_credential(
|
||||
request: CreateCredentialRequest,
|
||||
_: None = Depends(verify_token)
|
||||
):
|
||||
credential_id = f"cred_{uuid.uuid4().hex[:12]}"
|
||||
credentials_store[credential_id] = request.model_dump()
|
||||
return CredentialResponse(id=credential_id)
|
||||
|
||||
@app.get("/api/v1/credentials/{credential_id}")
|
||||
async def get_credential(
|
||||
credential_id: str,
|
||||
_: None = Depends(verify_token)
|
||||
):
|
||||
if credential_id not in credentials_store:
|
||||
raise HTTPException(404, "Credential not found")
|
||||
return credentials_store[credential_id]
|
||||
|
||||
@app.delete("/api/v1/credentials/{credential_id}")
|
||||
async def delete_credential(
|
||||
credential_id: str,
|
||||
_: None = Depends(verify_token)
|
||||
):
|
||||
if credential_id not in credentials_store:
|
||||
raise HTTPException(404, "Credential not found")
|
||||
del credentials_store[credential_id]
|
||||
return {"status": "deleted"}
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Self-hosted configuration (environment variables)">
|
||||
For self-hosted Skyvern deployments, set these environment variables instead of using the Settings UI:
|
||||
|
||||
```bash
|
||||
CREDENTIAL_VAULT_TYPE=custom
|
||||
CUSTOM_CREDENTIAL_API_BASE_URL=https://credentials.company.com/api/v1/credentials
|
||||
CUSTOM_CREDENTIAL_API_TOKEN=your_api_token_here
|
||||
```
|
||||
|
||||
Restart Skyvern after setting these variables.
|
||||
</Accordion>
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
| Problem | What to check |
|
||||
|---------|--------------|
|
||||
| Status stays Inactive | Verify the API base URL is a valid URL and the API token is not empty. The configuration is validated on save but does not make a live request to your server. |
|
||||
| Credentials not created | Review your API logs for auth errors. Ensure the response includes an `id` field. Skyvern expects HTTP 200 for all operations. |
|
||||
| Credentials not retrieved | Ensure the GET response includes all required fields for the credential type (`username` and `password` for passwords, all card fields for credit cards, `secret_value` for secrets). |
|
||||
| Env config not working | Restart Skyvern after setting variables. Verify `CREDENTIAL_VAULT_TYPE=custom` is set and both URL and token are provided. The default vault type is `bitwarden`, so this variable must be explicitly set. |
|
||||
|
||||
---
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="Credentials Overview"
|
||||
icon="lock"
|
||||
href="/cloud/managing-credentials/credentials-overview"
|
||||
>
|
||||
Built-in credential storage, security model, and quick start
|
||||
</Card>
|
||||
<Card
|
||||
title="Password Credentials"
|
||||
icon="key"
|
||||
href="/cloud/managing-credentials/password-credentials"
|
||||
>
|
||||
Store login details with optional 2FA
|
||||
</Card>
|
||||
<Card
|
||||
title="Workflow Parameters"
|
||||
icon="sliders"
|
||||
href="/cloud/building-workflows/add-parameters"
|
||||
>
|
||||
Configure credential parameters in the workflow editor
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
title: Password Credentials
|
||||
subtitle: Store login details and use them in automated sign-in flows
|
||||
description: Create and manage password credentials in the Skyvern Cloud UI with optional two-factor authentication via TOTP, email, or SMS for automated login workflows.
|
||||
slug: cloud/managing-credentials/password-credentials
|
||||
keywords:
|
||||
- username
|
||||
- password
|
||||
- login
|
||||
- TOTP
|
||||
- 2FA
|
||||
- automated sign-in
|
||||
---
|
||||
|
||||
Password credentials store a username, password, and optional 2FA configuration. Reference them from [Login blocks](/cloud/building-workflows/configure-blocks) in your workflows, and Skyvern handles the entire sign-in flow, including entering 2FA codes.
|
||||
|
||||
## Creating a password credential
|
||||
|
||||
<Steps>
|
||||
<Step title="Open the Add dialog">
|
||||
Click **+ Add → Password** from the Credentials page.
|
||||
</Step>
|
||||
<Step title="Fill in your login details">
|
||||
Enter a **Name** (a label like "Salesforce Production"), **Username or Email**, and **Password**. The password field has an eye icon to toggle visibility.
|
||||
</Step>
|
||||
<Step title="Configure 2FA (optional)">
|
||||
Expand the **Two-Factor Authentication** accordion to set up automated 2FA handling. See [below](#adding-two-factor-authentication) for details.
|
||||
</Step>
|
||||
<Step title="Save">
|
||||
Click **Save**. The credential is immediately available for use in workflows.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<img src="/images/cloud/credentials-add-password.png" alt="Add password credential modal" />
|
||||
|
||||
## Adding two-factor authentication
|
||||
|
||||
If the site requires 2FA, expand the **Two-Factor Authentication** accordion below the password fields. Three options, depending on how the site delivers codes:
|
||||
|
||||
<img src="/images/cloud/credentials-2fa-setup.png" alt="2FA setup options showing Authenticator App, Email, and Text Message" />
|
||||
|
||||
| Method | How it works |
|
||||
|--------|-------------|
|
||||
| **Authenticator App** | Paste the TOTP secret key and Skyvern generates codes locally on demand. Fully automated with no delay. Preferred when the site supports it. |
|
||||
| **Email** | Provide the email address that receives codes. Skyvern waits for you to push the code via the [2FA tab](/cloud/managing-credentials/totp-setup) or API. Identifier auto-fills from the Username field. |
|
||||
| **Text Message** | Provide the phone number that receives codes. Same push-based flow as Email. |
|
||||
|
||||
<Tip>
|
||||
Authenticator App is always the best option when available. Email and Text require either manual code entry or setting up automatic forwarding.
|
||||
</Tip>
|
||||
|
||||
<Accordion title="Finding your TOTP secret key">
|
||||
The secret key is the base32-encoded string behind the QR code you'd scan in an authenticator app. Most password managers let you view it:
|
||||
|
||||
- **Bitwarden**: Edit the login → TOTP field → copy the key
|
||||
- **1Password**: Edit the login → One-Time Password → copy the secret
|
||||
- **LastPass**: Edit the login → Advanced Settings → copy the TOTP secret
|
||||
- **Site settings**: Many sites show a "Can't scan?" link during 2FA setup that reveals the text key
|
||||
|
||||
If you only have a QR code, decode it to extract the `secret=` parameter from the `otpauth://totp/...?secret=BASE32KEY` URI.
|
||||
</Accordion>
|
||||
|
||||
## Using credentials in a workflow
|
||||
|
||||
In the Login block configuration, select a stored credential from the dropdown. Skyvern fills in the username and password automatically, and handles 2FA if configured.
|
||||
|
||||
## Managing credentials
|
||||
|
||||
Stored credentials show the name, credential ID, username (plain text), password (always masked), and 2FA method if configured.
|
||||
|
||||
<Note>
|
||||
To edit a credential, click the **pencil icon** on its row. For security, saved passwords and secrets are never retrieved, so you must re-enter all sensitive fields when updating.
|
||||
</Note>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="2FA / TOTP Setup"
|
||||
icon="shield-halved"
|
||||
href="/cloud/managing-credentials/totp-setup"
|
||||
>
|
||||
Push verification codes and manage 2FA for Email and Text methods
|
||||
</Card>
|
||||
<Card
|
||||
title="Block Reference"
|
||||
icon="cube"
|
||||
href="/cloud/building-workflows/configure-blocks"
|
||||
>
|
||||
Configure Login blocks and other blocks that use credentials
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,266 @@
|
||||
---
|
||||
title: 2FA / TOTP Setup
|
||||
subtitle: Configure two-factor authentication for automated logins
|
||||
description: Configure TOTP authenticator app, email, or SMS two-factor authentication for automated logins in the Skyvern Cloud UI, including secret key setup and manual code delivery.
|
||||
slug: cloud/managing-credentials/totp-setup
|
||||
keywords:
|
||||
- TOTP
|
||||
- 2FA
|
||||
- authenticator app
|
||||
- secret key
|
||||
- email code
|
||||
- SMS code
|
||||
- verification
|
||||
---
|
||||
|
||||
Skyvern supports three 2FA methods for automated logins. **Authenticator App (TOTP)** is fully automatic: Skyvern generates codes locally. **Email** and **Text Message** require you to push codes via the UI or API. All three are configured on the [password credential](/cloud/managing-credentials/password-credentials) itself.
|
||||
|
||||
## Authenticator App (TOTP)
|
||||
|
||||
The preferred method. Skyvern generates valid 6-digit codes on demand during login flows with no delay and no manual steps.
|
||||
|
||||
### How it works
|
||||
|
||||
1. The Login block enters the username and password
|
||||
2. The site prompts for a 2FA code
|
||||
3. Skyvern generates a fresh TOTP code from the stored secret key
|
||||
4. The code is entered automatically and login completes
|
||||
|
||||
### Setting it up
|
||||
|
||||
<Steps>
|
||||
<Step title="Create a password credential">
|
||||
Go to the Credentials page and create a new password credential.
|
||||
<img src="/images/cloud/totp-setup-1.png" alt="Credentials page showing password credentials with the Add button highlighted" />
|
||||
</Step>
|
||||
<Step title="Expand Two-Factor Authentication">
|
||||
Below the password fields, click the **Two-Factor Authentication** accordion.
|
||||
</Step>
|
||||
<Step title="Select Authenticator App">
|
||||
Choose **Authenticator App** from the three options.
|
||||
</Step>
|
||||
<Step title="Paste your TOTP secret key">
|
||||
Enter the secret key into the **Authenticator Key** field and click **Save**.
|
||||
<img src="/images/cloud/totp-setup-2.png" alt="Add Credential dialog with Authenticator App selected and the Authenticator Key field" />
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Accordion title="Finding your TOTP secret key">
|
||||
The secret key is the base32-encoded string behind the QR code you'd normally scan in an authenticator app. You can find it in a few places:
|
||||
|
||||
- **Bitwarden**: Edit the login → TOTP field → copy the key
|
||||
- **1Password**: Edit the login → One-Time Password → copy the secret
|
||||
- **LastPass**: Edit the login → Advanced Settings → copy the TOTP secret
|
||||
- **Site settings**: Many sites show a "Can't scan?" link during 2FA setup that reveals the text key
|
||||
|
||||
If you only have a QR code, decode it to extract the `secret=` parameter from the `otpauth://totp/...?secret=BASE32KEY` URI.
|
||||
</Accordion>
|
||||
|
||||
---
|
||||
|
||||
## Email and Text Message codes
|
||||
|
||||
When a site sends 2FA codes via email or SMS, someone (or something) needs to deliver the code to Skyvern before the login can complete.
|
||||
|
||||
### How it works
|
||||
|
||||
1. The Login block enters the username and password
|
||||
2. The site sends a 2FA code to the configured email or phone number
|
||||
3. You push the code to Skyvern via the **2FA tab** or the API
|
||||
4. Skyvern enters the code and completes the login
|
||||
|
||||
### Setting it up
|
||||
|
||||
<Steps>
|
||||
<Step title="Create a password credential">
|
||||
Go to the Credentials page and create a new password credential.
|
||||
<img src="/images/cloud/totp-setup-1.png" alt="Credentials page showing password credentials with the Add button highlighted" />
|
||||
</Step>
|
||||
<Step title="Expand Two-Factor Authentication">
|
||||
Below the password fields, click the **Two-Factor Authentication** accordion.
|
||||
</Step>
|
||||
<Step title="Select Email or Text Message">
|
||||
Choose the method that matches how the site delivers codes.
|
||||
</Step>
|
||||
<Step title="Enter the identifier">
|
||||
Provide the **email address** or **phone number** that receives the codes. For Email, this auto-fills from the Username field.
|
||||
<img src="/images/cloud/totp-setup-3.png" alt="Add Credential dialog with Email selected and the TOTP Identifier field" />
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
---
|
||||
|
||||
## Pushing codes to Skyvern
|
||||
|
||||
Once a workflow is running and waiting for a 2FA code, you need to deliver it. There are two ways.
|
||||
|
||||
### Via the UI
|
||||
|
||||
Open the **2FA** tab on the Credentials page. The **Push a 2FA Code** form has two fields:
|
||||
|
||||
| Field | What to enter |
|
||||
|-------|--------------|
|
||||
| **Identifier** | The email address or phone number that received the code |
|
||||
| **Verification content** | The full email/SMS body, or just the code itself. Skyvern extracts the digits automatically. |
|
||||
|
||||
<img src="/images/cloud/credentials-2fa-push-form.png" alt="2FA tab showing the Push a 2FA Code form and code history table" />
|
||||
|
||||
<Tip>
|
||||
If multiple workflows are running simultaneously, click **Add optional metadata** to link the code to a specific run using the workflow run ID, workflow ID, or task ID.
|
||||
</Tip>
|
||||
|
||||
### Via the API
|
||||
|
||||
For production, automate code delivery. Set up a forwarding rule that sends 2FA emails or texts to a script, and the script pushes the code to Skyvern:
|
||||
|
||||
<CodeGroup>
|
||||
```bash cURL
|
||||
curl -X POST "https://api.skyvern.com/v1/credentials/totp" \
|
||||
-H "x-api-key: YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"totp_identifier": "user@example.com",
|
||||
"content": "Your verification code is 847291",
|
||||
"source": "email_forwarder"
|
||||
}'
|
||||
```
|
||||
|
||||
```python Python
|
||||
from skyvern import Skyvern
|
||||
|
||||
skyvern = Skyvern(api_key="YOUR_API_KEY")
|
||||
await skyvern.send_totp_code(
|
||||
totp_identifier="user@example.com",
|
||||
content="Your verification code is 847291",
|
||||
source="email_forwarder",
|
||||
)
|
||||
```
|
||||
|
||||
```typescript TypeScript
|
||||
import { SkyvernClient } from "@skyvern/client";
|
||||
|
||||
const skyvern = new SkyvernClient({ apiKey: "YOUR_API_KEY" });
|
||||
await skyvern.sendTotpCode({
|
||||
totp_identifier: "user@example.com",
|
||||
content: "Your verification code is 847291",
|
||||
source: "email_forwarder",
|
||||
});
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
**Response:**
|
||||
```json
|
||||
{
|
||||
"totp_code_id": "tc_abc123",
|
||||
"totp_identifier": "user@example.com",
|
||||
"code": "847291",
|
||||
"source": "email_forwarder",
|
||||
"created_at": "2025-01-15T10:30:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
The `source` field is a free-text label for your own tracking (e.g., `"email_forwarder"`, `"twilio_webhook"`).
|
||||
|
||||
To link a code to a specific run, pass `workflow_run_id`, `workflow_id`, or `task_id`. This is the API equivalent of the **Add optional metadata** option in the UI.
|
||||
|
||||
<Tip>
|
||||
This turns email-based 2FA into something nearly as automated as an authenticator app. The main difference is latency while the email arrives and gets forwarded.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## Server-fetched codes (totp_url)
|
||||
|
||||
Instead of pushing codes to Skyvern, you can have Skyvern pull them from your server. Pass `totp_url` when running a [task](/cloud/getting-started/run-from-code) or [workflow](/cloud/building-workflows/build-a-workflow), and Skyvern will call your endpoint when it needs a verification code.
|
||||
|
||||
Your endpoint must accept a POST request with `task_id`, `workflow_run_id`, and `workflow_permanent_id` in the body, and return:
|
||||
|
||||
```json
|
||||
{
|
||||
"verification_code": "123456"
|
||||
}
|
||||
```
|
||||
|
||||
Validate the `x-skyvern-signature` header to confirm the request came from Skyvern:
|
||||
|
||||
```python
|
||||
import hashlib, hmac
|
||||
|
||||
def validate_skyvern_request(request) -> bool:
|
||||
signature = request.headers["x-skyvern-signature"]
|
||||
payload = request.body() # bytes
|
||||
expected = hmac.new(
|
||||
SKYVERN_API_KEY.encode("utf-8"),
|
||||
msg=payload,
|
||||
digestmod=hashlib.sha256,
|
||||
).hexdigest()
|
||||
return signature == expected
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Magic links (one-time login links)
|
||||
|
||||
Some sites use one-time login links instead of numeric codes. Skyvern supports these by splitting the flow into two steps:
|
||||
|
||||
1. **Trigger the magic link**: Run a task that initiates the login. The site emails a one-time link.
|
||||
2. **Use the link**: Monitor the inbox (e.g., via Zapier), extract the URL, then start a new task with that URL as the starting point.
|
||||
|
||||
```python
|
||||
# Step 1: Trigger the magic link email
|
||||
await client.run_task(
|
||||
prompt="Click 'Sign in with email link' and enter user@example.com",
|
||||
url="https://app.example.com/login",
|
||||
wait_for_completion=True,
|
||||
)
|
||||
|
||||
# Step 2: Your email monitor extracts the magic link URL, then:
|
||||
await client.run_task(
|
||||
prompt="Complete the onboarding form after login",
|
||||
url=magic_link_url, # The one-time URL from the email
|
||||
wait_for_completion=True,
|
||||
)
|
||||
```
|
||||
|
||||
The magic link URL becomes the `url` parameter for the second task. Skyvern opens it directly, which logs the user in, and then continues with the rest of the automation.
|
||||
|
||||
---
|
||||
|
||||
## Viewing past codes
|
||||
|
||||
The table below the push form shows all 2FA codes your organization has received: identifier, extracted code, source type, associated workflow run, and timestamps. Filter by identifier, OTP type (numeric code vs. magic link), and number of results per page.
|
||||
|
||||
Use this for auditing and debugging: confirming that a code was received and delivered to the right run.
|
||||
|
||||
### Listing codes via API
|
||||
|
||||
```bash
|
||||
curl -X GET "https://api.skyvern.com/v1/credentials/totp?totp_identifier=user@example.com&limit=10" \
|
||||
-H "x-api-key: $SKYVERN_API_KEY"
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
|-----------|-------------|
|
||||
| `totp_identifier` | Filter by identifier (email, phone, etc.) |
|
||||
| `workflow_run_id` | Restrict to a specific workflow run |
|
||||
| `otp_type` | Filter by `totp` or `magic_link` |
|
||||
| `limit` | Number of records (default 50, max 200) |
|
||||
|
||||
Returns a list ordered newest first. Only codes created within the last 10 minutes (configurable via `TOTP_LIFESPAN_MINUTES`) are returned.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Password Credentials"
|
||||
icon="key"
|
||||
href="/cloud/managing-credentials/password-credentials"
|
||||
>
|
||||
Create credentials with 2FA methods attached
|
||||
</Card>
|
||||
<Card
|
||||
title="Credentials Overview"
|
||||
icon="lock"
|
||||
href="/cloud/managing-credentials/credentials-overview"
|
||||
>
|
||||
Security model, quick start, and all credential types
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,104 @@
|
||||
---
|
||||
title: Downloading Artifacts
|
||||
subtitle: Access recordings, screenshots, and output files from your runs
|
||||
description: Download recordings, screenshots, extracted data, and generated code from completed runs in the Skyvern Cloud UI or programmatically via the API.
|
||||
slug: cloud/viewing-results/downloading-artifacts
|
||||
keywords:
|
||||
- download
|
||||
- recording
|
||||
- screenshot
|
||||
- HAR file
|
||||
- Playwright trace
|
||||
- generated code
|
||||
- extracted data
|
||||
---
|
||||
|
||||
Every run generates artifacts: video recordings, screenshots at each decision point, extracted data as JSON, and any downloaded files. Most are visible in the [Run Details](/cloud/viewing-results/run-details) page, but you can also save them locally or pull them into another system.
|
||||
|
||||
## From the UI
|
||||
|
||||
| Artifact | How to download |
|
||||
|----------|----------------|
|
||||
| **Recordings** | Recording tab → right-click the video → **Save video as...** |
|
||||
| **Screenshots** | Overview tab → click a timeline item → right-click the image → **Save image as...** |
|
||||
| **Extracted data** | Output tab → select the JSON text and copy |
|
||||
| **Downloaded files** | Output tab → **Workflow Run Downloaded Files** → click any link |
|
||||
| **Generated code** | Code tab → **Copy** button in the top right |
|
||||
|
||||
## From the API
|
||||
|
||||
Use the API when you need artifacts programmatically: for a pipeline, an archive, or integration with another tool.
|
||||
|
||||
### List artifacts for a run
|
||||
|
||||
```bash
|
||||
curl -X GET "https://api.skyvern.com/v1/runs/{run_id}/artifacts" \
|
||||
-H "x-api-key: YOUR_API_KEY"
|
||||
```
|
||||
|
||||
Filter by type using the `artifact_type` parameter (repeatable):
|
||||
|
||||
```bash
|
||||
curl -X GET "https://api.skyvern.com/v1/runs/{run_id}/artifacts?artifact_type=screenshot_llm&artifact_type=recording" \
|
||||
-H "x-api-key: YOUR_API_KEY"
|
||||
```
|
||||
|
||||
### Download an artifact
|
||||
|
||||
Each artifact in the response includes a `signed_url`, a temporary, pre-authenticated download link:
|
||||
|
||||
```json
|
||||
{
|
||||
"artifact_id": "art_abc123",
|
||||
"artifact_type": "screenshot_llm",
|
||||
"signed_url": "https://storage.example.com/screenshot.png?token=...",
|
||||
"created_at": "2025-01-15T10:30:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
```bash
|
||||
curl -o screenshot.png "SIGNED_URL_HERE"
|
||||
```
|
||||
|
||||
<Warning>
|
||||
Signed URLs expire after a short period. Always generate a fresh URL via the API rather than storing old ones.
|
||||
</Warning>
|
||||
|
||||
### Artifact types
|
||||
|
||||
| Value | What it is |
|
||||
|-------|-----------|
|
||||
| `recording` | Full browser session video |
|
||||
| `screenshot_llm` | Screenshots with numbered element annotations (what the AI analyzed) |
|
||||
| `screenshot_action` | Screenshots taken after each browser action |
|
||||
| `screenshot_final` | Final page state when the run ended |
|
||||
| `llm_prompt` | Complete prompt sent to the LLM (goal, element tree, system instructions) |
|
||||
| `llm_request` | Raw API request payload sent to the model provider |
|
||||
| `llm_response` | Raw model response |
|
||||
| `llm_response_parsed` | Parsed action list (what the AI decided to do) |
|
||||
| `visible_elements_tree` | DOM tree of interactive elements the AI could see (JSON) |
|
||||
| `html_scrape` | Full page HTML at the time of the step |
|
||||
| `skyvern_log` | Formatted execution logs |
|
||||
| `har` | HTTP Archive file (every network request the browser made) |
|
||||
| `trace` | Browser trace file for performance analysis |
|
||||
|
||||
<Tip>
|
||||
The annotated screenshots (`screenshot_llm`) and parsed action lists (`llm_response_parsed`) are the most useful for debugging. Annotated screenshots show which elements the AI identified, and the action list shows what it decided to do with them.
|
||||
</Tip>
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Run Details"
|
||||
icon="magnifying-glass"
|
||||
href="/cloud/viewing-results/run-details"
|
||||
>
|
||||
Understand what each tab shows and how to debug failures
|
||||
</Card>
|
||||
<Card
|
||||
title="Using Artifacts (API)"
|
||||
icon="code"
|
||||
href="/developers/debugging/using-artifacts"
|
||||
>
|
||||
Full API reference for artifact retrieval
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,127 @@
|
||||
---
|
||||
title: Run Details
|
||||
subtitle: Inspect actions, outputs, recordings, and parameters for any run
|
||||
description: Inspect the details of any task or workflow run in the Skyvern Cloud UI, including AI reasoning timelines, extracted data, recordings, screenshots, and parameters.
|
||||
slug: cloud/viewing-results/run-details
|
||||
keywords:
|
||||
- step timeline
|
||||
- AI reasoning
|
||||
- extracted data
|
||||
- recording
|
||||
- screenshot
|
||||
- parameters
|
||||
- action log
|
||||
---
|
||||
|
||||
Every run has a detail page showing what the AI saw, what it decided, what it extracted, and whether anything went wrong. Click any run in [Run History](/cloud/viewing-results/run-history) to get here.
|
||||
|
||||
<img src="/images/cloud/task-run-details.png" alt="Run details page showing a completed workflow run" />
|
||||
|
||||
## The header
|
||||
|
||||
The top of the page shows the workflow title, a color-coded status badge, and the run ID. Three buttons on the right:
|
||||
|
||||
- **API & Webhooks**: the exact API request that would reproduce this run, including endpoint, headers, and payload
|
||||
- **Edit**: jump to the workflow editor
|
||||
- **Rerun**: start a new run pre-filled with the same parameters (appears after the run finishes)
|
||||
|
||||
While a run is in progress, a **Cancel** button appears instead of Rerun.
|
||||
|
||||
<img src="/images/cloud/workflow-run-timeline.png" alt="A running workflow with live browser view and timeline" />
|
||||
|
||||
## Extracted information
|
||||
|
||||
On success, the **Extracted Information** section appears above the tabs, showing the structured data you asked for, displayed as JSON.
|
||||
|
||||
<img src="/images/cloud/task-run-results.png" alt="Workflow Run Outputs showing extracted JSON data" />
|
||||
|
||||
The output includes a `summary` (natural language description of what was accomplished), `extracted_information` (structured data matching your schema), and a `failure_reason` field that's `null` on success. On failure, a **Failure Reason** section appears instead with error details in a red box.
|
||||
|
||||
## The five tabs
|
||||
|
||||
### Overview
|
||||
|
||||
The left panel shows the browser state (live stream while running, screenshots after completion). The right panel shows the AI's reasoning timeline.
|
||||
|
||||
<img src="/images/cloud/task-run-actions-tab.png" alt="Overview tab showing browser screenshot and AI reasoning timeline" />
|
||||
|
||||
The timeline is a chronological feed of three card types:
|
||||
|
||||
| Card | What it shows |
|
||||
|------|--------------|
|
||||
| **Thought** | The AI's internal reasoning: what it sees, what it plans to do, and why. Tagged with "Decision." |
|
||||
| **Block** | When a workflow block starts or finishes (e.g., "Extraction"). Green checkmark = success. |
|
||||
| **Action** | Individual browser operations (e.g., "#1 Extract Data") with a description of what was done. |
|
||||
|
||||
Click any timeline item to see its corresponding screenshot in the left panel. The **Actions** and **Steps** counters at the top give you a quick sense of how much work the run involved.
|
||||
|
||||
<Tip>
|
||||
When a run produces wrong results, start with the Thought cards. Read the AI's reasoning to find where it went off track, such as a misidentified element, or a premature "goal met" conclusion.
|
||||
</Tip>
|
||||
|
||||
### Output
|
||||
|
||||
All output data in one place. **Workflow Run Outputs** shows the complete JSON with line numbers and syntax highlighting. **Workflow Run Downloaded Files** lists any files the workflow downloaded; click to download directly.
|
||||
|
||||
### Parameters
|
||||
|
||||
The configuration that produced this run: workflow input parameters (key-value pairs), webhook URL, proxy location, and HTTP headers. Use this to verify a run received the right inputs or to recreate a past result.
|
||||
|
||||
When you select a block in the Overview timeline, this tab also shows that block's configuration: prompt, URL, schema, and other settings.
|
||||
|
||||
### Recording
|
||||
|
||||
Full video replay of the browser session. Every run is recorded automatically. Scrub through to see exactly what appeared on screen at any point.
|
||||
|
||||
<Note>
|
||||
If the run was canceled before the browser started, you'll see a "No recording available" message.
|
||||
</Note>
|
||||
|
||||
### Code
|
||||
|
||||
Python code generated from the run. This tab appears when code generation is enabled (the default engine). Copy the code to run outside Skyvern, or click **Copy & Explain** for an AI-generated explanation.
|
||||
|
||||
<img src="/images/cloud/workflow-run-code-tab.png" alt="Code tab showing generated Python code with syntax highlighting" />
|
||||
|
||||
If the workflow uses cached code, a **Cache Key selector** lets you switch between versions.
|
||||
|
||||
## Debugging failed runs
|
||||
|
||||
Work through these in order:
|
||||
|
||||
1. **Read the Failure Reason** at the top. It usually tells you what happened: timeout, navigation error, or missing element.
|
||||
2. **Walk the Thought cards** in the Overview timeline. Find the point where the AI made an incorrect assumption about page state.
|
||||
3. **Check the Parameters tab** to confirm inputs were correct. A wrong URL or missing parameter is a common cause.
|
||||
4. **Watch the Recording** to see what actually happened. Popups, CAPTCHAs, and unexpected page layouts are often obvious on video.
|
||||
|
||||
## Run statuses
|
||||
|
||||
| Status | Meaning |
|
||||
|--------|---------|
|
||||
| `created` | Initialized, waiting to be queued |
|
||||
| `queued` | Waiting for an available browser slot |
|
||||
| `running` | Actively executing; browser stream is live |
|
||||
| `completed` | Finished successfully |
|
||||
| `failed` | Stopped due to an error |
|
||||
| `terminated` | Stopped by the system (e.g., resource limits) |
|
||||
| `canceled` | Stopped by you via the Cancel button |
|
||||
| `timed_out` | Exceeded the configured time limit |
|
||||
|
||||
While a run is in progress, the status badge updates automatically, the Overview tab shows a live browser stream, and the timeline grows as new items complete.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Downloading Artifacts"
|
||||
icon="download"
|
||||
href="/cloud/viewing-results/downloading-artifacts"
|
||||
>
|
||||
Access recordings, screenshots, and output files
|
||||
</Card>
|
||||
<Card
|
||||
title="Watching Live Execution"
|
||||
icon="eye"
|
||||
href="/cloud/getting-started/monitor-a-run"
|
||||
>
|
||||
Monitor and take control of running tasks
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
title: Run History
|
||||
subtitle: Find, filter, and inspect past task and workflow executions
|
||||
description: Search, filter, and inspect past task and workflow runs in the Skyvern Cloud UI Runs page, including filtering by status, trigger type, and run parameters.
|
||||
slug: cloud/viewing-results/run-history
|
||||
keywords:
|
||||
- filter
|
||||
- search
|
||||
- status
|
||||
- trigger type
|
||||
- pagination
|
||||
- past runs
|
||||
---
|
||||
|
||||
The **Runs** page shows every task and workflow execution, sorted newest-first. Use it to check on past runs, find failures, or verify that a scheduled workflow completed.
|
||||
|
||||
<img src="/images/cloud/run-history-overview.png" alt="Run History page overview" />
|
||||
|
||||
## Finding a specific run
|
||||
|
||||
**Search** narrows the list by run ID or workflow parameter value. Type part of an ID (e.g., `wr_49338`) or a parameter you passed (like a URL), and matching results appear as you type.
|
||||
|
||||
<img src="/images/cloud/run-history-search.png" alt="Searching for a run by ID" />
|
||||
|
||||
**Filter by Status** opens a multi-select dropdown. Check one or more statuses to narrow results; `failed` and `timed_out` together show everything that went wrong. Filters and search can be combined: search for a parameter value while filtering to only failed runs.
|
||||
|
||||
Available statuses: **Created**, **Queued**, **Running**, **Completed**, **Failed**, **Terminated**, **Canceled**, **Timed Out**.
|
||||
|
||||
## Reading the table
|
||||
|
||||
Each row is one run. The columns:
|
||||
|
||||
| Column | What it shows |
|
||||
|--------|--------------|
|
||||
| **Run ID** | Workflow run (`wr_...`) or task (`tsk_...`) identifier. Hover for the full ID. |
|
||||
| **Detail** | Workflow title or task description. A lightning bolt icon means code generation was used. |
|
||||
| **Status** | Color-coded badge: green (completed), yellow (running/queued/created), red (failed/timed_out), orange (terminated/canceled). |
|
||||
| **Trigger** | How the run was started: **Manual**, **API**, or **Scheduled** (calendar icon). |
|
||||
| **Created At** | Start time in your local timezone. Hover for UTC. |
|
||||
|
||||
Workflow runs have a **settings icon** in the last column. Click it to expand the row and see the parameters passed to that run. If your search matches something inside the parameters, the row auto-expands so you can see the match in context.
|
||||
|
||||
## Trigger type
|
||||
|
||||
Every run has a trigger type that indicates how it was started:
|
||||
|
||||
| Trigger type | Description |
|
||||
|-------------|-------------|
|
||||
| **Manual** | Started by clicking **Run** in the Cloud UI |
|
||||
| **API** | Started via the REST API or SDK |
|
||||
| **Scheduled** | Started automatically by a [schedule](/cloud/building-workflows/scheduling) |
|
||||
|
||||
Scheduled runs display a **calendar icon badge** next to the run ID. Click the run to see the schedule name and cron expression in the run details.
|
||||
|
||||
### Filtering by trigger type
|
||||
|
||||
Use the **Trigger Type** dropdown filter to show only runs of a specific type. For example, select **Scheduled** to see all runs triggered by cron schedules. This filter can be combined with the status filter and search.
|
||||
|
||||
---
|
||||
|
||||
## Opening a run
|
||||
|
||||
Click any row to jump to its [detail page](/cloud/viewing-results/run-details). Hold **Ctrl** (or **Cmd** on Mac) to open in a new tab.
|
||||
|
||||
Pagination controls at the bottom let you adjust the page size (5, 10, 20, or 50 items) and navigate between pages. Settings are stored in the URL, so you can bookmark a filtered view or share it with a teammate.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Run Details"
|
||||
icon="magnifying-glass"
|
||||
href="/cloud/viewing-results/run-details"
|
||||
>
|
||||
Inspect actions, outputs, recordings, and parameters for any run
|
||||
</Card>
|
||||
<Card
|
||||
title="Downloading Artifacts"
|
||||
icon="download"
|
||||
href="/cloud/viewing-results/downloading-artifacts"
|
||||
>
|
||||
Save recordings, screenshots, and output files
|
||||
</Card>
|
||||
</CardGroup>
|
||||
Reference in New Issue
Block a user