Skip to content

Automate browser based workflows with AI

docs: Add keywords and descriptions for every page, rewrote llms.txt, added another redirect (#5461)

Kunal Mishra022ec7b18542
diff --git a/docs/changelog.mdx b/docs/changelog.mdx
index baa67ec01..095d7c49b 100644
--- a/docs/changelog.mdx
+++ b/docs/changelog.mdx
@@ -2,6 +2,12 @@
title: "Changelog"
description: "New features, improvements, and fixes in Skyvern"
mode: custom
+keywords:
+ - changelog
+ - release notes
+ - new features
+ - improvements
+ - bug fixes
---
<div className="cl-page">
diff --git a/docs/cloud/account-settings/api-keys.mdx b/docs/cloud/account-settings/api-keys.mdx
index f6baff5c8..9a81bcb3a 100644
--- a/docs/cloud/account-settings/api-keys.mdx
+++ b/docs/cloud/account-settings/api-keys.mdx
@@ -1,7 +1,15 @@
---
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.
diff --git a/docs/cloud/account-settings/billing-usage.mdx b/docs/cloud/account-settings/billing-usage.mdx
index eabfb0df8..ba2e5fe53 100644
--- a/docs/cloud/account-settings/billing-usage.mdx
+++ b/docs/cloud/account-settings/billing-usage.mdx
@@ -1,7 +1,18 @@
---
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.
diff --git a/docs/cloud/account-settings/organization-settings.mdx b/docs/cloud/account-settings/organization-settings.mdx
index 0006027b1..50a5bfdc7 100644
--- a/docs/cloud/account-settings/organization-settings.mdx
+++ b/docs/cloud/account-settings/organization-settings.mdx
@@ -1,7 +1,15 @@
---
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.
diff --git a/docs/cloud/account-settings/profile-settings.mdx b/docs/cloud/account-settings/profile-settings.mdx
index 367aeba02..4471f1f4e 100644
--- a/docs/cloud/account-settings/profile-settings.mdx
+++ b/docs/cloud/account-settings/profile-settings.mdx
@@ -1,7 +1,14 @@
---
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**.
diff --git a/docs/cloud/browser-management/browser-profiles.mdx b/docs/cloud/browser-management/browser-profiles.mdx
index 682be848c..68a241e78 100644
--- a/docs/cloud/browser-management/browser-profiles.mdx
+++ b/docs/cloud/browser-management/browser-profiles.mdx
@@ -1,7 +1,15 @@
---
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.
diff --git a/docs/cloud/browser-management/browser-sessions.mdx b/docs/cloud/browser-management/browser-sessions.mdx
index 56421287e..2ccb4f2ad 100644
--- a/docs/cloud/browser-management/browser-sessions.mdx
+++ b/docs/cloud/browser-management/browser-sessions.mdx
@@ -1,7 +1,15 @@
---
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.
diff --git a/docs/cloud/building-workflows/add-parameters.mdx b/docs/cloud/building-workflows/add-parameters.mdx
index 7cf994577..f5cc0b8ab 100644
--- a/docs/cloud/building-workflows/add-parameters.mdx
+++ b/docs/cloud/building-workflows/add-parameters.mdx
@@ -1,7 +1,16 @@
---
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, reference a parameter and fill in the value when you run the workflow.
diff --git a/docs/cloud/building-workflows/build-a-workflow.mdx b/docs/cloud/building-workflows/build-a-workflow.mdx
index 63bccc873..191b30dc0 100644
--- a/docs/cloud/building-workflows/build-a-workflow.mdx
+++ b/docs/cloud/building-workflows/build-a-workflow.mdx
@@ -1,7 +1,17 @@
---
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
---
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.
diff --git a/docs/cloud/building-workflows/configure-blocks.mdx b/docs/cloud/building-workflows/configure-blocks.mdx
index 9d6ab31c6..015b474a7 100644
--- a/docs/cloud/building-workflows/configure-blocks.mdx
+++ b/docs/cloud/building-workflows/configure-blocks.mdx
@@ -1,7 +1,20 @@
---
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, Conditional, Code, HTTP Request, and more.
slug: cloud/configure-blocks
+keywords:
+ - navigation block
+ - action block
+ - extract block
+ - 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 [editor](/cloud/building-workflows/build-a-workflow), grouped by category.
diff --git a/docs/cloud/building-workflows/manage-workflows.mdx b/docs/cloud/building-workflows/manage-workflows.mdx
index add7b71e6..0a79466a9 100644
--- a/docs/cloud/building-workflows/manage-workflows.mdx
+++ b/docs/cloud/building-workflows/manage-workflows.mdx
@@ -1,7 +1,16 @@
---
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
---
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.
diff --git a/docs/cloud/building-workflows/run-a-workflow.mdx b/docs/cloud/building-workflows/run-a-workflow.mdx
index bfeca44fd..25973ee33 100644
--- a/docs/cloud/building-workflows/run-a-workflow.mdx
+++ b/docs/cloud/building-workflows/run-a-workflow.mdx
@@ -1,7 +1,17 @@
---
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, you can run it from the editor or the workflows list. Each run creates an independent execution with its own status, logs, and output.
diff --git a/docs/cloud/building-workflows/scheduling.mdx b/docs/cloud/building-workflows/scheduling.mdx
index b6cde8573..ae3c2fcae 100644
--- a/docs/cloud/building-workflows/scheduling.mdx
+++ b/docs/cloud/building-workflows/scheduling.mdx
@@ -1,7 +1,17 @@
---
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 saved workflow to run automatically on a recurring basis. Schedules are configured with a cron expression and timezone, and Skyvern triggers the workflow at each interval.
diff --git a/docs/cloud/getting-started/core-concepts.mdx b/docs/cloud/getting-started/core-concepts.mdx
index 803f12fd6..01ebe8e4d 100644
--- a/docs/cloud/getting-started/core-concepts.mdx
+++ b/docs/cloud/getting-started/core-concepts.mdx
@@ -1,7 +1,17 @@
---
title: Core Concepts
subtitle: The building blocks of Skyvern automations
+description: Understand the core building blocks of Skyvern automations including tasks, workflows, blocks, browser sessions, browser profiles, and credentials in the Cloud UI.
slug: cloud/getting-started/core-concepts
+keywords:
+ - task
+ - workflow
+ - block
+ - browser session
+ - browser profile
+ - credential
+ - engine
+ - run status
---
import CoreConceptsContent from "/snippets/core-concepts-content.mdx";
diff --git a/docs/cloud/getting-started/introduction.mdx b/docs/cloud/getting-started/introduction.mdx
index 7867fcd15..5b572f5f1 100644
--- a/docs/cloud/getting-started/introduction.mdx
+++ b/docs/cloud/getting-started/introduction.mdx
@@ -1,7 +1,15 @@
---
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";
diff --git a/docs/cloud/getting-started/monitor-a-run.mdx b/docs/cloud/getting-started/monitor-a-run.mdx
index d1d82d40b..3e14ba1ce 100644
--- a/docs/cloud/getting-started/monitor-a-run.mdx
+++ b/docs/cloud/getting-started/monitor-a-run.mdx
@@ -1,7 +1,15 @@
---
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.
diff --git a/docs/cloud/getting-started/overview.mdx b/docs/cloud/getting-started/overview.mdx
index dd5971c18..0675a5506 100644
--- a/docs/cloud/getting-started/overview.mdx
+++ b/docs/cloud/getting-started/overview.mdx
@@ -2,6 +2,15 @@
title: UI Overview
slug: cloud/overview
subtitle: Navigate the Skyvern Cloud dashboard
+description: Tour the Skyvern Cloud dashboard — run tasks, build workflows, manage credentials, view results, and configure settings from the web UI.
+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.
diff --git a/docs/cloud/getting-started/run-a-task.mdx b/docs/cloud/getting-started/run-a-task.mdx
index 16c8eecb0..c13350d82 100644
--- a/docs/cloud/getting-started/run-a-task.mdx
+++ b/docs/cloud/getting-started/run-a-task.mdx
@@ -1,7 +1,17 @@
---
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.
diff --git a/docs/cloud/getting-started/run-your-first-task.mdx b/docs/cloud/getting-started/run-your-first-task.mdx
index c39873f3e..2251f4c24 100644
--- a/docs/cloud/getting-started/run-your-first-task.mdx
+++ b/docs/cloud/getting-started/run-your-first-task.mdx
@@ -2,6 +2,14 @@
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.
diff --git a/docs/cloud/managing-credentials/credentials-overview.mdx b/docs/cloud/managing-credentials/credentials-overview.mdx
index c8b43d1c3..ca761b373 100644
--- a/docs/cloud/managing-credentials/credentials-overview.mdx
+++ b/docs/cloud/managing-credentials/credentials-overview.mdx
@@ -1,7 +1,17 @@
---
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.
diff --git a/docs/cloud/managing-credentials/credit-card-credentials.mdx b/docs/cloud/managing-credentials/credit-card-credentials.mdx
index ba494a38a..adbc15e2b 100644
--- a/docs/cloud/managing-credentials/credit-card-credentials.mdx
+++ b/docs/cloud/managing-credentials/credit-card-credentials.mdx
@@ -1,7 +1,15 @@
---
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.
diff --git a/docs/cloud/managing-credentials/external-providers.mdx b/docs/cloud/managing-credentials/external-providers.mdx
index 180ee1822..8d6852f17 100644
--- a/docs/cloud/managing-credentials/external-providers.mdx
+++ b/docs/cloud/managing-credentials/external-providers.mdx
@@ -1,7 +1,16 @@
---
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.
diff --git a/docs/cloud/managing-credentials/password-credentials.mdx b/docs/cloud/managing-credentials/password-credentials.mdx
index 40f07f975..c1e83ac21 100644
--- a/docs/cloud/managing-credentials/password-credentials.mdx
+++ b/docs/cloud/managing-credentials/password-credentials.mdx
@@ -1,7 +1,15 @@
---
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.
diff --git a/docs/cloud/managing-credentials/totp-setup.mdx b/docs/cloud/managing-credentials/totp-setup.mdx
index b12ddeba5..d90dc00bc 100644
--- a/docs/cloud/managing-credentials/totp-setup.mdx
+++ b/docs/cloud/managing-credentials/totp-setup.mdx
@@ -1,7 +1,16 @@
---
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.
diff --git a/docs/cloud/viewing-results/downloading-artifacts.mdx b/docs/cloud/viewing-results/downloading-artifacts.mdx
index 17b54d15f..70a437dd8 100644
--- a/docs/cloud/viewing-results/downloading-artifacts.mdx
+++ b/docs/cloud/viewing-results/downloading-artifacts.mdx
@@ -1,7 +1,16 @@
---
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.
diff --git a/docs/cloud/viewing-results/run-details.mdx b/docs/cloud/viewing-results/run-details.mdx
index 82f8d6843..52bf112a3 100644
--- a/docs/cloud/viewing-results/run-details.mdx
+++ b/docs/cloud/viewing-results/run-details.mdx
@@ -1,7 +1,16 @@
---
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.
diff --git a/docs/cloud/viewing-results/run-history.mdx b/docs/cloud/viewing-results/run-history.mdx
index a44c92bda..cea788526 100644
--- a/docs/cloud/viewing-results/run-history.mdx
+++ b/docs/cloud/viewing-results/run-history.mdx
@@ -1,7 +1,15 @@
---
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.
diff --git a/docs/cookbooks/bulk-invoice-downloader.mdx b/docs/cookbooks/bulk-invoice-downloader.mdx
index 773d04a18..a3188695c 100644
--- a/docs/cookbooks/bulk-invoice-downloader.mdx
+++ b/docs/cookbooks/bulk-invoice-downloader.mdx
@@ -1,6 +1,16 @@
---
title: Bulk Invoice Downloader
+subtitle: Automate invoice collection from any vendor portal
+description: Build a workflow that logs into vendor portals, finds order history, filters by date, and downloads invoices as PDFs.
slug: cookbooks/bulk-invoice-downloader
+keywords:
+ - invoice
+ - PDF download
+ - vendor portal
+ - order history
+ - date filter
+ - bulk download
+ - accounts payable
---
Automate invoice collection from any vendor portal.
diff --git a/docs/cookbooks/healthcare-portal-data.mdx b/docs/cookbooks/healthcare-portal-data.mdx
index dbc721133..3a4b4083a 100644
--- a/docs/cookbooks/healthcare-portal-data.mdx
+++ b/docs/cookbooks/healthcare-portal-data.mdx
@@ -1,7 +1,16 @@
---
title: Healthcare Portal Data Extraction
subtitle: Extract patient demographics and billing data from OpenEMR
+description: Extract patient demographics and billing data from OpenEMR using Skyvern workflows with residential proxies, browser profiles, and loop blocks for multi-page pagination.
slug: cookbooks/healthcare-portal-data
+keywords:
+ - healthcare
+ - patient demographics
+ - billing data
+ - OpenEMR
+ - HIPAA
+ - multi-page pagination
+ - medical records
---
This cookbook extracts two datasets from [OpenEMR](https://www.open-emr.org/), an open-source EHR, using the public demo at `https://demo.openemr.io/openemr/index.php`:
diff --git a/docs/cookbooks/job-application-filler.mdx b/docs/cookbooks/job-application-filler.mdx
index df62d7532..0c373231f 100644
--- a/docs/cookbooks/job-application-filler.mdx
+++ b/docs/cookbooks/job-application-filler.mdx
@@ -1,7 +1,16 @@
---
title: Job Applications Pipeline
subtitle: Search for jobs and automatically apply using your resume
+description: Build a workflow that parses your resume, searches job portals, extracts listings, generates tailored answers with AI, and submits applications automatically.
slug: cookbooks/job-application-filler
+keywords:
+ - job application
+ - resume
+ - cover letter
+ - job search
+ - auto-apply
+ - form filling
+ - AI-generated answers
---
Automate job applications across multiple postings on any job portal.
diff --git a/docs/cookbooks/overview.mdx b/docs/cookbooks/overview.mdx
index 3638e5485..9f301344e 100644
--- a/docs/cookbooks/overview.mdx
+++ b/docs/cookbooks/overview.mdx
@@ -1,7 +1,15 @@
---
title: Overview
subtitle: End-to-end workflow examples for common automation scenarios
+description: Production-ready cookbook examples for Skyvern browser automation including bulk invoice downloading, job application filling, and healthcare portal data extraction.
slug: cookbooks/overview
+keywords:
+ - cookbook
+ - example
+ - tutorial
+ - end-to-end
+ - production-ready
+ - use case
---
Cookbooks are complete, production-ready workflow examples that demonstrate how to use Skyvern Browser Automation agent in real-world use-cases.
diff --git a/docs/credentials/handle-2fa.mdx b/docs/credentials/handle-2fa.mdx
index bcb17146d..2965e77c6 100644
--- a/docs/credentials/handle-2fa.mdx
+++ b/docs/credentials/handle-2fa.mdx
@@ -1,7 +1,19 @@
---
title: Handle 2FA
subtitle: Configure two-factor authentication for automated logins
+description: Configure two-factor authentication for Skyvern automations using TOTP secrets, pushed verification codes, pull-based endpoints, or magic links. Supports Bitwarden TOTP integration.
slug: credentials/handle-2fa
+keywords:
+ - TOTP
+ - 2FA
+ - totp_identifier
+ - totp_url
+ - authenticator
+ - email code
+ - SMS code
+ - magic link
+ - send_totp_code
+ - verification
---
Many websites require two-factor authentication (2FA) during login. Skyvern supports multiple 2FA methods to handle these flows automatically.
diff --git a/docs/credentials/store-credentials.mdx b/docs/credentials/store-credentials.mdx
index f52506171..9c8db922b 100644
--- a/docs/credentials/store-credentials.mdx
+++ b/docs/credentials/store-credentials.mdx
@@ -1,7 +1,19 @@
---
title: Store Credentials
subtitle: Securely manage login credentials, credit cards, and API secrets
+description: Create, manage, and delete credentials using Skyvern's credential API. Store passwords, credit cards, and API secrets in Bitwarden, 1Password, Azure Key Vault, or a custom vault.
slug: credentials/store-credentials
+keywords:
+ - create_credential
+ - get_credentials
+ - delete_credential
+ - password
+ - credit card
+ - secret
+ - Bitwarden
+ - 1Password
+ - Azure Key Vault
+ - custom vault
---
Skyvern provides a credential management layer that gives you a unified API to create, use, and delete credentials. Your actual secrets are never stored in Skyvern. They live in your external vault (Bitwarden by default, or 1Password, Azure Key Vault, or your own service).
diff --git a/docs/credentials/troubleshooting-login.mdx b/docs/credentials/troubleshooting-login.mdx
index f6c30fde6..770c64c6c 100644
--- a/docs/credentials/troubleshooting-login.mdx
+++ b/docs/credentials/troubleshooting-login.mdx
@@ -1,7 +1,19 @@
---
title: Troubleshooting Login Failures
subtitle: Debug common authentication issues in your automations
+description: Debug common login failures in Skyvern automations including credential errors, expired 2FA codes, CAPTCHA blocks, SSO redirects, and multi-step login flows. Includes a step-by-step debugging checklist.
slug: credentials/troubleshooting-login
+keywords:
+ - login failure
+ - debug
+ - expired code
+ - CAPTCHA block
+ - SSO redirect
+ - multi-step login
+ - session timeout
+ - checklist
+ - recording
+ - screenshot
---
Login failures are the most common issue in web automation. This guide covers the most frequent problems and how to resolve them.
diff --git a/docs/debugging/faq.mdx b/docs/debugging/faq.mdx
index e4e634d4c..4b0dc303c 100644
--- a/docs/debugging/faq.mdx
+++ b/docs/debugging/faq.mdx
@@ -1,7 +1,17 @@
---
title: Frequently Asked Questions
subtitle: Common questions and answers from the Skyvern community
+description: Answers to common Skyvern questions covering troubleshooting failed tasks, workflow parameters, credentials, scheduling, proxy configuration, API polling, data extraction, and LLM model selection.
slug: debugging/faq
+keywords:
+ - FAQ
+ - common questions
+ - troubleshooting
+ - rate limit
+ - model selection
+ - polling
+ - concurrent runs
+ - community
---
## Troubleshooting
diff --git a/docs/debugging/observability-with-laminar.mdx b/docs/debugging/observability-with-laminar.mdx
index 173682126..a0c94be0b 100644
--- a/docs/debugging/observability-with-laminar.mdx
+++ b/docs/debugging/observability-with-laminar.mdx
@@ -1,7 +1,17 @@
---
title: Observability with Laminar
subtitle: Add observability to your Skyvern automations with Laminar
+description: Integrate Laminar observability into Skyvern to capture traces of automation runs, track LLM call latency and token usage, monitor failure rates, and debug performance across tasks and workflows.
slug: debugging/observability-with-laminar
+keywords:
+ - Laminar
+ - traces
+ - LLM latency
+ - token usage
+ - failure rate
+ - monitoring
+ - performance
+ - observability
---
[Laminar](https://www.lmnr.ai/) is an observability platform for AI applications. When integrated with Skyvern, it captures traces of your automation runs in Laminar's dashboard. What you see depends on how you're running Skyvern:
diff --git a/docs/debugging/troubleshooting-guide.mdx b/docs/debugging/troubleshooting-guide.mdx
index 7c7874d56..7bcdb9f5c 100644
--- a/docs/debugging/troubleshooting-guide.mdx
+++ b/docs/debugging/troubleshooting-guide.mdx
@@ -1,7 +1,17 @@
---
title: Troubleshooting Guide
subtitle: Common issues, step timeline, and when to adjust what
+description: Diagnose and fix common Skyvern run failures using the step timeline, artifacts, and run status. Covers issues like wrong output, timeouts, CAPTCHA blocks, login failures, and element detection problems.
slug: debugging/troubleshooting-guide
+keywords:
+ - step timeline
+ - wrong output
+ - timeout
+ - CAPTCHA block
+ - login failure
+ - element detection
+ - action failure
+ - diagnosis
---
When a run fails or produces unexpected results, this guide helps you identify the cause and fix it.
diff --git a/docs/debugging/using-artifacts.mdx b/docs/debugging/using-artifacts.mdx
index c68cefed6..98e984713 100644
--- a/docs/debugging/using-artifacts.mdx
+++ b/docs/debugging/using-artifacts.mdx
@@ -1,7 +1,18 @@
---
title: Using Artifacts
subtitle: Access recordings, screenshots, logs, and network data for every run
+description: Retrieve and inspect artifacts from Skyvern runs including browser recordings, screenshots, AI reasoning logs, DOM element trees, network HAR files, and Playwright traces to debug failures and unexpected results.
slug: debugging/using-artifacts
+keywords:
+ - artifact
+ - recording
+ - screenshot
+ - HAR file
+ - Playwright trace
+ - DOM tree
+ - AI reasoning log
+ - network data
+ - generated code
---
When a Skyvern run fails or produces unexpected results, artifacts are your debugging toolkit. Every run automatically captures what happened—recordings of the browser session, screenshots at each step, the AI's reasoning, and network traffic.
diff --git a/docs/docs.json b/docs/docs.json
index cf1fd8e1b..a0644cae7 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -288,6 +288,12 @@
"twitter": "https://twitter.com/skyvernai"
}
},
+ "contextual": {
+ "options": ["copy", "view", "claude", "chatgpt", "cursor", "vscode", "mcp"]
+ },
+ "seo": {
+ "indexing": "navigable"
+ },
"css": "/style.css",
"api": {
"baseUrl": "https://api.skyvern.com",
@@ -299,6 +305,13 @@
"display": "interactive"
}
},
+ "errors": {
+ "404": {
+ "redirect": false,
+ "title": "Page not found",
+ "description": "This page doesn't exist. Try the [documentation home](/) or use search to find what you need."
+ }
+ },
"redirects": [
{
"source": "/introduction",
@@ -432,6 +445,14 @@
"source": "/integrations/ollama-litellm",
"destination": "/integrations/local-llms"
},
+ {
+ "source": "/integrations/mcp-server",
+ "destination": "/integrations/mcp"
+ },
+ {
+ "source": "/home/integrations/mcp-server",
+ "destination": "/integrations/mcp"
+ },
{
"source": "/api-reference/api-reference/agent/run-task",
"destination": "/api-reference/agent/run-a-task"
diff --git a/docs/getting-started/ai-agents-quickstart.mdx b/docs/getting-started/ai-agents-quickstart.mdx
index deba58df2..648ce69ac 100644
--- a/docs/getting-started/ai-agents-quickstart.mdx
+++ b/docs/getting-started/ai-agents-quickstart.mdx
@@ -1,7 +1,18 @@
---
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: getting-started/ai-agents-quickstart
+keywords:
+ - MCP
+ - Claude Desktop
+ - Cursor
+ - Windsurf
+ - VS Code
+ - AI assistant
+ - Model Context Protocol
+ - pip install
+ - npm install
---
export const ApiKeyPrompt = ({ children }) => {
diff --git a/docs/getting-started/core-concepts.mdx b/docs/getting-started/core-concepts.mdx
index 99a06a79c..39c5bbbbd 100644
--- a/docs/getting-started/core-concepts.mdx
+++ b/docs/getting-started/core-concepts.mdx
@@ -1,7 +1,22 @@
---
title: Core Concepts
subtitle: The building blocks of Skyvern automations
+description: Learn about tasks, workflows, browser sessions, credentials, and other building blocks that make up Skyvern automations.
slug: getting-started/core-concepts
+keywords:
+ - task
+ - workflow
+ - browser session
+ - browser profile
+ - credential
+ - block
+ - parameter
+ - schedule
+ - navigation block
+ - action block
+ - extract block
+ - loop block
+ - text prompt block
---
import CoreConceptsContent from "/snippets/core-concepts-content.mdx";
diff --git a/docs/getting-started/introduction.mdx b/docs/getting-started/introduction.mdx
index 14ef89bee..655d08da4 100644
--- a/docs/getting-started/introduction.mdx
+++ b/docs/getting-started/introduction.mdx
@@ -1,7 +1,18 @@
---
title: What is Skyvern?
subtitle: AI-powered browser automation for any website
+description: Skyvern automates browser-based workflows using LLMs and computer vision. It navigates websites it has never seen before, filling forms, extracting data, and completing multi-step tasks via a simple API.
slug: getting-started/introduction
+keywords:
+ - browser automation
+ - AI agent
+ - computer vision
+ - LLM
+ - natural language
+ - visual reasoning
+ - web scraping
+ - form filling
+ - Playwright
---
import IntroductionContent from "/snippets/introduction-content.mdx";
diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx
index da9e50822..8685112f6 100644
--- a/docs/getting-started/quickstart.mdx
+++ b/docs/getting-started/quickstart.mdx
@@ -1,6 +1,18 @@
---
title: API Quickstart
+subtitle: Run your first browser automation in 5 minutes
+description: Run your first browser automation task with the Skyvern API. Scrape Hacker News using Python, TypeScript, or cURL in under 5 minutes.
slug: getting-started/quickstart
+keywords:
+ - quickstart
+ - 5 minutes
+ - Hacker News
+ - run_task
+ - get_run
+ - polling
+ - cURL
+ - pip install
+ - npm install
---
Run your first browser automation in 5 minutes. By the end of this guide, you'll scrape the top post from Hacker News using Skyvern's AI agent.
diff --git a/docs/going-to-production/captcha-bot-detection.mdx b/docs/going-to-production/captcha-bot-detection.mdx
index f3d8c2450..f29d17250 100644
--- a/docs/going-to-production/captcha-bot-detection.mdx
+++ b/docs/going-to-production/captcha-bot-detection.mdx
@@ -1,7 +1,18 @@
---
title: CAPTCHA & Bot Detection
subtitle: How Skyvern handles CAPTCHAs and avoids triggering anti-bot systems
+description: Learn how Skyvern automatically detects and solves CAPTCHAs including reCAPTCHA, hCaptcha, and Cloudflare Turnstile, and how to reduce bot detection risk using residential proxies, browser sessions, and browser profiles.
slug: going-to-production/captcha-bot-detection
+keywords:
+ - CAPTCHA
+ - reCAPTCHA
+ - hCaptcha
+ - Cloudflare Turnstile
+ - bot detection
+ - fingerprinting
+ - residential proxy
+ - stealth
+ - anti-bot
---
Skyvern detects CAPTCHAs using its vision model and solves them automatically.
diff --git a/docs/going-to-production/error-handling.mdx b/docs/going-to-production/error-handling.mdx
index 90492afc8..6df479ffd 100644
--- a/docs/going-to-production/error-handling.mdx
+++ b/docs/going-to-production/error-handling.mdx
@@ -1,7 +1,18 @@
---
title: Error Handling
subtitle: Build systems that detect, classify, and recover from failures
+description: Detect, classify, and recover from task and workflow failures using run status, failure_reason, custom error_code_mapping, and validation blocks. Build programmatic error handling with retry logic and branching.
slug: going-to-production/error-handling
+keywords:
+ - failure_reason
+ - run status
+ - error_code_mapping
+ - validation block
+ - retry logic
+ - branching
+ - failed
+ - terminated
+ - timed_out
---
Skyvern lets you make your workflows and tasks handle errors gracefully instead of failing silently.
diff --git a/docs/going-to-production/proxy-geolocation.mdx b/docs/going-to-production/proxy-geolocation.mdx
index 1cf178d50..73fbfdaf7 100644
--- a/docs/going-to-production/proxy-geolocation.mdx
+++ b/docs/going-to-production/proxy-geolocation.mdx
@@ -1,7 +1,17 @@
---
title: Proxy & Geolocation
subtitle: Route browser traffic through residential proxies worldwide
+description: Route Skyvern browser traffic through residential proxies in 20 countries to bypass geo-restrictions, avoid bot detection, and access region-locked content. Configure proxy_location for tasks, workflows, and browser sessions.
slug: going-to-production/proxy-geolocation
+keywords:
+ - proxy_location
+ - residential proxy
+ - geolocation
+ - RESIDENTIAL
+ - RESIDENTIAL_US
+ - geo-restriction
+ - IP rotation
+ - country
---
export const COUNTRY_PATHS = {
diff --git a/docs/going-to-production/reliability-tips.mdx b/docs/going-to-production/reliability-tips.mdx
index 05e79805d..c10e3e71a 100644
--- a/docs/going-to-production/reliability-tips.mdx
+++ b/docs/going-to-production/reliability-tips.mdx
@@ -1,7 +1,17 @@
---
title: Reliability Tips
subtitle: Write robust prompts and handle edge cases
+description: Write robust prompts with clear completion criteria, choose the right block type for each step, handle dynamic pages and popups, and add validation blocks to catch errors before they cascade.
slug: going-to-production/reliability-tips
+keywords:
+ - prompt engineering
+ - completion criteria
+ - block selection
+ - dynamic pages
+ - popups
+ - validation block
+ - edge cases
+ - robust prompts
---
The difference between a demo and production-ready automation is reliability. This page covers techniques for writing prompts that work consistently, handling dynamic pages, and validating results.
diff --git a/docs/going-to-production/webhooks.mdx b/docs/going-to-production/webhooks.mdx
index 574fe8192..84f04df05 100644
--- a/docs/going-to-production/webhooks.mdx
+++ b/docs/going-to-production/webhooks.mdx
@@ -1,7 +1,17 @@
---
title: Webhooks
subtitle: Get notified when tasks and workflows complete
+description: Configure webhook URLs for tasks and workflows to receive notifications when runs reach terminal status. Includes payload structure, HMAC-SHA256 signature verification, failure handling, and retry mechanisms.
slug: going-to-production/webhooks
+keywords:
+ - webhook_url
+ - HMAC-SHA256
+ - signature verification
+ - payload
+ - callback
+ - notification
+ - retry
+ - failure handling
---
Workflows and task runs are asynchronous. When you call `run_task` or `run_workflow`, the API returns immediately with a run ID, but the actual execution happens in the background and can take variable time.
diff --git a/docs/index.mdx b/docs/index.mdx
index f1b2696d3..a6e3bf47f 100644
--- a/docs/index.mdx
+++ b/docs/index.mdx
@@ -1,5 +1,6 @@
---
title: Skyvern Documentation
+description: Skyvern is an AI-powered browser automation platform. Describe tasks in plain English and Skyvern opens a real browser, reads the page visually, and completes the task using tasks, workflows, and the API or SDK.
slug: /
mode: custom
---
diff --git a/docs/integrations/cli.mdx b/docs/integrations/cli.mdx
index 525e1ee39..5375ec65c 100644
--- a/docs/integrations/cli.mdx
+++ b/docs/integrations/cli.mdx
@@ -1,7 +1,17 @@
---
title: CLI & Skills
subtitle: Automate browsers and manage workflows from the command line
+description: Use the skyvern CLI to run browser automations, manage workflows, store credentials, and configure MCP servers from the terminal. Supports shell scripts, CI/CD pipelines, and one-off tasks.
slug: going-to-production/cli
+keywords:
+ - CLI
+ - skyvern command
+ - terminal
+ - shell script
+ - CI/CD
+ - pipeline
+ - skills
+ - one-liner
---
The `skyvern` CLI gives you direct access to browser automation, workflow management, credential storage, and more — all from your terminal. Use it in shell scripts, CI/CD pipelines, or for quick one-off tasks.
diff --git a/docs/integrations/local-llms.mdx b/docs/integrations/local-llms.mdx
index 1d36ca4da..52d558ba4 100644
--- a/docs/integrations/local-llms.mdx
+++ b/docs/integrations/local-llms.mdx
@@ -1,7 +1,16 @@
---
title: Local LLMs
subtitle: Run Skyvern with Ollama or any OpenAI-compatible endpoint
+description: Configure Skyvern to use local LLMs through Ollama or any OpenAI-compatible endpoint via LiteLLM for self-hosted deployments without cloud LLM dependencies.
slug: integrations/local-llms
+keywords:
+ - Ollama
+ - LiteLLM
+ - local model
+ - OpenAI-compatible
+ - offline
+ - self-hosted LLM
+ - open-source model
---
Skyvern supports local LLMs for self-hosted deployments. Use Ollama directly or route through LiteLLM to connect any model provider.
diff --git a/docs/integrations/make.mdx b/docs/integrations/make.mdx
index 5ca9432e2..e92a095ef 100644
--- a/docs/integrations/make.mdx
+++ b/docs/integrations/make.mdx
@@ -1,7 +1,15 @@
---
title: Make.com
subtitle: Integrate browser automations into Make scenarios
+description: Connect Skyvern to 2,000+ apps through Make.com. Run tasks or workflows, retrieve results, and integrate browser automations into any Make scenario.
slug: integrations/make
+keywords:
+ - Make.com
+ - scenario
+ - module
+ - connection
+ - 2000 apps
+ - no-code
---
Connect Skyvern to 2,000+ apps through Make. Trigger browser automations from any scenario, or route Skyvern's results into downstream modules.
diff --git a/docs/integrations/mcp.mdx b/docs/integrations/mcp.mdx
index 6d85debdf..1c1e5b480 100644
--- a/docs/integrations/mcp.mdx
+++ b/docs/integrations/mcp.mdx
@@ -1,7 +1,19 @@
---
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, Cursor, Windsurf, VS Code, and other AI tools can run browser automations.
slug: going-to-production/mcp
+keywords:
+ - MCP
+ - Model Context Protocol
+ - Claude Desktop
+ - Cursor
+ - Windsurf
+ - VS Code
+ - AI assistant
+ - tools
+ - stdio
+ - SSE
---
The Skyvern MCP server lets AI assistants like Claude Desktop, Claude Code, Codex, Cursor, and Windsurf control a browser. Your AI can fill out forms, extract data, download files, and run multi-step workflows, all through natural language.
diff --git a/docs/integrations/n8n.mdx b/docs/integrations/n8n.mdx
index 66274e3e1..338756a60 100644
--- a/docs/integrations/n8n.mdx
+++ b/docs/integrations/n8n.mdx
@@ -1,7 +1,15 @@
---
title: n8n
subtitle: Run browser automations in your n8n workflows
+description: Connect Skyvern to n8n's open-source automation platform. Dispatch tasks and workflows, retrieve results, and integrate browser automations into any n8n workflow.
slug: integrations/n8n
+keywords:
+ - n8n
+ - open source
+ - node
+ - connection
+ - self-hosted
+ - automation platform
---
Connect Skyvern to n8n's open-source automation platform. Trigger browser automations from any workflow, or pipe Skyvern's results into downstream nodes.
diff --git a/docs/integrations/workato.mdx b/docs/integrations/workato.mdx
index 2a9df200b..5314a2fb4 100644
--- a/docs/integrations/workato.mdx
+++ b/docs/integrations/workato.mdx
@@ -1,7 +1,14 @@
---
title: Workato
subtitle: Run browser automations in your Workato recipes
+description: Connect Skyvern to Workato's enterprise automation platform. Run tasks or workflows, retrieve results, and integrate browser automations into any Workato recipe.
slug: integrations/workato
+keywords:
+ - Workato
+ - recipe
+ - connector
+ - enterprise
+ - automation platform
---
Connect Skyvern to Workato's enterprise automation platform. Trigger browser automations from any recipe, or route Skyvern's results into downstream actions.
diff --git a/docs/integrations/zapier.mdx b/docs/integrations/zapier.mdx
index 249af0445..5c101a953 100644
--- a/docs/integrations/zapier.mdx
+++ b/docs/integrations/zapier.mdx
@@ -1,7 +1,16 @@
---
title: Zapier
subtitle: Trigger browser automations from Zapier workflows
+description: Connect Skyvern to 7,000+ apps through Zapier. Create and run tasks or workflows, retrieve results, and trigger browser automations from any Zap.
slug: integrations/zapier
+keywords:
+ - Zapier
+ - Zap
+ - trigger
+ - action
+ - connection
+ - 7000 apps
+ - no-code
---
Connect Skyvern to 7,000+ apps through Zapier. Trigger browser automations from any Zap, or feed Skyvern's results into downstream steps.
diff --git a/docs/llms.txt b/docs/llms.txt
new file mode 100644
index 000000000..c0ad734cc
--- /dev/null
+++ b/docs/llms.txt
@@ -0,0 +1,115 @@
+# Skyvern
+
+> Skyvern automates browser-based workflows using LLMs and computer vision. It navigates websites it has never seen before — filling forms, extracting data, and completing multi-step tasks — via a simple API. Use the Python SDK, TypeScript SDK, REST API, MCP server, or Cloud UI to build and run browser automations. Key capabilities: natural-language task execution, multi-step workflows with loops and conditionals, credential management (passwords, credit cards, TOTP/2FA), browser session persistence, data extraction, file downloads, webhook notifications, and proxy/geolocation support.
+
+## Getting Started
+
+- [What is Skyvern?](https://skyvern.com/docs/getting-started/introduction.md): Overview of Skyvern's AI-powered browser automation platform — how it uses LLMs and computer vision to navigate any website without custom scripts
+- [Core Concepts](https://skyvern.com/docs/getting-started/core-concepts.md): Key building blocks — tasks, workflows, blocks, parameters, browser sessions, browser profiles, credentials, runs, and artifacts
+- [API Quickstart](https://skyvern.com/docs/getting-started/quickstart.md): Run your first browser automation task with the Skyvern REST API using Python, TypeScript, or cURL in under 5 minutes
+- [AI Agents Quickstart](https://skyvern.com/docs/getting-started/ai-agents-quickstart.md): Set up Skyvern's MCP server so Claude Desktop, Cursor, Windsurf, or any AI coding assistant can run browser automations
+
+## Creating & Running Tasks
+
+- [Run a Task](https://skyvern.com/docs/running-automations/run-a-task.md): Execute a single browser automation with a natural-language goal — configure URLs, navigation goals, data extraction schemas, webhooks, and proxy settings via API or SDK
+- [Task Parameters](https://skyvern.com/docs/running-automations/task-parameters.md): Configure task behavior — proxy location, browser session reuse, TOTP/2FA credentials, max steps, webhook callbacks, error handling, and extraction schemas
+- [Extract Structured Data](https://skyvern.com/docs/running-automations/extract-structured-data.md): Define JSON schemas to get consistent, typed data extraction output from tasks — prices, addresses, table rows, and more
+
+## Building Multi-Step Workflows
+
+- [Build a Workflow](https://skyvern.com/docs/multi-step-automations/build-a-workflow.md): Create multi-step browser automations by chaining task blocks, loops, conditionals, extraction, and file operations into reusable workflows
+- [Workflow Blocks Reference](https://skyvern.com/docs/multi-step-automations/workflow-blocks-reference.md): Complete reference for every block type — navigation block, action block, extract block, loop block, text prompt block, login block, file operations, email, webhook, and validation blocks
+- [Workflow Parameters](https://skyvern.com/docs/multi-step-automations/workflow-parameters.md): Pass dynamic values into workflows at runtime — configure proxy, webhook, browser session, and credential parameters per run
+- [File Operations](https://skyvern.com/docs/multi-step-automations/file-operations.md): Download, parse (CSV, PDF, Excel), and upload files within workflow blocks
+- [Scheduling Workflows](https://skyvern.com/docs/multi-step-automations/scheduling-workflows.md): Run workflows automatically on a recurring cron schedule via API, SDK, or the Cloud UI
+
+## Handling Authentication
+
+- [Store Credentials](https://skyvern.com/docs/credentials/store-credentials.md): Securely manage login passwords, credit cards, TOTP secrets, and API keys — with Bitwarden, 1Password, Azure Key Vault, or Skyvern's built-in vault
+- [Handle 2FA](https://skyvern.com/docs/credentials/handle-2fa.md): Configure TOTP-based two-factor authentication so Skyvern can complete login flows that require 2FA codes
+- [Troubleshooting Login](https://skyvern.com/docs/credentials/troubleshooting-login.md): Debug common authentication failures — credential issues, CAPTCHA blocks, bot detection, and session expiration
+
+## Optimizing Performance
+
+- [Browser Sessions](https://skyvern.com/docs/optimization/browser-sessions.md): Persist a live browser across multiple tasks and workflows — maintain login state, cookies, and page context between API calls
+- [Browser Profiles](https://skyvern.com/docs/optimization/browser-profiles.md): Save and reuse authenticated browser state (cookies, localStorage) across runs without re-logging in
+- [Cost Control](https://skyvern.com/docs/optimization/cost-control.md): Limit max steps, optimize prompts, and use caching to manage credit consumption
+
+## Shipping to Production
+
+- [Webhooks](https://skyvern.com/docs/going-to-production/webhooks.md): Receive HTTP callbacks when tasks and workflow runs complete, fail, or require human intervention
+- [Proxy & Geolocation](https://skyvern.com/docs/going-to-production/proxy-geolocation.md): Route browser traffic through residential proxies in specific countries and regions to handle geo-restricted content
+- [Error Handling](https://skyvern.com/docs/going-to-production/error-handling.md): Detect, classify, and recover from task failures — retry strategies, cancel runs, and webhook error payloads
+- [Reliability Tips](https://skyvern.com/docs/going-to-production/reliability-tips.md): Write robust prompts, handle edge cases, and build resilient automations that work across website changes
+- [CAPTCHA & Bot Detection](https://skyvern.com/docs/going-to-production/captcha-bot-detection.md): How Skyvern handles CAPTCHAs, anti-bot systems, and stealth browser configuration
+
+## Connecting Tools & Platforms
+
+- [MCP Server](https://skyvern.com/docs/going-to-production/mcp.md): Install and configure Skyvern's Model Context Protocol server for Claude Desktop, Cursor, Windsurf, VS Code, and other AI assistants
+- [CLI & Skills](https://skyvern.com/docs/going-to-production/cli.md): Run tasks, manage workflows, store credentials, and open browser sessions from the command line
+- [Zapier](https://skyvern.com/docs/integrations/zapier.md): Trigger browser automations from Zapier workflows — run tasks and get results via Zapier actions
+- [Make.com](https://skyvern.com/docs/integrations/make.md): Integrate Skyvern browser automations into Make.com scenarios
+- [n8n](https://skyvern.com/docs/integrations/n8n.md): Run browser automations as nodes in n8n workflows
+- [Workato](https://skyvern.com/docs/integrations/workato.md): Run browser automations in Workato recipes with the Skyvern connector
+- [Local LLMs](https://skyvern.com/docs/integrations/local-llms.md): Run Skyvern with Ollama, LiteLLM, or any OpenAI-compatible endpoint for self-hosted LLM inference
+
+## Python SDK Reference
+
+- [Python SDK Overview](https://skyvern.com/docs/sdk-reference/overview.md): Install, authenticate, and configure the Skyvern Python client
+- [Tasks](https://skyvern.com/docs/sdk-reference/tasks.md): Run single browser automations — run_task(), get_run(), cancel_run(), and extraction
+- [Workflows](https://skyvern.com/docs/sdk-reference/workflows.md): Create and run multi-step workflows — create_workflow(), run_workflow(), and block configuration
+- [Browser Sessions](https://skyvern.com/docs/sdk-reference/browser-sessions.md): Manage live browser state — create_session(), get_session(), close_session()
+- [Browser Profiles](https://skyvern.com/docs/sdk-reference/browser-profiles.md): Save and reuse browser state — create_profile(), list_profiles(), delete_profile()
+- [Credentials](https://skyvern.com/docs/sdk-reference/credentials.md): Store passwords, TOTP secrets, and credit cards — create_credential(), send_totp()
+- [Helper Methods](https://skyvern.com/docs/sdk-reference/helpers.md): High-level convenience methods for login, credential management, and common patterns
+- [Error Handling](https://skyvern.com/docs/sdk-reference/error-handling.md): Handle API errors, timeouts, rate limits, and configure retry behavior
+- [Complete Reference](https://skyvern.com/docs/sdk-reference/complete-reference.md): Every method, parameter, and type in the Python SDK on one page — optimized for LLM consumption
+
+## TypeScript SDK Reference
+
+- [TypeScript SDK Overview](https://skyvern.com/docs/ts-sdk-reference/overview.md): Install, authenticate, and configure the Skyvern TypeScript client
+- [Tasks](https://skyvern.com/docs/ts-sdk-reference/tasks.md): Run single browser automations — runTask(), getRun(), cancelRun(), and extraction
+- [Workflows](https://skyvern.com/docs/ts-sdk-reference/workflows.md): Create and run multi-step workflows — createWorkflow(), runWorkflow(), and block configuration
+- [Browser Sessions](https://skyvern.com/docs/ts-sdk-reference/browser-sessions.md): Manage live browser state — createSession(), getSession(), closeSession()
+- [Browser Profiles](https://skyvern.com/docs/ts-sdk-reference/browser-profiles.md): Save and reuse browser state — createProfile(), listProfiles(), deleteProfile()
+- [Credentials](https://skyvern.com/docs/ts-sdk-reference/credentials.md): Store passwords, TOTP secrets, and credit cards — createCredential(), sendTotp()
+- [Helper Methods](https://skyvern.com/docs/ts-sdk-reference/helpers.md): High-level convenience methods for login, credential management, and common patterns
+- [Browser Automation](https://skyvern.com/docs/ts-sdk-reference/browser-automation.md): Control cloud browsers with Playwright + AI — direct browser session automation
+- [Error Handling](https://skyvern.com/docs/ts-sdk-reference/error-handling.md): Handle API errors, timeouts, rate limits, and configure retry behavior
+- [Complete Reference](https://skyvern.com/docs/ts-sdk-reference/complete-reference.md): Every method, parameter, and type in the TypeScript SDK on one page — optimized for LLM consumption
+
+## Debugging & Troubleshooting
+
+- [Using Artifacts](https://skyvern.com/docs/debugging/using-artifacts.md): Access recordings, screenshots, action logs, and network data for every run
+- [Troubleshooting Guide](https://skyvern.com/docs/debugging/troubleshooting-guide.md): Diagnose common issues — step timeline analysis, prompt tuning, and when to adjust task configuration
+- [Observability with Laminar](https://skyvern.com/docs/debugging/observability-with-laminar.md): Add tracing and observability to Skyvern automations using Laminar
+- [FAQ](https://skyvern.com/docs/debugging/faq.md): Frequently asked questions — CAPTCHA handling, retries, artifacts, recordings, and error codes
+
+## Self-Hosted Deployment
+
+- [Self-Hosted Overview](https://skyvern.com/docs/self-hosted/overview.md): Run Skyvern on your own infrastructure with Docker or Kubernetes
+- [Docker Setup](https://skyvern.com/docs/self-hosted/docker.md): Get Skyvern running in 10 minutes with Docker Compose
+- [LLM Configuration](https://skyvern.com/docs/self-hosted/llm-configuration.md): Connect OpenAI, Anthropic, Azure OpenAI, AWS Bedrock, Ollama, or any OpenAI-compatible LLM provider
+- [Browser Configuration](https://skyvern.com/docs/self-hosted/browser.md): Configure browser modes, display settings, headless vs headed, and external Chrome connections via Playwright
+- [Proxy Setup](https://skyvern.com/docs/self-hosted/proxy.md): Configure residential proxies and geolocation for bot detection avoidance in self-hosted deployments
+- [Kubernetes Deployment](https://skyvern.com/docs/self-hosted/kubernetes.md): Deploy Skyvern at scale with Kubernetes manifests and Helm charts
+- [Storage Configuration](https://skyvern.com/docs/self-hosted/storage.md): Configure where Skyvern stores artifacts, recordings, and screenshots — local filesystem or S3-compatible storage
+
+## Cookbooks
+
+- [Cookbooks Overview](https://skyvern.com/docs/cookbooks/overview.md): End-to-end workflow examples for common browser automation scenarios
+- [Bulk Invoice Downloader](https://skyvern.com/docs/cookbooks/bulk-invoice-downloader.md): Build a workflow that logs into vendor portals, finds invoices by date, and downloads them as PDFs
+- [Job Application Pipeline](https://skyvern.com/docs/cookbooks/job-application-filler.md): Search for jobs and automatically fill out applications using stored credentials and resume data
+- [Healthcare Portal Data Extraction](https://skyvern.com/docs/cookbooks/healthcare-portal-data.md): Extract patient demographics and billing data from OpenEMR using the Python SDK
+
+## Cloud UI
+
+For visual dashboard documentation — running tasks, building workflows, managing credentials, viewing results, and account settings — see the [Cloud UI Guide](https://skyvern.com/docs/cloud/overview.md).
+
+## API Reference
+
+- [OpenAPI Specification](https://skyvern.com/docs/api-reference/openapi.json): Full OpenAPI 3.x spec for all Skyvern REST API endpoints — tasks, workflows, browser sessions, browser profiles, credentials, and artifacts
+
+## Changelog
+
+- [Changelog](https://skyvern.com/docs/changelog): Latest features, improvements, and fixes in Skyvern
diff --git a/docs/multi-step-automations/build-a-workflow.mdx b/docs/multi-step-automations/build-a-workflow.mdx
index 34482eaf4..7fb4baf0d 100644
--- a/docs/multi-step-automations/build-a-workflow.mdx
+++ b/docs/multi-step-automations/build-a-workflow.mdx
@@ -1,7 +1,16 @@
---
title: Build a Workflow
subtitle: Create, run, and test multi-step automations
+description: Create multi-step browser automations by chaining tasks, loops, conditionals, and data extraction blocks into reusable workflows.
slug: multi-step-automations/build-a-workflow
+keywords:
+ - create_workflow
+ - JSON definition
+ - YAML definition
+ - block chaining
+ - parameter passing
+ - test run
+ - publish
---
A **Workflow** chains multiple automation steps into a reusable template. While a Task handles a single goal on one page, a Workflow orchestrates an entire process: filling forms, validating data, downloading files, and sending results.
diff --git a/docs/multi-step-automations/file-operations.mdx b/docs/multi-step-automations/file-operations.mdx
index 207095cbf..116371637 100644
--- a/docs/multi-step-automations/file-operations.mdx
+++ b/docs/multi-step-automations/file-operations.mdx
@@ -1,7 +1,18 @@
---
title: File Operations
subtitle: Download, parse, and upload files in workflows
+description: Download, parse, and upload files in Skyvern workflows using file download, file parser, and upload blocks. Handle PDFs, CSVs, Excel files, and pass files between workflow blocks.
slug: multi-step-automations/file-operations
+keywords:
+ - file download
+ - file upload
+ - file parser
+ - PDF
+ - CSV
+ - Excel
+ - S3
+ - download_to_s3
+ - upload_to_s3
---
Workflows often need to handle files: downloading invoices, parsing spreadsheets, uploading documents to storage. This page covers the four core file operations: downloading, parsing, saving, and passing files between blocks.
diff --git a/docs/multi-step-automations/scheduling-workflows.mdx b/docs/multi-step-automations/scheduling-workflows.mdx
index 38b7d8b1e..cbe87dbf6 100644
--- a/docs/multi-step-automations/scheduling-workflows.mdx
+++ b/docs/multi-step-automations/scheduling-workflows.mdx
@@ -1,7 +1,18 @@
---
title: Scheduling Workflows
subtitle: Run workflows automatically on a recurring cron schedule
+description: Schedule Skyvern workflows to run automatically using cron expressions. Create, list, update, pause, resume, and delete recurring workflow schedules via the API.
slug: multi-step-automations/scheduling-workflows
+keywords:
+ - schedule
+ - cron expression
+ - recurring
+ - timezone
+ - enable
+ - disable
+ - pause
+ - resume
+ - delete schedule
---
Schedules let you run any workflow automatically on a recurring basis.
diff --git a/docs/multi-step-automations/workflow-blocks-reference.mdx b/docs/multi-step-automations/workflow-blocks-reference.mdx
index 019168170..caf35b120 100644
--- a/docs/multi-step-automations/workflow-blocks-reference.mdx
+++ b/docs/multi-step-automations/workflow-blocks-reference.mdx
@@ -1,7 +1,22 @@
---
title: Workflow Blocks Reference
subtitle: Complete reference for all workflow block types
+description: Complete reference for all Skyvern workflow block types including navigation, action, extraction, login, validation, conditional, for loop, file download, text prompt, code, HTTP request, and more.
slug: multi-step-automations/workflow-blocks-reference
+keywords:
+ - navigation block
+ - action block
+ - extract block
+ - loop block
+ - code block
+ - text prompt block
+ - login block
+ - validation block
+ - conditional block
+ - HTTP request block
+ - file download block
+ - file upload block
+ - send email block
---
This page covers all block types available for building workflows.
diff --git a/docs/multi-step-automations/workflow-parameters.mdx b/docs/multi-step-automations/workflow-parameters.mdx
index 28bb49f70..fc072711f 100644
--- a/docs/multi-step-automations/workflow-parameters.mdx
+++ b/docs/multi-step-automations/workflow-parameters.mdx
@@ -1,7 +1,18 @@
---
title: Workflow Parameters
subtitle: Configure how your workflow runs
+description: Full reference for all workflow creation and run parameters including title, definition, proxy location, webhooks, browser sessions, browser profiles, and credential parameters.
slug: multi-step-automations/workflow-parameters
+keywords:
+ - workflow_id
+ - parameters
+ - proxy_location
+ - webhook_url
+ - browser_session_id
+ - browser_profile_id
+ - max_steps_override
+ - template
+ - title
---
This page covers all parameters you can pass when creating and running workflows.
diff --git a/docs/optimization/browser-profiles.mdx b/docs/optimization/browser-profiles.mdx
index 970a264ee..b808fc0dc 100644
--- a/docs/optimization/browser-profiles.mdx
+++ b/docs/optimization/browser-profiles.mdx
@@ -1,7 +1,16 @@
---
title: Browser Profiles
subtitle: Save and reuse authenticated browser state across runs
+description: Save browser state snapshots including cookies, localStorage, and session files as reusable profiles. Skip login steps and restore authenticated state instantly across workflow runs.
slug: optimization/browser-profiles
+keywords:
+ - create_browser_profile
+ - state snapshot
+ - skip login
+ - cookies
+ - localStorage
+ - session files
+ - persist_browser_session
---
A **Browser Profile** is a saved snapshot of browser state (cookies, localStorage, and session files) that you can reuse across multiple runs. Profiles let you skip login steps and restore authenticated state instantly.
diff --git a/docs/optimization/browser-sessions.mdx b/docs/optimization/browser-sessions.mdx
index 94119e6a7..4400ce2f9 100644
--- a/docs/optimization/browser-sessions.mdx
+++ b/docs/optimization/browser-sessions.mdx
@@ -1,7 +1,17 @@
---
title: Browser Sessions
subtitle: Persist live browser state across multiple tasks and workflows
+description: Create and manage live browser sessions that persist cookies, local storage, and page state between task or workflow runs. Use sessions for back-to-back tasks, human-in-the-loop approval, and real-time agents.
slug: optimization/browser-sessions
+keywords:
+ - create_browser_session
+ - persistent state
+ - cookies
+ - local storage
+ - timeout
+ - session chaining
+ - human-in-the-loop
+ - real-time agent
---
A **Browser Session** is a live browser instance that persists cookies, local storage, and page state between task or workflow runs. Think of it as keeping a browser tab open. Use sessions when you need back-to-back tasks to share state, human-in-the-loop approval, or real-time agents.
diff --git a/docs/optimization/browser-tunneling.mdx b/docs/optimization/browser-tunneling.mdx
index 10f1df9e9..3614d159b 100644
--- a/docs/optimization/browser-tunneling.mdx
+++ b/docs/optimization/browser-tunneling.mdx
@@ -1,7 +1,16 @@
---
title: Connect Skyvern to Your Local Browser
subtitle: Run automations using your existing cookies, logins, and extensions
+description: Use skyvern browser serve to let Skyvern Cloud control a Chrome browser on your local machine, reusing your existing cookies, sessions, extensions, and saved passwords through a secure tunnel.
slug: optimization/browser-tunneling
+keywords:
+ - browser session
+ - task
+ - CLI
+ - authentication
+ - login
+ - proxy
+ - Playwright
---
Want Skyvern Cloud to automate a site where you're already logged in? With `skyvern browser serve`, Skyvern Cloud can control a Chrome browser running on your machine — using your existing cookies, sessions, extensions, and saved passwords.
diff --git a/docs/optimization/cost-control.mdx b/docs/optimization/cost-control.mdx
index d632fdbac..06af504c4 100644
--- a/docs/optimization/cost-control.mdx
+++ b/docs/optimization/cost-control.mdx
@@ -1,7 +1,16 @@
---
title: Cost Control
subtitle: Limit steps and optimize prompts to manage costs
+description: Control Skyvern costs using max_steps limits, code generation for repeatable tasks, cheaper engine tiers, and prompt optimization techniques to reduce step count and credit usage.
slug: optimization/cost-control
+keywords:
+ - max_steps
+ - credits
+ - code generation
+ - engine tier
+ - prompt optimization
+ - step count
+ - budget
---
Skyvern Cloud uses a **credit-based billing model**. Each plan includes a monthly credit allowance that determines how many actions you can run.
diff --git a/docs/running-automations/extract-structured-data.mdx b/docs/running-automations/extract-structured-data.mdx
index 7bae5ecf6..fd8991da4 100644
--- a/docs/running-automations/extract-structured-data.mdx
+++ b/docs/running-automations/extract-structured-data.mdx
@@ -1,7 +1,18 @@
---
title: Extract Structured Data
subtitle: Get consistent, typed output from your tasks
+description: Define JSON Schema extraction schemas for Skyvern tasks to get consistent, typed output. Build schemas for single objects or arrays of items with the interactive schema builder.
slug: running-automations/extract-structured-data
+keywords:
+ - JSON Schema
+ - extraction schema
+ - typed output
+ - schema builder
+ - array
+ - object
+ - string
+ - number
+ - boolean
---
export const FIELD_TYPES = [
diff --git a/docs/running-automations/run-a-task.mdx b/docs/running-automations/run-a-task.mdx
index ff818ff43..fe4fdf523 100644
--- a/docs/running-automations/run-a-task.mdx
+++ b/docs/running-automations/run-a-task.mdx
@@ -1,7 +1,18 @@
---
title: Run a Task
subtitle: Execute a single browser automation with natural language
+description: Create and run browser automation tasks using the Skyvern API or SDK. Configure URLs, goals, data extraction schemas, webhooks, and advanced options.
slug: running-automations/run-a-task
+keywords:
+ - run_task
+ - get_run
+ - cancel_run
+ - polling
+ - wait_for_completion
+ - webhook
+ - data extraction
+ - run status
+ - terminal state
---
A **Task** is the simplest way to automate a browser action.
diff --git a/docs/running-automations/task-parameters.mdx b/docs/running-automations/task-parameters.mdx
index 032d41e70..c67197b64 100644
--- a/docs/running-automations/task-parameters.mdx
+++ b/docs/running-automations/task-parameters.mdx
@@ -1,7 +1,20 @@
---
title: Task Parameters
subtitle: Configure how your task runs
+description: Full reference for all task parameters including prompt, URL, engine, data extraction schema, proxy location, browser sessions, TOTP, webhooks, and cost control options.
slug: running-automations/task-parameters
+keywords:
+ - prompt
+ - url
+ - engine
+ - data_extraction_schema
+ - max_steps
+ - proxy_location
+ - browser_session_id
+ - totp_identifier
+ - webhook_url
+ - error_code_mapping
+ - user_agent
---
This page covers all parameters you can pass to `run_task`.
diff --git a/docs/sdk-reference/browser-profiles.mdx b/docs/sdk-reference/browser-profiles.mdx
index fe2b6a67c..2515b2f2a 100644
--- a/docs/sdk-reference/browser-profiles.mdx
+++ b/docs/sdk-reference/browser-profiles.mdx
@@ -1,7 +1,17 @@
---
title: Browser Profiles
subtitle: Save and reuse browser state across runs
+description: Save and reuse browser state snapshots using the Skyvern Python SDK. Covers create_browser_profile(), list_browser_profiles(), get_browser_profile(), and delete_browser_profile() for persisting cookies and session data across runs.
slug: sdk-reference/browser-profiles
+keywords:
+ - create_browser_profile
+ - list_browser_profiles
+ - get_browser_profile
+ - delete_browser_profile
+ - cookies
+ - session snapshot
+ - persistent state
+ - reuse
---
A browser profile is a snapshot of browser state — cookies, local storage, session data. Create a profile from a completed run, then load it into future workflow runs to skip login and setup steps.
diff --git a/docs/sdk-reference/browser-sessions.mdx b/docs/sdk-reference/browser-sessions.mdx
index 503e41664..30398eced 100644
--- a/docs/sdk-reference/browser-sessions.mdx
+++ b/docs/sdk-reference/browser-sessions.mdx
@@ -1,7 +1,17 @@
---
title: Browser Sessions
subtitle: Maintain live browser state between API calls
+description: Create, manage, and close persistent browser sessions using the Skyvern Python SDK. Covers create_browser_session(), get_browser_session(), get_browser_sessions(), and close_browser_session() for chaining tasks in a single browser.
slug: sdk-reference/browser-sessions
+keywords:
+ - create_browser_session
+ - get_browser_session
+ - close_browser_session
+ - persistent browser
+ - session chaining
+ - cookies
+ - login state
+ - proxy
---
A browser session is a persistent browser instance that stays alive between API calls. Use sessions to chain multiple tasks in the same browser without losing cookies, local storage, or login state.
diff --git a/docs/sdk-reference/complete-reference.mdx b/docs/sdk-reference/complete-reference.mdx
index 8f6e43311..e30098f91 100644
--- a/docs/sdk-reference/complete-reference.mdx
+++ b/docs/sdk-reference/complete-reference.mdx
@@ -1,7 +1,21 @@
---
title: Complete Reference (For LLMs)
subtitle: Every method, parameter, and type in one page
+description: Complete reference for every method, parameter, and type in the Skyvern Python SDK. Includes tasks, workflows, browser sessions, browser profiles, credentials, helper methods, browser control, and error handling in a single page.
slug: sdk-reference/complete-reference
+keywords:
+ - complete reference
+ - all methods
+ - run_task
+ - run_workflow
+ - browser automation
+ - Playwright
+ - launch_cloud_browser
+ - page.act
+ - page.extract
+ - page.agent
+ - credential
+ - error handling
---
## Install and initialize
diff --git a/docs/sdk-reference/credentials.mdx b/docs/sdk-reference/credentials.mdx
index 28a15eb56..afaea7161 100644
--- a/docs/sdk-reference/credentials.mdx
+++ b/docs/sdk-reference/credentials.mdx
@@ -1,7 +1,19 @@
---
title: Credentials
subtitle: Store and manage authentication credentials securely
+description: Store and manage login credentials and TOTP secrets using the Skyvern Python SDK. Covers create_credential(), get_credentials(), get_credential(), delete_credential(), and send_totp_code() for secure authentication management.
slug: sdk-reference/credentials
+keywords:
+ - credential
+ - password
+ - TOTP
+ - 2FA
+ - authentication
+ - create_credential
+ - get_credentials
+ - delete_credential
+ - send_totp_code
+ - secret
---
Credentials let you store login information (username/password, TOTP secrets) securely in Skyvern's vault. Reference them by ID in tasks and workflows instead of passing secrets in your code.
diff --git a/docs/sdk-reference/error-handling.mdx b/docs/sdk-reference/error-handling.mdx
index 446cfb68b..70064cd69 100644
--- a/docs/sdk-reference/error-handling.mdx
+++ b/docs/sdk-reference/error-handling.mdx
@@ -1,7 +1,19 @@
---
title: Error Handling
subtitle: Handle API errors, timeouts, and configure retries
+description: Handle API errors, timeouts, and configure retries in the Skyvern Python SDK. Covers error types, exception handling, HTTP and completion timeouts, retry configuration, and run failure vs API error patterns.
slug: sdk-reference/error-handling
+keywords:
+ - BadRequestError
+ - ForbiddenError
+ - NotFoundError
+ - ConflictError
+ - UnprocessableEntityError
+ - timeout
+ - retry
+ - polling
+ - run status
+ - failure
---
The SDK raises typed exceptions for API errors. All errors extend `ApiError` and include the HTTP status code, response headers, and body.
diff --git a/docs/sdk-reference/helpers.mdx b/docs/sdk-reference/helpers.mdx
index f25dc4ddd..5c98b2d18 100644
--- a/docs/sdk-reference/helpers.mdx
+++ b/docs/sdk-reference/helpers.mdx
@@ -1,7 +1,20 @@
---
title: Helper Methods
subtitle: High-level methods for common automation patterns
+description: Use high-level helper methods in the Skyvern Python SDK for common automation patterns. Covers login(), download_files(), and upload_file() for streamlined authentication, file downloads, and file uploads.
slug: sdk-reference/helpers
+keywords:
+ - login
+ - download_files
+ - upload_file
+ - Bitwarden
+ - 1Password
+ - Azure Key Vault
+ - credential
+ - authentication
+ - file download
+ - file upload
+ - workflow
---
These methods wrap common multi-step patterns into single API calls. Under the hood, they create and run specialized workflows.
diff --git a/docs/sdk-reference/overview.mdx b/docs/sdk-reference/overview.mdx
index 1bd5f3b59..402fdb449 100644
--- a/docs/sdk-reference/overview.mdx
+++ b/docs/sdk-reference/overview.mdx
@@ -1,7 +1,19 @@
---
title: Python SDK
subtitle: Install, authenticate, and configure the Skyvern Python client
+description: Install the Skyvern Python SDK, authenticate with your API key, and start running browser automation tasks and workflows programmatically.
slug: sdk-reference/overview
+keywords:
+ - install
+ - pip
+ - api key
+ - client
+ - configuration
+ - authentication
+ - environment
+ - local mode
+ - timeout
+ - request options
---
The `skyvern` package wraps the Skyvern REST API in a typed, async Python client.
diff --git a/docs/sdk-reference/tasks.mdx b/docs/sdk-reference/tasks.mdx
index 0c96492fc..847327c85 100644
--- a/docs/sdk-reference/tasks.mdx
+++ b/docs/sdk-reference/tasks.mdx
@@ -1,7 +1,24 @@
---
title: Tasks
subtitle: Run single browser automations with natural language
+description: Create, run, and monitor browser automation tasks using the Skyvern Python SDK. Covers run_task(), get_run(), cancel_run(), get_run_timeline(), get_run_artifacts(), and task configuration options.
slug: sdk-reference/tasks
+keywords:
+ - run_task
+ - get_run
+ - cancel_run
+ - get_run_timeline
+ - get_run_artifacts
+ - retry_run_webhook
+ - data extraction
+ - polling
+ - webhook
+ - max_steps
+ - engine
+ - proxy
+ - TOTP
+ - 2FA
+ - artifact
---
A task is a single browser automation. You describe what you want in natural language — Skyvern opens a browser, navigates to the URL, and executes the instructions with AI.
diff --git a/docs/sdk-reference/workflows.mdx b/docs/sdk-reference/workflows.mdx
index c5b8f551d..a3a826641 100644
--- a/docs/sdk-reference/workflows.mdx
+++ b/docs/sdk-reference/workflows.mdx
@@ -1,7 +1,22 @@
---
title: Workflows
subtitle: Create and run multi-step browser automations
+description: Create, run, update, and manage multi-step workflow automations using the Skyvern Python SDK. Covers run_workflow(), create_workflow(), get_workflows(), update_workflow(), delete_workflow(), and workflow configuration options.
slug: sdk-reference/workflows
+keywords:
+ - run_workflow
+ - create_workflow
+ - get_workflow
+ - update_workflow
+ - delete_workflow
+ - get_workflow_versions
+ - parameter
+ - block
+ - YAML
+ - JSON
+ - template
+ - version
+ - Playwright
---
A workflow chains multiple steps (blocks) into a single automation. Workflows support loops, conditionals, data passing between steps, and code-based re-execution.
diff --git a/docs/self-hosted/browser.mdx b/docs/self-hosted/browser.mdx
index d6b8ee1ca..5d65fe2dd 100644
--- a/docs/self-hosted/browser.mdx
+++ b/docs/self-hosted/browser.mdx
@@ -1,7 +1,17 @@
---
title: Browser Configuration
subtitle: Configure browser modes, display settings, and external Chrome connections
+description: Configure Skyvern's browser modes including headful, headless, local Chrome, and CDP connect. Set display resolution, viewport size, and connect to external Chrome instances for self-hosted deployments.
slug: self-hosted/browser
+keywords:
+ - headless
+ - headful
+ - CDP
+ - Chrome DevTools Protocol
+ - display resolution
+ - viewport
+ - external Chrome
+ - BROWSER_TYPE
---
Skyvern uses Playwright with Chromium to execute browser automations.
diff --git a/docs/self-hosted/docker.mdx b/docs/self-hosted/docker.mdx
index 9461fc4d5..3e5935451 100644
--- a/docs/self-hosted/docker.mdx
+++ b/docs/self-hosted/docker.mdx
@@ -1,7 +1,16 @@
---
title: Docker Setup
subtitle: Get Skyvern running in 10 minutes with Docker Compose
+description: Deploy Skyvern using Docker Compose with the API server, embedded browser, PostgreSQL database, and web UI. Includes LLM provider configuration and first-run setup.
slug: self-hosted/docker
+keywords:
+ - Docker Compose
+ - docker-compose.yml
+ - PostgreSQL
+ - environment variables
+ - first-run
+ - setup
+ - .env
---
This guide walks you through deploying Skyvern using Docker Compose. By the end, you'll have a working Skyvern instance with the API server, browser, database, and web UI running on your machine.
diff --git a/docs/self-hosted/kubernetes.mdx b/docs/self-hosted/kubernetes.mdx
index ca20c3b1c..6ea8f02bd 100644
--- a/docs/self-hosted/kubernetes.mdx
+++ b/docs/self-hosted/kubernetes.mdx
@@ -1,7 +1,17 @@
---
title: Kubernetes Deployment
subtitle: Deploy Skyvern at scale with Kubernetes manifests
+description: Deploy Skyvern on Kubernetes for production environments with horizontal scaling and high availability. Includes manifests for the API server, frontend, PostgreSQL, and ingress configuration.
slug: self-hosted/kubernetes
+keywords:
+ - Kubernetes
+ - Helm
+ - manifests
+ - horizontal scaling
+ - high availability
+ - ingress
+ - PostgreSQL
+ - production
---
This guide walks through deploying Skyvern on Kubernetes for production environments. Use this when you need horizontal scaling, high availability, or integration with existing Kubernetes infrastructure.
diff --git a/docs/self-hosted/llm-configuration.mdx b/docs/self-hosted/llm-configuration.mdx
index 95a5fbab8..7f9e71ab8 100644
--- a/docs/self-hosted/llm-configuration.mdx
+++ b/docs/self-hosted/llm-configuration.mdx
@@ -1,7 +1,18 @@
---
title: LLM Configuration
subtitle: Connect your preferred language model provider
+description: Configure LLM providers for self-hosted Skyvern including OpenAI, Anthropic, Azure OpenAI, Google Gemini, AWS Bedrock, Ollama, and OpenAI-compatible endpoints via LiteLLM.
slug: self-hosted/llm-configuration
+keywords:
+ - OpenAI
+ - Anthropic
+ - Azure OpenAI
+ - Google Gemini
+ - AWS Bedrock
+ - Ollama
+ - LiteLLM
+ - LLM_KEY
+ - SECONDARY_LLM_KEY
---
Skyvern uses LLMs to analyze screenshots and decide what actions to take. You'll need to configure at least one LLM provider before running tasks.
diff --git a/docs/self-hosted/overview.mdx b/docs/self-hosted/overview.mdx
index 047c3e111..cf37cd92e 100644
--- a/docs/self-hosted/overview.mdx
+++ b/docs/self-hosted/overview.mdx
@@ -1,7 +1,16 @@
---
title: Self-Hosted Overview
subtitle: Run Skyvern on your own infrastructure
+description: Deploy Skyvern on your own infrastructure with Docker or Kubernetes. Configure LLM providers, browsers, proxies, and storage.
slug: self-hosted/overview
+keywords:
+ - self-hosted
+ - on-premise
+ - infrastructure
+ - deployment
+ - architecture
+ - components
+ - requirements
---
Self-hosted Skyvern runs entirely on your infrastructure: your servers, your browsers, your LLM API keys. This guide helps you decide if self-hosting fits your needs and which deployment method to choose.
diff --git a/docs/self-hosted/proxy.mdx b/docs/self-hosted/proxy.mdx
index 3bc845a12..e122cf155 100644
--- a/docs/self-hosted/proxy.mdx
+++ b/docs/self-hosted/proxy.mdx
@@ -1,7 +1,16 @@
---
title: Proxy Setup
subtitle: Configure proxies to avoid bot detection
+description: Configure residential, ISP, or datacenter proxies for self-hosted Skyvern deployments to avoid bot detection, bypass geo-restrictions, and prevent rate limiting on target websites.
slug: self-hosted/proxy
+keywords:
+ - residential proxy
+ - ISP proxy
+ - datacenter proxy
+ - rate limiting
+ - geo-restriction
+ - PROXY_URL
+ - configuration
---
Many websites block requests from datacenter IPs or detect automated browser patterns. Skyvern Cloud includes managed residential proxies that handle this automatically. Self-hosted deployments require you to configure your own proxy provider.
diff --git a/docs/self-hosted/storage.mdx b/docs/self-hosted/storage.mdx
index f3cc7dca1..013ce5c21 100644
--- a/docs/self-hosted/storage.mdx
+++ b/docs/self-hosted/storage.mdx
@@ -1,7 +1,16 @@
---
title: Storage Configuration
subtitle: Configure where Skyvern stores artifacts and recordings
+description: Configure Skyvern artifact storage using local filesystem, AWS S3, or Azure Blob Storage. Covers screenshots, browser recordings, HAR files, and extracted data storage for self-hosted deployments.
slug: self-hosted/storage
+keywords:
+ - AWS S3
+ - Azure Blob Storage
+ - local filesystem
+ - artifact storage
+ - ARTIFACT_STORAGE_TYPE
+ - bucket
+ - container
---
Skyvern generates several types of artifacts during task execution: screenshots, browser recordings, HAR files, and extracted data. By default, these are stored on the local filesystem. For production deployments, you can configure S3 or Azure Blob Storage.
diff --git a/docs/skill.md b/docs/skill.md
new file mode 100644
index 000000000..6ae1b0d12
--- /dev/null
+++ b/docs/skill.md
@@ -0,0 +1,179 @@
+---
+name: skyvern
+description: Automate any website with AI-powered browser automation. Use when the user needs to interact with a website — filling forms, extracting data, downloading files, logging in, or running multi-step workflows. Skyvern navigates sites it has never seen before using LLMs and computer vision. Integrates via Python SDK, TypeScript SDK, REST API, MCP server, or CLI.
+license: AGPL-3.0
+compatibility: Requires a Skyvern Cloud API key (https://app.skyvern.com) or a self-hosted Skyvern instance. Python SDK requires Python 3.11+. TypeScript SDK requires Node.js 18+. MCP server works with Claude Code, Claude Desktop, Cursor, Windsurf, and VS Code.
+metadata:
+ author: skyvern-docs
+ version: "1.0"
+ docs: https://skyvern.com/docs
+ github: https://github.com/Skyvern-AI/skyvern
+---
+
+# Skyvern — AI Browser Automation
+
+Skyvern automates browser-based workflows using LLMs and computer vision. It navigates websites it has never seen before — filling forms, extracting data, and completing multi-step tasks — via a simple API.
+
+## When to use Skyvern
+
+- The user needs to **interact with a website** programmatically (fill forms, click buttons, navigate pages)
+- The user needs to **extract structured data** from a website (scrape prices, addresses, table rows)
+- The user needs to **download files** from a web portal (invoices, reports, statements)
+- The user needs to **log in** to a website and perform actions behind authentication
+- The user needs to **automate a multi-step workflow** across one or more websites
+- The user needs to **run browser automation from an AI assistant** (Claude, Cursor, Windsurf)
+
+## Capabilities
+
+### Run a single task
+
+Execute a one-shot browser automation with natural language instructions.
+
+**Inputs:**
+- `prompt` (required): Natural language description of what to do
+- `url` (required): Starting page URL
+- `data_extraction_schema` (optional): JSON schema for structured output
+- `proxy_location` (optional): Country code for geo-routing (e.g., `US`, `DE`)
+
+**Python SDK:**
+```python
+from skyvern import Skyvern
+
+client = Skyvern(api_key="YOUR_API_KEY")
+result = await client.run_task(
+ prompt="Get the title of the top post on Hacker News",
+ url="https://news.ycombinator.com",
+)
+```
+
+**TypeScript SDK:**
+```typescript
+import Skyvern from "@skyvern/client";
+
+const client = new Skyvern({ apiKey: "YOUR_API_KEY" });
+const result = await client.runTask({
+ prompt: "Get the title of the top post on Hacker News",
+ url: "https://news.ycombinator.com",
+});
+```
+
+**REST API:**
+```bash
+curl -X POST https://api.skyvern.com/api/v2/run \
+ -H "x-api-key: YOUR_API_KEY" \
+ -H "Content-Type: application/json" \
+ -d '{"prompt": "Get the top post title", "url": "https://news.ycombinator.com"}'
+```
+
+### Extract structured data
+
+Define a JSON schema to get consistent, typed output from any page.
+
+```python
+result = await client.run_task(
+ prompt="Extract the top 3 posts",
+ url="https://news.ycombinator.com",
+ data_extraction_schema={
+ "type": "object",
+ "properties": {
+ "posts": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "title": {"type": "string"},
+ "url": {"type": "string"},
+ "points": {"type": "integer"}
+ }
+ }
+ }
+ }
+ },
+)
+```
+
+### Build multi-step workflows
+
+Chain task blocks, loops, conditionals, data extraction, and file operations into reusable automations.
+
+**Block types:** NavigationBlock, ActionBlock, ExtractBlock, LoopBlock, TextPromptBlock, LoginBlock, FileDownloadBlock, FileParseBlock, UploadBlock, EmailBlock, WebhookBlock, ValidationBlock, WaitBlock, CodeBlock, ForLoopBlock, FileURLParsingBlock, DownloadToS3Block, SendEmailBlock.
+
+```python
+workflow = await client.create_workflow(
+ title="Invoice Downloader",
+ blocks=[...], # See workflow blocks reference
+)
+run = await client.run_workflow(workflow_id=workflow.workflow_id)
+```
+
+### Manage browser sessions
+
+Persist a live browser across multiple tasks — maintain login state, cookies, and page context.
+
+```python
+session = await client.create_session()
+# Run multiple tasks on the same browser
+await client.run_task(prompt="Log in", url="https://example.com", browser_session_id=session.browser_session_id)
+await client.run_task(prompt="Download invoice", url="https://example.com/billing", browser_session_id=session.browser_session_id)
+await client.close_session(session.browser_session_id)
+```
+
+### Handle authentication
+
+Store passwords, TOTP/2FA secrets, and credit cards securely. Skyvern auto-fills login forms and generates 2FA codes during automation.
+
+**Supported credential providers:** Skyvern vault (built-in), Bitwarden, 1Password, Azure Key Vault.
+
+### Use via MCP server
+
+Connect AI assistants directly to browser automation. The MCP server exposes 75+ tools.
+
+**Install for Claude Code:**
+```bash
+claude mcp add skyvern-cloud -- npx @anthropic-ai/skyvern-mcp@latest --skyvern-api-key YOUR_API_KEY
+```
+
+**Install for Cursor/VS Code:** Add to MCP config:
+```json
+{
+ "mcpServers": {
+ "skyvern": {
+ "command": "npx",
+ "args": ["@anthropic-ai/skyvern-mcp@latest", "--skyvern-api-key", "YOUR_API_KEY"]
+ }
+ }
+}
+```
+
+### Use via CLI
+
+```bash
+pip install skyvern
+export SKYVERN_API_KEY="YOUR_KEY"
+
+skyvern browser session create # Start a cloud browser
+skyvern browser act "Click the login button" # Natural language action
+skyvern browser extract '{"title": "string"}' # Extract structured data
+skyvern browser screenshot # Capture screenshot
+skyvern task run --prompt "..." --url "..." # Run a task
+skyvern workflow run --id wf_xxx # Run a workflow
+```
+
+## Constraints
+
+- Tasks run in cloud browsers managed by Skyvern (or self-hosted browsers). They do not run in the user's local browser by default.
+- Each task step consumes credits. Set `max_steps` to control costs.
+- Browser automation takes 30-120 seconds per task depending on complexity.
+- Skyvern works best with natural language prompts that describe the goal, not low-level click instructions.
+- For websites that require login, credentials must be stored via the credentials API before running tasks.
+- Self-hosted deployments require Docker and a PostgreSQL database.
+
+## Key references
+
+- [API Quickstart](https://skyvern.com/docs/getting-started/quickstart.md): First task in 5 minutes
+- [Python SDK Reference](https://skyvern.com/docs/sdk-reference/complete-reference.md): All methods and types
+- [TypeScript SDK Reference](https://skyvern.com/docs/ts-sdk-reference/complete-reference.md): All methods and types
+- [MCP Server Setup](https://skyvern.com/docs/going-to-production/mcp.md): Connect AI assistants
+- [Workflow Blocks Reference](https://skyvern.com/docs/multi-step-automations/workflow-blocks-reference.md): All block types
+- [Task Parameters](https://skyvern.com/docs/running-automations/task-parameters.md): All task options
+- [Full documentation index](https://skyvern.com/docs/llms.txt): Complete page directory
diff --git a/docs/ts-sdk-reference/browser-automation.mdx b/docs/ts-sdk-reference/browser-automation.mdx
index 23c750785..a995e9a01 100644
--- a/docs/ts-sdk-reference/browser-automation.mdx
+++ b/docs/ts-sdk-reference/browser-automation.mdx
@@ -1,7 +1,23 @@
---
title: Browser Automation
subtitle: Control cloud browsers with Playwright + AI
+description: Use the Skyvern TypeScript SDK to launch cloud browsers with Playwright integration, run AI-powered tasks, and use enhanced click, fill, and selectOption methods that fall back to natural language selectors.
slug: ts-sdk-reference/browser-automation
+keywords:
+ - Playwright
+ - launchCloudBrowser
+ - useCloudBrowser
+ - connectToBrowserOverCdp
+ - act
+ - extract
+ - validate
+ - prompt
+ - click
+ - fill
+ - selectOption
+ - AI fallback
+ - cloud browser
+ - agent
---
The TypeScript SDK extends Playwright with AI-powered browser automation. Launch a cloud browser, get a page that works like a normal Playwright `Page`, then use `.agent` for full-task AI execution or AI-enhanced versions of `click`, `fill`, and `selectOption` that fall back to natural language when selectors fail.
diff --git a/docs/ts-sdk-reference/browser-profiles.mdx b/docs/ts-sdk-reference/browser-profiles.mdx
index a4d6cd467..222049241 100644
--- a/docs/ts-sdk-reference/browser-profiles.mdx
+++ b/docs/ts-sdk-reference/browser-profiles.mdx
@@ -1,7 +1,17 @@
---
title: Browser Profiles
subtitle: Save and reuse browser state across runs
+description: Use the Skyvern TypeScript SDK to create, list, and delete browser profiles that snapshot cookies and session data for reuse across workflow runs.
slug: ts-sdk-reference/browser-profiles
+keywords:
+ - createBrowserProfile
+ - listBrowserProfiles
+ - getBrowserProfile
+ - deleteBrowserProfile
+ - cookies
+ - session snapshot
+ - persistent state
+ - reuse
---
A browser profile is a snapshot of browser state — cookies, local storage, session data. Create a profile from a completed run, then load it into future workflow runs to skip login and setup steps.
diff --git a/docs/ts-sdk-reference/browser-sessions.mdx b/docs/ts-sdk-reference/browser-sessions.mdx
index fcae95ef8..5740d41fd 100644
--- a/docs/ts-sdk-reference/browser-sessions.mdx
+++ b/docs/ts-sdk-reference/browser-sessions.mdx
@@ -1,7 +1,17 @@
---
title: Browser Sessions
subtitle: Maintain live browser state between API calls
+description: Use the Skyvern TypeScript SDK to create, retrieve, and close persistent browser sessions that preserve cookies and login state across multiple tasks.
slug: ts-sdk-reference/browser-sessions
+keywords:
+ - createBrowserSession
+ - getBrowserSession
+ - closeBrowserSession
+ - persistent browser
+ - session chaining
+ - cookies
+ - login state
+ - proxy
---
A browser session is a persistent browser instance that stays alive between API calls. Use sessions to chain multiple tasks in the same browser without losing cookies, local storage, or login state.
diff --git a/docs/ts-sdk-reference/complete-reference.mdx b/docs/ts-sdk-reference/complete-reference.mdx
index ae02692a7..5831db259 100644
--- a/docs/ts-sdk-reference/complete-reference.mdx
+++ b/docs/ts-sdk-reference/complete-reference.mdx
@@ -1,7 +1,21 @@
---
title: Complete Reference (For LLMs)
subtitle: Every method, parameter, and type in one page
+description: Complete TypeScript SDK reference covering every Skyvern client method, parameter, return type, and error class on a single page for quick lookup.
slug: ts-sdk-reference/complete-reference
+keywords:
+ - complete reference
+ - all methods
+ - runTask
+ - runWorkflow
+ - browser automation
+ - Playwright
+ - launchCloudBrowser
+ - page.act
+ - page.extract
+ - page.agent
+ - credential
+ - error handling
---
## Install and initialize
diff --git a/docs/ts-sdk-reference/credentials.mdx b/docs/ts-sdk-reference/credentials.mdx
index 52b02dcbe..a215f2cad 100644
--- a/docs/ts-sdk-reference/credentials.mdx
+++ b/docs/ts-sdk-reference/credentials.mdx
@@ -1,7 +1,19 @@
---
title: Credentials
subtitle: Store and manage authentication credentials securely
+description: Use the Skyvern TypeScript SDK to create, list, retrieve, and delete credentials, and send TOTP codes for two-factor authentication during automated runs.
slug: ts-sdk-reference/credentials
+keywords:
+ - credential
+ - password
+ - TOTP
+ - 2FA
+ - authentication
+ - createCredential
+ - getCredentials
+ - deleteCredential
+ - sendTotpCode
+ - secret
---
Credentials let you store login information (username/password, TOTP secrets) securely in Skyvern's vault. Reference them by ID in tasks and workflows instead of passing secrets in your code.
diff --git a/docs/ts-sdk-reference/error-handling.mdx b/docs/ts-sdk-reference/error-handling.mdx
index eb5d713f7..1f520a13c 100644
--- a/docs/ts-sdk-reference/error-handling.mdx
+++ b/docs/ts-sdk-reference/error-handling.mdx
@@ -1,7 +1,19 @@
---
title: Error Handling
subtitle: Handle API errors, timeouts, and configure retries
+description: Handle typed API errors, timeouts, and configure automatic retries in the Skyvern TypeScript SDK using SkyvernError, status-specific exceptions, and the built-in retry mechanism.
slug: ts-sdk-reference/error-handling
+keywords:
+ - BadRequestError
+ - ForbiddenError
+ - NotFoundError
+ - SkyvernTimeoutError
+ - timeout
+ - retry
+ - AbortSignal
+ - polling
+ - run status
+ - failure
---
The SDK raises typed exceptions for API errors. All errors extend `SkyvernError` and include the HTTP status code, response body, and raw response.
diff --git a/docs/ts-sdk-reference/helpers.mdx b/docs/ts-sdk-reference/helpers.mdx
index c6d3e9623..a88042f11 100644
--- a/docs/ts-sdk-reference/helpers.mdx
+++ b/docs/ts-sdk-reference/helpers.mdx
@@ -1,7 +1,19 @@
---
title: Helper Methods
subtitle: High-level methods for common automation patterns
+description: Use the Skyvern TypeScript SDK helper methods for common patterns like automated login with stored credentials, file downloads, and multi-provider authentication via Bitwarden, 1Password, and Azure Key Vault.
slug: ts-sdk-reference/helpers
+keywords:
+ - login
+ - downloadFiles
+ - uploadFile
+ - Bitwarden
+ - 1Password
+ - Azure Key Vault
+ - credential
+ - authentication
+ - file download
+ - file upload
---
These methods wrap common multi-step patterns into single API calls. Under the hood, they create and run specialized workflows.
diff --git a/docs/ts-sdk-reference/overview.mdx b/docs/ts-sdk-reference/overview.mdx
index 6285190e7..39c5721eb 100644
--- a/docs/ts-sdk-reference/overview.mdx
+++ b/docs/ts-sdk-reference/overview.mdx
@@ -1,7 +1,19 @@
---
title: TypeScript SDK
subtitle: Install, authenticate, and configure the Skyvern TypeScript client
+description: Install the Skyvern TypeScript SDK, authenticate with your API key, and start running browser automation tasks and workflows programmatically.
slug: ts-sdk-reference/overview
+keywords:
+ - install
+ - npm
+ - api key
+ - client
+ - configuration
+ - authentication
+ - environment
+ - timeout
+ - maxRetries
+ - abortSignal
---
The `@skyvern/client` package wraps the Skyvern REST API in a typed TypeScript client with built-in browser automation via Playwright.
diff --git a/docs/ts-sdk-reference/tasks.mdx b/docs/ts-sdk-reference/tasks.mdx
index 8185d2823..40030c5d5 100644
--- a/docs/ts-sdk-reference/tasks.mdx
+++ b/docs/ts-sdk-reference/tasks.mdx
@@ -1,7 +1,24 @@
---
title: Tasks
subtitle: Run single browser automations with natural language
+description: Use the Skyvern TypeScript SDK to run, monitor, cancel, and retrieve browser automation tasks with the runTask, getRun, and cancelRun methods.
slug: ts-sdk-reference/tasks
+keywords:
+ - runTask
+ - getRun
+ - cancelRun
+ - getRunTimeline
+ - getRunArtifacts
+ - retryRunWebhook
+ - data extraction
+ - polling
+ - webhook
+ - maxSteps
+ - engine
+ - proxy
+ - TOTP
+ - 2FA
+ - artifact
---
A task is a single browser automation. You describe what you want in natural language — Skyvern opens a browser, navigates to the URL, and executes the instructions with AI.
diff --git a/docs/ts-sdk-reference/workflows.mdx b/docs/ts-sdk-reference/workflows.mdx
index e486a051f..992667205 100644
--- a/docs/ts-sdk-reference/workflows.mdx
+++ b/docs/ts-sdk-reference/workflows.mdx
@@ -1,7 +1,21 @@
---
title: Workflows
subtitle: Create and run multi-step browser automations
+description: Use the Skyvern TypeScript SDK to execute, monitor, and manage multi-step workflows with the runWorkflow method, including parameter passing and browser session reuse.
slug: ts-sdk-reference/workflows
+keywords:
+ - runWorkflow
+ - createWorkflow
+ - getWorkflow
+ - updateWorkflow
+ - deleteWorkflow
+ - getWorkflowVersions
+ - parameter
+ - block
+ - YAML
+ - JSON
+ - template
+ - version
---
A workflow chains multiple steps (blocks) into a single automation. Workflows support loops, conditionals, data passing between steps, and code-based re-execution.