Skip to content

Automate browser based workflows with AI

Update API specifications with fern api update (#4983)

Shuchang Zheng94c0ca4d418d
diff --git a/fern/openapi/skyvern_openapi.json b/fern/openapi/skyvern_openapi.json
index cd27aa77d..7b74dee62 100644
--- a/fern/openapi/skyvern_openapi.json
+++ b/fern/openapi/skyvern_openapi.json
@@ -1968,6 +1968,9 @@
"403": {
"description": "Unauthorized - Invalid or missing authentication"
},
+ "404": {
+ "description": "Browser profile not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -3430,6 +3433,46 @@
"x-fern-sdk-method-name": "run_sdk_action"
}
},
+ "/api/v1/auth/api-key": {
+ "post": {
+ "summary": "Get Api Key",
+ "description": "Exchange a Clerk JWT for an API key.\n\nRequires Authorization: Bearer <clerk_jwt> header.\nAuto-creates org + billing + API key on first login (handled by Clerk auth dependency).\nReturns the user's email from the JWT for CLI display.",
+ "operationId": "get_api_key_api_v1_auth_api_key_post",
+ "parameters": [
+ {
+ "name": "authorization",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Authorization"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ApiKeyResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/api/v1/billing/checkout": {
"post": {
"summary": "Create Checkout Session",
@@ -4732,6 +4775,29 @@
],
"title": "ActionType"
},
+ "ApiKeyResponse": {
+ "properties": {
+ "organization_id": {
+ "type": "string",
+ "title": "Organization Id"
+ },
+ "api_key": {
+ "type": "string",
+ "title": "Api Key"
+ },
+ "email": {
+ "type": "string",
+ "title": "Email"
+ }
+ },
+ "type": "object",
+ "required": [
+ "organization_id",
+ "api_key",
+ "email"
+ ],
+ "title": "ApiKeyResponse"
+ },
"Artifact": {
"properties": {
"created_at": {
@@ -5753,7 +5819,8 @@
"pdf_parser",
"http_request",
"human_interaction",
- "print_page"
+ "print_page",
+ "workflow_trigger"
],
"title": "BlockType"
},
@@ -6107,6 +6174,18 @@
],
"description": "The type of browser used for the session."
},
+ "browser_profile_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Profile Id",
+ "description": "ID of the browser profile loaded into this session, if any. browser_profile_id starts with `bp_`."
+ },
"vnc_streaming_supported": {
"type": "boolean",
"title": "Vnc Streaming Supported",
@@ -6930,7 +7009,7 @@
"type": "null"
}
],
- "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n"
+ "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_KR: South Korea\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_BR: Brazil\n- RESIDENTIAL_TR: Turkey\n- RESIDENTIAL_CA: Canada\n- RESIDENTIAL_MX: Mexico\n- RESIDENTIAL_IT: Italy\n- RESIDENTIAL_NL: Netherlands\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n"
},
"extensions": {
"anyOf": [
@@ -6957,6 +7036,19 @@
}
],
"description": "The type of browser to use for the session."
+ },
+ "browser_profile_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "pattern": "^bp_"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Profile Id",
+ "description": "ID of a browser profile to load into this session (restores cookies, localStorage, etc.). browser_profile_id starts with `bp_`."
}
},
"type": "object",
@@ -9406,6 +9498,9 @@
},
{
"$ref": "#/components/schemas/PrintPageBlock"
+ },
+ {
+ "$ref": "#/components/schemas/WorkflowTriggerBlock"
}
],
"discriminator": {
@@ -9433,7 +9528,8 @@
"text_prompt": "#/components/schemas/TextPromptBlock",
"upload_to_s3": "#/components/schemas/UploadToS3Block",
"validation": "#/components/schemas/ValidationBlock",
- "wait": "#/components/schemas/WaitBlock"
+ "wait": "#/components/schemas/WaitBlock",
+ "workflow_trigger": "#/components/schemas/WorkflowTriggerBlock"
}
}
},
@@ -9659,6 +9755,9 @@
},
{
"$ref": "#/components/schemas/PrintPageBlockYAML"
+ },
+ {
+ "$ref": "#/components/schemas/WorkflowTriggerBlockYAML"
}
]
},
@@ -14543,7 +14642,7 @@
}
],
"title": "Proxy Location",
- "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}",
+ "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_KR: South Korea\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_BR: Brazil\n- RESIDENTIAL_TR: Turkey\n- RESIDENTIAL_CA: Canada\n- RESIDENTIAL_MX: Mexico\n- RESIDENTIAL_IT: Italy\n- RESIDENTIAL_NL: Netherlands\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}",
"default": "RESIDENTIAL"
},
"data_extraction_schema": {
@@ -17204,6 +17303,16 @@
],
"title": "Cache Key"
},
+ "adaptive_caching": {
+ "type": "boolean",
+ "title": "Adaptive Caching",
+ "default": false
+ },
+ "generate_script_on_terminal": {
+ "type": "boolean",
+ "title": "Generate Script On Terminal",
+ "default": false
+ },
"run_sequentially": {
"anyOf": [
{
@@ -17435,6 +17544,16 @@
"title": "Cache Key",
"default": "default"
},
+ "adaptive_caching": {
+ "type": "boolean",
+ "title": "Adaptive Caching",
+ "default": false
+ },
+ "generate_script_on_terminal": {
+ "type": "boolean",
+ "title": "Generate Script On Terminal",
+ "default": false
+ },
"run_sequentially": {
"type": "boolean",
"title": "Run Sequentially",
@@ -17605,6 +17724,9 @@
},
{
"$ref": "#/components/schemas/PrintPageBlock"
+ },
+ {
+ "$ref": "#/components/schemas/WorkflowTriggerBlock"
}
],
"discriminator": {
@@ -17632,7 +17754,8 @@
"text_prompt": "#/components/schemas/TextPromptBlock",
"upload_to_s3": "#/components/schemas/UploadToS3Block",
"validation": "#/components/schemas/ValidationBlock",
- "wait": "#/components/schemas/WaitBlock"
+ "wait": "#/components/schemas/WaitBlock",
+ "workflow_trigger": "#/components/schemas/WorkflowTriggerBlock"
}
}
},
@@ -17789,6 +17912,9 @@
},
{
"$ref": "#/components/schemas/PrintPageBlockYAML"
+ },
+ {
+ "$ref": "#/components/schemas/WorkflowTriggerBlockYAML"
}
],
"discriminator": {
@@ -17816,7 +17942,8 @@
"text_prompt": "#/components/schemas/TextPromptBlockYAML",
"upload_to_s3": "#/components/schemas/UploadToS3BlockYAML",
"validation": "#/components/schemas/ValidationBlockYAML",
- "wait": "#/components/schemas/WaitBlockYAML"
+ "wait": "#/components/schemas/WaitBlockYAML",
+ "workflow_trigger": "#/components/schemas/WorkflowTriggerBlockYAML"
}
}
},
@@ -18877,7 +19004,7 @@
}
],
"title": "Proxy Location",
- "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}",
+ "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_KR: South Korea\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_BR: Brazil\n- RESIDENTIAL_TR: Turkey\n- RESIDENTIAL_CA: Canada\n- RESIDENTIAL_MX: Mexico\n- RESIDENTIAL_IT: Italy\n- RESIDENTIAL_NL: Netherlands\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}",
"default": "RESIDENTIAL"
},
"webhook_url": {
@@ -19418,6 +19545,271 @@
],
"title": "WorkflowStatus"
},
+ "WorkflowTriggerBlock": {
+ "properties": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
+ },
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ },
+ "block_type": {
+ "type": "string",
+ "const": "workflow_trigger",
+ "title": "Block Type",
+ "default": "workflow_trigger"
+ },
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
+ },
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "workflow_permanent_id": {
+ "type": "string",
+ "title": "Workflow Permanent Id"
+ },
+ "payload": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Payload"
+ },
+ "wait_for_completion": {
+ "type": "boolean",
+ "title": "Wait For Completion",
+ "default": true
+ },
+ "browser_session_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Session Id"
+ },
+ "use_parent_browser_session": {
+ "type": "boolean",
+ "title": "Use Parent Browser Session",
+ "default": false
+ },
+ "parameters": {
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowParameter"
+ },
+ {
+ "$ref": "#/components/schemas/ContextParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AWSSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "parameter_type",
+ "mapping": {
+ "aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
+ "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
+ "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
+ "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
+ "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
+ "context": "#/components/schemas/ContextParameter",
+ "credential": "#/components/schemas/CredentialParameter",
+ "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
+ "output": "#/components/schemas/OutputParameter",
+ "workflow": "#/components/schemas/WorkflowParameter"
+ }
+ }
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "output_parameter",
+ "workflow_permanent_id"
+ ],
+ "title": "WorkflowTriggerBlock"
+ },
+ "WorkflowTriggerBlockYAML": {
+ "properties": {
+ "block_type": {
+ "type": "string",
+ "const": "workflow_trigger",
+ "title": "Block Type",
+ "default": "workflow_trigger"
+ },
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
+ },
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "workflow_permanent_id": {
+ "type": "string",
+ "title": "Workflow Permanent Id"
+ },
+ "payload": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Payload"
+ },
+ "wait_for_completion": {
+ "type": "boolean",
+ "title": "Wait For Completion",
+ "default": true
+ },
+ "browser_session_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Session Id"
+ },
+ "use_parent_browser_session": {
+ "type": "boolean",
+ "title": "Use Parent Browser Session",
+ "default": false
+ },
+ "parameter_keys": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Parameter Keys"
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "workflow_permanent_id"
+ ],
+ "title": "WorkflowTriggerBlockYAML"
+ },
"skyvern__forge__sdk__schemas__credentials__CredentialType": {
"type": "string",
"enum": [