vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

cloud ui docs + cookbooks (#4759)

Browse Source 
Co-authored-by: Ritik Sahni <ritiksahni0203@gmail.com>
Co-authored-by: Kunal Mishra <kunalm2345@gmail.com>
This commit is contained in:
Naman
2026-02-17 03:44:40 +05:30
committed by GitHub
parent 06fe51adfa
commit bf8c7de8f9
52 changed files with 4211 additions and 471 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
docs/cloud/building-workflows/add-parameters.mdx Normal file
View File

@@ -0,0 +1,153 @@
---
title: Workflow Parameters
subtitle: Pass dynamic values into your workflows at runtime
slug: cloud/add-parameters
---
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, reference a parameter and fill in the value when you run the workflow.
---
## 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 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>

299
docs/cloud/building-workflows/build-a-workflow.mdx Normal file
View File

@@ -0,0 +1,299 @@
---
title: Build a Workflow
subtitle: Create multi-step automations with the visual workflow editor
slug: cloud/build-a-workflow
---
A task handles one goal on one page. When your automation needs multiple steps, you need a workflow. 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, 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
```
[find_hiring_thread] → [scrape_listings] → [process_each (loop)] → [send_digest]
Browser Task Extraction └─ [summarize] Send Email
Text Prompt
```
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.
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 |
| **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>
</CardGroup>

361
docs/cloud/building-workflows/configure-blocks.mdx Normal file
View File

@@ -0,0 +1,361 @@
---
title: Block Types and Configuration
subtitle: Reference for every block available in the workflow editor
slug: cloud/configure-blocks
---
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 [editor](/cloud/building-workflows/build-a-workflow), grouped by category.
## 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, 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).*
<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).*
### 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).*
### 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). |
### 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 |
---
## 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. |
### 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 |
---
## 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)
<img src="/images/cloud/block-loop-config.png" alt="Loop block configuration" />
### 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 }}
```
<img src="/images/cloud/block-conditional-config.png" alt="Conditional block configuration" />
### 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 |
### 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 |
### Wait
Pause workflow execution for a specified duration.
| Field | Type | Description |
|-------|------|-------------|
| **Wait in Seconds** | number | Seconds to wait (0–300) |
---
## 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).*
### 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>
---
## 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 |
### 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) |
### 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") |

106
docs/cloud/building-workflows/manage-workflows.mdx Normal file
View File

@@ -0,0 +1,106 @@
---
title: Managing Workflows
subtitle: Create, organize, clone, import, and export reusable automations
slug: cloud/manage-workflows
---
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.
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>

107
docs/cloud/building-workflows/run-a-workflow.mdx Normal file
View File

@@ -0,0 +1,107 @@
---
title: Running Workflows
subtitle: Execute workflows, fill parameters, and track status
slug: cloud/run-a-workflow
---
Once you've built and saved a workflow, you can run it from the editor or the workflows list. Each run creates an independent execution with its own status, logs, and output.
## 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.
2. **From the workflows list**: Click the **play icon** on the workflow's row.
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.
## 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 |
---
## 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
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
2. **History** button (clock icon) in the workflow editor: shows runs for this specific workflow
---
## 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>