Skip to main content
GET
/
v1
/
agents
Get all agents
curl --request GET \
  --url https://api.skyvern.com/v1/agents
[
  {
    "workflow_id": "<string>",
    "organization_id": "<string>",
    "title": "<string>",
    "workflow_permanent_id": "<string>",
    "version": 123,
    "is_saved_task": true,
    "workflow_definition": {
      "parameters": [
        {
          "key": "<string>",
          "workflow_parameter_id": "<string>",
          "workflow_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "parameter_type": "workflow",
          "description": "<string>",
          "default_value": "<string>",
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "blocks": [
        {
          "label": "<string>",
          "output_parameter": {
            "key": "<string>",
            "output_parameter_id": "<string>",
            "workflow_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "parameter_type": "output",
            "description": "<string>",
            "deleted_at": "2023-11-07T05:31:56Z"
          },
          "next_block_label": "<string>",
          "block_type": "conditional",
          "continue_on_failure": false,
          "model": {},
          "disable_cache": false,
          "ignore_workflow_system_prompt": false,
          "next_loop_on_failure": false,
          "branch_conditions": [
            {
              "id": "<string>",
              "criteria": {
                "expression": "<string>",
                "criteria_type": "jinja2_template",
                "description": "<string>"
              },
              "next_block_label": "<string>",
              "description": "<string>",
              "is_default": false
            }
          ]
        }
      ],
      "version": 1,
      "finally_block_label": "<string>",
      "error_code_mapping": {},
      "workflow_system_prompt": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "agent_id": "<string>",
    "is_template": false,
    "description": "<string>",
    "webhook_callback_url": "<string>",
    "totp_verification_url": "<string>",
    "totp_identifier": "<string>",
    "persist_browser_session": false,
    "browser_profile_id": "<string>",
    "model": {},
    "status": "published",
    "max_screenshot_scrolls": 123,
    "max_elapsed_time_minutes": 123,
    "extra_http_headers": {},
    "cdp_connect_headers": {},
    "run_with": "agent",
    "ai_fallback": true,
    "cache_key": "<string>",
    "adaptive_caching": false,
    "code_version": 123,
    "generate_script_on_terminal": false,
    "run_sequentially": true,
    "sequential_key": "<string>",
    "folder_id": "<string>",
    "import_error": "<string>",
    "created_by": "<string>",
    "edited_by": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
]

Headers

​
x-api-key
string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:10
Required range: x >= 1
​
only_saved_tasks
boolean
default:false
​
only_workflows
boolean
default:false
​
only_templates
boolean
default:false
​
search_key
string | null

Case-insensitive substring search across: workflow title, folder name, and parameter metadata (key, description, default_value). A workflow is returned if any of these fields match. Soft-deleted parameter definitions are excluded. Takes precedence over the deprecated title parameter.

Example:

"my_workflow"

​
title
string
default:""
deprecated

Deprecated: use search_key instead. Falls back to title-only search if search_key is not provided.

​
folder_id
string | null

Filter workflows by folder ID

​
status
enum<string>[] | null
Available options:
published,
draft,
auto_generated,
importing,
import_failed
​
tags
string[] | null

Filter by tags as key:value pairs. Repeat the param or comma-separate (?tags=env:prod,env:staging). AND across distinct keys, OR within a key (?tags=customer:acme,env:prod,env:staging -> customer=acme AND env in (prod, staging)). Matches current tag values only. Not supported with template=true.

Maximum array length: 20
Example:

"env:prod"

​
template
boolean
default:false

Response

Successful Response

​
workflow_id
string
required
​
organization_id
string
required
​
title
string
required
​
workflow_permanent_id
string
required
​
version
integer
required
​
is_saved_task
boolean
required
​
workflow_definition
WorkflowDefinition · object
required
​
created_at
string<date-time>
required
​
modified_at
string<date-time>
required
​
agent_id
string
required
read-only

Alias of workflow_permanent_id — the stable agent identifier (starts with wpid_).

​
is_template
boolean
default:false
​
description
string | null
​
proxy_location
Available options:
RESIDENTIAL,
US-CA,
US-NY,
US-TX,
US-FL,
US-WA,
RESIDENTIAL_ES,
RESIDENTIAL_IE,
RESIDENTIAL_GB,
RESIDENTIAL_IN,
RESIDENTIAL_JP,
RESIDENTIAL_FR,
RESIDENTIAL_DE,
RESIDENTIAL_NZ,
RESIDENTIAL_ZA,
RESIDENTIAL_AR,
RESIDENTIAL_AU,
RESIDENTIAL_BR,
RESIDENTIAL_TR,
RESIDENTIAL_CA,
RESIDENTIAL_MX,
RESIDENTIAL_IT,
RESIDENTIAL_NL,
RESIDENTIAL_PH,
RESIDENTIAL_KR,
RESIDENTIAL_SA,
RESIDENTIAL_ISP,
NONE
​
webhook_callback_url
string | null
​
totp_verification_url
string | null
​
totp_identifier
string | null
​
persist_browser_session
boolean
default:false
​
browser_profile_id
string | null
​
model
Model · object
​
status
enum<string>
default:published
Available options:
published,
draft,
auto_generated,
importing,
import_failed
​
max_screenshot_scrolls
integer | null
​
max_elapsed_time_minutes
integer | null
​
extra_http_headers
Extra Http Headers · object
​
cdp_connect_headers
Cdp Connect Headers · object
​
run_with
string
default:agent
​
ai_fallback
boolean
default:true
​
cache_key
string | null
​
adaptive_caching
boolean
default:false
​
code_version
integer | null
​
generate_script_on_terminal
boolean
default:false
​
run_sequentially
boolean | null
​
sequential_key
string | null
​
folder_id
string | null
​
import_error
string | null
​
created_by
string | null
​
edited_by
string | null
​
deleted_at
string<date-time> | null