Skyvern: Get an agent by id

Skyvern agents.getWorkflow: arguments, response, policy and SDK examples.

Operation skyvern.get_workflow_v1_workflows_workflow_permanent_id_get

Provider route: GET /v1/agents/{workflow_permanent_id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["agents"]["getWorkflow"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.agents.getWorkflow(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.agents.get_workflow(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.workflow_permanent_id`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.version`	JSON	Optional
`query.version (anyOf 1)`	integer	Alternative
`query.version (anyOf 2)`	null	Alternative
`query.template`	boolean	Optional	Default: false

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Update an agent — response body

Referenced models: Update an agent — response body

Schemas

55 more schemas are linked from the tables above, on the schema pages.

Update an agent — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`adaptive_caching`	boolean	Optional	Default: false
`agent_id`	string	Required within parent	Alias of `workflow_permanent_id` — the stable agent identifier (starts with `wpid_`). Read only: true
`ai_fallback`	boolean	Optional	Default: true
`browser_profile_id`	JSON	Optional
`browser_profile_id (anyOf 1)`	string	Alternative
`browser_profile_id (anyOf 2)`	null	Alternative
`browser_profile_key`	JSON	Optional
`browser_profile_key (anyOf 1)`	string	Alternative
`browser_profile_key (anyOf 2)`	null	Alternative
`browser_type`	JSON	Optional
`browser_type (anyOf 1)`	string	Alternative
`browser_type (anyOf 2)`	null	Alternative
`build_source`	JSON	Optional	Which surface wrote this version: ui, copilot, mcp, cli, api, or internal. Null before tracking began.
`build_source (anyOf 1)`	string	Alternative	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) Known values: ui, copilot, mcp, cli, api, internal
`build_source (anyOf 2)`	null	Alternative
`cache_key`	JSON	Optional
`cache_key (anyOf 1)`	string	Alternative
`cache_key (anyOf 2)`	null	Alternative
`cdp_connect_headers`	JSON	Optional
`cdp_connect_headers (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`cdp_connect_headers (anyOf 1).*`	string	Additional keys
`cdp_connect_headers (anyOf 2)`	null	Alternative
`code_version`	JSON	Optional
`code_version (anyOf 1)`	JSON	Alternative
`code_version (anyOf 1) (anyOf 1)`	integer	Alternative
`code_version (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`code_version (anyOf 2)`	null	Alternative
`copilot_authored`	boolean	Optional	Default: false
`created_at`	string	Required within parent	Format: date-time
`created_by`	JSON	Optional
`created_by (anyOf 1)`	string	Alternative
`created_by (anyOf 2)`	null	Alternative
`deleted_at`	JSON	Optional
`deleted_at (anyOf 1)`	string	Alternative	Format: date-time
`deleted_at (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`edited_by`	JSON	Optional
`edited_by (anyOf 1)`	string	Alternative
`edited_by (anyOf 2)`	null	Alternative
`effective_default_engine`	JSON	Optional	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.
`effective_default_engine (anyOf 1)`	string	Alternative	Known values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
`effective_default_engine (anyOf 2)`	null	Alternative
`enable_self_healing`	boolean	Optional	Default: false
`extra_http_headers`	JSON	Optional
`extra_http_headers (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`extra_http_headers (anyOf 1).*`	string	Additional keys
`extra_http_headers (anyOf 2)`	null	Alternative
`folder_id`	JSON	Optional
`folder_id (anyOf 1)`	string	Alternative
`folder_id (anyOf 2)`	null	Alternative
`generate_script_on_terminal`	boolean	Optional	Default: false
`import_error`	JSON	Optional
`import_error (anyOf 1)`	string	Alternative
`import_error (anyOf 2)`	null	Alternative
`is_saved_task`	boolean	Required within parent
`is_template`	boolean	Optional	Default: false
`mask_secrets`	boolean	Optional	Default: false
`max_elapsed_time_minutes`	JSON	Optional
`max_elapsed_time_minutes (anyOf 1)`	JSON	Alternative
`max_elapsed_time_minutes (anyOf 1) (anyOf 1)`	integer	Alternative
`max_elapsed_time_minutes (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`max_elapsed_time_minutes (anyOf 2)`	null	Alternative
`max_screenshot_scrolls`	JSON	Optional
`max_screenshot_scrolls (anyOf 1)`	JSON	Alternative
`max_screenshot_scrolls (anyOf 1) (anyOf 1)`	integer	Alternative
`max_screenshot_scrolls (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`max_screenshot_scrolls (anyOf 2)`	null	Alternative
`model`	JSON	Optional
`model (anyOf 1)`	object	Alternative	Additional keys: allowed
`model (anyOf 2)`	null	Alternative
`modified_at`	string	Required within parent	Format: date-time
`organization_id`	string	Required within parent
`original_created_at`	JSON	Optional	When the agent's first version was created. Populated by the list endpoint only.
`original_created_at (anyOf 1)`	string	Alternative	Format: date-time
`original_created_at (anyOf 2)`	null	Alternative
`original_created_by`	JSON	Optional	Who created the agent's first version. Populated by the list endpoint only.
`original_created_by (anyOf 1)`	string	Alternative
`original_created_by (anyOf 2)`	null	Alternative
`persist_browser_session`	boolean	Optional	Default: false
`pin_saved_session_ip`	boolean	Optional	Default: false
`proxy_location`	JSON	Optional
`proxy_location (anyOf 1)`	Model	Alternative	Expand Update an agent — response body — proxy location string
`proxy_location (anyOf 2)`	Model	Alternative	Expand Update an agent — response body — proxy location city, country, is ISP, subdivision
`proxy_location (anyOf 3)`	object	Alternative	Additional keys: allowed
`proxy_location (anyOf 4)`	null	Alternative
`reuse_browser_session`	boolean	Optional	Default: false
`run_sequentially`	JSON	Optional
`run_sequentially (anyOf 1)`	boolean	Alternative
`run_sequentially (anyOf 2)`	null	Alternative
`run_with`	string	Optional	Default: agent
`sequential_key`	JSON	Optional
`sequential_key (anyOf 1)`	string	Alternative
`sequential_key (anyOf 2)`	null	Alternative
`status`	string	Optional	Known values: published, draft, auto_generated, importing, import_failed Default: published
`title`	string	Required within parent
`totp_identifier`	JSON	Optional
`totp_identifier (anyOf 1)`	string	Alternative
`totp_identifier (anyOf 2)`	null	Alternative
`totp_verification_url`	JSON	Optional
`totp_verification_url (anyOf 1)`	string	Alternative
`totp_verification_url (anyOf 2)`	null	Alternative
`version`	JSON	Required within parent
`version (anyOf 1)`	integer	Alternative
`version (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`webhook_callback_url`	JSON	Optional
`webhook_callback_url (anyOf 1)`	string	Alternative
`webhook_callback_url (anyOf 2)`	null	Alternative
`workflow_definition`	Model	Required within parent	Expand Update an agent — response body — workflow definition
`workflow_id`	string	Required within parent
`workflow_permanent_id`	string	Required within parent

Referenced models: Update an agent — response body — proxy location city, country, is ISP, subdivision, Update an agent — response body — proxy location string, Update an agent — response body — workflow definition

Update an agent — response body — proxy location city, country, is ISP, subdivision

Field	Type	Presence	Description and constraints
`$`	object	Root	Granular proxy geo-targeting request with country, optional subdivision, and optional city.
`city`	JSON	Optional	City name in English from GeoNames (e.g., 'New York', 'Los Angeles', 'London')
`city (anyOf 1)`	string	Alternative	Maximum length: 100
`city (anyOf 2)`	null	Alternative
`country`	string	Required within parent	ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE') Maximum length: 2 Minimum length: 2
`isISP`	boolean	Optional	Whether this geo target is marked as an ISP proxy location. Default: false
`subdivision`	JSON	Optional	ISO 3166-2 subdivision code without country prefix (e.g., 'CA' for California, 'NY' for New York)
`subdivision (anyOf 1)`	string	Alternative	Maximum length: 10
`subdivision (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: skyvern.get_workflow_v1_workflows_workflow_permanent_id_get. Catalog operation: get_workflow_v1_workflows__workflow_permanent_id__get. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page