Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Update API specifications with fern api update (#5196)
Shuchang Zhenga24486938daf
diff --git a/fern/openapi/skyvern_openapi.json b/fern/openapi/skyvern_openapi.jsonindex 8cd60deb0..55baa62a9 100644--- a/fern/openapi/skyvern_openapi.json+++ b/fern/openapi/skyvern_openapi.json@@ -3833,292 +3833,6 @@}}},- "/v1/sdk/run_action": {- "post": {- "tags": [- "SDK"- ],- "summary": "Run an SDK action",- "description": "Execute a single SDK action with the specified parameters",- "operationId": "run_sdk_action_v1_sdk_run_action_post",- "parameters": [- {- "name": "x-api-key",- "in": "header",- "required": false,- "schema": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",- "title": "X-Api-Key"- },- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."- }- ],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/RunSdkActionRequest"- }- }- }- },- "responses": {- "200": {- "description": "Successful Response",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/RunSdkActionResponse"- }- }- }- },- "422": {- "description": "Validation Error",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/HTTPValidationError"- }- }- }- }- },- "x-fern-sdk-method-name": "run_sdk_action"- }- },- "/api/v1/billing/checkout": {- "post": {- "summary": "Create Checkout Session",- "description": "Create a Stripe Checkout Session for subscribing to a tier.\n\nFrontend should redirect the user to the returned URL.\nAfter successful checkout, Stripe will send a webhook that we handle\nto store the subscription and initialize billing state.\n\nReturns 400 if org already has an active subscription (use portal instead).",- "operationId": "create_checkout_session_api_v1_billing_checkout_post",- "parameters": [- {- "name": "x-api-key",- "in": "header",- "required": false,- "schema": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",- "title": "X-Api-Key"- },- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."- }- ],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/CheckoutSubscriptionRequest"- }- }- }- },- "responses": {- "200": {- "description": "Successful Response",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/CheckoutSessionResponse"- }- }- }- },- "422": {- "description": "Validation Error",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/HTTPValidationError"- }- }- }- }- }- }- },- "/api/v1/billing/portal": {- "post": {- "summary": "Create Portal Session",- "description": "Create a Stripe Customer Portal session for managing subscription.\n\nFrontend should redirect the user to the returned URL.\nThe portal allows users to:\n- Update payment methods\n- Upgrade/downgrade plans\n- Cancel subscription\n- View invoices",- "operationId": "create_portal_session_api_v1_billing_portal_post",- "parameters": [- {- "name": "x-api-key",- "in": "header",- "required": false,- "schema": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",- "title": "X-Api-Key"- },- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."- }- ],- "responses": {- "200": {- "description": "Successful Response",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PortalSessionResponse"- }- }- }- },- "422": {- "description": "Validation Error",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/HTTPValidationError"- }- }- }- }- }- }- },- "/api/v1/billing/state": {- "get": {- "summary": "Get Organization Billing",- "operationId": "get_organization_billing_api_v1_billing_state_get",- "parameters": [- {- "name": "x-api-key",- "in": "header",- "required": false,- "schema": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",- "title": "X-Api-Key"- },- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."- }- ],- "responses": {- "200": {- "description": "Successful Response",- "content": {- "application/json": {- "schema": {- "anyOf": [- {- "$ref": "#/components/schemas/BillingStateResponse"- },- {- "type": "null"- }- ],- "title": "Response Get Organization Billing Api V1 Billing State Get"- }- }- }- },- "422": {- "description": "Validation Error",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/HTTPValidationError"- }- }- }- }- }- }- },- "/api/v1/billing/change-tier": {- "post": {- "summary": "Change Tier",- "description": "Redirect to Stripe Portal for tier changes.\nPortal handles proration based on configured settings:\n- Upgrades: Immediate proration charge\n- Downgrades: Apply at end of billing period",- "operationId": "change_tier_api_v1_billing_change_tier_post",- "parameters": [- {- "name": "x-api-key",- "in": "header",- "required": false,- "schema": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",- "title": "X-Api-Key"- },- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."- }- ],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/ChangeTierRequest"- }- }- }- },- "responses": {- "200": {- "description": "Successful Response",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/ChangeTierResponse"- }- }- }- },- "422": {- "description": "Validation Error",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/HTTPValidationError"- }- }- }- }- }- }- },"/api/v1/schedules": {"get": {"tags": [@@ -4823,41 +4537,6 @@],"title": "AWSSecretParameterYAML"},- "ActAction": {- "properties": {- "type": {- "type": "string",- "const": "ai_act",- "title": "Type",- "default": "ai_act"- },- "intention": {- "type": "string",- "title": "Intention",- "description": "Natural language prompt for the action",- "default": ""- },- "data": {- "anyOf": [- {- "type": "string"- },- {- "additionalProperties": true,- "type": "object"- },- {- "type": "null"- }- ],- "title": "Data",- "description": "Additional context data"- }- },- "type": "object",- "title": "ActAction",- "description": "AI act action parameters."- },"Action": {"properties": {"action_type": {@@ -6200,116 +5879,6 @@],"title": "AzureVaultCredentialParameterYAML"},- "BillingStateResponse": {- "properties": {- "billing_id": {- "type": "string",- "title": "Billing Id"- },- "organization_id": {- "type": "string",- "title": "Organization Id"- },- "plan_tier": {- "$ref": "#/components/schemas/PlanTier"- },- "current_period_start": {- "anyOf": [- {- "type": "string",- "format": "date-time"- },- {- "type": "null"- }- ],- "title": "Current Period Start"- },- "current_period_end": {- "anyOf": [- {- "type": "string",- "format": "date-time"- },- {- "type": "null"- }- ],- "title": "Current Period End"- },- "included_credits_this_period": {- "type": "integer",- "title": "Included Credits This Period"- },- "credits_consumed_this_period": {- "type": "integer",- "title": "Credits Consumed This Period"- },- "cached_credits_consumed_this_period": {- "type": "integer",- "title": "Cached Credits Consumed This Period"- },- "overage_enabled": {- "type": "boolean",- "title": "Overage Enabled"- },- "browser_uptime_seconds_consumed": {- "type": "integer",- "title": "Browser Uptime Seconds Consumed"- },- "topup_credits_total": {- "type": "integer",- "title": "Topup Credits Total"- },- "topup_credits_used": {- "type": "integer",- "title": "Topup Credits Used"- },- "topup_credits_remaining": {- "type": "integer",- "title": "Topup Credits Remaining"- },- "credits_remaining": {- "type": "integer",- "title": "Credits Remaining"- },- "cancel_at_period_end": {- "type": "boolean",- "title": "Cancel At Period End",- "default": false- },- "created_at": {- "type": "string",- "format": "date-time",- "title": "Created At"- },- "modified_at": {- "type": "string",- "format": "date-time",- "title": "Modified At"- }- },- "type": "object",- "required": [- "billing_id",- "organization_id",- "plan_tier",- "current_period_start",- "current_period_end",- "included_credits_this_period",- "credits_consumed_this_period",- "cached_credits_consumed_this_period",- "overage_enabled",- "browser_uptime_seconds_consumed",- "topup_credits_total",- "topup_credits_used",- "topup_credits_remaining",- "credits_remaining",- "created_at",- "modified_at"- ],- "title": "BillingStateResponse"- },"BitwardenCreditCardDataParameter": {"properties": {"parameter_type": {@@ -7244,192 +6813,67 @@"title": "Recordings","description": "The list of video recordings from the browser session"},- "started_at": {- "anyOf": [- {- "type": "string",- "format": "date-time"- },- {- "type": "null"- }- ],- "title": "Started At",- "description": "Timestamp when the session was started"- },- "completed_at": {- "anyOf": [- {- "type": "string",- "format": "date-time"- },- {- "type": "null"- }- ],- "title": "Completed At",- "description": "Timestamp when the session was completed"- },- "created_at": {- "type": "string",- "format": "date-time",- "title": "Created At",- "description": "Timestamp when the session was created (the timestamp for the initial request)"- },- "modified_at": {- "type": "string",- "format": "date-time",- "title": "Modified At",- "description": "Timestamp when the session was last modified"- },- "deleted_at": {- "anyOf": [- {- "type": "string",- "format": "date-time"- },- {- "type": "null"- }- ],- "title": "Deleted At",- "description": "Timestamp when the session was deleted, if applicable"- }- },- "type": "object",- "required": [- "browser_session_id",- "organization_id",- "created_at",- "modified_at"- ],- "title": "BrowserSessionResponse",- "description": "Response model for browser session information."- },- "ChangeTierRequest": {- "properties": {- "tier": {- "$ref": "#/components/schemas/PlanTier"- }- },- "type": "object",- "required": [- "tier"- ],- "title": "ChangeTierRequest"- },- "ChangeTierResponse": {- "properties": {- "status": {- "type": "string",- "title": "Status"- },- "tier": {- "type": "string",- "title": "Tier"- },- "redirect_url": {+ "started_at": {"anyOf": [{- "type": "string"+ "type": "string",+ "format": "date-time"},{"type": "null"}],- "title": "Redirect Url"- }- },- "type": "object",- "required": [- "status",- "tier"- ],- "title": "ChangeTierResponse"- },- "CheckoutSessionResponse": {- "properties": {- "id": {- "type": "string",- "title": "Id"- },- "url": {- "type": "string",- "title": "Url"- }- },- "type": "object",- "required": [- "id",- "url"- ],- "title": "CheckoutSessionResponse"- },- "CheckoutSubscriptionRequest": {- "properties": {- "tier": {- "$ref": "#/components/schemas/PlanTier"- }- },- "type": "object",- "required": [- "tier"- ],- "title": "CheckoutSubscriptionRequest"- },- "ClickAction": {- "properties": {- "type": {- "type": "string",- "const": "ai_click",- "title": "Type",- "default": "ai_click"+ "title": "Started At",+ "description": "Timestamp when the session was started"},- "selector": {+ "completed_at": {"anyOf": [{- "type": "string"+ "type": "string",+ "format": "date-time"},{"type": "null"}],- "title": "Selector",- "description": "CSS selector for the element",- "default": ""+ "title": "Completed At",+ "description": "Timestamp when the session was completed"},- "intention": {+ "created_at": {"type": "string",- "title": "Intention",- "description": "The intention or goal of the click",- "default": ""+ "format": "date-time",+ "title": "Created At",+ "description": "Timestamp when the session was created (the timestamp for the initial request)"+ },+ "modified_at": {+ "type": "string",+ "format": "date-time",+ "title": "Modified At",+ "description": "Timestamp when the session was last modified"},- "data": {+ "deleted_at": {"anyOf": [{- "type": "string"- },- {- "additionalProperties": true,- "type": "object"+ "type": "string",+ "format": "date-time"},{"type": "null"}],- "title": "Data",- "description": "Additional context data"- },- "timeout": {- "type": "number",- "title": "Timeout",- "description": "Timeout in milliseconds",- "default": 10000+ "title": "Deleted At",+ "description": "Timestamp when the session was deleted, if applicable"}},"type": "object",- "title": "ClickAction",- "description": "Click action parameters."+ "required": [+ "browser_session_id",+ "organization_id",+ "created_at",+ "modified_at"+ ],+ "title": "BrowserSessionResponse",+ "description": "Response model for browser session information."},"ClickContext": {"properties": {@@ -8772,88 +8216,6 @@],"title": "Extensions"},- "ExtractAction": {- "properties": {- "type": {- "type": "string",- "const": "extract",- "title": "Type",- "default": "extract"- },- "prompt": {- "type": "string",- "title": "Prompt",- "description": "Extraction prompt",- "default": ""- },- "extract_schema": {- "anyOf": [- {- "additionalProperties": true,- "type": "object"- },- {- "items": {},- "type": "array"- },- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Extract Schema",- "description": "Schema for extraction"- },- "error_code_mapping": {- "anyOf": [- {- "additionalProperties": {- "type": "string"- },- "type": "object"- },- {- "type": "null"- }- ],- "title": "Error Code Mapping",- "description": "Error code mapping for extraction"- },- "intention": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Intention",- "description": "The intention or goal of the extraction"- },- "data": {- "anyOf": [- {- "type": "string"- },- {- "additionalProperties": true,- "type": "object"- },- {- "type": "null"- }- ],- "title": "Data",- "description": "Additional context data"- }- },- "type": "object",- "title": "ExtractAction",- "description": "Extract data action parameters."- },"ExtractionBlock": {"properties": {"label": {@@ -11888,97 +11250,6 @@"type": "object","title": "InputOrSelectContext"},- "InputTextAction": {- "properties": {- "type": {- "type": "string",- "const": "ai_input_text",- "title": "Type",- "default": "ai_input_text"- },- "selector": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Selector",- "description": "CSS selector for the element",- "default": ""- },- "value": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Value",- "description": "Value to input",- "default": ""- },- "intention": {- "type": "string",- "title": "Intention",- "description": "The intention or goal of the input",- "default": ""- },- "data": {- "anyOf": [- {- "type": "string"- },- {- "additionalProperties": true,- "type": "object"- },- {- "type": "null"- }- ],- "title": "Data",- "description": "Additional context data"- },- "totp_identifier": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Totp Identifier",- "description": "TOTP identifier for input_text actions"- },- "totp_url": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Totp Url",- "description": "TOTP URL for input_text actions"- },- "timeout": {- "type": "number",- "title": "Timeout",- "description": "Timeout in milliseconds",- "default": 10000- }- },- "type": "object",- "title": "InputTextAction",- "description": "Input text action parameters."- },"JinjaBranchCriteria": {"properties": {"criteria_type": {@@ -12010,25 +11281,6 @@"title": "JinjaBranchCriteria","description": "Jinja2-templated branch criteria (only supported criteria type for now)."},- "LocateElementAction": {- "properties": {- "type": {- "type": "string",- "const": "locate_element",- "title": "Type",- "default": "locate_element"- },- "prompt": {- "type": "string",- "title": "Prompt",- "description": "Natural language prompt to locate an element",- "default": ""- }- },- "type": "object",- "title": "LocateElementAction",- "description": "Locate element action parameters."- },"LoginBlock": {"properties": {"label": {@@ -13952,40 +13204,16 @@"username"],"title": "PasswordCredentialResponse",- "description": "Response model for password credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include password, TOTP secret, or TOTP identifier."- },- "PersistentBrowserType": {- "type": "string",- "enum": [- "msedge",- "chrome",- "stealth-chromium"- ],- "title": "PersistentBrowserType"- },- "PlanTier": {- "type": "string",- "enum": [- "free",- "hobby",- "pro",- "enterprise"- ],- "title": "PlanTier",- "description": "Self-serve subscription tiers. Enterprise customers use manual billing (bypass)."- },- "PortalSessionResponse": {- "properties": {- "url": {- "type": "string",- "title": "Url"- }- },- "type": "object",- "required": [- "url"+ "description": "Response model for password credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include password, TOTP secret, or TOTP identifier."+ },+ "PersistentBrowserType": {+ "type": "string",+ "enum": [+ "msedge",+ "chrome",+ "stealth-chromium"],- "title": "PortalSessionResponse"+ "title": "PersistentBrowserType"},"PrintPageBlock": {"properties": {@@ -14237,53 +13465,6 @@],"title": "PrintPageBlockYAML"},- "PromptAction": {- "properties": {- "type": {- "type": "string",- "const": "prompt",- "title": "Type",- "default": "prompt"- },- "prompt": {- "type": "string",- "title": "Prompt",- "description": "The prompt to send to the LLM"- },- "response_schema": {- "anyOf": [- {- "additionalProperties": true,- "type": "object"- },- {- "type": "null"- }- ],- "title": "Response Schema",- "description": "Optional JSON schema to structure the response"- },- "model": {- "anyOf": [- {- "additionalProperties": true,- "type": "object"- },- {- "type": "null"- }- ],- "title": "Model",- "description": "Optional model configuration"- }- },- "type": "object",- "required": [- "prompt"- ],- "title": "PromptAction",- "description": "Prompt action parameters."- },"PromptBranchCriteria": {"properties": {"criteria_type": {@@ -14377,130 +13558,6 @@],"title": "RunEngine"},- "RunSdkActionRequest": {- "properties": {- "url": {- "type": "string",- "title": "Url",- "description": "The URL where the action should be executed"- },- "browser_session_id": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Browser Session Id",- "description": "The browser session ID"- },- "browser_address": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Browser Address",- "description": "The browser address"- },- "workflow_run_id": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Workflow Run Id",- "description": "Optional workflow run ID to continue an existing workflow run"- },- "action": {- "oneOf": [- {- "$ref": "#/components/schemas/ClickAction"- },- {- "$ref": "#/components/schemas/InputTextAction"- },- {- "$ref": "#/components/schemas/SelectOptionAction"- },- {- "$ref": "#/components/schemas/UploadFileAction"- },- {- "$ref": "#/components/schemas/ActAction"- },- {- "$ref": "#/components/schemas/ExtractAction"- },- {- "$ref": "#/components/schemas/LocateElementAction"- },- {- "$ref": "#/components/schemas/ValidateAction"- },- {- "$ref": "#/components/schemas/PromptAction"- }- ],- "title": "Action",- "description": "The action to execute with its specific parameters",- "discriminator": {- "propertyName": "type",- "mapping": {- "ai_act": "#/components/schemas/ActAction",- "ai_click": "#/components/schemas/ClickAction",- "ai_input_text": "#/components/schemas/InputTextAction",- "ai_select_option": "#/components/schemas/SelectOptionAction",- "ai_upload_file": "#/components/schemas/UploadFileAction",- "extract": "#/components/schemas/ExtractAction",- "locate_element": "#/components/schemas/LocateElementAction",- "prompt": "#/components/schemas/PromptAction",- "validate": "#/components/schemas/ValidateAction"- }- }- }- },- "type": "object",- "required": [- "url",- "action"- ],- "title": "RunSdkActionRequest",- "description": "Request to run a single SDK action."- },- "RunSdkActionResponse": {- "properties": {- "workflow_run_id": {- "type": "string",- "title": "Workflow Run Id",- "description": "The workflow run ID used for this action"- },- "result": {- "anyOf": [- {},- {- "type": "null"- }- ],- "title": "Result",- "description": "The result from the action (e.g., selector, value, extracted data)"- }- },- "type": "object",- "required": [- "workflow_run_id"- ],- "title": "RunSdkActionResponse",- "description": "Response from running an SDK action."- },"RunStatus": {"type": "string","enum": [@@ -14727,73 +13784,6 @@"type": "object","title": "SelectOption"},- "SelectOptionAction": {- "properties": {- "type": {- "type": "string",- "const": "ai_select_option",- "title": "Type",- "default": "ai_select_option"- },- "selector": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Selector",- "description": "CSS selector for the element",- "default": ""- },- "value": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Value",- "description": "Value to select",- "default": ""- },- "intention": {- "type": "string",- "title": "Intention",- "description": "The intention or goal of the selection",- "default": ""- },- "data": {- "anyOf": [- {- "type": "string"- },- {- "additionalProperties": true,- "type": "object"- },- {- "type": "null"- }- ],- "title": "Data",- "description": "Additional context data"- },- "timeout": {- "type": "number",- "title": "Timeout",- "description": "Timeout in milliseconds",- "default": 10000- }- },- "type": "object",- "title": "SelectOptionAction",- "description": "Select option action parameters."- },"SendEmailBlock": {"properties": {"label": {@@ -17139,73 +16129,6 @@"title": "UpdateWorkflowFolderRequest","description": "Request model for updating a workflow's folder assignment"},- "UploadFileAction": {- "properties": {- "type": {- "type": "string",- "const": "ai_upload_file",- "title": "Type",- "default": "ai_upload_file"- },- "selector": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Selector",- "description": "CSS selector for the element",- "default": ""- },- "file_url": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "File Url",- "description": "File URL for upload",- "default": ""- },- "intention": {- "type": "string",- "title": "Intention",- "description": "The intention or goal of the upload",- "default": ""- },- "data": {- "anyOf": [- {- "type": "string"- },- {- "additionalProperties": true,- "type": "object"- },- {- "type": "null"- }- ],- "title": "Data",- "description": "Additional context data"- },- "timeout": {- "type": "number",- "title": "Timeout",- "description": "Timeout in milliseconds",- "default": 10000- }- },- "type": "object",- "title": "UploadFileAction",- "description": "Upload file action parameters."- },"UploadFileResponse": {"properties": {"s3_uri": {@@ -17741,40 +16664,6 @@],"title": "UserDefinedError"},- "ValidateAction": {- "properties": {- "type": {- "type": "string",- "const": "validate",- "title": "Type",- "default": "validate"- },- "prompt": {- "type": "string",- "title": "Prompt",- "description": "Validation criteria or condition to check"- },- "model": {- "anyOf": [- {- "additionalProperties": true,- "type": "object"- },- {- "type": "null"- }- ],- "title": "Model",- "description": "Optional model configuration"- }- },- "type": "object",- "required": [- "prompt"- ],- "title": "ValidateAction",- "description": "Validate action parameters."- },"ValidationBlock": {"properties": {"label": {