Files
Dorod-Sky/fern/openapi/skyvern_openapi.json

7539 lines
227 KiB
JSON
Raw Normal View History

{
"openapi": "3.1.0",
"info": {
2025-03-21 15:53:11 -07:00
"title": "Skyvern API",
"description": "API for Skyvern",
"version": "1.0.0"
},
"paths": {
"/v1/runs/{run_id}": {
"get": {
"tags": [
2025-04-02 11:07:14 -04:00
"Agent"
],
2025-04-02 11:07:14 -04:00
"summary": "Get a task or a workflow run by id",
"description": "Get a task or a workflow run by id",
"operationId": "get_run_v1_runs__run_id__get",
"parameters": [
{
"name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
2025-04-02 11:07:14 -04:00
"description": "The id of the task run or the workflow run.",
"title": "Run Id"
2025-04-02 11:07:14 -04:00
},
"description": "The id of the task run or the workflow run."
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
2025-04-02 11:07:14 -04:00
"description": "Successfully got run",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TaskRunResponse"
},
{
"$ref": "#/components/schemas/WorkflowRunResponse"
}
],
"discriminator": {
"propertyName": "run_type",
"mapping": {
"task_v1": "#/components/schemas/TaskRunResponse",
"task_v2": "#/components/schemas/TaskRunResponse",
"workflow_run": "#/components/schemas/WorkflowRunResponse"
}
},
"title": "Response Get Run V1 Runs Run Id Get"
}
}
}
},
2025-04-02 11:07:14 -04:00
"404": {
"description": "Run not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "get_run"
}
},
2025-04-02 11:07:14 -04:00
"/v1/workflows": {
"post": {
"tags": [
"Agent"
],
2025-04-02 11:07:14 -04:00
"summary": "Create a new workflow",
"description": "Create a new workflow",
"operationId": "create_workflow_v1_workflows_post",
"parameters": [
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
2025-04-02 11:07:14 -04:00
"description": "Successfully created workflow",
"content": {
"application/json": {
"schema": {
2025-04-02 11:07:14 -04:00
"$ref": "#/components/schemas/Workflow"
}
}
}
},
"422": {
2025-04-02 11:07:14 -04:00
"description": "Invalid workflow definition"
}
2025-03-21 15:53:11 -07:00
},
"x-fern-sdk-group-name": "agent",
2025-04-02 11:07:14 -04:00
"x-fern-sdk-method-name": "create_workflow"
}
},
2025-04-02 11:07:14 -04:00
"/v1/workflows/{workflow_id}": {
"post": {
"tags": [
2025-04-02 11:07:14 -04:00
"Agent"
],
2025-04-02 11:07:14 -04:00
"summary": "Update a workflow definition",
"description": "Update a workflow definition",
"operationId": "update_workflow_v1_workflows__workflow_id__post",
"parameters": [
{
2025-04-02 11:07:14 -04:00
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
2025-04-02 11:07:14 -04:00
"title": "Workflow Id"
}
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
2025-04-02 11:07:14 -04:00
"description": "Successfully updated workflow",
"content": {
"application/json": {
"schema": {
2025-04-02 11:07:14 -04:00
"$ref": "#/components/schemas/Workflow"
}
}
}
},
"422": {
2025-04-02 11:07:14 -04:00
"description": "Invalid workflow definition"
}
},
"requestBody": {
"content": {
"application/x-yaml": {
"schema": {
"$defs": {
"AWSSecretParameterYAML": {
"properties": {
"parameter_type": {
"const": "aws_secret",
"default": "aws_secret",
"title": "Parameter Type",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"aws_key": {
"title": "Aws Key",
"type": "string"
}
},
"required": [
"key",
"aws_key"
],
"title": "AWSSecretParameterYAML",
"type": "object"
},
"ActionBlockYAML": {
"properties": {
"block_type": {
"const": "action",
"default": "action",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"default": 0,
"title": "Max Retries",
"type": "integer"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
},
"complete_on_download": {
"default": false,
"title": "Complete On Download",
"type": "boolean"
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"default": false,
"title": "Cache Actions",
"type": "boolean"
}
},
"required": [
"label"
],
"title": "ActionBlockYAML",
"type": "object"
},
"BitwardenCreditCardDataParameterYAML": {
"properties": {
"parameter_type": {
"const": "bitwarden_credit_card_data",
"default": "bitwarden_credit_card_data",
"title": "Parameter Type",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"bitwarden_client_id_aws_secret_key": {
"title": "Bitwarden Client Id Aws Secret Key",
"type": "string"
},
"bitwarden_client_secret_aws_secret_key": {
"title": "Bitwarden Client Secret Aws Secret Key",
"type": "string"
},
"bitwarden_master_password_aws_secret_key": {
"title": "Bitwarden Master Password Aws Secret Key",
"type": "string"
},
"bitwarden_collection_id": {
"title": "Bitwarden Collection Id",
"type": "string"
},
"bitwarden_item_id": {
"title": "Bitwarden Item Id",
"type": "string"
}
},
"required": [
"key",
"bitwarden_client_id_aws_secret_key",
"bitwarden_client_secret_aws_secret_key",
"bitwarden_master_password_aws_secret_key",
"bitwarden_collection_id",
"bitwarden_item_id"
],
"title": "BitwardenCreditCardDataParameterYAML",
"type": "object"
},
"BitwardenLoginCredentialParameterYAML": {
"properties": {
"parameter_type": {
"const": "bitwarden_login_credential",
"default": "bitwarden_login_credential",
"title": "Parameter Type",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"bitwarden_client_id_aws_secret_key": {
"title": "Bitwarden Client Id Aws Secret Key",
"type": "string"
},
"bitwarden_client_secret_aws_secret_key": {
"title": "Bitwarden Client Secret Aws Secret Key",
"type": "string"
},
"bitwarden_master_password_aws_secret_key": {
"title": "Bitwarden Master Password Aws Secret Key",
"type": "string"
},
"url_parameter_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url Parameter Key"
},
"bitwarden_collection_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Bitwarden Collection Id"
},
"bitwarden_item_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Bitwarden Item Id"
}
},
"required": [
"key",
"bitwarden_client_id_aws_secret_key",
"bitwarden_client_secret_aws_secret_key",
"bitwarden_master_password_aws_secret_key"
],
"title": "BitwardenLoginCredentialParameterYAML",
"type": "object"
},
"BitwardenSensitiveInformationParameterYAML": {
"properties": {
"parameter_type": {
"const": "bitwarden_sensitive_information",
"default": "bitwarden_sensitive_information",
"title": "Parameter Type",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"bitwarden_client_id_aws_secret_key": {
"title": "Bitwarden Client Id Aws Secret Key",
"type": "string"
},
"bitwarden_client_secret_aws_secret_key": {
"title": "Bitwarden Client Secret Aws Secret Key",
"type": "string"
},
"bitwarden_master_password_aws_secret_key": {
"title": "Bitwarden Master Password Aws Secret Key",
"type": "string"
},
"bitwarden_collection_id": {
"title": "Bitwarden Collection Id",
"type": "string"
},
"bitwarden_identity_key": {
"title": "Bitwarden Identity Key",
"type": "string"
},
"bitwarden_identity_fields": {
"items": {
"type": "string"
},
"title": "Bitwarden Identity Fields",
"type": "array"
}
},
"required": [
"key",
"bitwarden_client_id_aws_secret_key",
"bitwarden_client_secret_aws_secret_key",
"bitwarden_master_password_aws_secret_key",
"bitwarden_collection_id",
"bitwarden_identity_key",
"bitwarden_identity_fields"
],
"title": "BitwardenSensitiveInformationParameterYAML",
"type": "object"
},
"CodeBlockYAML": {
"properties": {
"block_type": {
"const": "code",
"default": "code",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"code": {
"title": "Code",
"type": "string"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
}
},
"required": [
"label",
"code"
],
"title": "CodeBlockYAML",
"type": "object"
},
"ContextParameterYAML": {
"properties": {
"parameter_type": {
"const": "context",
"default": "context",
"title": "Parameter Type",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"source_parameter_key": {
"title": "Source Parameter Key",
"type": "string"
}
},
"required": [
"key",
"source_parameter_key"
],
"title": "ContextParameterYAML",
"type": "object"
},
"CredentialParameterYAML": {
"properties": {
"parameter_type": {
"const": "credential",
"default": "credential",
"title": "Parameter Type",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credential_id": {
"title": "Credential Id",
"type": "string"
}
},
"required": [
"key",
"credential_id"
],
"title": "CredentialParameterYAML",
"type": "object"
},
"DownloadToS3BlockYAML": {
"properties": {
"block_type": {
"const": "download_to_s3",
"default": "download_to_s3",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"url": {
"title": "Url",
"type": "string"
}
},
"required": [
"label",
"url"
],
"title": "DownloadToS3BlockYAML",
"type": "object"
},
"ExtractionBlockYAML": {
"properties": {
"block_type": {
"const": "extraction",
"default": "extraction",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"data_extraction_goal": {
"title": "Data Extraction Goal",
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"max_retries": {
"default": 0,
"title": "Max Retries",
"type": "integer"
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
},
"cache_actions": {
"default": false,
"title": "Cache Actions",
"type": "boolean"
}
},
"required": [
"label",
"data_extraction_goal"
],
"title": "ExtractionBlockYAML",
"type": "object"
},
"FileDownloadBlockYAML": {
"properties": {
"block_type": {
"const": "file_download",
"default": "file_download",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"navigation_goal": {
"title": "Navigation Goal",
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"default": 0,
"title": "Max Retries",
"type": "integer"
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"default": false,
"title": "Cache Actions",
"type": "boolean"
}
},
"required": [
"label",
"navigation_goal"
],
"title": "FileDownloadBlockYAML",
"type": "object"
},
"FileParserBlockYAML": {
"properties": {
"block_type": {
"const": "file_url_parser",
"default": "file_url_parser",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"file_url": {
"title": "File Url",
"type": "string"
},
"file_type": {
"$ref": "#/$defs/FileType"
}
},
"required": [
"label",
"file_url",
"file_type"
],
"title": "FileParserBlockYAML",
"type": "object"
},
"FileStorageType": {
"enum": [
"s3"
],
"title": "FileStorageType",
"type": "string"
},
"FileType": {
"enum": [
"csv"
],
"title": "FileType",
"type": "string"
},
"FileUploadBlockYAML": {
"properties": {
"block_type": {
"const": "file_upload",
"default": "file_upload",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"storage_type": {
"$ref": "#/$defs/FileStorageType",
"default": "s3"
},
"s3_bucket": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "S3 Bucket"
},
"aws_access_key_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Aws Access Key Id"
},
"aws_secret_access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Aws Secret Access Key"
},
"region_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Region Name"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
}
},
"required": [
"label"
],
"title": "FileUploadBlockYAML",
"type": "object"
},
"ForLoopBlockYAML": {
"properties": {
"block_type": {
"const": "for_loop",
"default": "for_loop",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"loop_blocks": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/TaskBlockYAML"
},
{
"$ref": "#/$defs/ForLoopBlockYAML"
},
{
"$ref": "#/$defs/CodeBlockYAML"
},
{
"$ref": "#/$defs/TextPromptBlockYAML"
},
{
"$ref": "#/$defs/DownloadToS3BlockYAML"
},
{
"$ref": "#/$defs/UploadToS3BlockYAML"
},
{
"$ref": "#/$defs/FileUploadBlockYAML"
},
{
"$ref": "#/$defs/SendEmailBlockYAML"
},
{
"$ref": "#/$defs/FileParserBlockYAML"
},
{
"$ref": "#/$defs/ValidationBlockYAML"
},
{
"$ref": "#/$defs/ActionBlockYAML"
},
{
"$ref": "#/$defs/NavigationBlockYAML"
},
{
"$ref": "#/$defs/ExtractionBlockYAML"
},
{
"$ref": "#/$defs/LoginBlockYAML"
},
{
"$ref": "#/$defs/WaitBlockYAML"
},
{
"$ref": "#/$defs/FileDownloadBlockYAML"
},
{
"$ref": "#/$defs/UrlBlockYAML"
},
{
"$ref": "#/$defs/PDFParserBlockYAML"
},
{
"$ref": "#/$defs/TaskV2BlockYAML"
}
]
},
"title": "Loop Blocks",
"type": "array"
},
"loop_over_parameter_key": {
"default": "",
"title": "Loop Over Parameter Key",
"type": "string"
},
"loop_variable_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Loop Variable Reference"
},
"complete_if_empty": {
"default": false,
"title": "Complete If Empty",
"type": "boolean"
}
},
"required": [
"label",
"loop_blocks"
],
"title": "ForLoopBlockYAML",
"type": "object"
},
"LoginBlockYAML": {
"properties": {
"block_type": {
"const": "login",
"default": "login",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"default": 0,
"title": "Max Retries",
"type": "integer"
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"default": false,
"title": "Cache Actions",
"type": "boolean"
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"complete_verification": {
"default": true,
"title": "Complete Verification",
"type": "boolean"
}
},
"required": [
"label"
],
"title": "LoginBlockYAML",
"type": "object"
},
"NavigationBlockYAML": {
"properties": {
"block_type": {
"const": "navigation",
"default": "navigation",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"navigation_goal": {
"title": "Navigation Goal",
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"default": 0,
"title": "Max Retries",
"type": "integer"
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
},
"complete_on_download": {
"default": false,
"title": "Complete On Download",
"type": "boolean"
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"default": false,
"title": "Cache Actions",
"type": "boolean"
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"complete_verification": {
"default": true,
"title": "Complete Verification",
"type": "boolean"
}
},
"required": [
"label",
"navigation_goal"
],
"title": "NavigationBlockYAML",
"type": "object"
},
"OutputParameterYAML": {
"properties": {
"parameter_type": {
"const": "output",
"default": "output",
"title": "Parameter Type",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
}
},
"required": [
"key"
],
"title": "OutputParameterYAML",
"type": "object"
},
"PDFParserBlockYAML": {
"properties": {
"block_type": {
"const": "pdf_parser",
"default": "pdf_parser",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"file_url": {
"title": "File Url",
"type": "string"
},
"json_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Json Schema"
}
},
"required": [
"label",
"file_url"
],
"title": "PDFParserBlockYAML",
"type": "object"
},
"ProxyLocation": {
"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_ISP",
"NONE"
],
"title": "ProxyLocation",
"type": "string"
},
"SendEmailBlockYAML": {
"properties": {
"block_type": {
"const": "send_email",
"default": "send_email",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"smtp_host_secret_parameter_key": {
"title": "Smtp Host Secret Parameter Key",
"type": "string"
},
"smtp_port_secret_parameter_key": {
"title": "Smtp Port Secret Parameter Key",
"type": "string"
},
"smtp_username_secret_parameter_key": {
"title": "Smtp Username Secret Parameter Key",
"type": "string"
},
"smtp_password_secret_parameter_key": {
"title": "Smtp Password Secret Parameter Key",
"type": "string"
},
"sender": {
"title": "Sender",
"type": "string"
},
"recipients": {
"items": {
"type": "string"
},
"title": "Recipients",
"type": "array"
},
"subject": {
"title": "Subject",
"type": "string"
},
"body": {
"title": "Body",
"type": "string"
},
"file_attachments": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "File Attachments"
}
},
"required": [
"label",
"smtp_host_secret_parameter_key",
"smtp_port_secret_parameter_key",
"smtp_username_secret_parameter_key",
"smtp_password_secret_parameter_key",
"sender",
"recipients",
"subject",
"body"
],
"title": "SendEmailBlockYAML",
"type": "object"
},
"TaskBlockYAML": {
"properties": {
"block_type": {
"const": "task",
"default": "task",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"data_extraction_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"default": 0,
"title": "Max Retries",
"type": "integer"
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
},
"complete_on_download": {
"default": false,
"title": "Complete On Download",
"type": "boolean"
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"default": false,
"title": "Cache Actions",
"type": "boolean"
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"complete_verification": {
"default": true,
"title": "Complete Verification",
"type": "boolean"
}
},
"required": [
"label"
],
"title": "TaskBlockYAML",
"type": "object"
},
"TaskV2BlockYAML": {
"properties": {
"block_type": {
"const": "task_v2",
"default": "task_v2",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"prompt": {
"title": "Prompt",
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"max_iterations": {
"default": 10,
"title": "Max Iterations",
"type": "integer"
},
"max_steps": {
"default": 25,
"title": "Max Steps",
"type": "integer"
}
},
"required": [
"label",
"prompt"
],
"title": "TaskV2BlockYAML",
"type": "object"
},
"TextPromptBlockYAML": {
"properties": {
"block_type": {
"const": "text_prompt",
"default": "text_prompt",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"llm_key": {
"default": "OPENAI_GPT4O_MINI",
"title": "Llm Key",
"type": "string"
},
"prompt": {
"title": "Prompt",
"type": "string"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
},
"json_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Json Schema"
}
},
"required": [
"label",
"prompt"
],
"title": "TextPromptBlockYAML",
"type": "object"
},
"UploadToS3BlockYAML": {
"properties": {
"block_type": {
"const": "upload_to_s3",
"default": "upload_to_s3",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
}
},
"required": [
"label"
],
"title": "UploadToS3BlockYAML",
"type": "object"
},
"UrlBlockYAML": {
"properties": {
"block_type": {
"const": "goto_url",
"default": "goto_url",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"url": {
"title": "Url",
"type": "string"
}
},
"required": [
"label",
"url"
],
"title": "UrlBlockYAML",
"type": "object"
},
"ValidationBlockYAML": {
"properties": {
"block_type": {
"const": "validation",
"default": "validation",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"parameter_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Keys"
}
},
"required": [
"label"
],
"title": "ValidationBlockYAML",
"type": "object"
},
"WaitBlockYAML": {
"properties": {
"block_type": {
"const": "wait",
"default": "wait",
"title": "Block Type",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"continue_on_failure": {
"default": false,
"title": "Continue On Failure",
"type": "boolean"
},
"wait_sec": {
"default": 0,
"title": "Wait Sec",
"type": "integer"
}
},
"required": [
"label"
],
"title": "WaitBlockYAML",
"type": "object"
},
"WorkflowDefinitionYAML": {
"properties": {
"parameters": {
"items": {
"discriminator": {
"mapping": {
"aws_secret": "#/$defs/AWSSecretParameterYAML",
"bitwarden_credit_card_data": "#/$defs/BitwardenCreditCardDataParameterYAML",
"bitwarden_login_credential": "#/$defs/BitwardenLoginCredentialParameterYAML",
"bitwarden_sensitive_information": "#/$defs/BitwardenSensitiveInformationParameterYAML",
"context": "#/$defs/ContextParameterYAML",
"credential": "#/$defs/CredentialParameterYAML",
"output": "#/$defs/OutputParameterYAML",
"workflow": "#/$defs/WorkflowParameterYAML"
},
"propertyName": "parameter_type"
},
"oneOf": [
{
"$ref": "#/$defs/AWSSecretParameterYAML"
},
{
"$ref": "#/$defs/BitwardenLoginCredentialParameterYAML"
},
{
"$ref": "#/$defs/BitwardenSensitiveInformationParameterYAML"
},
{
"$ref": "#/$defs/BitwardenCreditCardDataParameterYAML"
},
{
"$ref": "#/$defs/WorkflowParameterYAML"
},
{
"$ref": "#/$defs/ContextParameterYAML"
},
{
"$ref": "#/$defs/OutputParameterYAML"
},
{
"$ref": "#/$defs/CredentialParameterYAML"
}
]
},
"title": "Parameters",
"type": "array"
},
"blocks": {
"items": {
"discriminator": {
"mapping": {
"action": "#/$defs/ActionBlockYAML",
"code": "#/$defs/CodeBlockYAML",
"download_to_s3": "#/$defs/DownloadToS3BlockYAML",
"extraction": "#/$defs/ExtractionBlockYAML",
"file_download": "#/$defs/FileDownloadBlockYAML",
"file_upload": "#/$defs/FileUploadBlockYAML",
"file_url_parser": "#/$defs/FileParserBlockYAML",
"for_loop": "#/$defs/ForLoopBlockYAML",
"goto_url": "#/$defs/UrlBlockYAML",
"login": "#/$defs/LoginBlockYAML",
"navigation": "#/$defs/NavigationBlockYAML",
"pdf_parser": "#/$defs/PDFParserBlockYAML",
"send_email": "#/$defs/SendEmailBlockYAML",
"task": "#/$defs/TaskBlockYAML",
"task_v2": "#/$defs/TaskV2BlockYAML",
"text_prompt": "#/$defs/TextPromptBlockYAML",
"upload_to_s3": "#/$defs/UploadToS3BlockYAML",
"validation": "#/$defs/ValidationBlockYAML",
"wait": "#/$defs/WaitBlockYAML"
},
"propertyName": "block_type"
},
"oneOf": [
{
"$ref": "#/$defs/TaskBlockYAML"
},
{
"$ref": "#/$defs/ForLoopBlockYAML"
},
{
"$ref": "#/$defs/CodeBlockYAML"
},
{
"$ref": "#/$defs/TextPromptBlockYAML"
},
{
"$ref": "#/$defs/DownloadToS3BlockYAML"
},
{
"$ref": "#/$defs/UploadToS3BlockYAML"
},
{
"$ref": "#/$defs/FileUploadBlockYAML"
},
{
"$ref": "#/$defs/SendEmailBlockYAML"
},
{
"$ref": "#/$defs/FileParserBlockYAML"
},
{
"$ref": "#/$defs/ValidationBlockYAML"
},
{
"$ref": "#/$defs/ActionBlockYAML"
},
{
"$ref": "#/$defs/NavigationBlockYAML"
},
{
"$ref": "#/$defs/ExtractionBlockYAML"
},
{
"$ref": "#/$defs/LoginBlockYAML"
},
{
"$ref": "#/$defs/WaitBlockYAML"
},
{
"$ref": "#/$defs/FileDownloadBlockYAML"
},
{
"$ref": "#/$defs/UrlBlockYAML"
},
{
"$ref": "#/$defs/PDFParserBlockYAML"
},
{
"$ref": "#/$defs/TaskV2BlockYAML"
}
]
},
"title": "Blocks",
"type": "array"
}
},
"required": [
"parameters",
"blocks"
],
"title": "WorkflowDefinitionYAML",
"type": "object"
},
"WorkflowParameterType": {
"enum": [
"string",
"integer",
"float",
"boolean",
"json",
"file_url",
"credential_id"
],
"title": "WorkflowParameterType",
"type": "string"
},
"WorkflowParameterYAML": {
"properties": {
"parameter_type": {
"const": "workflow",
"default": "workflow",
"title": "Parameter Type",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"workflow_parameter_type": {
"$ref": "#/$defs/WorkflowParameterType"
},
"default_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Default Value"
}
},
"required": [
"key",
"workflow_parameter_type"
],
"title": "WorkflowParameterYAML",
"type": "object"
},
"WorkflowStatus": {
"enum": [
"published",
"draft",
"auto_generated"
],
"title": "WorkflowStatus",
"type": "string"
}
},
"properties": {
"title": {
"title": "Title",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"proxy_location": {
"anyOf": [
{
"$ref": "#/$defs/ProxyLocation"
},
{
"type": "null"
}
]
},
"webhook_callback_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Webhook Callback Url"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"persist_browser_session": {
"default": false,
"title": "Persist Browser Session",
"type": "boolean"
},
"workflow_definition": {
"$ref": "#/$defs/WorkflowDefinitionYAML"
},
"is_saved_task": {
"default": false,
"title": "Is Saved Task",
"type": "boolean"
},
"status": {
"$ref": "#/$defs/WorkflowStatus",
"default": "published"
}
},
"required": [
"title",
"workflow_definition"
],
"title": "WorkflowCreateYAMLRequest",
"type": "object"
}
}
2025-04-02 11:07:14 -04:00
},
"required": true
2025-03-21 15:53:11 -07:00
},
2025-04-02 11:07:14 -04:00
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "update_workflow"
}
},
2025-04-02 11:07:14 -04:00
"/v1/workflows/{workflow_id}/delete": {
"post": {
2025-03-21 15:53:11 -07:00
"tags": [
2025-04-02 11:07:14 -04:00
"Agent"
2025-03-21 15:53:11 -07:00
],
2025-04-02 11:07:14 -04:00
"summary": "Delete a workflow",
"description": "Delete a workflow",
"operationId": "delete_workflow_v1_workflows__workflow_id__delete_post",
"parameters": [
2025-04-02 11:07:14 -04:00
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Workflow Id"
}
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
2025-04-02 11:07:14 -04:00
"description": "Successfully deleted workflow",
"content": {
"application/json": {
"schema": {
2025-04-02 11:07:14 -04:00
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
2025-03-21 15:53:11 -07:00
},
2025-04-02 11:07:14 -04:00
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "delete_workflow"
}
},
"/v1/run/tasks": {
"post": {
2025-03-21 15:53:11 -07:00
"tags": [
2025-04-02 11:07:14 -04:00
"Agent"
2025-03-21 15:53:11 -07:00
],
2025-04-02 11:07:14 -04:00
"summary": "Run a task",
"description": "Run a task",
"operationId": "run_task_v1_run_tasks_post",
"parameters": [
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
2025-04-02 11:07:14 -04:00
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRunRequest"
}
}
}
},
"responses": {
"200": {
2025-04-02 11:07:14 -04:00
"description": "Successfully run task",
"content": {
"application/json": {
"schema": {
2025-04-02 11:07:14 -04:00
"$ref": "#/components/schemas/TaskRunResponse"
}
}
}
},
2025-04-02 11:07:14 -04:00
"400": {
"description": "Invalid agent engine"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
2025-03-21 15:53:11 -07:00
},
2025-04-02 11:07:14 -04:00
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "run_task"
}
},
2025-04-02 11:07:14 -04:00
"/v1/run/workflows": {
"post": {
2025-03-21 15:53:11 -07:00
"tags": [
2025-04-02 11:07:14 -04:00
"Agent"
2025-03-21 15:53:11 -07:00
],
2025-04-02 11:07:14 -04:00
"summary": "Run a workflow",
"description": "Run a workflow",
"operationId": "run_workflow_v1_run_workflows_post",
"parameters": [
{
2025-04-02 11:07:14 -04:00
"name": "template",
"in": "query",
"required": false,
"schema": {
2025-04-02 11:07:14 -04:00
"type": "boolean",
"default": false,
"title": "Template"
}
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
2025-04-02 11:07:14 -04:00
{
"name": "x-max-steps-override",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "X-Max-Steps-Override"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
2025-04-02 11:07:14 -04:00
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowRunRequest"
}
}
}
},
"responses": {
"200": {
2025-04-02 11:07:14 -04:00
"description": "Successfully run workflow",
"content": {
"application/json": {
"schema": {
2025-04-02 11:07:14 -04:00
"$ref": "#/components/schemas/WorkflowRunResponse"
}
}
}
},
2025-04-02 11:07:14 -04:00
"400": {
"description": "Invalid workflow run request"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
2025-03-21 15:53:11 -07:00
},
2025-04-02 11:07:14 -04:00
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "run_workflow"
}
2025-04-02 11:07:14 -04:00
},
"/v1/runs/{run_id}/cancel": {
"post": {
"tags": [
"Agent"
],
"summary": "Cancel a task or workflow run",
"description": "Cancel a task or workflow run",
"operationId": "cancel_run_v1_runs__run_id__cancel_post",
"parameters": [
{
"name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The id of the task run or the workflow run to cancel.",
"title": "Run Id"
},
"description": "The id of the task run or the workflow run to cancel."
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "cancel_run"
}
},
"/v1/browser_sessions/{browser_session_id}": {
"get": {
"tags": [
"Browser Sessions"
],
"summary": "Get browser session details",
"description": "Get details about a specific browser session by ID",
"operationId": "get_browser_session_v1_browser_sessions__browser_session_id__get",
"parameters": [
{
"name": "browser_session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Browser Session Id"
}
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved browser session details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrowserSessionResponse"
}
}
}
},
"404": {
"description": "Browser session not found"
},
"401": {
"description": "Unauthorized - Invalid or missing authentication"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "browser_session",
"x-fern-sdk-method-name": "get_browser_session"
}
},
"/v1/browser_sessions": {
"get": {
"tags": [
"Browser Sessions"
],
"summary": "Get all active browser sessions",
"description": "Get all active browser sessions for the organization",
"operationId": "get_browser_sessions_v1_browser_sessions_get",
"parameters": [
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved all active browser sessions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BrowserSessionResponse"
},
"title": "Response Get Browser Sessions V1 Browser Sessions Get"
}
}
}
},
"401": {
"description": "Unauthorized - Invalid or missing authentication"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "browser_session",
"x-fern-sdk-method-name": "get_browser_sessions"
},
"post": {
"tags": [
"Browser Sessions"
],
"summary": "Create a new browser session",
"description": "Create a new browser session",
"operationId": "create_browser_session_v1_browser_sessions_post",
"parameters": [
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successfully created browser session",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrowserSessionResponse"
}
}
}
},
"401": {
"description": "Unauthorized - Invalid or missing authentication"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "browser_session",
"x-fern-sdk-method-name": "create_browser_session"
}
},
"/v1/browser_sessions/{browser_session_id}/close": {
"post": {
"tags": [
"Browser Sessions"
],
"summary": "Close a browser session",
"description": "Close a browser session",
"operationId": "close_browser_session_v1_browser_sessions__browser_session_id__close_post",
"parameters": [
{
"name": "browser_session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Browser Session Id"
}
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successfully closed browser session",
"content": {
"application/json": {
"schema": {
}
}
}
},
"401": {
"description": "Unauthorized - Invalid or missing authentication"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "browser_session",
"x-fern-sdk-method-name": "close_browser_session"
}
}
},
"components": {
"schemas": {
"AWSSecretParameter": {
"properties": {
"parameter_type": {
"type": "string",
"const": "aws_secret",
"title": "Parameter Type",
"default": "aws_secret"
},
"key": {
"type": "string",
"title": "Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"aws_secret_parameter_id": {
"type": "string",
"title": "Aws Secret Parameter Id"
},
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"aws_key": {
"type": "string",
"title": "Aws 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",
"aws_secret_parameter_id",
"workflow_id",
"aws_key",
"created_at",
"modified_at"
],
"title": "AWSSecretParameter"
},
"ActionBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "action",
"title": "Block Type",
"default": "action"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"task_type": {
"type": "string",
"title": "Task Type",
"default": "general"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"data_extraction_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"type": "integer",
"title": "Max Retries",
"default": 0
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
},
"complete_on_download": {
"type": "boolean",
"title": "Complete On Download",
"default": false
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"type": "boolean",
"title": "Cache Actions",
"default": false
},
"complete_verification": {
"type": "boolean",
"title": "Complete Verification",
"default": true
}
},
"type": "object",
"required": [
"label",
"output_parameter"
],
"title": "ActionBlock"
},
"BitwardenCreditCardDataParameter": {
"properties": {
"parameter_type": {
"type": "string",
"const": "bitwarden_credit_card_data",
"title": "Parameter Type",
"default": "bitwarden_credit_card_data"
},
"key": {
"type": "string",
"title": "Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"bitwarden_credit_card_data_parameter_id": {
"type": "string",
"title": "Bitwarden Credit Card Data Parameter Id"
},
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"bitwarden_client_id_aws_secret_key": {
"type": "string",
"title": "Bitwarden Client Id Aws Secret Key"
},
"bitwarden_client_secret_aws_secret_key": {
"type": "string",
"title": "Bitwarden Client Secret Aws Secret Key"
},
"bitwarden_master_password_aws_secret_key": {
"type": "string",
"title": "Bitwarden Master Password Aws Secret Key"
},
"bitwarden_collection_id": {
"type": "string",
"title": "Bitwarden Collection Id"
},
"bitwarden_item_id": {
"type": "string",
"title": "Bitwarden 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",
"bitwarden_credit_card_data_parameter_id",
"workflow_id",
"bitwarden_client_id_aws_secret_key",
"bitwarden_client_secret_aws_secret_key",
"bitwarden_master_password_aws_secret_key",
"bitwarden_collection_id",
"bitwarden_item_id",
"created_at",
"modified_at"
],
"title": "BitwardenCreditCardDataParameter"
},
"BitwardenLoginCredentialParameter": {
"properties": {
"parameter_type": {
"type": "string",
"const": "bitwarden_login_credential",
"title": "Parameter Type",
"default": "bitwarden_login_credential"
},
"key": {
"type": "string",
"title": "Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"bitwarden_login_credential_parameter_id": {
"type": "string",
"title": "Bitwarden Login Credential Parameter Id"
},
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"bitwarden_client_id_aws_secret_key": {
"type": "string",
"title": "Bitwarden Client Id Aws Secret Key"
},
"bitwarden_client_secret_aws_secret_key": {
"type": "string",
"title": "Bitwarden Client Secret Aws Secret Key"
},
"bitwarden_master_password_aws_secret_key": {
"type": "string",
"title": "Bitwarden Master Password Aws Secret Key"
},
"url_parameter_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url Parameter Key"
},
"bitwarden_collection_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Bitwarden Collection Id"
},
"bitwarden_item_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Bitwarden 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",
"bitwarden_login_credential_parameter_id",
"workflow_id",
"bitwarden_client_id_aws_secret_key",
"bitwarden_client_secret_aws_secret_key",
"bitwarden_master_password_aws_secret_key",
"created_at",
"modified_at"
],
"title": "BitwardenLoginCredentialParameter"
},
"BitwardenSensitiveInformationParameter": {
"properties": {
"parameter_type": {
"type": "string",
"const": "bitwarden_sensitive_information",
"title": "Parameter Type",
"default": "bitwarden_sensitive_information"
},
"key": {
"type": "string",
"title": "Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"bitwarden_sensitive_information_parameter_id": {
"type": "string",
"title": "Bitwarden Sensitive Information Parameter Id"
},
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"bitwarden_client_id_aws_secret_key": {
"type": "string",
"title": "Bitwarden Client Id Aws Secret Key"
},
"bitwarden_client_secret_aws_secret_key": {
"type": "string",
"title": "Bitwarden Client Secret Aws Secret Key"
},
"bitwarden_master_password_aws_secret_key": {
"type": "string",
"title": "Bitwarden Master Password Aws Secret Key"
},
"bitwarden_collection_id": {
"type": "string",
"title": "Bitwarden Collection Id"
},
"bitwarden_identity_key": {
"type": "string",
"title": "Bitwarden Identity Key"
},
"bitwarden_identity_fields": {
"items": {
"type": "string"
},
"type": "array",
"title": "Bitwarden Identity Fields"
},
"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",
"bitwarden_sensitive_information_parameter_id",
"workflow_id",
"bitwarden_client_id_aws_secret_key",
"bitwarden_client_secret_aws_secret_key",
"bitwarden_master_password_aws_secret_key",
"bitwarden_collection_id",
"bitwarden_identity_key",
"bitwarden_identity_fields",
"created_at",
"modified_at"
],
"title": "BitwardenSensitiveInformationParameter"
},
"BrowserSessionResponse": {
"properties": {
"browser_session_id": {
"type": "string",
"title": "Browser Session Id",
"description": "Unique identifier for the browser session"
},
"organization_id": {
"type": "string",
2025-04-02 11:07:14 -04:00
"title": "Organization Id",
"description": "ID of the organization that owns this session"
},
"runnable_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Runnable Type",
"description": "Type of runnable associated with this session (workflow, task etc)"
},
"runnable_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Runnable Id",
"description": "ID of the associated runnable"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "Timestamp when the session was created"
},
"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."
},
"CodeBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "code",
"title": "Block Type",
"default": "code"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"code": {
"type": "string",
"title": "Code"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"code"
],
"title": "CodeBlock"
},
"ContextParameter": {
"properties": {
"parameter_type": {
"type": "string",
"const": "context",
"title": "Parameter Type",
"default": "context"
},
"key": {
"type": "string",
"title": "Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"title": "Source"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Value"
}
},
"type": "object",
"required": [
"key",
"source"
],
"title": "ContextParameter"
},
"CredentialParameter": {
"properties": {
"parameter_type": {
"type": "string",
"const": "credential",
"title": "Parameter Type",
"default": "credential"
},
"key": {
"type": "string",
"title": "Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credential_parameter_id": {
"type": "string",
"title": "Credential Parameter Id"
},
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"credential_id": {
"type": "string",
"title": "Credential 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",
"credential_parameter_id",
"workflow_id",
"credential_id",
"created_at",
"modified_at"
],
"title": "CredentialParameter"
},
"DownloadToS3Block": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "download_to_s3",
"title": "Block Type",
"default": "download_to_s3"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"url": {
"type": "string",
"title": "Url"
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"url"
],
"title": "DownloadToS3Block"
},
"ExtractionBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "extraction",
"title": "Block Type",
"default": "extraction"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"task_type": {
"type": "string",
"title": "Task Type",
"default": "general"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"data_extraction_goal": {
"type": "string",
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"type": "integer",
"title": "Max Retries",
"default": 0
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
},
"complete_on_download": {
"type": "boolean",
"title": "Complete On Download",
"default": false
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"type": "boolean",
"title": "Cache Actions",
"default": false
},
"complete_verification": {
"type": "boolean",
"title": "Complete Verification",
"default": true
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"data_extraction_goal"
],
"title": "ExtractionBlock"
},
"FileDownloadBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "file_download",
"title": "Block Type",
"default": "file_download"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"task_type": {
"type": "string",
"title": "Task Type",
"default": "general"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"data_extraction_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"type": "integer",
"title": "Max Retries",
"default": 0
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
},
"complete_on_download": {
"type": "boolean",
"title": "Complete On Download",
"default": false
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"type": "boolean",
"title": "Cache Actions",
"default": false
},
"complete_verification": {
"type": "boolean",
"title": "Complete Verification",
"default": true
}
},
"type": "object",
"required": [
"label",
"output_parameter"
],
"title": "FileDownloadBlock"
},
"FileInfo": {
"properties": {
"url": {
"type": "string",
"title": "Url",
"description": "URL to access the file"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Checksum",
"description": "SHA-256 checksum of the file"
},
"filename": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filename",
"description": "Original filename"
}
},
"type": "object",
"required": [
"url"
],
"title": "FileInfo",
"description": "Information about a downloaded file, including URL and checksum."
},
"FileParserBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "file_url_parser",
"title": "Block Type",
"default": "file_url_parser"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"file_url": {
"type": "string",
"title": "File Url"
},
"file_type": {
"$ref": "#/components/schemas/FileType"
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"file_url",
"file_type"
],
"title": "FileParserBlock"
},
"FileStorageType": {
"type": "string",
"enum": [
"s3"
],
"title": "FileStorageType"
},
"FileType": {
"type": "string",
"enum": [
"csv"
],
"title": "FileType"
},
"FileUploadBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "file_upload",
"title": "Block Type",
"default": "file_upload"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"storage_type": {
"$ref": "#/components/schemas/FileStorageType",
"default": "s3"
},
"s3_bucket": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "S3 Bucket"
},
"aws_access_key_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Aws Access Key Id"
},
"aws_secret_access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Aws Secret Access Key"
},
"region_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Region Name"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
}
},
"type": "object",
"required": [
"label",
"output_parameter"
],
"title": "FileUploadBlock"
},
"ForLoopBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "for_loop",
"title": "Block Type",
"default": "for_loop"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"loop_blocks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ForLoopBlock"
},
{
"$ref": "#/components/schemas/TaskBlock"
},
{
"$ref": "#/components/schemas/CodeBlock"
},
{
"$ref": "#/components/schemas/TextPromptBlock"
},
{
"$ref": "#/components/schemas/DownloadToS3Block"
},
{
"$ref": "#/components/schemas/UploadToS3Block"
},
{
"$ref": "#/components/schemas/SendEmailBlock"
},
{
"$ref": "#/components/schemas/FileParserBlock"
},
{
"$ref": "#/components/schemas/PDFParserBlock"
},
{
"$ref": "#/components/schemas/ValidationBlock"
},
{
"$ref": "#/components/schemas/ActionBlock"
},
{
"$ref": "#/components/schemas/NavigationBlock"
},
{
"$ref": "#/components/schemas/ExtractionBlock"
},
{
"$ref": "#/components/schemas/LoginBlock"
},
{
"$ref": "#/components/schemas/WaitBlock"
},
{
"$ref": "#/components/schemas/FileDownloadBlock"
},
{
"$ref": "#/components/schemas/UrlBlock"
},
{
"$ref": "#/components/schemas/TaskV2Block"
},
{
"$ref": "#/components/schemas/FileUploadBlock"
}
],
"discriminator": {
"propertyName": "block_type",
"mapping": {
"action": "#/components/schemas/ActionBlock",
"code": "#/components/schemas/CodeBlock",
"download_to_s3": "#/components/schemas/DownloadToS3Block",
"extraction": "#/components/schemas/ExtractionBlock",
"file_download": "#/components/schemas/FileDownloadBlock",
"file_upload": "#/components/schemas/FileUploadBlock",
"file_url_parser": "#/components/schemas/FileParserBlock",
"for_loop": "#/components/schemas/ForLoopBlock",
"goto_url": "#/components/schemas/UrlBlock",
"login": "#/components/schemas/LoginBlock",
"navigation": "#/components/schemas/NavigationBlock",
"pdf_parser": "#/components/schemas/PDFParserBlock",
"send_email": "#/components/schemas/SendEmailBlock",
"task": "#/components/schemas/TaskBlock",
"task_v2": "#/components/schemas/TaskV2Block",
"text_prompt": "#/components/schemas/TextPromptBlock",
"upload_to_s3": "#/components/schemas/UploadToS3Block",
"validation": "#/components/schemas/ValidationBlock",
"wait": "#/components/schemas/WaitBlock"
}
}
},
"type": "array",
"title": "Loop Blocks"
},
"loop_over": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
{
"type": "null"
}
],
"title": "Loop Over"
},
"loop_variable_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Loop Variable Reference"
},
"complete_if_empty": {
"type": "boolean",
"title": "Complete If Empty",
"default": false
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"loop_blocks"
],
"title": "ForLoopBlock"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"LoginBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "login",
"title": "Block Type",
"default": "login"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"task_type": {
"type": "string",
"title": "Task Type",
"default": "general"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"data_extraction_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"type": "integer",
"title": "Max Retries",
"default": 0
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
},
"complete_on_download": {
"type": "boolean",
"title": "Complete On Download",
"default": false
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"type": "boolean",
"title": "Cache Actions",
"default": false
},
"complete_verification": {
"type": "boolean",
"title": "Complete Verification",
"default": true
}
},
"type": "object",
"required": [
"label",
"output_parameter"
],
"title": "LoginBlock"
},
"NavigationBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "navigation",
"title": "Block Type",
"default": "navigation"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"task_type": {
"type": "string",
"title": "Task Type",
"default": "general"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"navigation_goal": {
"type": "string",
"title": "Navigation Goal"
},
"data_extraction_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"type": "integer",
"title": "Max Retries",
"default": 0
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
},
"complete_on_download": {
"type": "boolean",
"title": "Complete On Download",
"default": false
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"type": "boolean",
"title": "Cache Actions",
"default": false
},
"complete_verification": {
"type": "boolean",
"title": "Complete Verification",
"default": true
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"navigation_goal"
],
"title": "NavigationBlock"
},
"OutputParameter": {
"properties": {
"parameter_type": {
"type": "string",
"const": "output",
"title": "Parameter Type",
"default": "output"
},
"key": {
"type": "string",
"title": "Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"output_parameter_id": {
"type": "string",
"title": "Output Parameter Id"
},
"workflow_id": {
"type": "string",
"title": "Workflow 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",
"output_parameter_id",
"workflow_id",
"created_at",
"modified_at"
],
"title": "OutputParameter"
},
"PDFParserBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "pdf_parser",
"title": "Block Type",
"default": "pdf_parser"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"file_url": {
"type": "string",
"title": "File Url"
},
"json_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Json Schema"
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"file_url"
],
"title": "PDFParserBlock"
},
"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_ISP",
"NONE"
],
"title": "ProxyLocation"
},
"RunEngine": {
"type": "string",
"enum": [
"skyvern-1.0",
"skyvern-2.0"
],
"title": "RunEngine"
},
"RunStatus": {
"type": "string",
"enum": [
"created",
"queued",
"running",
"timed_out",
"failed",
"terminated",
"completed",
"canceled"
],
"title": "RunStatus"
},
"SendEmailBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "send_email",
"title": "Block Type",
"default": "send_email"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"smtp_host": {
"$ref": "#/components/schemas/AWSSecretParameter"
},
"smtp_port": {
"$ref": "#/components/schemas/AWSSecretParameter"
},
"smtp_username": {
"$ref": "#/components/schemas/AWSSecretParameter"
},
"smtp_password": {
"$ref": "#/components/schemas/AWSSecretParameter"
},
"sender": {
"type": "string",
"title": "Sender"
},
"recipients": {
"items": {
"type": "string"
},
"type": "array",
"title": "Recipients"
},
"subject": {
"type": "string",
"title": "Subject"
},
"body": {
"type": "string",
"title": "Body"
},
"file_attachments": {
"items": {
"type": "string"
},
"type": "array",
"title": "File Attachments",
"default": []
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"smtp_host",
"smtp_port",
"smtp_username",
"smtp_password",
"sender",
"recipients",
"subject",
"body"
],
"title": "SendEmailBlock"
},
"TaskBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "task",
"title": "Block Type",
"default": "task"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"task_type": {
"type": "string",
"title": "Task Type",
"default": "general"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"data_extraction_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"type": "integer",
"title": "Max Retries",
"default": 0
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
},
"complete_on_download": {
"type": "boolean",
"title": "Complete On Download",
"default": false
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"type": "boolean",
"title": "Cache Actions",
"default": false
},
"complete_verification": {
"type": "boolean",
"title": "Complete Verification",
"default": true
}
},
"type": "object",
"required": [
"label",
"output_parameter"
],
"title": "TaskBlock"
},
"TaskRunRequest": {
"properties": {
"prompt": {
"type": "string",
"title": "Prompt",
"description": "The goal or task description for Skyvern to accomplish"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"description": "The starting URL for the task. If not provided, Skyvern will attempt to determine an appropriate URL"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "Optional title for the task"
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"description": "The Skyvern engine version to use for this task",
"default": "skyvern-2.0"
},
"proxy_location": {
"anyOf": [
{
"$ref": "#/components/schemas/ProxyLocation"
},
{
"type": "null"
}
],
"description": "Geographic Proxy location to route the browser traffic through",
"default": "RESIDENTIAL"
},
"data_extraction_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Schema",
"description": "Schema defining what data should be extracted from the webpage"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping",
"description": "Custom mapping of error codes to error messages if Skyvern encounters an error"
},
"max_steps": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps",
"description": "Maximum number of steps the task can take before timing out"
},
"webhook_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Webhook Url",
"description": "URL to send task status updates to after a run is finished"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier",
"description": "Identifier for TOTP (Time-based One-Time Password) authentication if codes are being pushed to Skyvern"
},
"totp_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Url",
"description": "URL for TOTP authentication setup if Skyvern should be polling endpoint for 2FA codes"
},
"browser_session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Browser Session Id",
"description": "ID of an existing browser session to reuse, having it continue from the current screen state"
},
"publish_workflow": {
"type": "boolean",
"title": "Publish Workflow",
"description": "Whether to publish this task as a reusable workflow. ",
"default": false
}
},
"type": "object",
"required": [
"prompt"
],
"title": "TaskRunRequest"
},
"TaskRunResponse": {
"properties": {
"run_id": {
"type": "string",
"title": "Run Id",
"description": "Unique identifier for this run"
},
"status": {
"$ref": "#/components/schemas/RunStatus",
"description": "Current status of the run"
},
"output": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Output",
"description": "Output data from the run, if any. Format depends on the schema in the input"
},
"downloaded_files": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Downloaded Files",
"description": "List of files downloaded during the run"
},
"recording_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recording Url",
"description": "URL to the recording of the run"
},
"failure_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Failure Reason",
"description": "Reason for failure if the run failed"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "Timestamp when this run was created"
},
"modified_at": {
"type": "string",
"format": "date-time",
"title": "Modified At",
"description": "Timestamp when this run was last modified"
},
"run_type": {
"type": "string",
"enum": [
"task_v1",
"task_v2"
],
"title": "Run Type",
"description": "Type of task run - either task_v1 or task_v2"
},
"run_request": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunRequest"
},
{
"type": "null"
}
],
"description": "The original request parameters used to start this task run"
}
},
"type": "object",
"required": [
"run_id",
"status",
"created_at",
"modified_at",
"run_type"
],
"title": "TaskRunResponse"
},
"TaskV2Block": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "task_v2",
"title": "Block Type",
"default": "task_v2"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"prompt": {
"type": "string",
"title": "Prompt"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"max_iterations": {
"type": "integer",
"title": "Max Iterations",
"default": 10
},
"max_steps": {
"type": "integer",
"title": "Max Steps",
"default": 25
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"prompt"
],
"title": "TaskV2Block"
},
"TextPromptBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
2025-04-02 11:07:14 -04:00
"block_type": {
"type": "string",
"const": "text_prompt",
"title": "Block Type",
"default": "text_prompt"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"llm_key": {
"type": "string",
"title": "Llm Key",
"default": "AZURE_OPENAI"
},
"prompt": {
"type": "string",
"title": "Prompt"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
},
"json_schema": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Json Schema"
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"prompt"
],
"title": "TextPromptBlock"
},
"UploadToS3Block": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
2025-04-02 11:07:14 -04:00
"block_type": {
"type": "string",
"const": "upload_to_s3",
"title": "Block Type",
"default": "upload_to_s3"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Path"
}
},
"type": "object",
"required": [
"label",
"output_parameter"
],
"title": "UploadToS3Block"
},
"UrlBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
2025-04-02 11:07:14 -04:00
"block_type": {
"type": "string",
2025-04-02 11:07:14 -04:00
"const": "goto_url",
"title": "Block Type",
"default": "goto_url"
},
2025-04-02 11:07:14 -04:00
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"task_type": {
"type": "string",
2025-04-02 11:07:14 -04:00
"title": "Task Type",
"default": "general"
},
2025-04-02 11:07:14 -04:00
"url": {
"type": "string",
"title": "Url"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"complete_criterion": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Complete Criterion"
},
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
"navigation_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Navigation Goal"
},
"data_extraction_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"type": "integer",
"title": "Max Retries",
"default": 0
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameters": {
"items": {
2025-04-02 11:07:14 -04:00
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
2025-04-02 11:07:14 -04:00
"title": "Parameters",
"default": []
},
"complete_on_download": {
"type": "boolean",
"title": "Complete On Download",
"default": false
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier"
},
"cache_actions": {
"type": "boolean",
"title": "Cache Actions",
"default": false
},
"complete_verification": {
"type": "boolean",
"title": "Complete Verification",
"default": true
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"url"
],
2025-04-02 11:07:14 -04:00
"title": "UrlBlock"
},
2025-04-02 11:07:14 -04:00
"ValidationBlock": {
"properties": {
2025-04-02 11:07:14 -04:00
"label": {
"type": "string",
2025-04-02 11:07:14 -04:00
"title": "Label"
},
"block_type": {
"type": "string",
"const": "validation",
"title": "Block Type",
"default": "validation"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"task_type": {
"type": "string",
"title": "Task Type",
"default": "general"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Url"
},
"title": {
2025-04-02 11:07:14 -04:00
"type": "string",
"title": "Title",
"default": ""
},
"complete_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Complete Criterion"
},
2025-04-02 11:07:14 -04:00
"terminate_criterion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terminate Criterion"
},
2025-04-02 11:07:14 -04:00
"navigation_goal": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Navigation Goal"
},
2025-04-02 11:07:14 -04:00
"data_extraction_goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data Extraction Goal"
},
"data_schema": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
2025-04-02 11:07:14 -04:00
{
"type": "null"
}
],
"title": "Data Schema"
},
"error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Error Code Mapping"
},
"max_retries": {
"type": "integer",
"title": "Max Retries",
"default": 0
},
"max_steps_per_run": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Steps Per Run"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
},
"complete_on_download": {
"type": "boolean",
"title": "Complete On Download",
"default": false
},
"download_suffix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Download Suffix"
},
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Verification Url"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Totp Identifier"
},
2025-04-02 11:07:14 -04:00
"cache_actions": {
"type": "boolean",
"title": "Cache Actions",
"default": false
},
"complete_verification": {
"type": "boolean",
"title": "Complete Verification",
"default": true
}
},
"type": "object",
"required": [
"label",
"output_parameter"
],
"title": "ValidationBlock"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WaitBlock": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"block_type": {
"type": "string",
"const": "wait",
"title": "Block Type",
"default": "wait"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
"title": "Continue On Failure",
"default": false
},
"wait_sec": {
"type": "integer",
"title": "Wait Sec"
},
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters",
"default": []
}
},
"type": "object",
"required": [
"label",
"output_parameter",
"wait_sec"
],
"title": "WaitBlock"
},
"Workflow": {
"properties": {
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"title": {
"type": "string",
"title": "Title"
},
"workflow_permanent_id": {
"type": "string",
"title": "Workflow Permanent Id"
},
"version": {
"type": "integer",
"title": "Version"
},
"is_saved_task": {
"type": "boolean",
"title": "Is Saved Task"
},
"description": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Description"
},
2025-04-02 11:07:14 -04:00
"workflow_definition": {
"$ref": "#/components/schemas/WorkflowDefinition"
},
"proxy_location": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"$ref": "#/components/schemas/ProxyLocation"
},
{
"type": "null"
}
2025-04-02 11:07:14 -04:00
]
},
2025-04-02 11:07:14 -04:00
"webhook_callback_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Webhook Callback Url"
},
2025-04-02 11:07:14 -04:00
"totp_verification_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Totp Verification Url"
},
2025-04-02 11:07:14 -04:00
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Totp Identifier"
},
2025-04-02 11:07:14 -04:00
"persist_browser_session": {
"type": "boolean",
"title": "Persist Browser Session",
"default": false
},
"status": {
"$ref": "#/components/schemas/WorkflowStatus",
"default": "published"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"modified_at": {
"type": "string",
"format": "date-time",
"title": "Modified At"
},
"deleted_at": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Deleted At"
}
},
"type": "object",
"required": [
"workflow_id",
"organization_id",
"title",
"workflow_permanent_id",
"version",
"is_saved_task",
"workflow_definition",
"created_at",
"modified_at"
],
"title": "Workflow"
},
"WorkflowDefinition": {
"properties": {
"parameters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowParameter"
},
{
"$ref": "#/components/schemas/ContextParameter"
},
{
"$ref": "#/components/schemas/AWSSecretParameter"
},
{
"$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
},
{
"$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
"$ref": "#/components/schemas/OutputParameter"
},
{
"$ref": "#/components/schemas/CredentialParameter"
}
],
"discriminator": {
"propertyName": "parameter_type",
"mapping": {
"aws_secret": "#/components/schemas/AWSSecretParameter",
"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",
"output": "#/components/schemas/OutputParameter",
"workflow": "#/components/schemas/WorkflowParameter"
}
}
},
"type": "array",
"title": "Parameters"
},
2025-04-02 11:07:14 -04:00
"blocks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ForLoopBlock"
},
{
"$ref": "#/components/schemas/TaskBlock"
},
{
"$ref": "#/components/schemas/CodeBlock"
},
{
"$ref": "#/components/schemas/TextPromptBlock"
},
{
"$ref": "#/components/schemas/DownloadToS3Block"
},
{
"$ref": "#/components/schemas/UploadToS3Block"
},
{
"$ref": "#/components/schemas/SendEmailBlock"
},
{
"$ref": "#/components/schemas/FileParserBlock"
},
{
"$ref": "#/components/schemas/PDFParserBlock"
},
{
"$ref": "#/components/schemas/ValidationBlock"
},
{
"$ref": "#/components/schemas/ActionBlock"
},
{
"$ref": "#/components/schemas/NavigationBlock"
},
{
"$ref": "#/components/schemas/ExtractionBlock"
},
{
"$ref": "#/components/schemas/LoginBlock"
},
{
"$ref": "#/components/schemas/WaitBlock"
},
{
"$ref": "#/components/schemas/FileDownloadBlock"
},
{
"$ref": "#/components/schemas/UrlBlock"
},
{
"$ref": "#/components/schemas/TaskV2Block"
},
{
"$ref": "#/components/schemas/FileUploadBlock"
}
],
"discriminator": {
"propertyName": "block_type",
"mapping": {
"action": "#/components/schemas/ActionBlock",
"code": "#/components/schemas/CodeBlock",
"download_to_s3": "#/components/schemas/DownloadToS3Block",
"extraction": "#/components/schemas/ExtractionBlock",
"file_download": "#/components/schemas/FileDownloadBlock",
"file_upload": "#/components/schemas/FileUploadBlock",
"file_url_parser": "#/components/schemas/FileParserBlock",
"for_loop": "#/components/schemas/ForLoopBlock",
"goto_url": "#/components/schemas/UrlBlock",
"login": "#/components/schemas/LoginBlock",
"navigation": "#/components/schemas/NavigationBlock",
"pdf_parser": "#/components/schemas/PDFParserBlock",
"send_email": "#/components/schemas/SendEmailBlock",
"task": "#/components/schemas/TaskBlock",
"task_v2": "#/components/schemas/TaskV2Block",
"text_prompt": "#/components/schemas/TextPromptBlock",
"upload_to_s3": "#/components/schemas/UploadToS3Block",
"validation": "#/components/schemas/ValidationBlock",
"wait": "#/components/schemas/WaitBlock"
}
}
},
"type": "array",
"title": "Blocks"
}
},
"type": "object",
"required": [
2025-04-02 11:07:14 -04:00
"parameters",
"blocks"
],
2025-04-02 11:07:14 -04:00
"title": "WorkflowDefinition"
},
2025-04-02 11:07:14 -04:00
"WorkflowParameter": {
"properties": {
2025-04-02 11:07:14 -04:00
"parameter_type": {
"type": "string",
2025-04-02 11:07:14 -04:00
"const": "workflow",
"title": "Parameter Type",
"default": "workflow"
},
2025-04-02 11:07:14 -04:00
"key": {
"type": "string",
"title": "Key"
},
2025-04-02 11:07:14 -04:00
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Description"
},
2025-04-02 11:07:14 -04:00
"workflow_parameter_id": {
"type": "string",
"title": "Workflow Parameter Id"
},
"workflow_parameter_type": {
"$ref": "#/components/schemas/WorkflowParameterType"
},
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"default_value": {
"anyOf": [
{
"type": "string"
},
2025-04-02 11:07:14 -04:00
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Default Value"
},
"created_at": {
"type": "string",
"format": "date-time",
2025-04-02 11:07:14 -04:00
"title": "Created At"
},
"modified_at": {
"type": "string",
"format": "date-time",
2025-04-02 11:07:14 -04:00
"title": "Modified At"
},
2025-04-02 11:07:14 -04:00
"deleted_at": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
2025-04-02 11:07:14 -04:00
"title": "Deleted At"
}
},
"type": "object",
"required": [
2025-04-02 11:07:14 -04:00
"key",
"workflow_parameter_id",
"workflow_parameter_type",
"workflow_id",
"created_at",
2025-04-02 11:07:14 -04:00
"modified_at"
],
2025-04-02 11:07:14 -04:00
"title": "WorkflowParameter"
},
2025-04-02 11:07:14 -04:00
"WorkflowParameterType": {
"type": "string",
"enum": [
"string",
"integer",
"float",
"boolean",
"json",
"file_url",
"credential_id"
],
2025-04-02 11:07:14 -04:00
"title": "WorkflowParameterType"
},
"WorkflowRunRequest": {
"properties": {
"workflow_id": {
"type": "string",
"title": "Workflow Id",
"description": "ID of the workflow to run"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "Optional title for this workflow run"
},
"parameters": {
2025-04-02 11:07:14 -04:00
"additionalProperties": true,
"type": "object",
"title": "Parameters",
"description": "Parameters to pass to the workflow",
"default": {
}
},
"proxy_location": {
"$ref": "#/components/schemas/ProxyLocation",
"description": "Location of proxy to use for this workflow run",
"default": "RESIDENTIAL"
},
"webhook_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Webhook Url",
"description": "URL to send workflow status updates to after a run is finished"
},
"totp_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Url",
"description": "URL for TOTP authentication setup if Skyvern should be polling endpoint for 2FA codes"
},
"totp_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp Identifier",
"description": "Identifier for TOTP (Time-based One-Time Password) authentication if codes are being pushed to Skyvern"
},
"browser_session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Browser Session Id",
"description": "ID of an existing browser session to reuse, having it continue from the current screen state"
}
},
"type": "object",
"required": [
"workflow_id"
2025-03-21 15:53:11 -07:00
],
"title": "WorkflowRunRequest"
},
"WorkflowRunResponse": {
"properties": {
"run_id": {
"type": "string",
"title": "Run Id",
"description": "Unique identifier for this run"
},
"status": {
"$ref": "#/components/schemas/RunStatus",
"description": "Current status of the run"
},
"output": {
"anyOf": [
{
2025-04-02 11:07:14 -04:00
"additionalProperties": true,
"type": "object"
},
{
"items": {
},
"type": "array"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Output",
"description": "Output data from the run, if any. Format depends on the schema in the input"
},
2025-04-02 11:07:14 -04:00
"downloaded_files": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/FileInfo"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Downloaded Files",
"description": "List of files downloaded during the run"
},
"recording_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recording Url",
"description": "URL to the recording of the run"
},
"failure_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Failure Reason",
"description": "Reason for failure if the run failed"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "Timestamp when this run was created"
},
"modified_at": {
"type": "string",
"format": "date-time",
"title": "Modified At",
"description": "Timestamp when this run was last modified"
},
"run_type": {
"type": "string",
"const": "workflow_run",
"title": "Run Type",
"description": "Type of run - always workflow_run for workflow runs"
},
"run_request": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkflowRunRequest"
},
{
"type": "null"
}
],
"description": "The original request parameters used to start this workflow run"
}
},
"type": "object",
"required": [
"run_id",
"status",
"created_at",
"modified_at",
"run_type"
],
"title": "WorkflowRunResponse"
2025-04-02 11:07:14 -04:00
},
"WorkflowStatus": {
"type": "string",
"enum": [
"published",
"draft",
"auto_generated"
],
"title": "WorkflowStatus"
}
}
2025-03-21 15:53:11 -07:00
},
"servers": [
{
"url": "https://api.skyvern.com",
"x-fern-server-name": "Production"
},
{
"url": "https://api-staging.skyvern.com",
"x-fern-server-name": "Staging"
},
{
"url": "http://localhost:8000",
"x-fern-server-name": "Development"
2025-03-21 15:53:11 -07:00
}
]
}