Get an agent by id

curl --request GET \
  --url https://api.skyvern.com/v1/agents/{workflow_permanent_id}

const options = {method: 'GET'};

fetch('https://api.skyvern.com/v1/agents/{workflow_permanent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skyvern.com/v1/agents/{workflow_permanent_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skyvern.com/v1/agents/{workflow_permanent_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.skyvern.com/v1/agents/{workflow_permanent_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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_parameter_type": "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": {},
    "retry_policy": {
      "retry_on": [
        {
          "status": "completed",
          "error_codes": [
            "<string>"
          ]
        }
      ],
      "max_retries": 1,
      "delay_seconds": 0,
      "webhook_on_retry": "final_only"
    },
    "workflow_system_prompt": "<string>",
    "completion_contract": {},
    "browser_settings": {
      "timezone_id": "America/New_York"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "agent_id": "<string>",
  "is_template": false,
  "description": "<string>",
  "proxy_location": "RESIDENTIAL",
  "webhook_callback_url": "<string>",
  "totp_verification_url": "<string>",
  "totp_identifier": "<string>",
  "persist_browser_session": false,
  "reuse_browser_session": false,
  "mask_secrets": false,
  "pin_saved_session_ip": false,
  "browser_profile_id": "<string>",
  "browser_profile_key": "<string>",
  "model": {},
  "status": "published",
  "max_screenshot_scrolls": 123,
  "max_elapsed_time_minutes": 123,
  "extra_http_headers": {},
  "cdp_connect_headers": {},
  "run_with": "agent",
  "browser_type": "<string>",
  "ai_fallback": true,
  "cache_key": "<string>",
  "adaptive_caching": false,
  "enable_self_healing": 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>",
  "copilot_authored": false,
  "effective_default_engine": "skyvern-1.0",
  "original_created_by": "<string>",
  "original_created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

agents

{workflow_permanent_id}

Get an agent by id

curl --request GET \
  --url https://api.skyvern.com/v1/agents/{workflow_permanent_id}

const options = {method: 'GET'};

fetch('https://api.skyvern.com/v1/agents/{workflow_permanent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skyvern.com/v1/agents/{workflow_permanent_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skyvern.com/v1/agents/{workflow_permanent_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.skyvern.com/v1/agents/{workflow_permanent_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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_parameter_type": "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": {},
    "retry_policy": {
      "retry_on": [
        {
          "status": "completed",
          "error_codes": [
            "<string>"
          ]
        }
      ],
      "max_retries": 1,
      "delay_seconds": 0,
      "webhook_on_retry": "final_only"
    },
    "workflow_system_prompt": "<string>",
    "completion_contract": {},
    "browser_settings": {
      "timezone_id": "America/New_York"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "agent_id": "<string>",
  "is_template": false,
  "description": "<string>",
  "proxy_location": "RESIDENTIAL",
  "webhook_callback_url": "<string>",
  "totp_verification_url": "<string>",
  "totp_identifier": "<string>",
  "persist_browser_session": false,
  "reuse_browser_session": false,
  "mask_secrets": false,
  "pin_saved_session_ip": false,
  "browser_profile_id": "<string>",
  "browser_profile_key": "<string>",
  "model": {},
  "status": "published",
  "max_screenshot_scrolls": 123,
  "max_elapsed_time_minutes": 123,
  "extra_http_headers": {},
  "cdp_connect_headers": {},
  "run_with": "agent",
  "browser_type": "<string>",
  "ai_fallback": true,
  "cache_key": "<string>",
  "adaptive_caching": false,
  "enable_self_healing": 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>",
  "copilot_authored": false,
  "effective_default_engine": "skyvern-1.0",
  "original_created_by": "<string>",
  "original_created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-api-key

string | null

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

Path Parameters

workflow_permanent_id

string

required

Query Parameters

version

integer | null

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

Show child attributes

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

reuse_browser_session

boolean

default:false

mask_secrets

boolean

default:false

pin_saved_session_ip

boolean

default:false

browser_profile_id

string | null

browser_profile_key

string | null

model

Model · object | null

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 | null

Show child attributes

cdp_connect_headers

Cdp Connect Headers · object | null

Show child attributes

run_with

string

default:agent

browser_type

string | null

ai_fallback

boolean

default:true

cache_key

string | null

adaptive_caching

boolean

default:false

enable_self_healing

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

copilot_authored

boolean

default:false

effective_default_engine

enum<string> | null

The engine a task block with no engine set runs on in this agent, or null when engine routing decides it. Populated by the detail endpoint only.

Available options:

skyvern-1.0,

skyvern-2.0,

skyvern-3.0,

openai-cua,

anthropic-cua,

ui-tars,

yutori-navigator

original_created_by

string | null

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

original_created_at

string<date-time> | null

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

deleted_at

string<date-time> | null

Agents

Runs

Folders

Server

Artifacts

Files

Browser Profiles

Browser Sessions

Credentials

Schedules

Recipes

Get an agent by id

Headers

Path Parameters

Query Parameters

Response