Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Update API specifications with fern api update (#5470)
Shuchang Zheng8fa7093ec97e
diff --git a/fern/openapi/skyvern_openapi.json b/fern/openapi/skyvern_openapi.jsonindex 5a64fddc3..ecd0b6de5 100644--- a/fern/openapi/skyvern_openapi.json+++ b/fern/openapi/skyvern_openapi.json@@ -3970,6 +3970,599 @@},"x-fern-sdk-method-name": "run_sdk_action"}+ },+ "/v1/schedules": {+ "get": {+ "tags": [+ "Schedules"+ ],+ "summary": "List all schedules for the organization",+ "operationId": "schedules_list_all",+ "parameters": [+ {+ "name": "page",+ "in": "query",+ "required": false,+ "schema": {+ "type": "integer",+ "minimum": 1,+ "default": 1,+ "title": "Page"+ }+ },+ {+ "name": "page_size",+ "in": "query",+ "required": false,+ "schema": {+ "type": "integer",+ "maximum": 100,+ "minimum": 1,+ "default": 10,+ "title": "Page Size"+ }+ },+ {+ "name": "status",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "enum": [+ "active",+ "paused"+ ],+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "description": "Filter by status: 'active' or 'paused'",+ "title": "Status"+ },+ "description": "Filter by status: 'active' or 'paused'"+ },+ {+ "name": "search",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "description": "Search by workflow title or schedule name",+ "title": "Search"+ },+ "description": "Search by workflow title or schedule name"+ },+ {+ "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/OrganizationScheduleListResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/v1/workflows/{workflow_permanent_id}/schedules": {+ "post": {+ "tags": [+ "Schedules"+ ],+ "summary": "Create a schedule for a workflow",+ "operationId": "schedules_create",+ "parameters": [+ {+ "name": "workflow_permanent_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Permanent Id"+ }+ },+ {+ "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/WorkflowScheduleUpsertRequest"+ }+ }+ }+ },+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/WorkflowScheduleResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ },+ "get": {+ "tags": [+ "Schedules"+ ],+ "summary": "List schedules for a workflow",+ "operationId": "schedules_list",+ "parameters": [+ {+ "name": "workflow_permanent_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Permanent Id"+ }+ },+ {+ "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/WorkflowScheduleListResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/v1/workflows/{workflow_permanent_id}/schedules/{workflow_schedule_id}": {+ "get": {+ "tags": [+ "Schedules"+ ],+ "summary": "Get a workflow schedule by id",+ "operationId": "schedules_get",+ "parameters": [+ {+ "name": "workflow_permanent_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Permanent Id"+ }+ },+ {+ "name": "workflow_schedule_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Schedule Id"+ }+ },+ {+ "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/WorkflowScheduleResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ },+ "put": {+ "tags": [+ "Schedules"+ ],+ "summary": "Update a workflow schedule",+ "operationId": "schedules_update",+ "parameters": [+ {+ "name": "workflow_permanent_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Permanent Id"+ }+ },+ {+ "name": "workflow_schedule_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Schedule Id"+ }+ },+ {+ "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/WorkflowScheduleUpsertRequest"+ }+ }+ }+ },+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/WorkflowScheduleResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ },+ "delete": {+ "tags": [+ "Schedules"+ ],+ "summary": "Delete a workflow schedule",+ "operationId": "schedules_delete",+ "parameters": [+ {+ "name": "workflow_permanent_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Permanent Id"+ }+ },+ {+ "name": "workflow_schedule_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Schedule Id"+ }+ },+ {+ "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/DeleteScheduleResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/v1/workflows/{workflow_permanent_id}/schedules/{workflow_schedule_id}/enable": {+ "post": {+ "tags": [+ "Schedules"+ ],+ "summary": "Enable a workflow schedule",+ "operationId": "schedules_enable",+ "parameters": [+ {+ "name": "workflow_permanent_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Permanent Id"+ }+ },+ {+ "name": "workflow_schedule_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Schedule Id"+ }+ },+ {+ "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/WorkflowScheduleResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/v1/workflows/{workflow_permanent_id}/schedules/{workflow_schedule_id}/disable": {+ "post": {+ "tags": [+ "Schedules"+ ],+ "summary": "Disable a workflow schedule",+ "operationId": "schedules_disable",+ "parameters": [+ {+ "name": "workflow_permanent_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Permanent Id"+ }+ },+ {+ "name": "workflow_schedule_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Workflow Schedule Id"+ }+ },+ {+ "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/WorkflowScheduleResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }}},"components": {@@ -5983,7 +6576,7 @@"properties": {"file": {"type": "string",- "format": "binary",+ "contentMediaType": "application/octet-stream","title": "File"}},@@ -7554,6 +8147,19 @@"title": "CreditCardCredentialResponse","description": "Response model for credit card credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include full card number, CVV, expiration date, or card holder name."},+ "DeleteScheduleResponse": {+ "properties": {+ "ok": {+ "type": "boolean",+ "title": "Ok"+ }+ },+ "type": "object",+ "required": [+ "ok"+ ],+ "title": "DeleteScheduleResponse"+ },"DeployScriptRequest": {"properties": {"files": {@@ -12540,9 +13146,164 @@"title": "Parameter Type","default": "onepassword"},- "key": {- "type": "string",- "title": "Key"+ "key": {+ "type": "string",+ "title": "Key"+ },+ "description": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Description"+ },+ "onepassword_credential_parameter_id": {+ "type": "string",+ "title": "Onepassword Credential Parameter Id"+ },+ "workflow_id": {+ "type": "string",+ "title": "Workflow Id"+ },+ "vault_id": {+ "type": "string",+ "title": "Vault Id"+ },+ "item_id": {+ "type": "string",+ "title": "Item Id"+ },+ "created_at": {+ "type": "string",+ "format": "date-time",+ "title": "Created At"+ },+ "modified_at": {+ "type": "string",+ "format": "date-time",+ "title": "Modified At"+ },+ "deleted_at": {+ "anyOf": [+ {+ "type": "string",+ "format": "date-time"+ },+ {+ "type": "null"+ }+ ],+ "title": "Deleted At"+ }+ },+ "type": "object",+ "required": [+ "key",+ "onepassword_credential_parameter_id",+ "workflow_id",+ "vault_id",+ "item_id",+ "created_at",+ "modified_at"+ ],+ "title": "OnePasswordCredentialParameter"+ },+ "OnePasswordCredentialParameterYAML": {+ "properties": {+ "parameter_type": {+ "type": "string",+ "const": "onepassword",+ "title": "Parameter Type",+ "default": "onepassword"+ },+ "key": {+ "type": "string",+ "title": "Key"+ },+ "description": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Description"+ },+ "vault_id": {+ "type": "string",+ "title": "Vault Id"+ },+ "item_id": {+ "type": "string",+ "title": "Item Id"+ }+ },+ "type": "object",+ "required": [+ "key",+ "vault_id",+ "item_id"+ ],+ "title": "OnePasswordCredentialParameterYAML"+ },+ "OrganizationScheduleItem": {+ "properties": {+ "workflow_schedule_id": {+ "type": "string",+ "title": "Workflow Schedule Id"+ },+ "organization_id": {+ "type": "string",+ "title": "Organization Id"+ },+ "workflow_permanent_id": {+ "type": "string",+ "title": "Workflow Permanent Id"+ },+ "workflow_title": {+ "type": "string",+ "title": "Workflow Title"+ },+ "cron_expression": {+ "type": "string",+ "title": "Cron Expression"+ },+ "timezone": {+ "type": "string",+ "title": "Timezone"+ },+ "enabled": {+ "type": "boolean",+ "title": "Enabled"+ },+ "parameters": {+ "anyOf": [+ {+ "additionalProperties": true,+ "type": "object"+ },+ {+ "type": "null"+ }+ ],+ "title": "Parameters"+ },+ "name": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Name"},"description": {"anyOf": [@@ -12555,21 +13316,17 @@],"title": "Description"},- "onepassword_credential_parameter_id": {- "type": "string",- "title": "Onepassword Credential Parameter Id"- },- "workflow_id": {- "type": "string",- "title": "Workflow Id"- },- "vault_id": {- "type": "string",- "title": "Vault Id"- },- "item_id": {- "type": "string",- "title": "Item Id"+ "next_run": {+ "anyOf": [+ {+ "type": "string",+ "format": "date-time"+ },+ {+ "type": "null"+ }+ ],+ "title": "Next Run"},"created_at": {"type": "string",@@ -12580,71 +13337,53 @@"type": "string","format": "date-time","title": "Modified At"- },- "deleted_at": {- "anyOf": [- {- "type": "string",- "format": "date-time"- },- {- "type": "null"- }- ],- "title": "Deleted At"}},"type": "object","required": [- "key",- "onepassword_credential_parameter_id",- "workflow_id",- "vault_id",- "item_id",+ "workflow_schedule_id",+ "organization_id",+ "workflow_permanent_id",+ "workflow_title",+ "cron_expression",+ "timezone",+ "enabled","created_at","modified_at"],- "title": "OnePasswordCredentialParameter"+ "title": "OrganizationScheduleItem",+ "description": "Compact schedule projection for the org-wide list endpoint.\n\nIntentionally omits `backend_schedule_id` — the list view is for browsing\nschedules in the dashboard, not for managing the underlying execution-backend\nbinding. Callers that need the backend id should fetch the individual\nschedule via the per-workflow get endpoint."},- "OnePasswordCredentialParameterYAML": {+ "OrganizationScheduleListResponse": {"properties": {- "parameter_type": {- "type": "string",- "const": "onepassword",- "title": "Parameter Type",- "default": "onepassword"- },- "key": {- "type": "string",- "title": "Key"+ "schedules": {+ "items": {+ "$ref": "#/components/schemas/OrganizationScheduleItem"+ },+ "type": "array",+ "title": "Schedules"},- "description": {- "anyOf": [- {- "type": "string"- },- {- "type": "null"- }- ],- "title": "Description"+ "total_count": {+ "type": "integer",+ "title": "Total Count"},- "vault_id": {- "type": "string",- "title": "Vault Id"+ "page": {+ "type": "integer",+ "title": "Page"},- "item_id": {- "type": "string",- "title": "Item Id"+ "page_size": {+ "type": "integer",+ "title": "Page Size"}},"type": "object","required": [- "key",- "vault_id",- "item_id"+ "schedules",+ "total_count",+ "page",+ "page_size"],- "title": "OnePasswordCredentialParameterYAML"+ "title": "OrganizationScheduleListResponse"},"OutputParameter": {"properties": {@@ -14913,8 +15652,8 @@},"engine": {"$ref": "#/components/schemas/RunEngine",- "description": "\nThe engine that powers the agent task. The default value is `skyvern-2.0`, the latest Skyvern agent that performs pretty well with complex and multi-step tasks. `skyvern-1.0` is good for simple tasks like filling a form, or searching for information on Google. The `openai-cua` engine uses OpenAI's CUA model. The `anthropic-cua` uses Anthropic's Claude Sonnet 3.7 model with the computer use tool.\n",- "default": "skyvern-2.0"+ "description": "\nThe engine that powers the agent task. The default value is `skyvern-1.0`, which is good for simple tasks like filling a form, or searching for information on Google. `skyvern-2.0` is the latest Skyvern agent that performs well with complex and multi-step tasks. The `openai-cua` engine uses OpenAI's CUA model. The `anthropic-cua` uses Anthropic's Claude Sonnet 3.7 model with the computer use tool.\n",+ "default": "skyvern-1.0"},"title": {"anyOf": [@@ -19896,6 +20635,206 @@"title": "WorkflowRunTriggerType","description": "How a workflow run was initiated.\n\n- manual: User clicked \"Run\" in the UI\n- api: Direct API call to the run endpoint\n- scheduled: Triggered by a cron schedule\n- webhook: Triggered by an external system via the webhook endpoint"},+ "WorkflowSchedule": {+ "properties": {+ "workflow_schedule_id": {+ "type": "string",+ "title": "Workflow Schedule Id"+ },+ "organization_id": {+ "type": "string",+ "title": "Organization Id"+ },+ "workflow_permanent_id": {+ "type": "string",+ "title": "Workflow Permanent Id"+ },+ "cron_expression": {+ "type": "string",+ "title": "Cron Expression"+ },+ "timezone": {+ "type": "string",+ "title": "Timezone"+ },+ "enabled": {+ "type": "boolean",+ "title": "Enabled"+ },+ "parameters": {+ "anyOf": [+ {+ "additionalProperties": true,+ "type": "object"+ },+ {+ "type": "null"+ }+ ],+ "title": "Parameters"+ },+ "temporal_schedule_id": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Temporal Schedule Id"+ },+ "name": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Name"+ },+ "description": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Description"+ },+ "created_at": {+ "type": "string",+ "format": "date-time",+ "title": "Created At"+ },+ "modified_at": {+ "type": "string",+ "format": "date-time",+ "title": "Modified At"+ },+ "deleted_at": {+ "anyOf": [+ {+ "type": "string",+ "format": "date-time"+ },+ {+ "type": "null"+ }+ ],+ "title": "Deleted At"+ }+ },+ "type": "object",+ "required": [+ "workflow_schedule_id",+ "organization_id",+ "workflow_permanent_id",+ "cron_expression",+ "timezone",+ "enabled",+ "created_at",+ "modified_at"+ ],+ "title": "WorkflowSchedule"+ },+ "WorkflowScheduleListResponse": {+ "properties": {+ "schedules": {+ "items": {+ "$ref": "#/components/schemas/WorkflowSchedule"+ },+ "type": "array",+ "title": "Schedules"+ }+ },+ "type": "object",+ "required": [+ "schedules"+ ],+ "title": "WorkflowScheduleListResponse"+ },+ "WorkflowScheduleResponse": {+ "properties": {+ "schedule": {+ "$ref": "#/components/schemas/WorkflowSchedule"+ },+ "next_runs": {+ "items": {+ "type": "string",+ "format": "date-time"+ },+ "type": "array",+ "title": "Next Runs"+ }+ },+ "type": "object",+ "required": [+ "schedule"+ ],+ "title": "WorkflowScheduleResponse"+ },+ "WorkflowScheduleUpsertRequest": {+ "properties": {+ "cron_expression": {+ "type": "string",+ "title": "Cron Expression"+ },+ "timezone": {+ "type": "string",+ "title": "Timezone"+ },+ "enabled": {+ "type": "boolean",+ "title": "Enabled",+ "default": true+ },+ "parameters": {+ "anyOf": [+ {+ "additionalProperties": true,+ "type": "object"+ },+ {+ "type": "null"+ }+ ],+ "title": "Parameters"+ },+ "name": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Name"+ },+ "description": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Description"+ }+ },+ "type": "object",+ "required": [+ "cron_expression",+ "timezone"+ ],+ "title": "WorkflowScheduleUpsertRequest"+ },"WorkflowStatus": {"type": "string","enum": [