Skip to content

Automate browser based workflows with AI

Update API specifications with fern api update (#3170)

Shuchang Zheng5bf6b27d6d60
diff --git a/fern/docs.yml b/fern/docs.yml
index f1025bfd0..ef149e592 100644
--- a/fern/docs.yml
+++ b/fern/docs.yml
@@ -190,12 +190,12 @@ navigation:
contents:
- GET /v1/artifacts/{artifact_id}
- GET /v1/runs/{run_id}/artifacts
- - section: Projects
+ - section: Scripts
contents:
- - POST /v1/projects
- - POST /v1/projects/{project_id}/deploy
- - GET /v1/projects/{project_id}
- - GET /v1/projects
+ - POST /v1/scripts
+ - POST /v1/scripts/{script_id}/deploy
+ - GET /v1/scripts/{script_id}
+ - GET /v1/scripts
- tab: blog
- tab: community
- tab: github
diff --git a/fern/openapi/skyvern_openapi.json b/fern/openapi/skyvern_openapi.json
index 068940c2f..b55e4a632 100644
--- a/fern/openapi/skyvern_openapi.json
+++ b/fern/openapi/skyvern_openapi.json
@@ -1699,14 +1699,67 @@
]
}
},
- "/v1/projects": {
+ "/v1/credentials/onepassword/get": {
+ "get": {
+ "tags": [
+ "Auth Tokens"
+ ],
+ "summary": "Get OnePassword service account token",
+ "description": "Retrieves the current OnePassword service account token for the organization.",
+ "operationId": "get_onepassword_token_v1_credentials_onepassword_get_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": {
+ "$ref": "#/components/schemas/CreateOnePasswordTokenResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-fern-sdk-method-name": "get_onepassword_token"
+ }
+ },
+ "/v1/credentials/onepassword/create": {
"post": {
"tags": [
- "Projects"
+ "Auth Tokens"
],
- "summary": "Create project",
- "description": "Create a new project with optional files and metadata",
- "operationId": "create_project_v1_projects_post",
+ "summary": "Create or update OnePassword service account token",
+ "description": "Creates or updates a OnePassword service account token for the current organization. Only one valid token is allowed per organization.",
+ "operationId": "update_onepassword_token_v1_credentials_onepassword_create_post",
"parameters": [
{
"name": "x-api-key",
@@ -1732,7 +1785,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateProjectRequest"
+ "$ref": "#/components/schemas/CreateOnePasswordTokenRequest",
+ "description": "The OnePassword token data",
+ "openapi_extra": {
+ "x-fern-sdk-parameter-name": "data"
+ }
}
}
}
@@ -1743,7 +1800,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateProjectResponse"
+ "$ref": "#/components/schemas/CreateOnePasswordTokenResponse"
}
}
}
@@ -1759,15 +1816,159 @@
}
}
},
- "x-fern-sdk-method-name": "create_project"
+ "x-fern-sdk-method-name": "update_onepassword_token"
+ }
+ },
+ "/v1/run/tasks/login": {
+ "post": {
+ "tags": [
+ "Agent"
+ ],
+ "summary": "Login Task",
+ "description": "Log in to a website using either credential stored in Skyvern, Bitwarden or 1Password",
+ "operationId": "login_v1_run_tasks_login_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/LoginRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkflowRunResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-fern-sdk-method-name": "login",
+ "x-fern-examples": [
+ {
+ "code-samples": [
+ {
+ "sdk": "python",
+ "code": "# Login with password saved in Skyvern\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"skyvern\",\n credential_id=\"cred_123\"),\n)\n"
+ },
+ {
+ "sdk": "python",
+ "code": "# Login with password saved in Bitwarden\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\n# Login with a Bitwarden collection and website url filter\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"bitwarden\",\n bitwarden_collection_id=\"BITWARDEN COLLECTION ID\",\n)\n\n# Login with a Bitwarden item\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"bitwarden\",\n bitwarden_item_id=\"BITWARDEN ITEM ID\",\n)\n"
+ },
+ {
+ "sdk": "python",
+ "code": "# Login with password saved in 1Password\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"onepassword\",\n onepassword_vault_id=\"1PASSWORD VAULT ID\",\n onepassword_item_id=\"1PASSWORD ITEM ID\",\n)\n"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "/v1/scripts": {
+ "post": {
+ "tags": [
+ "Scripts"
+ ],
+ "summary": "Create script",
+ "description": "Create a new script with optional files and metadata",
+ "operationId": "create_script_v1_scripts_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/CreateScriptRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateScriptResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-fern-sdk-method-name": "create_script"
},
"get": {
"tags": [
- "Projects"
+ "Scripts"
],
- "summary": "Get all projects",
- "description": "Retrieves a paginated list of projects for the current organization",
- "operationId": "get_projects_v1_projects_get",
+ "summary": "Get all scripts",
+ "description": "Retrieves a paginated list of scripts for the current organization",
+ "operationId": "get_scripts_v1_scripts_get",
"parameters": [
{
"name": "page",
@@ -1828,9 +2029,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Project"
+ "$ref": "#/components/schemas/Script"
},
- "title": "Response Get Projects V1 Projects Get"
+ "title": "Response Get Scripts V1 Scripts Get"
}
}
}
@@ -1846,31 +2047,31 @@
}
}
},
- "x-fern-sdk-method-name": "get_projects"
+ "x-fern-sdk-method-name": "get_scripts"
}
},
- "/v1/projects/{project_id}": {
+ "/v1/scripts/{script_id}": {
"get": {
"tags": [
- "Projects"
+ "Scripts"
],
- "summary": "Get project by ID",
- "description": "Retrieves a specific project by its ID",
- "operationId": "get_project_v1_projects__project_id__get",
+ "summary": "Get script by ID",
+ "description": "Retrieves a specific script by its ID",
+ "operationId": "get_script_v1_scripts__script_id__get",
"parameters": [
{
- "name": "project_id",
+ "name": "script_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The unique identifier of the project",
+ "description": "The unique identifier of the script",
"examples": [
- "proj_abc123"
+ "s_abc123"
],
- "title": "Project Id"
+ "title": "Script Id"
},
- "description": "The unique identifier of the project"
+ "description": "The unique identifier of the script"
},
{
"name": "x-api-key",
@@ -1897,7 +2098,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Project"
+ "$ref": "#/components/schemas/Script"
}
}
}
@@ -1913,31 +2114,31 @@
}
}
},
- "x-fern-sdk-method-name": "get_project"
+ "x-fern-sdk-method-name": "get_script"
}
},
- "/v1/projects/{project_id}/deploy": {
+ "/v1/scripts/{script_id}/deploy": {
"post": {
"tags": [
- "Projects"
+ "Scripts"
],
- "summary": "Deploy project",
- "description": "Deploy a project with updated files, creating a new version",
- "operationId": "deploy_project_v1_projects__project_id__deploy_post",
+ "summary": "Deploy script",
+ "description": "Deploy a script with updated files, creating a new version",
+ "operationId": "deploy_script_v1_scripts__script_id__deploy_post",
"parameters": [
{
- "name": "project_id",
+ "name": "script_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The unique identifier of the project",
+ "description": "The unique identifier of the script",
"examples": [
- "proj_abc123"
+ "s_abc123"
],
- "title": "Project Id"
+ "title": "Script Id"
},
- "description": "The unique identifier of the project"
+ "description": "The unique identifier of the script"
},
{
"name": "x-api-key",
@@ -1963,7 +2164,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DeployProjectRequest"
+ "$ref": "#/components/schemas/DeployScriptRequest"
}
}
}
@@ -1974,7 +2175,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateProjectResponse"
+ "$ref": "#/components/schemas/CreateScriptResponse"
}
}
}
@@ -1990,18 +2191,32 @@
}
}
},
- "x-fern-sdk-method-name": "deploy_project"
+ "x-fern-sdk-method-name": "deploy_script"
}
},
- "/v1/run/tasks/login": {
+ "/v1/scripts/{script_id}/run": {
"post": {
"tags": [
- "Agent"
+ "Scripts"
],
- "summary": "Login Task",
- "description": "Log in to a website using either credential stored in Skyvern, Bitwarden or 1Password",
- "operationId": "login_v1_run_tasks_login_post",
+ "summary": "Run script",
+ "description": "Run a script",
+ "operationId": "run_script_v1_scripts__script_id__run_post",
"parameters": [
+ {
+ "name": "script_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "The unique identifier of the script",
+ "examples": [
+ "s_abc123"
+ ],
+ "title": "Script Id"
+ },
+ "description": "The unique identifier of the script"
+ },
{
"name": "x-api-key",
"in": "header",
@@ -2021,24 +2236,12 @@
"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/LoginRequest"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/WorkflowRunResponse"
- }
+ "schema": {}
}
}
},
@@ -2052,26 +2255,7 @@
}
}
}
- },
- "x-fern-sdk-method-name": "login",
- "x-fern-examples": [
- {
- "code-samples": [
- {
- "sdk": "python",
- "code": "# Login with password saved in Skyvern\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"skyvern\",\n credential_id=\"cred_123\"),\n)\n"
- },
- {
- "sdk": "python",
- "code": "# Login with password saved in Bitwarden\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\n# Login with a Bitwarden collection and website url filter\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"bitwarden\",\n bitwarden_collection_id=\"BITWARDEN COLLECTION ID\",\n)\n\n# Login with a Bitwarden item\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"bitwarden\",\n bitwarden_item_id=\"BITWARDEN ITEM ID\",\n)\n"
- },
- {
- "sdk": "python",
- "code": "# Login with password saved in 1Password\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"onepassword\",\n onepassword_vault_id=\"1PASSWORD VAULT ID\",\n onepassword_item_id=\"1PASSWORD ITEM ID\",\n)\n"
- }
- ]
- }
- ]
+ }
}
}
},
@@ -2343,6 +2527,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -2366,6 +2553,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -2746,10 +2934,79 @@
"html_action",
"trace",
"har",
- "project_file"
+ "script_file"
],
"title": "ArtifactType"
},
+ "AzureSecretParameter": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "azure_secret",
+ "title": "Parameter Type",
+ "default": "azure_secret"
+ },
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Description"
+ },
+ "azure_secret_parameter_id": {
+ "type": "string",
+ "title": "Azure Secret Parameter Id"
+ },
+ "workflow_id": {
+ "type": "string",
+ "title": "Workflow Id"
+ },
+ "azure_key": {
+ "type": "string",
+ "title": "Azure Key"
+ },
+ "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",
+ "azure_secret_parameter_id",
+ "workflow_id",
+ "azure_key",
+ "created_at",
+ "modified_at"
+ ],
+ "title": "AzureSecretParameter"
+ },
"BitwardenCreditCardDataParameter": {
"properties": {
"parameter_type": {
@@ -3448,6 +3705,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -3471,6 +3731,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -3584,6 +3845,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -3732,14 +3996,46 @@
},
"type": "object",
"required": [
- "name",
- "credential_type",
- "credential"
+ "name",
+ "credential_type",
+ "credential"
+ ],
+ "title": "CreateCredentialRequest",
+ "description": "Request model for creating a new credential."
+ },
+ "CreateOnePasswordTokenRequest": {
+ "properties": {
+ "token": {
+ "type": "string",
+ "title": "Token",
+ "description": "The 1Password service account token",
+ "examples": [
+ "op_1234567890abcdef"
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "token"
+ ],
+ "title": "CreateOnePasswordTokenRequest",
+ "description": "Request model for creating or updating a 1Password service account token."
+ },
+ "CreateOnePasswordTokenResponse": {
+ "properties": {
+ "token": {
+ "$ref": "#/components/schemas/OrganizationAuthToken",
+ "description": "The created or updated 1Password service account token"
+ }
+ },
+ "type": "object",
+ "required": [
+ "token"
],
- "title": "CreateCredentialRequest",
- "description": "Request model for creating a new credential."
+ "title": "CreateOnePasswordTokenResponse",
+ "description": "Response model for 1Password token operations."
},
- "CreateProjectRequest": {
+ "CreateScriptRequest": {
"properties": {
"workflow_id": {
"anyOf": [
@@ -3769,7 +4065,7 @@
"anyOf": [
{
"items": {
- "$ref": "#/components/schemas/ProjectFile"
+ "$ref": "#/components/schemas/ScriptFileCreate"
},
"type": "array"
},
@@ -3778,7 +4074,7 @@
}
],
"title": "Files",
- "description": "Array of files to include in the project",
+ "description": "Array of files to include in the script",
"examples": [
{
"content": "cHJpbnQoIkhlbGxvLCBXb3JsZCEiKQ==",
@@ -3796,22 +4092,22 @@
}
},
"type": "object",
- "title": "CreateProjectRequest"
+ "title": "CreateScriptRequest"
},
- "CreateProjectResponse": {
+ "CreateScriptResponse": {
"properties": {
- "project_id": {
+ "script_id": {
"type": "string",
- "title": "Project Id",
- "description": "Unique project identifier",
+ "title": "Script Id",
+ "description": "Unique script identifier",
"examples": [
- "proj_abc123"
+ "s_abc123"
]
},
"version": {
"type": "integer",
"title": "Version",
- "description": "Project version number",
+ "description": "Script version number",
"examples": [
1
]
@@ -3826,12 +4122,12 @@
}
],
"title": "Run Id",
- "description": "ID of the workflow run or task run that generated this project"
+ "description": "ID of the workflow run or task run that generated this script"
},
"file_count": {
"type": "integer",
"title": "File Count",
- "description": "Total number of files in the project"
+ "description": "Total number of files in the script"
},
"file_tree": {
"additionalProperties": {
@@ -3845,18 +4141,18 @@
"type": "string",
"format": "date-time",
"title": "Created At",
- "description": "Timestamp when the project was created"
+ "description": "Timestamp when the script was created"
}
},
"type": "object",
"required": [
- "project_id",
+ "script_id",
"version",
"file_count",
"file_tree",
"created_at"
],
- "title": "CreateProjectResponse"
+ "title": "CreateScriptResponse"
},
"CredentialParameter": {
"properties": {
@@ -4043,15 +4339,15 @@
"title": "CreditCardCredentialResponse",
"description": "Response model for credit card credentials, containing only the last four digits and brand."
},
- "DeployProjectRequest": {
+ "DeployScriptRequest": {
"properties": {
"files": {
"items": {
- "$ref": "#/components/schemas/ProjectFile"
+ "$ref": "#/components/schemas/ScriptFileCreate"
},
"type": "array",
"title": "Files",
- "description": "Array of files to include in the project",
+ "description": "Array of files to include in the script",
"examples": [
{
"content": "cHJpbnQoIkhlbGxvLCBXb3JsZCEiKQ==",
@@ -4066,8 +4362,8 @@
"required": [
"files"
],
- "title": "DeployProjectRequest",
- "description": "Request model for deploying a project with updated files."
+ "title": "DeployScriptRequest",
+ "description": "Request model for deploying a script with updated files."
},
"DownloadToS3Block": {
"properties": {
@@ -4310,6 +4606,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -4333,6 +4632,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -4687,6 +4987,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -4710,6 +5013,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -4932,7 +5236,8 @@
"FileEncoding": {
"type": "string",
"enum": [
- "base64"
+ "base64",
+ "utf-8"
],
"title": "FileEncoding",
"description": "Supported file content encodings."
@@ -5087,6 +5392,18 @@
},
"file_type": {
"$ref": "#/components/schemas/FileType"
+ },
+ "json_schema": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Json Schema"
}
},
"type": "object",
@@ -5133,6 +5450,18 @@
},
"file_type": {
"$ref": "#/components/schemas/FileType"
+ },
+ "json_schema": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Json Schema"
}
},
"type": "object",
@@ -5146,14 +5475,17 @@
"FileStorageType": {
"type": "string",
"enum": [
- "s3"
+ "s3",
+ "azure"
],
"title": "FileStorageType"
},
"FileType": {
"type": "string",
"enum": [
- "csv"
+ "csv",
+ "excel",
+ "pdf"
],
"title": "FileType"
},
@@ -5237,6 +5569,39 @@
],
"title": "Region Name"
},
+ "azure_storage_account_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Storage Account Name"
+ },
+ "azure_storage_account_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Storage Account Key"
+ },
+ "azure_blob_container_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Blob Container Name"
+ },
"path": {
"anyOf": [
{
@@ -5333,6 +5698,39 @@
],
"title": "Region Name"
},
+ "azure_storage_account_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Storage Account Name"
+ },
+ "azure_storage_account_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Storage Account Key"
+ },
+ "azure_blob_container_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Blob Container Name"
+ },
"path": {
"anyOf": [
{
@@ -5489,6 +5887,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -5512,6 +5913,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -5789,6 +6191,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -5812,6 +6217,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -6099,6 +6505,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -6122,6 +6531,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -6707,6 +7117,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -6730,6 +7143,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -7214,6 +7628,58 @@
],
"title": "OnePasswordCredentialParameterYAML"
},
+ "OrganizationAuthToken": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "Id"
+ },
+ "organization_id": {
+ "type": "string",
+ "title": "Organization Id"
+ },
+ "token_type": {
+ "$ref": "#/components/schemas/OrganizationAuthTokenType"
+ },
+ "token": {
+ "type": "string",
+ "title": "Token"
+ },
+ "valid": {
+ "type": "boolean",
+ "title": "Valid"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ },
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "organization_id",
+ "token_type",
+ "token",
+ "valid",
+ "created_at",
+ "modified_at"
+ ],
+ "title": "OrganizationAuthToken"
+ },
+ "OrganizationAuthTokenType": {
+ "type": "string",
+ "enum": [
+ "api",
+ "onepassword_service_account"
+ ],
+ "title": "OrganizationAuthTokenType"
+ },
"OutputParameter": {
"properties": {
"parameter_type": {
@@ -7363,7 +7829,8 @@
"output_parameter",
"file_url"
],
- "title": "PDFParserBlock"
+ "title": "PDFParserBlock",
+ "description": "DEPRECATED: Use FileParserBlock with file_type=FileType.PDF instead.\nThis block will be removed in a future version."
},
"PDFParserBlockYAML": {
"properties": {
@@ -7436,22 +7903,72 @@
"title": "PasswordCredentialResponse",
"description": "Response model for password credentials, containing only the username."
},
- "Project": {
+ "ProxyLocation": {
+ "type": "string",
+ "enum": [
+ "RESIDENTIAL",
+ "US-CA",
+ "US-NY",
+ "US-TX",
+ "US-FL",
+ "US-WA",
+ "RESIDENTIAL_ES",
+ "RESIDENTIAL_IE",
+ "RESIDENTIAL_GB",
+ "RESIDENTIAL_IN",
+ "RESIDENTIAL_JP",
+ "RESIDENTIAL_FR",
+ "RESIDENTIAL_DE",
+ "RESIDENTIAL_NZ",
+ "RESIDENTIAL_ZA",
+ "RESIDENTIAL_AR",
+ "RESIDENTIAL_AU",
+ "RESIDENTIAL_ISP",
+ "NONE"
+ ],
+ "title": "ProxyLocation"
+ },
+ "RunEngine": {
+ "type": "string",
+ "enum": [
+ "skyvern-1.0",
+ "skyvern-2.0",
+ "openai-cua",
+ "anthropic-cua",
+ "ui-tars"
+ ],
+ "title": "RunEngine"
+ },
+ "RunStatus": {
+ "type": "string",
+ "enum": [
+ "created",
+ "queued",
+ "running",
+ "timed_out",
+ "failed",
+ "terminated",
+ "completed",
+ "canceled"
+ ],
+ "title": "RunStatus"
+ },
+ "Script": {
"properties": {
- "project_revision_id": {
+ "script_revision_id": {
"type": "string",
- "title": "Project Revision Id",
- "description": "Unique identifier for this specific project revision"
+ "title": "Script Revision Id",
+ "description": "Unique identifier for this specific script revision"
},
- "project_id": {
+ "script_id": {
"type": "string",
- "title": "Project Id",
- "description": "User-facing project identifier, consistent across versions"
+ "title": "Script Id",
+ "description": "User-facing script identifier, consistent across versions"
},
"organization_id": {
"type": "string",
"title": "Organization Id",
- "description": "ID of the organization that owns this project"
+ "description": "ID of the organization that owns this script"
},
"run_id": {
"anyOf": [
@@ -7463,24 +7980,24 @@
}
],
"title": "Run Id",
- "description": "ID of the workflow run or task run that generated this project"
+ "description": "ID of the workflow run or task run that generated this script"
},
"version": {
"type": "integer",
"title": "Version",
- "description": "Version number of the project"
+ "description": "Version number of the script"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
- "description": "Timestamp when the project was created"
+ "description": "Timestamp when the script was created"
},
"modified_at": {
"type": "string",
"format": "date-time",
"title": "Modified At",
- "description": "Timestamp when the project was last modified"
+ "description": "Timestamp when the script was last modified"
},
"deleted_at": {
"anyOf": [
@@ -7493,26 +8010,26 @@
}
],
"title": "Deleted At",
- "description": "Timestamp when the project was soft deleted"
+ "description": "Timestamp when the script was soft deleted"
}
},
"type": "object",
"required": [
- "project_revision_id",
- "project_id",
+ "script_revision_id",
+ "script_id",
"organization_id",
"version",
"created_at",
"modified_at"
],
- "title": "Project"
+ "title": "Script"
},
- "ProjectFile": {
+ "ScriptFileCreate": {
"properties": {
"path": {
"type": "string",
"title": "Path",
- "description": "File path relative to project root",
+ "description": "File path relative to script root",
"examples": [
"src/main.py"
]
@@ -7545,58 +8062,8 @@
"path",
"content"
],
- "title": "ProjectFile",
- "description": "Model representing a file in a project."
- },
- "ProxyLocation": {
- "type": "string",
- "enum": [
- "RESIDENTIAL",
- "US-CA",
- "US-NY",
- "US-TX",
- "US-FL",
- "US-WA",
- "RESIDENTIAL_ES",
- "RESIDENTIAL_IE",
- "RESIDENTIAL_GB",
- "RESIDENTIAL_IN",
- "RESIDENTIAL_JP",
- "RESIDENTIAL_FR",
- "RESIDENTIAL_DE",
- "RESIDENTIAL_NZ",
- "RESIDENTIAL_ZA",
- "RESIDENTIAL_AR",
- "RESIDENTIAL_AU",
- "RESIDENTIAL_ISP",
- "NONE"
- ],
- "title": "ProxyLocation"
- },
- "RunEngine": {
- "type": "string",
- "enum": [
- "skyvern-1.0",
- "skyvern-2.0",
- "openai-cua",
- "anthropic-cua",
- "ui-tars"
- ],
- "title": "RunEngine"
- },
- "RunStatus": {
- "type": "string",
- "enum": [
- "created",
- "queued",
- "running",
- "timed_out",
- "failed",
- "terminated",
- "completed",
- "canceled"
- ],
- "title": "RunStatus"
+ "title": "ScriptFileCreate",
+ "description": "Model representing a file in a script."
},
"SendEmailBlock": {
"properties": {
@@ -8184,6 +8651,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -8207,6 +8677,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -9204,6 +9675,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -9227,6 +9701,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -9588,6 +10063,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -9611,6 +10089,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -9891,6 +10370,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -9914,6 +10396,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -10157,6 +10640,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -10180,6 +10666,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
@@ -10374,6 +10861,22 @@
],
"title": "Extra Http Headers"
},
+ "generate_script": {
+ "type": "boolean",
+ "title": "Generate Script",
+ "default": false
+ },
+ "cache_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cache Key"
+ },
"created_at": {
"type": "string",
"format": "date-time",
@@ -10525,12 +11028,12 @@
"$ref": "#/components/schemas/WorkflowStatus",
"default": "published"
},
- "use_cache": {
+ "generate_script": {
"type": "boolean",
- "title": "Use Cache",
+ "title": "Generate Script",
"default": false
},
- "cache_project_id": {
+ "cache_key": {
"anyOf": [
{
"type": "string"
@@ -10539,7 +11042,7 @@
"type": "null"
}
],
- "title": "Cache Project Id"
+ "title": "Cache Key"
}
},
"type": "object",
@@ -10563,6 +11066,9 @@
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
@@ -10586,6 +11092,7 @@
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",