---
canonical_url: "https://docs.composio.dev/toolkits/skyvern"
markdown_url: "https://docs.composio.dev/toolkits/skyvern.md"
product: "platform"
version: null
last_updated: null
---

# Skyvern

Skyvern automates browser-based workflows with AI agents that can navigate websites, extract data, and complete tasks.

- **Category:** web scraping & browser
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `SKYVERN`
- **Version:** 20261014_00

## Tools

### Cancel Runs

**Slug:** `SKYVERN_CANCEL_RUNS`

Cancel one or more active task or workflow runs in one request and report which IDs succeeded or failed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_ids` | array | Yes | One to 100 task or workflow run IDs to cancel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Folder

**Slug:** `SKYVERN_CREATE_FOLDER`

Create a folder for organizing Skyvern agents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Folder title. |
| `description` | string | No | Optional folder description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Folder

**Slug:** `SKYVERN_DELETE_FOLDER`

Delete a Skyvern folder without deleting the agents it contains.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | Folder ID beginning with fld_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Folder

**Slug:** `SKYVERN_GET_FOLDER`

Get one Skyvern folder by ID, including its current agent count.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | Folder ID beginning with fld_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Run

**Slug:** `SKYVERN_GET_RUN`

Get current status, output, errors, files, and observation links for a task or workflow run.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Task or workflow run ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Agents

**Slug:** `SKYVERN_LIST_AGENTS`

Search and list the latest versions of Skyvern agents available to the connected organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Case-insensitive search across agent title, folder name, and parameter metadata. |
| `statuses` | array | No | Filter by one or more agent publication or import statuses. |
| `folder_id` | string | No | Only return agents assigned to this folder. |
| `page_size` | integer | No | Maximum agents to return in this page. |
| `next_cursor` | string | No | Continuation cursor from the previous response; omit for the first page. |
| `only_workflows` | boolean | No | Return only workflow agents. |
| `only_saved_tasks` | boolean | No | Return only saved-task agents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Folders

**Slug:** `SKYVERN_LIST_FOLDERS`

Search and list folders used to organize Skyvern agents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Case-insensitive search by folder title or description. |
| `page_size` | integer | No | Maximum folders to return in this page (1-500). |
| `next_cursor` | string | No | Continuation cursor from the previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Runs

**Slug:** `SKYVERN_LIST_RUNS`

Find task and workflow runs for the connected organization, with status, type, workflow, and text filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Case-insensitive substring search of at least 3 characters, including run IDs and task metadata. |
| `statuses` | array | No | Filter by one or more run statuses. |
| `page_size` | integer | No | Maximum runs to return in this page (1-100). |
| `run_types` | array | No | Filter by one or more task or workflow run types. |
| `next_cursor` | string | No | Continuation cursor from the previous response; omit for the first page. |
| `workflow_permanent_ids` | array | No | Return runs belonging to any of these stable agent IDs (wpid_...). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Browser Task

**Slug:** `SKYVERN_START_BROWSER_TASK`

Start an autonomous browser task that can navigate and interact with websites, including clicking and submitting forms. It may cause external side effects and consume Skyvern credits; use GET_RUN to monitor it and CANCEL_RUNS to stop it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Starting URL; omit to let Skyvern choose one from the goal. |
| `title` | string | No | Optional human-readable task title. |
| `engine` | string ("skyvern-1.0" | "skyvern-2.0" | "openai-cua" | "anthropic-cua" | "ui-tars" | "yutori-navigator") | No | Execution engine; keep skyvern-1.0 unless the task specifically requires another supported engine. |
| `prompt` | string | Yes | The browser goal Skyvern should accomplish. |
| `max_steps` | integer | No | Maximum browser steps before failure; set a reasonable bound because Skyvern charges per step. |
| `webhook_url` | string | No | HTTPS callback URL to notify when the run finishes. |
| `proxy_location` | string ("RESIDENTIAL" | "RESIDENTIAL_ES" | "RESIDENTIAL_IE" | "RESIDENTIAL_GB" | "RESIDENTIAL_IN" | "RESIDENTIAL_JP" | "RESIDENTIAL_FR" | "RESIDENTIAL_DE" | "RESIDENTIAL_NZ" | "RESIDENTIAL_ZA" | "RESIDENTIAL_AR" | "RESIDENTIAL_AU" | "RESIDENTIAL_BR" | "RESIDENTIAL_TR" | "RESIDENTIAL_CA" | "RESIDENTIAL_MX" | "RESIDENTIAL_IT" | "RESIDENTIAL_NL" | "RESIDENTIAL_PH" | "RESIDENTIAL_KR" | "RESIDENTIAL_SA" | "RESIDENTIAL_ISP" | "NONE") | No | Skyvern Cloud proxy location. Use RESIDENTIAL for a random US residential proxy, a RESIDENTIAL country code for a specific country, RESIDENTIAL_ISP for an ISP proxy, or NONE for no proxy. |
| `start_fresh_browser` | boolean | No | Start with empty browser state and do not read or write saved browser memory. |
| `data_extraction_schema` | string | No | Optional JSON Schema or equivalent extraction shape for consistent structured output. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Folder

**Slug:** `SKYVERN_UPDATE_FOLDER`

Change the title or description of an existing Skyvern folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | New folder title; omit to leave unchanged. |
| `folder_id` | string | Yes | Folder ID beginning with fld_. |
| `description` | string | No | New folder description; omit to leave unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |