SKskyvern-ai
Agents

Get all agents

Changed on

Get all workflows with the latest version for the organization.

Search semantics:

  • If search_key is provided, its value is used as a unified search term for workflows.title, folders.title, and workflow parameter metadata (key, description, and default_value for WorkflowParameterModel).
  • Falls back to deprecated title (title-only search) if search_key is not provided.
  • Parameter metadata search excludes soft-deleted parameter rows across all parameter tables.
get/v1/agents

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/agents
  • Auth
    API key in header x-api-key

Query parameters

pageinteger
page_sizeinteger
only_saved_tasksboolean
only_workflowsboolean
only_templatesboolean
search_keystring nullable

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
titlestring

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

folder_idstring nullable

Filter workflows by folder ID

statusWorkflowStatus[] nullable
tagsstring[] nullable

Filter by tags. Each term is a label (production), a group (env:*), or a group:label (env:prod). Repeat the param or comma-separate (?tags=env:prod,env:staging). AND across distinct terms, OR within a group's labels (?tags=customer:acme,env:prod,env:staging -> customer=acme AND env in (prod, staging)). A label term matches the value across any/no group. Matches current tag values only. Not supported with template=true.

templateboolean

Response

Successful Response

workflow_idstring required
organization_idstring required
titlestring required
workflow_permanent_idstring required
versioninteger required
is_saved_taskboolean required
is_templateboolean
descriptionstring nullable
webhook_callback_urlstring nullable
totp_verification_urlstring nullable
totp_identifierstring nullable
persist_browser_sessionboolean
reuse_browser_sessionboolean
mask_secretsboolean
pin_saved_session_ipboolean
browser_profile_idstring nullable
browser_profile_keystring nullable
modelobject nullable
status'published' | 'draft' | 'auto_generated' | 'importing' | 'import_failed'
max_screenshot_scrollsinteger nullable
max_elapsed_time_minutesinteger nullable
extra_http_headersobject nullable
cdp_connect_headersobject nullable
run_withstring
browser_typestring nullable
ai_fallbackboolean
cache_keystring nullable
adaptive_cachingboolean
enable_self_healingboolean
code_versioninteger nullable
generate_script_on_terminalboolean
run_sequentiallyboolean nullable
sequential_keystring nullable
folder_idstring nullable
import_errorstring nullable
created_bystring nullable
edited_bystring nullable
build_source'ui' | 'copilot' | 'mcp' | 'cli' | 'api' | 'internal'

Which surface wrote a workflow version.

  • ui: the Skyvern app
  • copilot: the workflow copilot
  • mcp: a first-party MCP client
  • cli: the Skyvern CLI
  • api: any other API or SDK caller
  • internal: a workflow Skyvern creates for its own runs (task v2, login, credential tests)
copilot_authoredboolean
effective_default_engine'skyvern-1.0' | 'skyvern-2.0' | 'skyvern-3.0' | 'openai-cua' | 'anthropic-cua' | 'ui-tars' | 'yutori-navigator'
original_created_bystring nullable

Who created the agent's first version. Populated by the list endpoint only.

original_created_atstring date-time nullable

When the agent's first version was created. Populated by the list endpoint only.

created_atstring date-time required
modified_atstring date-time required
deleted_atstring date-time nullable
agent_idstring required

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

Changes

  • af198ec3f005Revision changes
    • breaking

      added to the /// response property oneOf list for the response status

    • breaking

      added to the ////// response property oneOf list for the response status

    • breaking

      added to the ///////// response property oneOf list for the response status

    • breaking

      added to the ////// response property oneOf list for the response status

    • info

      added powerbi_query discriminator mapping keys to the /// response property for the response status

    • info

      added powerbi_query discriminator mapping keys to the ////// response property for the response status

    • info

      added powerbi_query discriminator mapping keys to the ///////// response property for the response status

    • info

      added powerbi_query discriminator mapping keys to the ////// response property for the response status

  • c0cb7ae29c1fRevision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //////// to the response with the status