SKskyvern-ai
Agents

Create a new agent

Changed on

Create a new agent

post/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

folder_idstring nullable

Optional folder ID to assign the workflow to

Headers

Idempotency-Keystring nullable

Idempotency-Key must contain 1 to 255 visible ASCII bytes.

Request body

yaml_definitionstring nullable

Workflow definition in YAML format

Response

Successfully created agent

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 //// request property

    • info

      added powerbi_query discriminator mapping keys to the /////// request property

    • info

      added powerbi_query discriminator mapping keys to the ////////// request property

    • info

      added powerbi_query discriminator mapping keys to the /////// request property

    • info

      added to the //// request property oneOf list

    • info

      added to the /////// request property oneOf list

    • info

      added to the ////////// request property oneOf list

    • info

      added to the /////// request property oneOf list

    • 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

  • d356843b6621Revision changes
    • breaking

      removed from the /////// request property anyOf list

    • breaking

      removed from the /////// request property anyOf list

    • info

      added discriminator to /////// request property

    • info

      added discriminator to /////// request property

    • info

      added to the /////// request property oneOf list

    • info

      added to the /////// request property oneOf list