Skip to content

Automate browser based workflows with AI

Update API specifications with fern api update (#8846)

Shuchang Zheng7dd6e9019ff3
diff --git a/fern/openapi/skyvern_openapi.json b/fern/openapi/skyvern_openapi.json
index 43d927a7a..224ca94e2 100644
--- a/fern/openapi/skyvern_openapi.json
+++ b/fern/openapi/skyvern_openapi.json
@@ -28,10 +28,8 @@
"type": "null"
}
],
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
"title": "X-Api-Key"
- },
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
},
{
"name": "x-user-agent",
@@ -204,6 +202,17 @@
}
}
}
+ },
+ "503": {
+ "description": "The server is busy dispatching other runs. No run was created; retry after Retry-After seconds.",
+ "headers": {
+ "Retry-After": {
+ "description": "Seconds to wait before retrying",
+ "schema": {
+ "type": "integer"
+ }
+ }
+ }
}
},
"x-fern-sdk-method-name": "run_workflow",
@@ -286,11 +295,11 @@
"mapping": {
"task_v1": "#/components/schemas/TaskRunResponse",
"task_v2": "#/components/schemas/TaskRunResponse",
+ "task_v3": "#/components/schemas/TaskRunResponse",
"openai_cua": "#/components/schemas/TaskRunResponse",
"anthropic_cua": "#/components/schemas/TaskRunResponse",
"ui_tars": "#/components/schemas/TaskRunResponse",
"yutori_navigator": "#/components/schemas/TaskRunResponse",
- "task_v3": "#/components/schemas/TaskRunResponse",
"workflow_run": "#/components/schemas/WorkflowRunResponse"
}
},
@@ -527,6 +536,24 @@
"title": "X-Api-Key"
},
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ },
+ {
+ "name": "Idempotency-Key",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Idempotency-Key must contain 1 to 255 visible ASCII bytes.",
+ "title": "Idempotency-Key"
+ },
+ "description": "Idempotency-Key must contain 1 to 255 visible ASCII bytes."
}
],
"requestBody": {
@@ -550,6 +577,9 @@
}
}
},
+ "409": {
+ "description": "A create with this idempotency key is still in progress"
+ },
"422": {
"description": "Invalid agent definition"
}
@@ -560,15 +590,15 @@
"code-samples": [
{
"sdk": "curl",
- "code": "curl -X POST https://api.skyvern.com/v1/workflows --header 'x-api-key: {{x-api-key}}' --header 'Content-Type: text/plain' --data-raw 'title: Contact Forms\ndescription: Fill the contact form on the website\nproxy_location: RESIDENTIAL\nwebhook_callback_url: https://example.com/webhook\ntotp_verification_url: https://example.com/totp\npersist_browser_session: false\nmodel:\n name: gpt-4.1\nworkflow_definition:\n parameters:\n - key: website_url\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: name\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: additional_information\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: |-\n Message: I'd love to learn more about your...\n Phone: 123-456-7890\n Inquiry type: sales\n Optional Subject: Hello from [Company Here]\n - key: email\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n blocks:\n - label: Fill_Out_Contact_Form\n continue_on_failure: true\n block_type: navigation\n url: \"{{website_url}}\"\n title: Fill_Out_Contact_Form\n engine: skyvern-1.0\n navigation_goal: >-\n Find the contact form. Fill out the contact us form and submit it. Your\n goal is complete when the page says your message has been sent. In the\n case you can't find a contact us form, terminate.\n\n\n Fill out required fields as best you can using the following\n information:\n\n {{name}}\n\n {{email}}\n\n {{additional_information}}\n error_code_mapping: null\n max_retries: 0\n max_steps_per_run: null\n complete_on_download: false\n download_suffix: null\n parameter_keys: []\n totp_identifier: null\n totp_verification_url: null\n complete_criterion: \"\"\n terminate_criterion: \"\"\n include_action_history_in_verification: false\n - label: Extract_Email\n continue_on_failure: false\n block_type: extraction\n url: \"\"\n title: Extract_Email\n data_extraction_goal: \"Extract a company email if available \"\n data_schema: null\n max_retries: 0\n max_steps_per_run: null\n parameter_keys: []\n'\n"
+ "code": "curl -X POST https://api.skyvern.com/v1/workflows --header 'x-api-key: {{x-api-key}}' --header 'Content-Type: text/plain' --data-raw 'title: Contact Forms\ndescription: Fill the contact form on the website\nproxy_location: RESIDENTIAL\nwebhook_callback_url: https://example.com/webhook\ntotp_verification_url: https://example.com/totp\npersist_browser_session: false\nmodel:\n name: gpt-4.1\nworkflow_definition:\n parameters:\n - key: website_url\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: name\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: additional_information\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: |-\n Message: I'd love to learn more about your...\n Phone: 123-456-7890\n Inquiry type: sales\n Optional Subject: Hello from [Company Here]\n - key: email\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n blocks:\n - label: Fill_Out_Contact_Form\n continue_on_failure: true\n block_type: navigation\n url: \"{{website_url}}\"\n title: Fill_Out_Contact_Form\n navigation_goal: >-\n Find the contact form. Fill out the contact us form and submit it. Your\n goal is complete when the page says your message has been sent. In the\n case you can't find a contact us form, terminate.\n\n\n Fill out required fields as best you can using the following\n information:\n\n {{name}}\n\n {{email}}\n\n {{additional_information}}\n error_code_mapping: null\n max_retries: 0\n max_steps_per_run: null\n complete_on_download: false\n download_suffix: null\n parameter_keys: []\n totp_identifier: null\n totp_verification_url: null\n complete_criterion: \"\"\n terminate_criterion: \"\"\n include_action_history_in_verification: false\n - label: Extract_Email\n continue_on_failure: false\n block_type: extraction\n url: \"\"\n title: Extract_Email\n data_extraction_goal: \"Extract a company email if available \"\n data_schema: null\n max_retries: 0\n max_steps_per_run: null\n parameter_keys: []\n'\n"
},
{
"sdk": "python",
- "code": "\nfrom skyvern import Skyvern\n\n# Create a workflow in JSON format\nworkflow_definition = {\n \"title\": \"Contact Forms Workflow\",\n \"description\": \"Fill the contact form on the website\",\n \"proxy_location\": \"RESIDENTIAL\",\n \"webhook_callback_url\": \"https://example.com/webhook\",\n \"totp_verification_url\": \"https://example.com/totp\",\n \"totp_identifier\": \"4155555555\",\n \"model\": {\"name\": \"gpt-4.1\"},\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"website_url\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"name\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"additional_information\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": \"Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]\",\n },\n {\n \"key\": \"email\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n ],\n \"blocks\": [\n {\n \"label\": \"Fill_Out_Contact_Form\",\n \"continue_on_failure\": True,\n \"block_type\": \"navigation\",\n \"url\": \"{{website_url}}\",\n \"title\": \"Fill_Out_Contact_Form\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}\",\n \"error_code_mapping\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"complete_on_download\": False,\n \"download_suffix\": None,\n \"parameter_keys\": [],\n \"totp_identifier\": None,\n \"totp_verification_url\": None,\n \"complete_criterion\": \"\",\n \"terminate_criterion\": \"\",\n \"include_action_history_in_verification\": False,\n },\n {\n \"label\": \"Extract_Email\",\n \"continue_on_failure\": False,\n \"block_type\": \"extraction\",\n \"url\": \"\",\n \"title\": \"Extract_Email\",\n \"data_extraction_goal\": \"Extract a company email if available \",\n \"data_schema\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"parameter_keys\": [],\n },\n ],\n },\n}\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nworkflow = await skyvern.create_workflow(json_definition=workflow_definition)\nprint(workflow)\n"
+ "code": "\nfrom skyvern import Skyvern\n\n# Create a workflow in JSON format\nworkflow_definition = {\n \"title\": \"Contact Forms Workflow\",\n \"description\": \"Fill the contact form on the website\",\n \"proxy_location\": \"RESIDENTIAL\",\n \"webhook_callback_url\": \"https://example.com/webhook\",\n \"totp_verification_url\": \"https://example.com/totp\",\n \"totp_identifier\": \"4155555555\",\n \"model\": {\"name\": \"gpt-4.1\"},\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"website_url\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"name\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"additional_information\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": \"Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]\",\n },\n {\n \"key\": \"email\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n ],\n \"blocks\": [\n {\n \"label\": \"Fill_Out_Contact_Form\",\n \"continue_on_failure\": True,\n \"block_type\": \"navigation\",\n \"url\": \"{{website_url}}\",\n \"title\": \"Fill_Out_Contact_Form\",\n \"navigation_goal\": \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}\",\n \"error_code_mapping\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"complete_on_download\": False,\n \"download_suffix\": None,\n \"parameter_keys\": [],\n \"totp_identifier\": None,\n \"totp_verification_url\": None,\n \"complete_criterion\": \"\",\n \"terminate_criterion\": \"\",\n \"include_action_history_in_verification\": False,\n },\n {\n \"label\": \"Extract_Email\",\n \"continue_on_failure\": False,\n \"block_type\": \"extraction\",\n \"url\": \"\",\n \"title\": \"Extract_Email\",\n \"data_extraction_goal\": \"Extract a company email if available \",\n \"data_schema\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"parameter_keys\": [],\n },\n ],\n },\n}\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nworkflow = await skyvern.create_workflow(json_definition=workflow_definition)\nprint(workflow)\n"
},
{
"sdk": "typescript",
- "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n\n// Create a workflow in JSON format\nconst workflowDefinition = {\n title: \"Contact Forms Workflow\",\n description: \"Fill the contact form on the website\",\n proxy_location: \"RESIDENTIAL\",\n webhook_callback_url: \"https://example.com/webhook\",\n totp_verification_url: \"https://example.com/totp\",\n totp_identifier: \"4155555555\",\n model: { name: \"gpt-4.1\" },\n workflow_definition: {\n parameters: [\n {\n key: \"website_url\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n },\n {\n key: \"name\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n },\n {\n key: \"additional_information\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: \"Message: I'd love to learn more about your...\\nPhone: 123-456-7890\\nInquiry type: sales\\nOptional Subject: Hello from [Company Here]\"\n },\n {\n key: \"email\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n }\n ],\n blocks: [\n {\n label: \"Fill_Out_Contact_Form\",\n continue_on_failure: true,\n block_type: \"navigation\",\n url: \"{{website_url}}\",\n title: \"Fill_Out_Contact_Form\",\n engine: \"skyvern-1.0\",\n navigation_goal: \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\\n\\nFill out required fields as best you can using the following information:\\n{{name}}\\n{{email}}\\n{{additional_information}}\",\n error_code_mapping: null,\n max_retries: 0,\n max_steps_per_run: null,\n complete_on_download: false,\n download_suffix: null,\n parameter_keys: [],\n totp_identifier: null,\n totp_verification_url: null,\n complete_criterion: \"\",\n terminate_criterion: \"\",\n include_action_history_in_verification: false\n },\n {\n label: \"Extract_Email\",\n continue_on_failure: false,\n block_type: \"extraction\",\n url: \"\",\n title: \"Extract_Email\",\n data_extraction_goal: \"Extract a company email if available \",\n data_schema: null,\n max_retries: 0,\n max_steps_per_run: null,\n parameter_keys: [],\n }\n ]\n }\n};\n\nconst workflow = await skyvern.createWorkflow({\n json_definition: workflowDefinition\n});\nconsole.log(workflow);\n"
+ "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n\n// Create a workflow in JSON format\nconst workflowDefinition = {\n title: \"Contact Forms Workflow\",\n description: \"Fill the contact form on the website\",\n proxy_location: \"RESIDENTIAL\",\n webhook_callback_url: \"https://example.com/webhook\",\n totp_verification_url: \"https://example.com/totp\",\n totp_identifier: \"4155555555\",\n model: { name: \"gpt-4.1\" },\n workflow_definition: {\n parameters: [\n {\n key: \"website_url\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n },\n {\n key: \"name\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n },\n {\n key: \"additional_information\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: \"Message: I'd love to learn more about your...\\nPhone: 123-456-7890\\nInquiry type: sales\\nOptional Subject: Hello from [Company Here]\"\n },\n {\n key: \"email\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n }\n ],\n blocks: [\n {\n label: \"Fill_Out_Contact_Form\",\n continue_on_failure: true,\n block_type: \"navigation\",\n url: \"{{website_url}}\",\n title: \"Fill_Out_Contact_Form\",\n navigation_goal: \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\\n\\nFill out required fields as best you can using the following information:\\n{{name}}\\n{{email}}\\n{{additional_information}}\",\n error_code_mapping: null,\n max_retries: 0,\n max_steps_per_run: null,\n complete_on_download: false,\n download_suffix: null,\n parameter_keys: [],\n totp_identifier: null,\n totp_verification_url: null,\n complete_criterion: \"\",\n terminate_criterion: \"\",\n include_action_history_in_verification: false\n },\n {\n label: \"Extract_Email\",\n continue_on_failure: false,\n block_type: \"extraction\",\n url: \"\",\n title: \"Extract_Email\",\n data_extraction_goal: \"Extract a company email if available \",\n data_schema: null,\n max_retries: 0,\n max_steps_per_run: null,\n parameter_keys: [],\n }\n ]\n }\n};\n\nconst workflow = await skyvern.createWorkflow({\n json_definition: workflowDefinition\n});\nconsole.log(workflow);\n"
}
]
}
@@ -881,15 +911,15 @@
"code-samples": [
{
"sdk": "curl",
- "code": "curl -X POST https://api.skyvern.com/v1/workflows/wpid_123 --header 'x-api-key: {{x-api-key}}' --header 'Content-Type: text/plain' --data-raw 'title: Contact Forms\ndescription: Fill the contact form on the website\nproxy_location: RESIDENTIAL\nwebhook_callback_url: https://example.com/webhook\ntotp_verification_url: https://example.com/totp\npersist_browser_session: false\nmodel:\n name: gpt-4.1\nworkflow_definition:\n parameters:\n - key: website_url\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: name\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: additional_information\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: |-\n Message: I'd love to learn more about your...\n Phone: 123-456-7890\n Inquiry type: sales\n Optional Subject: Hello from [Company Here]\n - key: email\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n blocks:\n - label: Fill_Out_Contact_Form\n continue_on_failure: true\n block_type: navigation\n url: \"{{website_url}}\"\n title: Fill_Out_Contact_Form\n engine: skyvern-1.0\n navigation_goal: >-\n Find the contact form. Fill out the contact us form and submit it. Your\n goal is complete when the page says your message has been sent. In the\n case you can't find a contact us form, terminate.\n\n\n Fill out required fields as best you can using the following\n information:\n\n {{name}}\n\n {{email}}\n\n {{additional_information}}\n error_code_mapping: null\n max_retries: 0\n max_steps_per_run: null\n complete_on_download: false\n download_suffix: null\n parameter_keys: []\n totp_identifier: null\n totp_verification_url: null\n complete_criterion: \"\"\n terminate_criterion: \"\"\n include_action_history_in_verification: false\n - label: Extract_Email\n continue_on_failure: false\n block_type: extraction\n url: \"\"\n title: Extract_Email\n data_extraction_goal: \"Extract a company email if available \"\n data_schema: null\n max_retries: 0\n max_steps_per_run: null\n parameter_keys: []\n'\n"
+ "code": "curl -X POST https://api.skyvern.com/v1/workflows/wpid_123 --header 'x-api-key: {{x-api-key}}' --header 'Content-Type: text/plain' --data-raw 'title: Contact Forms\ndescription: Fill the contact form on the website\nproxy_location: RESIDENTIAL\nwebhook_callback_url: https://example.com/webhook\ntotp_verification_url: https://example.com/totp\npersist_browser_session: false\nmodel:\n name: gpt-4.1\nworkflow_definition:\n parameters:\n - key: website_url\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: name\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: additional_information\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: |-\n Message: I'd love to learn more about your...\n Phone: 123-456-7890\n Inquiry type: sales\n Optional Subject: Hello from [Company Here]\n - key: email\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n blocks:\n - label: Fill_Out_Contact_Form\n continue_on_failure: true\n block_type: navigation\n url: \"{{website_url}}\"\n title: Fill_Out_Contact_Form\n navigation_goal: >-\n Find the contact form. Fill out the contact us form and submit it. Your\n goal is complete when the page says your message has been sent. In the\n case you can't find a contact us form, terminate.\n\n\n Fill out required fields as best you can using the following\n information:\n\n {{name}}\n\n {{email}}\n\n {{additional_information}}\n error_code_mapping: null\n max_retries: 0\n max_steps_per_run: null\n complete_on_download: false\n download_suffix: null\n parameter_keys: []\n totp_identifier: null\n totp_verification_url: null\n complete_criterion: \"\"\n terminate_criterion: \"\"\n include_action_history_in_verification: false\n - label: Extract_Email\n continue_on_failure: false\n block_type: extraction\n url: \"\"\n title: Extract_Email\n data_extraction_goal: \"Extract a company email if available \"\n data_schema: null\n max_retries: 0\n max_steps_per_run: null\n parameter_keys: []\n'\n"
},
{
"sdk": "python",
- "code": "\nfrom skyvern import Skyvern\n\nupdated_workflow_definition = {\n \"title\": \"Updated Contact Forms Workflow\",\n \"description\": \"Fill the contact form on the website\",\n \"proxy_location\": \"RESIDENTIAL\",\n \"webhook_callback_url\": \"https://example.com/webhook\",\n \"totp_verification_url\": \"https://example.com/totp\",\n \"totp_identifier\": \"4155555555\",\n \"model\": {\"name\": \"gpt-4.1\"},\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"website_url\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"name\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"additional_information\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": \"Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]\",\n },\n {\n \"key\": \"email\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n ],\n \"blocks\": [\n {\n \"label\": \"Fill_Out_Contact_Form\",\n \"continue_on_failure\": True,\n \"block_type\": \"navigation\",\n \"url\": \"{{website_url}}\",\n \"title\": \"Fill_Out_Contact_Form\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}\",\n \"error_code_mapping\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"complete_on_download\": False,\n \"download_suffix\": None,\n \"parameter_keys\": [],\n \"totp_identifier\": None,\n \"totp_verification_url\": None,\n \"complete_criterion\": \"\",\n \"terminate_criterion\": \"\",\n \"include_action_history_in_verification\": False,\n },\n {\n \"label\": \"Extract_Email\",\n \"continue_on_failure\": False,\n \"block_type\": \"extraction\",\n \"url\": \"\",\n \"title\": \"Extract_Email\",\n \"data_extraction_goal\": \"Extract a company email if available \",\n \"data_schema\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"parameter_keys\": [],\n },\n ],\n },\n}\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nworkflow = await skyvern.update_workflow(workflow_id=\"wpid_123\", json_definition=updated_workflow_definition)\nprint(workflow)\n"
+ "code": "\nfrom skyvern import Skyvern\n\nupdated_workflow_definition = {\n \"title\": \"Updated Contact Forms Workflow\",\n \"description\": \"Fill the contact form on the website\",\n \"proxy_location\": \"RESIDENTIAL\",\n \"webhook_callback_url\": \"https://example.com/webhook\",\n \"totp_verification_url\": \"https://example.com/totp\",\n \"totp_identifier\": \"4155555555\",\n \"model\": {\"name\": \"gpt-4.1\"},\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"website_url\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"name\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"additional_information\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": \"Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]\",\n },\n {\n \"key\": \"email\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n ],\n \"blocks\": [\n {\n \"label\": \"Fill_Out_Contact_Form\",\n \"continue_on_failure\": True,\n \"block_type\": \"navigation\",\n \"url\": \"{{website_url}}\",\n \"title\": \"Fill_Out_Contact_Form\",\n \"navigation_goal\": \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}\",\n \"error_code_mapping\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"complete_on_download\": False,\n \"download_suffix\": None,\n \"parameter_keys\": [],\n \"totp_identifier\": None,\n \"totp_verification_url\": None,\n \"complete_criterion\": \"\",\n \"terminate_criterion\": \"\",\n \"include_action_history_in_verification\": False,\n },\n {\n \"label\": \"Extract_Email\",\n \"continue_on_failure\": False,\n \"block_type\": \"extraction\",\n \"url\": \"\",\n \"title\": \"Extract_Email\",\n \"data_extraction_goal\": \"Extract a company email if available \",\n \"data_schema\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"parameter_keys\": [],\n },\n ],\n },\n}\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nworkflow = await skyvern.update_workflow(workflow_id=\"wpid_123\", json_definition=updated_workflow_definition)\nprint(workflow)\n"
},
{
"sdk": "typescript",
- "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n\nconst updatedWorkflowDefinition = {\n title: \"Updated Contact Forms Workflow\",\n description: \"Fill the contact form on the website\",\n proxy_location: \"RESIDENTIAL\",\n webhook_callback_url: \"https://example.com/webhook\",\n totp_verification_url: \"https://example.com/totp\",\n totp_identifier: \"4155555555\",\n model: { name: \"gpt-4.1\" },\n workflow_definition: {\n parameters: [\n {\n key: \"website_url\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n },\n {\n key: \"name\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n },\n {\n key: \"additional_information\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: \"Message: I'd love to learn more about your...\\nPhone: 123-456-7890\\nInquiry type: sales\\nOptional Subject: Hello from [Company Here]\"\n },\n {\n key: \"email\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n }\n ],\n blocks: [\n {\n label: \"Fill_Out_Contact_Form\",\n continue_on_failure: true,\n block_type: \"navigation\",\n url: \"{{website_url}}\",\n title: \"Fill_Out_Contact_Form\",\n engine: \"skyvern-1.0\",\n navigation_goal: \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\\n\\nFill out required fields as best you can using the following information:\\n{{name}}\\n{{email}}\\n{{additional_information}}\",\n error_code_mapping: null,\n max_retries: 0,\n max_steps_per_run: null,\n complete_on_download: false,\n download_suffix: null,\n parameter_keys: [],\n totp_identifier: null,\n totp_verification_url: null,\n complete_criterion: \"\",\n terminate_criterion: \"\",\n include_action_history_in_verification: false\n },\n {\n label: \"Extract_Email\",\n continue_on_failure: false,\n block_type: \"extraction\",\n url: \"\",\n title: \"Extract_Email\",\n data_extraction_goal: \"Extract a company email if available \",\n data_schema: null,\n max_retries: 0,\n max_steps_per_run: null,\n parameter_keys: []\n }\n ]\n }\n};\n\nconst workflow = await skyvern.updateWorkflow(\"wpid_123\", {\n json_definition: updatedWorkflowDefinition\n});\nconsole.log(workflow);\n"
+ "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n\nconst updatedWorkflowDefinition = {\n title: \"Updated Contact Forms Workflow\",\n description: \"Fill the contact form on the website\",\n proxy_location: \"RESIDENTIAL\",\n webhook_callback_url: \"https://example.com/webhook\",\n totp_verification_url: \"https://example.com/totp\",\n totp_identifier: \"4155555555\",\n model: { name: \"gpt-4.1\" },\n workflow_definition: {\n parameters: [\n {\n key: \"website_url\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n },\n {\n key: \"name\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n },\n {\n key: \"additional_information\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: \"Message: I'd love to learn more about your...\\nPhone: 123-456-7890\\nInquiry type: sales\\nOptional Subject: Hello from [Company Here]\"\n },\n {\n key: \"email\",\n description: null,\n parameter_type: \"workflow\",\n workflow_parameter_type: \"string\",\n default_value: null\n }\n ],\n blocks: [\n {\n label: \"Fill_Out_Contact_Form\",\n continue_on_failure: true,\n block_type: \"navigation\",\n url: \"{{website_url}}\",\n title: \"Fill_Out_Contact_Form\",\n navigation_goal: \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\\n\\nFill out required fields as best you can using the following information:\\n{{name}}\\n{{email}}\\n{{additional_information}}\",\n error_code_mapping: null,\n max_retries: 0,\n max_steps_per_run: null,\n complete_on_download: false,\n download_suffix: null,\n parameter_keys: [],\n totp_identifier: null,\n totp_verification_url: null,\n complete_criterion: \"\",\n terminate_criterion: \"\",\n include_action_history_in_verification: false\n },\n {\n label: \"Extract_Email\",\n continue_on_failure: false,\n block_type: \"extraction\",\n url: \"\",\n title: \"Extract_Email\",\n data_extraction_goal: \"Extract a company email if available \",\n data_schema: null,\n max_retries: 0,\n max_steps_per_run: null,\n parameter_keys: []\n }\n ]\n }\n};\n\nconst workflow = await skyvern.updateWorkflow(\"wpid_123\", {\n json_definition: updatedWorkflowDefinition\n});\nconsole.log(workflow);\n"
}
]
}
@@ -1371,6 +1401,63 @@
"x-fern-sdk-method-name": "delete_folder"
}
},
+ "/v1/browser_types": {
+ "get": {
+ "tags": [
+ "Server"
+ ],
+ "summary": "List selectable browser types",
+ "description": "List the selectable browser engines for the workflow/run browser_type setting. The list is runtime-capability aware: a runtime that can honor an explicit engine (the cloud dynamic-browser capability) returns all supported engines, while a runtime without it (OSS/self-host) returns an empty list rather than advertising selections the server would reject.",
+ "operationId": "get_browser_types_v1_browser_types_get",
+ "parameters": [
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
+ "title": "X-Api-Key"
+ },
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully listed selectable browser types",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/BrowserTypeOption"
+ },
+ "title": "Response Get Browser Types V1 Browser Types Get"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-fern-sdk-method-name": "get_browser_types"
+ }
+ },
"/v1/runs/{workflow_run_id}/tags": {
"post": {
"tags": [
@@ -1441,6 +1528,7 @@
"description": "Invalid tag key or value"
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "apply_run_tags"
},
"get": {
@@ -1509,6 +1597,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "get_run_tags"
}
},
@@ -1593,6 +1682,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "delete_run_tag"
}
},
@@ -1714,6 +1804,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "get_run_tag_history"
}
},
@@ -1771,6 +1862,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "list_tag_keys"
}
},
@@ -1841,6 +1933,7 @@
"description": "Description too long"
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "update_tag_key"
},
"delete": {
@@ -1909,6 +2002,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "delete_tag_key"
}
},
@@ -1984,7 +2078,66 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "list_tag_values"
+ },
+ "post": {
+ "tags": [
+ "Tags"
+ ],
+ "summary": "Create tag value",
+ "description": "Register a grouped tag (key, value) with a palette color before any workflow uses it. The label shows a zero workflow count until applied to a workflow.",
+ "operationId": "create_tag_value_v1_tag_values_post",
+ "parameters": [
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
+ "title": "X-Api-Key"
+ },
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TagValueCreate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successfully registered tag value",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TagValue"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Tag value already exists"
+ },
+ "422": {
+ "description": "Invalid key, value, or color"
+ }
+ },
+ "x-hidden": true,
+ "x-fern-sdk-method-name": "create_tag_value"
}
},
"/v1/tag-values/{key}": {
@@ -2057,6 +2210,7 @@
"description": "Invalid palette color"
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "update_tag_value"
},
"delete": {
@@ -2135,6 +2289,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "delete_tag_value"
}
},
@@ -2211,6 +2366,7 @@
"description": "Invalid value"
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "rename_tag_value"
}
},
@@ -2500,6 +2656,60 @@
"x-fern-sdk-method-name": "batch_get_run_tags_post"
}
},
+ "/v1/run-tag-suggestions": {
+ "get": {
+ "tags": [
+ "Tags"
+ ],
+ "summary": "List run tag suggestions",
+ "description": "List distinct (key, value) pairs ever set on a run for the organization, sourced from the run-tag event log rather than the tag-key/tag-value registry. Surfaces reserved 'skyvern.*' system keys (which are never registered) so pickers can offer them alongside user-defined tags.",
+ "operationId": "get_run_tag_suggestions_v1_run_tag_suggestions_get",
+ "parameters": [
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
+ "title": "X-Api-Key"
+ },
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved run tag suggestions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RunTagSuggestionsResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-hidden": true,
+ "x-fern-sdk-method-name": "get_run_tag_suggestions"
+ }
+ },
"/v1/artifacts/{artifact_id}/content": {
"get": {
"tags": [
@@ -2863,7 +3073,8 @@
"tags": [
"agent"
],
- "summary": "Get Runs V2",
+ "summary": "List runs",
+ "description": "List the organization's task and agent runs, newest first, filterable by status, run type, agent, a free-text search term, and failure category. Returns a paginated array of run summaries.",
"operationId": "get_runs_v2_v1_runs_get",
"parameters": [
{
@@ -2923,14 +3134,16 @@
"type": "null"
}
],
- "description": "Case-insensitive substring search (min 3 chars for trigram index).",
+ "description": "Case-insensitive substring search (min 3 chars for trigram index) across the run's title, URL, run ID, agent (workflow) ID and inputs, plus a workflow run's webhook callback URL. A complete browser profile ID, browser session ID or credential ID matches the run that used it exactly (no substring match). A complete browser profile or browser session ID is matched against those identifiers only, not the text fields. A credential ID matches when it is the run's sequential credential, the credential the run selected from a pool or fell back to, or the credential bound by a credential parameter on the run's workflow version when the run was created and the run recorded no selection for it. Browser profile and credential IDs apply to workflow runs; a browser session ID also matches a standalone task that used it.",
"examples": [
"login_url",
- "wr_abc123"
+ "wr_abc123",
+ "bp_123456789",
+ "cred_123456789"
],
"title": "Search Key"
},
- "description": "Case-insensitive substring search (min 3 chars for trigram index)."
+ "description": "Case-insensitive substring search (min 3 chars for trigram index) across the run's title, URL, run ID, agent (workflow) ID and inputs, plus a workflow run's webhook callback URL. A complete browser profile ID, browser session ID or credential ID matches the run that used it exactly (no substring match). A complete browser profile or browser session ID is matched against those identifiers only, not the text fields. A credential ID matches when it is the run's sequential credential, the credential the run selected from a pool or fell back to, or the credential bound by a credential parameter on the run's workflow version when the run was created and the run recorded no selection for it. Browser profile and credential IDs apply to workflow runs; a browser session ID also matches a standalone task that used it."
},
{
"name": "run_type",
@@ -2951,6 +3164,79 @@
"title": "Run Type"
}
},
+ {
+ "name": "workflow_permanent_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 50
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Filter to runs of these workflows (agents). Repeat the param to include multiple.",
+ "title": "Workflow Permanent Id"
+ },
+ "description": "Filter to runs of these workflows (agents). Repeat the param to include multiple."
+ },
+ {
+ "name": "tags",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 20
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Filter by run tags. Each term is a label (`production`), a group (`env:*`), or a group:label (`env:prod`). Repeat the param or comma-separate (`?tags=env:prod,env:staging`). AND across distinct terms, OR within a group's labels (`?tags=customer:acme,env:prod,env:staging` -> customer=acme AND env in (prod, staging)). A label term matches the value across any/no group. Matches current tag values only.",
+ "examples": [
+ "env:prod",
+ "production",
+ "env:*",
+ "customer:acme,env:prod"
+ ],
+ "title": "Tags"
+ },
+ "description": "Filter by run tags. Each term is a label (`production`), a group (`env:*`), or a group:label (`env:prod`). Repeat the param or comma-separate (`?tags=env:prod,env:staging`). AND across distinct terms, OR within a group's labels (`?tags=customer:acme,env:prod,env:staging` -> customer=acme AND env in (prod, staging)). A label term matches the value across any/no group. Matches current tag values only."
+ },
+ {
+ "name": "failure_category",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 100
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Exact-match filter on a workflow run's top classifier failure category (`failure_category[0].category`). Only failed, terminated, and timed_out runs are eligible; canceled runs are never returned by this filter. Applies to `run_type=workflow_run` only — combined with a task run_type it matches nothing.",
+ "examples": [
+ "ANTI_BOT_DETECTION",
+ "AUTH_FAILURE"
+ ],
+ "title": "Failure Category"
+ },
+ "description": "Exact-match filter on a workflow run's top classifier failure category (`failure_category[0].category`). Only failed, terminated, and timed_out runs are eligible; canceled runs are never returned by this filter. Applies to `run_type=workflow_run` only — combined with a task run_type it matches nothing."
+ },
{
"name": "x-api-key",
"in": "header",
@@ -3005,7 +3291,8 @@
"tags": [
"Files"
],
- "summary": "Upload File",
+ "summary": "Upload a file",
+ "description": "Upload a file to Skyvern storage so runs can reference it as an input. Returns the file id, its storage URI, a presigned download URL, and the expiry implied by the requested retention period.",
"operationId": "upload_file_v1_upload_file_post",
"parameters": [
{
@@ -3062,18 +3349,73 @@
"x-fern-sdk-method-name": "upload_file"
}
},
- "/v1/browser_profiles": {
- "post": {
+ "/v1/files/{file_id}": {
+ "delete": {
"tags": [
- "Browser Profiles"
+ "Files"
],
- "summary": "Create a browser profile",
- "description": "Create a blank browser profile, or create one from a persistent browser session or workflow run.",
- "operationId": "create_browser_profile_v1_browser_profiles_post",
+ "summary": "Delete File",
+ "description": "Delete a previously uploaded file.\n\nA file that does not exist, was already deleted, or belongs to another organization all\nanswer 404 alike — the endpoint must not tell a caller whether someone else's file id\nexists.",
+ "operationId": "delete_file_v1_files__file_id__delete",
"parameters": [
{
- "name": "x-api-key",
- "in": "header",
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "File Id"
+ }
+ },
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
+ "title": "X-Api-Key"
+ },
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-fern-sdk-method-name": "delete_file"
+ }
+ },
+ "/v1/browser_profiles": {
+ "post": {
+ "tags": [
+ "Browser Profiles"
+ ],
+ "summary": "Create a browser profile",
+ "description": "Create a blank browser profile, or create one from a persistent browser session or workflow run.",
+ "operationId": "create_browser_profile_v1_browser_profiles_post",
+ "parameters": [
+ {
+ "name": "x-api-key",
+ "in": "header",
"required": false,
"schema": {
"anyOf": [
@@ -3134,11 +3476,11 @@
"code-samples": [
{
"sdk": "python",
- "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\n# Create a blank browser profile for future runs\nblank_profile = await skyvern.browser_profiles.create_browser_profile(\n name=\"Fresh Profile\",\n)\nprint(blank_profile)\n\n# Create a browser profile from a persistent browser session\nbrowser_profile = await skyvern.browser_profiles.create_browser_profile(\n name=\"My Profile\",\n browser_session_id=\"pbs_123\",\n)\nprint(browser_profile)\n\n# Or create from a workflow run with persist_browser_session=True\nbrowser_profile = await skyvern.browser_profiles.create_browser_profile(\n name=\"My Profile\",\n workflow_run_id=\"wr_123\",\n)\nprint(browser_profile)\n"
+ "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\n# Create a blank browser profile for future runs\nblank_profile = await skyvern.browser_profiles.create_browser_profile(\n name=\"Fresh Profile\",\n)\nprint(blank_profile)\n\n# Create a browser profile from a persistent browser session\nbrowser_profile = await skyvern.browser_profiles.create_browser_profile(\n name=\"My Profile\",\n browser_session_id=\"pbs_123\",\n)\nprint(browser_profile)\n\n# Or create from any workflow run that saved a browser (has a persisted archive)\nbrowser_profile = await skyvern.browser_profiles.create_browser_profile(\n name=\"My Profile\",\n workflow_run_id=\"wr_123\",\n)\nprint(browser_profile)\n"
},
{
"sdk": "typescript",
- "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n// Create a blank browser profile for future runs\nconst blankProfile = await skyvern.browserProfiles.createBrowserProfile({\n name: \"Fresh Profile\",\n});\nconsole.log(blankProfile);\n\n// Create a browser profile from a persistent browser session\nconst browserProfile = await skyvern.browserProfiles.createBrowserProfile({\n name: \"My Profile\",\n browser_session_id: \"pbs_123\",\n});\nconsole.log(browserProfile);\n\n// Or create from a workflow run with persist_browser_session=True\nconst browserProfile2 = await skyvern.browserProfiles.createBrowserProfile({\n name: \"My Profile\",\n workflow_run_id: \"wr_123\",\n});\nconsole.log(browserProfile2);\n"
+ "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n// Create a blank browser profile for future runs\nconst blankProfile = await skyvern.browserProfiles.createBrowserProfile({\n name: \"Fresh Profile\",\n});\nconsole.log(blankProfile);\n\n// Create a browser profile from a persistent browser session\nconst browserProfile = await skyvern.browserProfiles.createBrowserProfile({\n name: \"My Profile\",\n browser_session_id: \"pbs_123\",\n});\nconsole.log(browserProfile);\n\n// Or create from any workflow run that saved a browser (has a persisted archive)\nconst browserProfile2 = await skyvern.browserProfiles.createBrowserProfile({\n name: \"My Profile\",\n workflow_run_id: \"wr_123\",\n});\nconsole.log(browserProfile2);\n"
}
]
}
@@ -3542,6 +3884,76 @@
]
}
},
+ "/v1/browser_profiles/{profile_id}/usage": {
+ "get": {
+ "tags": [
+ "Browser Profiles"
+ ],
+ "summary": "Get browser profile usage",
+ "description": "List the workflows, credentials, and recent runs that depend on a browser profile.",
+ "operationId": "get_browser_profile_usage_v1_browser_profiles__profile_id__usage_get",
+ "parameters": [
+ {
+ "name": "profile_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "The ID of the browser profile. browser_profile_id starts with `bp_`",
+ "examples": [
+ "bp_123456"
+ ],
+ "title": "Profile Id"
+ },
+ "description": "The ID of the browser profile. browser_profile_id starts with `bp_`"
+ },
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
+ "title": "X-Api-Key"
+ },
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved browser profile usage",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BrowserProfileUsage"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Browser profile not found"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-fern-sdk-method-name": "get_browser_profile_usage"
+ }
+ },
"/v1/browser_sessions": {
"post": {
"tags": [
@@ -3577,7 +3989,8 @@
"$ref": "#/components/schemas/CreateBrowserSessionRequest",
"default": {
"timeout": 60,
- "generate_browser_profile": false
+ "generate_browser_profile": false,
+ "needs_live_view": false
}
}
}
@@ -3594,6 +4007,9 @@
}
}
},
+ "400": {
+ "description": "Invalid request"
+ },
"403": {
"description": "Unauthorized - Invalid or missing authentication"
},
@@ -3848,18 +4264,18 @@
}
}
},
- "404": {
- "description": "Browser session not found"
+ "202": {
+ "description": "Accepted - the extension was requested but its effect could not be confirmed yet. The body carries the session as last recorded and a `warning`; read `timeout` back with a GET rather than retrying, because each retry adds again."
},
"403": {
"description": "Unauthorized - Invalid or missing authentication"
},
+ "404": {
+ "description": "Browser session not found"
+ },
"409": {
"description": "Conflict - the browser session has ended, is about to expire, is already at its maximum lifetime, or runs on infrastructure whose lifetime is fixed at creation"
},
- "202": {
- "description": "Accepted - the extension was requested but its effect could not be confirmed yet. The body carries the session as last recorded and a `warning`; read `timeout` back with a GET rather than retrying, because each retry adds again."
- },
"422": {
"description": "Validation Error",
"content": {
@@ -4040,6 +4456,39 @@
}
}
}
+ },
+ "503": {
+ "description": "Downloaded files could not be returned",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "detail"
+ ],
+ "properties": {
+ "detail": {
+ "type": "object",
+ "required": [
+ "code",
+ "retryable"
+ ],
+ "properties": {
+ "code": {
+ "type": "string",
+ "enum": [
+ "downloaded_files_unavailable"
+ ]
+ },
+ "retryable": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-fern-sdk-method-name": "get_browser_session",
@@ -4108,6 +4557,9 @@
}
}
},
+ "402": {
+ "description": "Insufficient credits to parse OTP content"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -4717,6 +5169,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "list_custom_llms"
},
"post": {
@@ -4778,6 +5231,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "create_custom_llm"
}
},
@@ -4852,6 +5306,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "update_custom_llm"
},
"delete": {
@@ -4914,6 +5369,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "delete_custom_llm"
}
},
@@ -4939,10 +5395,8 @@
"type": "null"
}
],
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
"title": "X-Api-Key"
- },
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
},
{
"name": "x-user-agent",
@@ -5050,10 +5504,8 @@
"type": "null"
}
],
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
"title": "X-Api-Key"
- },
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
},
{
"name": "x-user-agent",
@@ -5183,6 +5635,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "create_script"
},
"get": {
@@ -5270,6 +5723,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "get_scripts"
}
},
@@ -5337,6 +5791,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "get_script"
}
},
@@ -5414,6 +5869,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "deploy_script"
}
},
@@ -5478,7 +5934,8 @@
}
}
}
- }
+ },
+ "x-hidden": true
}
},
"/v1/sdk/run_action": {
@@ -5551,6 +6008,7 @@
"Schedules"
],
"summary": "List all schedules for the organization",
+ "description": "List every schedule in the organization, across all agents, filterable by active/paused status and a search term matched against agent title or schedule name. Returns a paginated list plus the total count.",
"operationId": "schedules_list_all",
"parameters": [
{
@@ -5812,6 +6270,7 @@
"description": "Invalid tag key or value"
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "apply_workflow_tags"
},
"get": {
@@ -5880,6 +6339,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "get_workflow_tags"
}
},
@@ -5964,6 +6424,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "delete_workflow_tag"
}
},
@@ -6085,6 +6546,7 @@
}
}
},
+ "x-hidden": true,
"x-fern-sdk-method-name": "get_workflow_tag_history"
}
},
@@ -6186,6 +6648,17 @@
}
}
}
+ },
+ "503": {
+ "description": "The server is busy dispatching other runs. No run was created; retry after Retry-After seconds.",
+ "headers": {
+ "Retry-After": {
+ "description": "Seconds to wait before retrying",
+ "schema": {
+ "type": "integer"
+ }
+ }
+ }
}
},
"x-fern-sdk-method-name": "retry_workflow_run"
@@ -6197,7 +6670,7 @@
"Runs"
],
"summary": "Get all runs",
- "description": "List workflow runs across all workflows for the current organization.\n\nResults are paginated and can be filtered by **status**, **search_key**, and **error_code**. All filters are combined with **AND** logic — a run must match every supplied filter to be returned.\n\n### search_key\n\nA case-insensitive substring search that matches against **any** of the following fields:\n\n| Searched field | Description |\n|---|---|\n| `workflow_run_id` | The unique run identifier (e.g. `wr_123…`) |\n| Parameter **key** | The `key` of any workflow parameter definition associated with the run |\n| Parameter **description** | The `description` of any workflow parameter definition |\n| Run parameter **value** | The actual value supplied for any parameter when the run was created |\n| `extra_http_headers` | Extra HTTP headers attached to the run (searched as raw JSON text) |\n\nSoft-deleted parameter definitions are excluded from key/description matching. A run is returned if **any** of the fields above contain the search term.\n\n### error_code\n\nAn **exact-match** filter against the `error_code` field inside each task's `errors` JSON array. A run matches if **any** of its tasks contains an error object with a matching `error_code` value. Error codes are user-defined strings set during workflow execution (e.g. `INVALID_CREDENTIALS`, `LOGIN_FAILED`, `CAPTCHA_DETECTED`).\n\n### Combining filters\n\nAll query parameters use AND logic:\n- `?status=failed` — only failed runs\n- `?status=failed&error_code=LOGIN_FAILED` — failed runs **and** have a LOGIN_FAILED error\n- `?status=failed&error_code=LOGIN_FAILED&search_key=prod_credential` — all three conditions must match",
+ "description": "List workflow runs across all workflows for the current organization.\n\nResults are paginated and can be filtered by **status**, **search_key**, and **error_code**. All filters are combined with **AND** logic — a run must match every supplied filter to be returned.\n\n### search_key\n\nA case-insensitive substring search that matches against **any** of the following fields:\n\n| Searched field | Description |\n|---|---|\n| `workflow_run_id` | The unique run identifier (e.g. `wr_123…`) |\n| `workflow_permanent_id` | The permanent ID of the workflow that ran (e.g. `wpid_123…`) |\n| Workflow **title** | The title of the workflow that ran |\n| Parameter **key** | The `key` of any workflow parameter definition associated with the run |\n| Parameter **description** | The `description` of any workflow parameter definition |\n| Run parameter **value** | The actual value supplied for any parameter when the run was created |\n| `extra_http_headers` | Extra HTTP headers attached to the run (searched as raw JSON text) |\n| `webhook_callback_url` | The webhook URL the run posts its result to |\n\nSoft-deleted parameter definitions are excluded from key/description matching. A run is returned if **any** of the fields above contain the search term.\n\nA **complete** identifier also matches the run that used it, by exact equality:\n\n| Identifier | Description |\n|---|---|\n| `browser_profile_id` | The browser profile the run used (e.g. `bp_123…`) |\n| `browser_session_id` | The browser session the run used (e.g. `pbs_123…`) |\n| **Credential id** | A credential the run used (e.g. `cred_123…`) |\n\nA complete browser profile or browser session id is matched against those identifiers only, not the text fields above. A credential id matches a run when it is the run's sequential credential, the credential the run selected from a pool or fell back to, or the credential bound by a credential parameter on the run's workflow version when the run was created and the run recorded no selection for that parameter. Other pool and fallback members the run did not use do not match.\n\n### error_code\n\nAn **exact-match** filter against the `error_code` field inside each task's `errors` JSON array. A run matches if **any** of its tasks contains an error object with a matching `error_code` value. Error codes are user-defined strings set during workflow execution (e.g. `INVALID_CREDENTIALS`, `LOGIN_FAILED`, `CAPTCHA_DETECTED`).\n\n### Combining filters\n\nAll query parameters use AND logic:\n- `?status=failed` — only failed runs\n- `?status=failed&error_code=LOGIN_FAILED` — failed runs **and** have a LOGIN_FAILED error\n- `?status=failed&error_code=LOGIN_FAILED&search_key=prod_credential` — all three conditions must match",
"operationId": "get_workflow_runs_v1_workflows_runs_get",
"parameters": [
{
@@ -6261,15 +6734,16 @@
"type": "null"
}
],
- "description": "Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching.",
+ "description": "Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, extra HTTP headers and webhook callback URL. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching. A complete browser profile ID, browser session ID or credential ID matches the run that used it exactly (no substring match). A complete browser profile or browser session ID is matched against those identifiers only, not the text fields. A credential ID matches when it is the run's sequential credential, the credential the run selected from a pool or fell back to, or the credential bound by a credential parameter on the run's workflow version when the run was created and the run recorded no selection for it. The workflow title and workflow permanent ID are matched as well.",
"examples": [
"login_url",
- "credential_value",
- "wr_abc123"
+ "wr_abc123",
+ "bp_123456789",
+ "cred_123456789"
],
"title": "Search Key"
},
- "description": "Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching."
+ "description": "Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, extra HTTP headers and webhook callback URL. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching. A complete browser profile ID, browser session ID or credential ID matches the run that used it exactly (no substring match). A complete browser profile or browser session ID is matched against those identifiers only, not the text fields. A credential ID matches when it is the run's sequential credential, the credential the run selected from a pool or fell back to, or the credential bound by a credential parameter on the run's workflow version when the run was created and the run recorded no selection for it. The workflow title and workflow permanent ID are matched as well."
},
{
"name": "error_code",
@@ -6349,7 +6823,7 @@
"Runs"
],
"summary": "Get all runs by agent",
- "description": "List runs for a specific workflow.\n\nSupports filtering by **status**, **search_key**, and **error_code**. All filters are combined with **AND** logic.\n\n### search_key\n\nCase-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. Soft-deleted parameter definitions are excluded.\n\n### error_code\n\nExact-match filter on the `error_code` field inside each task's `errors` JSON array. A run matches if any of its tasks contains an error with a matching `error_code`.",
+ "description": "List runs for a specific workflow.\n\nSupports filtering by **status**, **search_key**, and **error_code**. All filters are combined with **AND** logic.\n\n### search_key\n\nCase-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, extra HTTP headers and webhook callback URL. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching. A complete browser profile ID, browser session ID or credential ID matches the run that used it exactly (no substring match). A complete browser profile or browser session ID is matched against those identifiers only, not the text fields. A credential ID matches when it is the run's sequential credential, the credential the run selected from a pool or fell back to, or the credential bound by a credential parameter on the run's workflow version when the run was created and the run recorded no selection for it. The workflow title and workflow permanent ID are matched as well.\n\n### error_code\n\nExact-match filter on the `error_code` field inside each task's `errors` JSON array. A run matches if any of its tasks contains an error with a matching `error_code`.\n\n### include_child_runs\n\nChild runs — runs this workflow started from inside another workflow run — are **excluded by default**, so the history shows only top-level runs. Pass `include_child_runs=true` to list them as well; every run carries a `parent_workflow_run_id` that is `null` for top-level runs.",
"operationId": "get_workflow_runs_by_id_v1_workflows__workflow_id__runs_get",
"parameters": [
{
@@ -6422,15 +6896,16 @@
"type": "null"
}
],
- "description": "Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching.",
+ "description": "Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, extra HTTP headers and webhook callback URL. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching. A complete browser profile ID, browser session ID or credential ID matches the run that used it exactly (no substring match). A complete browser profile or browser session ID is matched against those identifiers only, not the text fields. A credential ID matches when it is the run's sequential credential, the credential the run selected from a pool or fell back to, or the credential bound by a credential parameter on the run's workflow version when the run was created and the run recorded no selection for it. The workflow title and workflow permanent ID are matched as well.",
"examples": [
"login_url",
- "credential_value",
- "wr_abc123"
+ "wr_abc123",
+ "bp_123456789",
+ "cred_123456789"
],
"title": "Search Key"
},
- "description": "Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching."
+ "description": "Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, extra HTTP headers and webhook callback URL. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching. A complete browser profile ID, browser session ID or credential ID matches the run that used it exactly (no substring match). A complete browser profile or browser session ID is matched against those identifiers only, not the text fields. A credential ID matches when it is the run's sequential credential, the credential the run selected from a pool or fell back to, or the credential bound by a credential parameter on the run's workflow version when the run was created and the run recorded no selection for it. The workflow title and workflow permanent ID are matched as well."
},
{
"name": "error_code",
@@ -6494,6 +6969,46 @@
},
"description": "Only include runs created strictly before this UTC timestamp (ISO 8601)."
},
+ {
+ "name": "tags",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 20
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Filter by run tags. Each term is a label (`production`), a group (`env:*`), or a group:label (`env:prod`). Repeat the param or comma-separate (`?tags=env:prod,env:staging`). AND across distinct terms, OR within a group's labels (`?tags=customer:acme,env:prod,env:staging` -> customer=acme AND env in (prod, staging)). A label term matches the value across any/no group. Matches current tag values only.",
+ "examples": [
+ "env:prod",
+ "production",
+ "env:*",
+ "customer:acme,env:prod"
+ ],
+ "title": "Tags"
+ },
+ "description": "Filter by run tags. Each term is a label (`production`), a group (`env:*`), or a group:label (`env:prod`). Repeat the param or comma-separate (`?tags=env:prod,env:staging`). AND across distinct terms, OR within a group's labels (`?tags=customer:acme,env:prod,env:staging` -> customer=acme AND env in (prod, staging)). A label term matches the value across any/no group. Matches current tag values only."
+ },
+ {
+ "name": "include_child_runs",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "description": "Include child workflow runs — runs started from inside another workflow run. Excluded by default so the history shows only top-level runs.",
+ "default": false,
+ "title": "Include Child Runs"
+ },
+ "description": "Include child workflow runs — runs started from inside another workflow run. Excluded by default so the history shows only top-level runs."
+ },
{
"name": "x-api-key",
"in": "header",
@@ -6548,6 +7063,7 @@
"Agents"
],
"summary": "Get an agent by id",
+ "description": "Fetch a single agent definition by its permanent id, optionally pinned to a specific version. Returns the agent's blocks, parameters, and metadata.",
"operationId": "get_workflow_v1_workflows__workflow_permanent_id__get",
"parameters": [
{
@@ -6777,6 +7293,7 @@
"Schedules"
],
"summary": "Create a schedule for an agent",
+ "description": "Create a cron, fixed-interval or one-time schedule that runs the given agent automatically with a fixed set of parameters. An interval schedule first runs at first_fire_at, or one interval after creation. A one-time schedule runs once at run_at. Returns the stored schedule and its next upcoming run times.",
"operationId": "schedules_create",
"parameters": [
{
@@ -6838,14 +7355,14 @@
}
}
}
- },
- "description": "Create a cron, fixed-interval or one-time schedule that runs the given agent automatically with a fixed set of parameters. An interval schedule first runs at first_fire_at, or one interval after creation. A one-time schedule runs once at run_at. Returns the stored schedule and its next upcoming run times."
+ }
},
"get": {
"tags": [
"Schedules"
],
"summary": "List schedules for an agent",
+ "description": "List all schedules attached to a single agent. Returns the schedules in creation order.",
"operationId": "schedules_list",
"parameters": [
{
@@ -6906,6 +7423,7 @@
"Schedules"
],
"summary": "Get an agent schedule by id",
+ "description": "Fetch one schedule belonging to an agent. Returns the schedule's cron expression or interval, timezone, parameters, enabled state, and next upcoming run times.",
"operationId": "schedules_get",
"parameters": [
{
@@ -6966,14 +7484,14 @@
}
}
}
- },
- "description": "Fetch one schedule belonging to an agent. Returns the schedule's cron expression or interval, timezone, parameters, enabled state, and next upcoming run times."
+ }
},
"put": {
"tags": [
"Schedules"
],
"summary": "Update an agent schedule",
+ "description": "Replace a schedule's cron expression, interval or one-time run_at, timezone, run parameters, and enabled state. A one-time schedule stays one-time and can change only until it fires; afterwards this returns 409. Returns the updated schedule and its next upcoming run times.",
"operationId": "schedules_update",
"parameters": [
{
@@ -7044,14 +7562,14 @@
}
}
}
- },
- "description": "Replace a schedule's cron expression, interval or one-time run_at, timezone, run parameters, and enabled state. A one-time schedule stays one-time and can change only until it fires; afterwards this returns 409. Returns the updated schedule and its next upcoming run times."
+ }
},
"delete": {
"tags": [
"Schedules"
],
"summary": "Delete an agent schedule",
+ "description": "Permanently delete a schedule so it never triggers again. Returns an acknowledgement flag.",
"operationId": "schedules_delete",
"parameters": [
{
@@ -7115,13 +7633,14 @@
}
}
},
- "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/enable": {
+ "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/cancel": {
"post": {
"tags": [
"Schedules"
],
- "summary": "Enable an agent schedule",
- "operationId": "schedules_enable",
+ "summary": "Cancel a one-time agent schedule",
+ "description": "Cancel a one-time schedule that has not fired yet. The schedule stays readable with dispatch_status canceled. Returns 409 once it has fired or was already canceled, and 422 for a recurring schedule.",
+ "operationId": "schedules_cancel",
"parameters": [
{
"name": "workflow_permanent_id",
@@ -7184,13 +7703,14 @@
}
}
},
- "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/disable": {
+ "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/enable": {
"post": {
"tags": [
"Schedules"
],
- "summary": "Disable an agent schedule",
- "operationId": "schedules_disable",
+ "summary": "Enable an agent schedule",
+ "description": "Resume a paused schedule so it starts triggering runs again. Returns the updated schedule.",
+ "operationId": "schedules_enable",
"parameters": [
{
"name": "workflow_permanent_id",
@@ -7253,14 +7773,14 @@
}
}
},
- "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/cancel": {
+ "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/disable": {
"post": {
"tags": [
"Schedules"
],
- "summary": "Cancel a one-time agent schedule",
- "description": "Cancel a one-time schedule that has not fired yet. The schedule stays readable with dispatch_status canceled. Returns 409 once it has fired or was already canceled, and 422 for a recurring schedule.",
- "operationId": "schedules_cancel",
+ "summary": "Disable an agent schedule",
+ "description": "Pause a schedule so it stops triggering runs, without deleting it. Returns the updated schedule.",
+ "operationId": "schedules_disable",
"parameters": [
{
"name": "workflow_permanent_id",
@@ -7322,32 +7842,1546 @@
}
}
}
- }
- },
- "components": {
- "schemas": {
- "AIFallbackMode": {
- "type": "string",
- "enum": [
- "fallback",
- "proactive"
+ },
+ "/v1/recipes/jobs/extract": {
+ "post": {
+ "tags": [
+ "Recipes"
],
- "title": "AIFallbackMode",
- "description": "Controls how an action block uses a CSS/XPath selector relative to AI.\n\n- `fallback`: attempt the selector first; fall back to AI on failure.\n- `proactive`: always use AI; the selector (if any) is a hint only.\n\nWhen `selector` is None, both modes degrade to AI-only — the difference\nis purely semantic (whether the author expected to have a selector here)."
- },
- "AWSSecretParameter": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "aws_secret",
- "title": "Parameter Type",
- "default": "aws_secret"
- },
- "key": {
- "type": "string",
+ "summary": "Extract a job application posting",
+ "description": "Start a workflow run that extracts structured details from a job posting.",
+ "operationId": "extract_job_application_v1_recipes_jobs_extract_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "job_url": {
+ "type": "string",
+ "format": "uri",
+ "title": "Job Url"
+ }
+ },
+ "additionalProperties": false,
+ "type": "object",
+ "required": [
+ "job_url"
+ ],
+ "title": "JobRecipeExtractRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfully started job application extraction",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/JobRecipeRunResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Insufficient credits or required billing state"
+ },
+ "403": {
+ "description": "Unauthorized or insufficient organization permission"
+ },
+ "422": {
+ "description": "Invalid extract request"
+ },
+ "429": {
+ "description": "Workflow submission rate limit exceeded"
+ },
+ "500": {
+ "description": "Workflow launch failed"
+ }
+ },
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "x-fern-sdk-method-name": "extract_job_application"
+ }
+ },
+ "/v1/recipes/jobs/apply": {
+ "post": {
+ "tags": [
+ "Recipes"
+ ],
+ "summary": "Apply to a job",
+ "description": "Start a workflow run that applies to a job with a résumé and optional credentials.",
+ "operationId": "apply_to_job_v1_recipes_jobs_apply_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "job_url": {
+ "type": "string",
+ "format": "uri",
+ "title": "Job Url"
+ },
+ "custom_prompt": {
+ "type": "string",
+ "title": "Custom Prompt"
+ },
+ "resume_url": {
+ "type": "string",
+ "format": "uri",
+ "title": "Resume Url"
+ },
+ "other_information": {
+ "title": "Other Information"
+ },
+ "terminate_criterion": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Terminate Criterion",
+ "description": "Condition that stops Apply. Omit to use the recipe default; null or empty text disables it.",
+ "default": "Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient."
+ },
+ "error_code_mapping": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error Code Mapping",
+ "description": "Error codes and descriptions. Omit for the recipe default; null or {} disables mapping. A supplied mapping replaces the default independently of terminate_criterion.",
+ "default": {
+ "job_expired": "The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications."
+ }
+ },
+ "username": {
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 1
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Username"
+ },
+ "password": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Password"
+ },
+ "persist_credentials": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Persist Credentials"
+ },
+ "2fa_identifier": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "2Fa Identifier"
+ }
+ },
+ "additionalProperties": false,
+ "type": "object",
+ "required": [
+ "job_url",
+ "custom_prompt",
+ "resume_url"
+ ],
+ "title": "JobRecipeApplyJSONRequest"
+ }
+ },
+ "multipart/form-data": {
+ "schema": {
+ "properties": {
+ "job_url": {
+ "type": "string",
+ "format": "uri",
+ "title": "Job Url"
+ },
+ "custom_prompt": {
+ "type": "string",
+ "title": "Custom Prompt"
+ },
+ "resume_file": {
+ "type": "string",
+ "format": "binary",
+ "title": "Resume File"
+ },
+ "other_information": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Other Information"
+ },
+ "terminate_criterion": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Terminate Criterion",
+ "description": "Condition that stops Apply. Omit for the recipe default; empty text disables it.",
+ "default": "Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient."
+ },
+ "error_code_mapping": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error Code Mapping",
+ "description": "JSON text containing an object of error codes and descriptions. Omit for the recipe default; JSON null or {} disables mapping. A supplied mapping replaces the default independently of terminate_criterion.",
+ "default": "{\"job_expired\": \"The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.\"}"
+ },
+ "username": {
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 1
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Username"
+ },
+ "password": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Password"
+ },
+ "persist_credentials": {
+ "anyOf": [
+ {
+ "type": "string",
+ "pattern": "^true$"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Persist Credentials"
+ },
+ "2fa_identifier": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "2Fa Identifier"
+ }
+ },
+ "additionalProperties": false,
+ "type": "object",
+ "required": [
+ "job_url",
+ "custom_prompt",
+ "resume_file"
+ ],
+ "title": "JobRecipeApplyMultipartRequest",
+ "description": "OpenAPI representation of the text and file parts accepted by Apply."
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfully started job application",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/JobRecipeRunResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid multipart structure"
+ },
+ "402": {
+ "description": "Insufficient credits or required billing state"
+ },
+ "403": {
+ "description": "Unauthorized or insufficient organization permission"
+ },
+ "413": {
+ "description": "Résumé file exceeds the upload limit"
+ },
+ "422": {
+ "description": "Invalid apply request"
+ },
+ "429": {
+ "description": "Workflow submission rate limit exceeded"
+ },
+ "500": {
+ "description": "Upload or workflow launch failed"
+ },
+ "502": {
+ "description": "Credential service failed"
+ }
+ },
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "x-fern-sdk-method-name": "apply_to_job"
+ }
+ },
+ "/v1/recipes/jobs/runs": {
+ "get": {
+ "tags": [
+ "Recipes"
+ ],
+ "summary": "List job recipe runs",
+ "description": "List workflow runs started by job recipe requests.",
+ "operationId": "list_job_recipe_runs_v1_recipes_jobs_runs_get",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "Page number.",
+ "default": 1,
+ "title": "Page"
+ },
+ "description": "Page number."
+ },
+ {
+ "name": "page_size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 100,
+ "minimum": 1,
+ "description": "Number of runs per page.",
+ "default": 25,
+ "title": "Page Size"
+ },
+ "description": "Number of runs per page."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/JobRecipeRunListResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized or insufficient organization permission"
+ },
+ "422": {
+ "description": "Invalid pagination parameters"
+ }
+ },
+ "x-fern-sdk-method-name": "list_job_recipe_runs"
+ }
+ },
+ "/v1/audit-events/export": {
+ "get": {
+ "tags": [
+ "Server"
+ ],
+ "summary": "Export organization audit events",
+ "description": "Export audit events for the authenticated organization as JSON or CSV. Only organization admins and full API keys may export. The default window is the last 90 days, with timezone-aware since/until bounds, newest-first keyset pagination, and a maximum page size of 500. CSV output uses fixed columns and is protected from spreadsheet formula execution.",
+ "operationId": "export_audit_events_v1_audit_events_export_get",
+ "parameters": [
+ {
+ "name": "since",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Since"
+ }
+ },
+ {
+ "name": "until",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Until"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 500,
+ "minimum": 1,
+ "default": 100,
+ "title": "Limit"
+ }
+ },
+ {
+ "name": "cursor",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Cursor"
+ }
+ },
+ {
+ "name": "format",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "json",
+ "csv"
+ ],
+ "type": "string",
+ "default": "json",
+ "title": "Format"
+ }
+ },
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "X-Api-Key"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A page of audit events as JSON, or a CSV download when format=csv.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuditEventExportResponse"
+ }
+ },
+ "text/csv": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The caller must be an organization admin or use a full API key.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuditExportDenialResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-fern-sdk-method-name": "export_audit_events"
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "AIFallbackMode": {
+ "type": "string",
+ "enum": [
+ "fallback",
+ "proactive"
+ ],
+ "title": "AIFallbackMode",
+ "description": "Controls how an action block uses a CSS/XPath selector relative to AI.\n\n- `fallback`: attempt the selector first; fall back to AI on failure.\n- `proactive`: always use AI; the selector (if any) is a hint only.\n\nWhen `selector` is None, both modes degrade to AI-only — the difference\nis purely semantic (whether the author expected to have a selector here)."
+ },
+ "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"
+ },
+ "AWSSecretParameterYAML": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "aws_secret",
+ "title": "Parameter Type",
+ "default": "aws_secret"
+ },
+ "key": {
+ "type": "string",
"title": "Key"
},
- "description": {
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Description"
+ },
+ "aws_key": {
+ "type": "string",
+ "title": "Aws Key"
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "aws_key"
+ ],
+ "title": "AWSSecretParameterYAML"
+ },
+ "ActAction": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "const": "ai_act",
+ "title": "Type",
+ "default": "ai_act"
+ },
+ "intention": {
+ "type": "string",
+ "title": "Intention",
+ "description": "Natural language prompt for the action",
+ "default": ""
+ },
+ "data": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data",
+ "description": "Additional context data"
+ }
+ },
+ "type": "object",
+ "title": "ActAction",
+ "description": "AI act action parameters."
+ },
+ "Action": {
+ "properties": {
+ "action_type": {
+ "$ref": "#/components/schemas/ActionType"
+ },
+ "status": {
+ "$ref": "#/components/schemas/ActionStatus",
+ "default": "pending"
+ },
+ "action_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Action Id"
+ },
+ "source_action_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Source Action Id"
+ },
+ "organization_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ },
+ "workflow_run_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Workflow Run Id"
+ },
+ "task_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Task Id"
+ },
+ "step_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Step Id"
+ },
+ "step_order": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Step Order"
+ },
+ "action_order": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Action Order"
+ },
+ "confidence_float": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Confidence Float"
+ },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Description"
+ },
+ "reasoning": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Reasoning"
+ },
+ "intention": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Intention"
+ },
+ "response": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Response"
+ },
+ "element_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Element Id"
+ },
+ "skyvern_element_hash": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Skyvern Element Hash"
+ },
+ "skyvern_element_data": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Skyvern Element Data"
+ },
+ "screenshot_artifact_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Screenshot Artifact Id"
+ },
+ "tool_call_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Tool Call Id"
+ },
+ "xpath": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Xpath"
+ },
+ "errors": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/UserDefinedError"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Errors"
+ },
+ "terminal_user_errors": {
+ "type": "boolean",
+ "title": "Terminal User Errors",
+ "default": false
+ },
+ "data_extraction_goal": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data Extraction Goal"
+ },
+ "output": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Output"
+ },
+ "file_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File Name"
+ },
+ "file_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File Url"
+ },
+ "download": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Download"
+ },
+ "download_triggered": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Download Triggered"
+ },
+ "downloaded_files": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Downloaded Files"
+ },
+ "is_upload_file_tag": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Is Upload File Tag"
+ },
+ "text": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Text"
+ },
+ "input_or_select_context": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/InputOrSelectContext"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "option": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SelectOption"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "is_checked": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Is Checked"
+ },
+ "verified": {
+ "type": "boolean",
+ "title": "Verified",
+ "default": false
+ },
+ "click_context": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ClickContext"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "totp_timing_info": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Totp Timing Info"
+ },
+ "has_mini_agent": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Has Mini Agent"
+ },
+ "skip_auto_complete_tab": {
+ "type": "boolean",
+ "title": "Skip Auto Complete Tab",
+ "default": false
+ },
+ "started_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Started At"
+ },
+ "finished_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Finished At"
+ },
+ "created_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created At"
+ },
+ "modified_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Modified At"
+ },
+ "created_by": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created By"
+ }
+ },
+ "type": "object",
+ "required": [
+ "action_type"
+ ],
+ "title": "Action"
+ },
+ "ActionBlock": {
+ "properties": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
+ },
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ },
+ "block_type": {
+ "type": "string",
+ "const": "action",
+ "title": "Block Type",
+ "default": "action"
+ },
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
+ },
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop 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": ""
+ },
+ "engine": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
+ },
+ "complete_criterion": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Complete Criterion"
+ },
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
+ "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": "string"
+ },
+ {
+ "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/AzureSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "parameter_type",
+ "mapping": {
+ "aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
+ "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
+ "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
+ "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
+ "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
+ "context": "#/components/schemas/ContextParameter",
+ "credential": "#/components/schemas/CredentialParameter",
+ "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
+ "output": "#/components/schemas/OutputParameter",
+ "workflow": "#/components/schemas/WorkflowParameter"
+ }
+ }
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
+ },
+ "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"
+ },
+ "complete_verification": {
+ "type": "boolean",
+ "title": "Complete Verification",
+ "default": true
+ },
+ "include_action_history_in_verification": {
+ "type": "boolean",
+ "title": "Include Action History In Verification",
+ "default": false
+ },
+ "download_timeout": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Download Timeout"
+ },
+ "include_extracted_text": {
+ "type": "boolean",
+ "title": "Include Extracted Text",
+ "default": true
+ },
+ "selector": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Selector"
+ },
+ "ai_fallback": {
+ "$ref": "#/components/schemas/AIFallbackMode",
+ "default": "fallback"
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "output_parameter"
+ ],
+ "title": "ActionBlock"
+ },
+ "ActionBlockYAML": {
+ "properties": {
+ "block_type": {
+ "type": "string",
+ "const": "action",
+ "title": "Block Type",
+ "default": "action"
+ },
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
+ },
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -7356,67 +9390,262 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
},
- "aws_secret_parameter_id": {
- "type": "string",
- "title": "Aws Secret Parameter Id"
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
},
- "workflow_id": {
- "type": "string",
- "title": "Workflow Id"
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
},
- "aws_key": {
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Url"
+ },
+ "title": {
"type": "string",
- "title": "Aws Key"
+ "title": "Title",
+ "default": ""
+ },
+ "engine": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "description": "Set to true only when skyvern-1.0 was explicitly chosen for this block; leave it unset otherwise.",
+ "default": false
+ },
+ "navigation_goal": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Navigation Goal"
+ },
+ "selector": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Selector"
+ },
+ "ai_fallback": {
+ "$ref": "#/components/schemas/AIFallbackMode",
+ "default": "fallback"
+ },
+ "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"
+ },
+ "parameter_keys": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Parameter Keys"
+ },
+ "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"
},
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ }
+ },
+ "type": "object",
+ "required": [
+ "label"
+ ],
+ "title": "ActionBlockYAML"
+ },
+ "ActionStatus": {
+ "type": "string",
+ "enum": [
+ "pending",
+ "skipped",
+ "failed",
+ "completed"
+ ],
+ "title": "ActionStatus"
+ },
+ "ActionType": {
+ "type": "string",
+ "enum": [
+ "click",
+ "input_text",
+ "paste_text",
+ "upload_file",
+ "download_file",
+ "select_option",
+ "checkbox",
+ "wait",
+ "hover",
+ "null_action",
+ "solve_captcha",
+ "terminate",
+ "complete",
+ "reload_page",
+ "close_page",
+ "new_tab",
+ "switch_tab",
+ "extract",
+ "verification_code",
+ "goto_url",
+ "go_back",
+ "go_forward",
+ "scroll",
+ "keypress",
+ "move",
+ "drag",
+ "left_mouse",
+ "execute_js"
+ ],
+ "title": "ActionType"
+ },
+ "Artifact": {
+ "properties": {
"created_at": {
"type": "string",
- "format": "date-time",
- "title": "Created At"
+ "title": "Created At",
+ "description": "The creation datetime of the task.",
+ "examples": [
+ "2023-01-01T00:00:00Z"
+ ]
},
"modified_at": {
"type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "title": "Modified At",
+ "description": "The modification datetime of the task.",
+ "examples": [
+ "2023-01-01T00:00:00Z"
+ ]
},
- "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"
- },
- "AWSSecretParameterYAML": {
- "properties": {
- "parameter_type": {
+ "artifact_id": {
"type": "string",
- "const": "aws_secret",
- "title": "Parameter Type",
- "default": "aws_secret"
+ "title": "Artifact Id"
},
- "key": {
+ "artifact_type": {
+ "$ref": "#/components/schemas/ArtifactType"
+ },
+ "uri": {
"type": "string",
- "title": "Key"
+ "title": "Uri"
},
- "description": {
+ "bundle_key": {
"anyOf": [
{
"type": "string"
@@ -7425,76 +9654,31 @@
"type": "null"
}
],
- "title": "Description"
- },
- "aws_key": {
- "type": "string",
- "title": "Aws Key"
- }
- },
- "type": "object",
- "required": [
- "key",
- "aws_key"
- ],
- "title": "AWSSecretParameterYAML"
- },
- "ActAction": {
- "properties": {
- "type": {
- "type": "string",
- "const": "ai_act",
- "title": "Type",
- "default": "ai_act"
- },
- "intention": {
- "type": "string",
- "title": "Intention",
- "description": "Natural language prompt for the action",
- "default": ""
+ "title": "Bundle Key"
},
- "data": {
+ "checksum": {
"anyOf": [
{
"type": "string"
},
- {
- "additionalProperties": true,
- "type": "object"
- },
{
"type": "null"
}
],
- "title": "Data",
- "description": "Additional context data"
- }
- },
- "type": "object",
- "title": "ActAction",
- "description": "AI act action parameters."
- },
- "Action": {
- "properties": {
- "action_type": {
- "$ref": "#/components/schemas/ActionType"
- },
- "status": {
- "$ref": "#/components/schemas/ActionStatus",
- "default": "pending"
+ "title": "Checksum"
},
- "action_id": {
+ "file_size": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Action Id"
+ "title": "File Size"
},
- "source_action_id": {
+ "task_id": {
"anyOf": [
{
"type": "string"
@@ -7503,9 +9687,9 @@
"type": "null"
}
],
- "title": "Source Action Id"
+ "title": "Task Id"
},
- "organization_id": {
+ "step_id": {
"anyOf": [
{
"type": "string"
@@ -7514,7 +9698,7 @@
"type": "null"
}
],
- "title": "Organization Id"
+ "title": "Step Id"
},
"workflow_run_id": {
"anyOf": [
@@ -7527,7 +9711,7 @@
],
"title": "Workflow Run Id"
},
- "task_id": {
+ "workflow_run_block_id": {
"anyOf": [
{
"type": "string"
@@ -7536,9 +9720,9 @@
"type": "null"
}
],
- "title": "Task Id"
+ "title": "Workflow Run Block Id"
},
- "step_id": {
+ "run_id": {
"anyOf": [
{
"type": "string"
@@ -7547,42 +9731,42 @@
"type": "null"
}
],
- "title": "Step Id"
+ "title": "Run Id"
},
- "step_order": {
+ "browser_session_id": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Step Order"
+ "title": "Browser Session Id"
},
- "action_order": {
+ "observer_cruise_id": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Action Order"
+ "title": "Observer Cruise Id"
},
- "confidence_float": {
+ "observer_thought_id": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Confidence Float"
+ "title": "Observer Thought Id"
},
- "description": {
+ "ai_suggestion_id": {
"anyOf": [
{
"type": "string"
@@ -7591,9 +9775,9 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Ai Suggestion Id"
},
- "reasoning": {
+ "signed_url": {
"anyOf": [
{
"type": "string"
@@ -7602,9 +9786,85 @@
"type": "null"
}
],
- "title": "Reasoning"
+ "title": "Signed Url"
},
- "intention": {
+ "archived": {
+ "type": "boolean",
+ "title": "Archived",
+ "default": false
+ },
+ "organization_id": {
+ "type": "string",
+ "title": "Organization Id"
+ }
+ },
+ "type": "object",
+ "required": [
+ "created_at",
+ "modified_at",
+ "artifact_id",
+ "artifact_type",
+ "uri",
+ "organization_id"
+ ],
+ "title": "Artifact"
+ },
+ "ArtifactType": {
+ "type": "string",
+ "enum": [
+ "recording",
+ "audio",
+ "session_replay",
+ "eval_score",
+ "eval_trajectory",
+ "eval_rubrics",
+ "browser_console_log",
+ "browser_session_action_log",
+ "skyvern_log",
+ "skyvern_log_raw",
+ "screenshot",
+ "screenshot_llm",
+ "screenshot_action",
+ "screenshot_final",
+ "screenshot_proxy",
+ "screenshot_pre_submit",
+ "llm_prompt",
+ "llm_request",
+ "llm_response",
+ "llm_response_parsed",
+ "llm_response_rendered",
+ "visible_elements_id_css_map",
+ "visible_elements_id_frame_map",
+ "visible_elements_tree",
+ "visible_elements_tree_trimmed",
+ "visible_elements_tree_in_prompt",
+ "hashed_href_map",
+ "visible_elements_id_xpath_map",
+ "html",
+ "html_scrape",
+ "html_action",
+ "html_pre_submit",
+ "trace",
+ "har",
+ "script_file",
+ "pdf",
+ "step_archive",
+ "task_archive",
+ "download",
+ "unknown"
+ ],
+ "title": "ArtifactType"
+ },
+ "AuditEventExportResponse": {
+ "properties": {
+ "rows": {
+ "items": {
+ "$ref": "#/components/schemas/AuditEventExportRow"
+ },
+ "type": "array",
+ "title": "Rows"
+ },
+ "next": {
"anyOf": [
{
"type": "string"
@@ -7613,9 +9873,32 @@
"type": "null"
}
],
- "title": "Intention"
+ "title": "Next"
+ }
+ },
+ "type": "object",
+ "required": [
+ "rows",
+ "next"
+ ],
+ "title": "AuditEventExportResponse"
+ },
+ "AuditEventExportRow": {
+ "properties": {
+ "audit_event_id": {
+ "type": "string",
+ "title": "Audit Event Id"
},
- "response": {
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ },
+ "organization_id": {
+ "type": "string",
+ "title": "Organization Id"
+ },
+ "actor_user_id": {
"anyOf": [
{
"type": "string"
@@ -7624,9 +9907,13 @@
"type": "null"
}
],
- "title": "Response"
+ "title": "Actor User Id"
},
- "element_id": {
+ "auth_kind": {
+ "type": "string",
+ "title": "Auth Kind"
+ },
+ "org_role": {
"anyOf": [
{
"type": "string"
@@ -7635,9 +9922,17 @@
"type": "null"
}
],
- "title": "Element Id"
+ "title": "Org Role"
+ },
+ "action": {
+ "type": "string",
+ "title": "Action"
+ },
+ "resource_type": {
+ "type": "string",
+ "title": "Resource Type"
},
- "skyvern_element_hash": {
+ "resource_id": {
"anyOf": [
{
"type": "string"
@@ -7646,21 +9941,119 @@
"type": "null"
}
],
- "title": "Skyvern Element Hash"
+ "title": "Resource Id"
},
- "skyvern_element_data": {
+ "request_id": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Skyvern Element Data"
+ "title": "Request Id"
},
- "screenshot_artifact_id": {
+ "details": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Details"
+ }
+ },
+ "type": "object",
+ "required": [
+ "audit_event_id",
+ "created_at",
+ "organization_id",
+ "actor_user_id",
+ "auth_kind",
+ "org_role",
+ "action",
+ "resource_type",
+ "resource_id",
+ "request_id",
+ "details"
+ ],
+ "title": "AuditEventExportRow"
+ },
+ "AuditExportDenialDetail": {
+ "properties": {
+ "error_code": {
+ "type": "string",
+ "const": "organization_admin_required",
+ "title": "Error Code"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message"
+ },
+ "reason_kind": {
+ "type": "string",
+ "const": "role",
+ "title": "Reason Kind"
+ },
+ "required": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object",
+ "title": "Required"
+ },
+ "caller_has": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "type": "object",
+ "title": "Caller Has"
+ },
+ "next_action": {
+ "type": "string",
+ "title": "Next Action"
+ }
+ },
+ "type": "object",
+ "required": [
+ "error_code",
+ "message",
+ "reason_kind",
+ "required",
+ "caller_has",
+ "next_action"
+ ],
+ "title": "AuditExportDenialDetail"
+ },
+ "AuditExportDenialResponse": {
+ "properties": {
+ "detail": {
+ "$ref": "#/components/schemas/AuditExportDenialDetail"
+ }
+ },
+ "type": "object",
+ "required": [
+ "detail"
+ ],
+ "title": "AuditExportDenialResponse"
+ },
+ "AzureSecretParameter": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "azure_secret",
+ "title": "Parameter Type",
+ "default": "azure_secret"
+ },
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7669,20 +10062,67 @@
"type": "null"
}
],
- "title": "Screenshot Artifact Id"
+ "title": "Description"
},
- "tool_call_id": {
+ "azure_secret_parameter_id": {
+ "type": "string",
+ "title": "Azure Secret Parameter Id"
+ },
+ "workflow_id": {
+ "type": "string",
+ "title": "Workflow Id"
+ },
+ "azure_key": {
+ "type": "string",
+ "title": "Azure Key"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ },
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
+ },
+ "deleted_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Tool Call Id"
+ "title": "Deleted At"
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "azure_secret_parameter_id",
+ "workflow_id",
+ "azure_key",
+ "created_at",
+ "modified_at"
+ ],
+ "title": "AzureSecretParameter"
+ },
+ "AzureVaultCredentialParameter": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "azure_vault_credential",
+ "title": "Parameter Type",
+ "default": "azure_vault_credential"
},
- "xpath": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7691,48 +10131,89 @@
"type": "null"
}
],
- "title": "Xpath"
+ "title": "Description"
},
- "errors": {
+ "azure_vault_credential_parameter_id": {
+ "type": "string",
+ "title": "Azure Vault Credential Parameter Id"
+ },
+ "workflow_id": {
+ "type": "string",
+ "title": "Workflow Id"
+ },
+ "vault_name": {
+ "type": "string",
+ "title": "Vault Name"
+ },
+ "username_key": {
+ "type": "string",
+ "title": "Username Key"
+ },
+ "password_key": {
+ "type": "string",
+ "title": "Password Key"
+ },
+ "totp_secret_key": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/UserDefinedError"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Errors"
+ "title": "Totp Secret Key"
},
- "terminal_user_errors": {
- "type": "boolean",
- "title": "Terminal User Errors",
- "default": false
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
},
- "data_extraction_goal": {
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
+ },
+ "deleted_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Data Extraction Goal"
+ "title": "Deleted At"
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "azure_vault_credential_parameter_id",
+ "workflow_id",
+ "vault_name",
+ "username_key",
+ "password_key",
+ "created_at",
+ "modified_at"
+ ],
+ "title": "AzureVaultCredentialParameter"
+ },
+ "AzureVaultCredentialParameterYAML": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "azure_vault_credential",
+ "title": "Parameter Type",
+ "default": "azure_vault_credential"
},
- "output": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "items": {},
- "type": "array"
- },
{
"type": "string"
},
@@ -7740,9 +10221,21 @@
"type": "null"
}
],
- "title": "Output"
+ "title": "Description"
},
- "file_name": {
+ "vault_name": {
+ "type": "string",
+ "title": "Vault Name"
+ },
+ "username_key": {
+ "type": "string",
+ "title": "Username Key"
+ },
+ "password_key": {
+ "type": "string",
+ "title": "Password Key"
+ },
+ "totp_secret_key": {
"anyOf": [
{
"type": "string"
@@ -7751,9 +10244,31 @@
"type": "null"
}
],
- "title": "File Name"
+ "title": "Totp Secret Key"
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "vault_name",
+ "username_key",
+ "password_key"
+ ],
+ "title": "AzureVaultCredentialParameterYAML"
+ },
+ "BitwardenCreditCardDataParameter": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "bitwarden_credit_card_data",
+ "title": "Parameter Type",
+ "default": "bitwarden_credit_card_data"
+ },
+ "key": {
+ "type": "string",
+ "title": "Key"
},
- "file_url": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7762,56 +10277,173 @@
"type": "null"
}
],
- "title": "File Url"
+ "title": "Description"
},
- "download": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Download"
+ "bitwarden_credit_card_data_parameter_id": {
+ "type": "string",
+ "title": "Bitwarden Credit Card Data Parameter Id"
},
- "download_triggered": {
+ "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": "boolean"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Download Triggered"
+ "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"
+ },
+ "BitwardenCreditCardDataParameterYAML": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "bitwarden_credit_card_data",
+ "title": "Parameter Type",
+ "default": "bitwarden_credit_card_data"
},
- "downloaded_files": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Downloaded Files"
+ "title": "Description"
},
- "is_upload_file_tag": {
+ "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"
+ }
+ },
+ "type": "object",
+ "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"
+ },
+ "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": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Is Upload File Tag"
+ "title": "Description"
},
- "text": {
+ "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"
@@ -7820,107 +10452,146 @@
"type": "null"
}
],
- "title": "Text"
+ "title": "Url Parameter Key"
},
- "input_or_select_context": {
+ "bitwarden_collection_id": {
"anyOf": [
{
- "$ref": "#/components/schemas/InputOrSelectContext"
+ "type": "string"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Bitwarden Collection Id"
},
- "option": {
+ "bitwarden_item_id": {
"anyOf": [
{
- "$ref": "#/components/schemas/SelectOption"
+ "type": "string"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Bitwarden Item Id"
},
- "is_checked": {
+ "totp_identifier": {
"anyOf": [
{
- "type": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Is Checked"
+ "title": "Totp Identifier"
},
- "verified": {
- "type": "boolean",
- "title": "Verified",
- "default": false
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
},
- "click_context": {
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
+ },
+ "deleted_at": {
"anyOf": [
{
- "$ref": "#/components/schemas/ClickContext"
+ "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"
+ },
+ "BitwardenLoginCredentialParameterYAML": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "bitwarden_login_credential",
+ "title": "Parameter Type",
+ "default": "bitwarden_login_credential"
},
- "totp_timing_info": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Totp Timing Info"
+ "title": "Description"
+ },
+ "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"
},
- "has_mini_agent": {
+ "url_parameter_key": {
"anyOf": [
{
- "type": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Has Mini Agent"
- },
- "skip_auto_complete_tab": {
- "type": "boolean",
- "title": "Skip Auto Complete Tab",
- "default": false
+ "title": "Url Parameter Key"
},
- "created_at": {
+ "bitwarden_collection_id": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Created At"
+ "title": "Bitwarden Collection Id"
},
- "modified_at": {
+ "bitwarden_item_id": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Modified At"
+ "title": "Bitwarden Item Id"
},
- "created_by": {
+ "totp_identifier": {
"anyOf": [
{
"type": "string"
@@ -7929,23 +10600,31 @@
"type": "null"
}
],
- "title": "Created By"
+ "title": "Totp Identifier"
}
},
"type": "object",
"required": [
- "action_type"
+ "key",
+ "bitwarden_client_id_aws_secret_key",
+ "bitwarden_client_secret_aws_secret_key",
+ "bitwarden_master_password_aws_secret_key"
],
- "title": "Action"
+ "title": "BitwardenLoginCredentialParameterYAML"
},
- "ActionBlock": {
+ "BitwardenSensitiveInformationParameter": {
"properties": {
- "label": {
+ "parameter_type": {
"type": "string",
- "title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "const": "bitwarden_sensitive_information",
+ "title": "Parameter Type",
+ "default": "bitwarden_sensitive_information"
},
- "next_block_label": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7954,87 +10633,95 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ "title": "Description"
},
- "block_type": {
+ "bitwarden_sensitive_information_parameter_id": {
"type": "string",
- "const": "action",
- "title": "Block Type",
- "default": "action"
- },
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
+ "title": "Bitwarden Sensitive Information Parameter Id"
},
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "workflow_id": {
+ "type": "string",
+ "title": "Workflow Id"
},
- "model": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
+ "bitwarden_client_id_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Client Id Aws Secret Key"
},
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
+ "bitwarden_client_secret_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Client Secret Aws Secret Key"
},
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "bitwarden_master_password_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Master Password Aws Secret Key"
},
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
+ "bitwarden_collection_id": {
+ "type": "string",
+ "title": "Bitwarden Collection Id"
},
- "task_type": {
+ "bitwarden_identity_key": {
"type": "string",
- "title": "Task Type",
- "default": "general"
+ "title": "Bitwarden Identity Key"
},
- "url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Url"
+ "bitwarden_identity_fields": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Bitwarden Identity Fields"
},
- "title": {
+ "created_at": {
"type": "string",
- "title": "Title",
- "default": ""
+ "format": "date-time",
+ "title": "Created At"
},
- "engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
},
- "complete_criterion": {
+ "deleted_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Complete Criterion"
+ "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"
+ },
+ "BitwardenSensitiveInformationParameterYAML": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "bitwarden_sensitive_information",
+ "title": "Parameter Type",
+ "default": "bitwarden_sensitive_information"
},
- "terminate_criterion": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -8043,154 +10730,189 @@
"type": "null"
}
],
- "title": "Terminate Criterion"
+ "title": "Description"
},
- "navigation_goal": {
+ "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"
+ }
+ },
+ "type": "object",
+ "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"
+ },
+ "BlockType": {
+ "type": "string",
+ "enum": [
+ "task",
+ "task_v2",
+ "for_loop",
+ "while_loop",
+ "conditional",
+ "code",
+ "text_prompt",
+ "download_to_s3",
+ "upload_to_s3",
+ "file_upload",
+ "send_email",
+ "file_url_parser",
+ "validation",
+ "action",
+ "navigation",
+ "extraction",
+ "login",
+ "wait",
+ "file_download",
+ "goto_url",
+ "pdf_parser",
+ "http_request",
+ "web_search",
+ "human_interaction",
+ "print_page",
+ "workflow_trigger",
+ "google_sheets_read",
+ "google_sheets_write",
+ "pdf_fill",
+ "split_pdf",
+ "email_inbox",
+ "data_export",
+ "terminate"
+ ],
+ "title": "BlockType"
+ },
+ "Body_upload_file_v1_upload_file_post": {
+ "properties": {
+ "retention_days": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Navigation Goal"
+ "title": "Retention Days",
+ "description": "Number of days to keep the file before it is deleted automatically. Omit to keep the file until the organization's data retention policy removes it."
},
- "data_extraction_goal": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Data Extraction Goal"
+ "file": {
+ "type": "string",
+ "contentMediaType": "application/octet-stream",
+ "title": "File"
+ }
+ },
+ "type": "object",
+ "required": [
+ "file"
+ ],
+ "title": "Body_upload_file_v1_upload_file_post"
+ },
+ "BranchCondition": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "Id"
},
- "data_schema": {
+ "criteria": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
- },
- {
- "items": {},
- "type": "array"
- },
- {
- "type": "string"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/JinjaBranchCriteria"
+ },
+ {
+ "$ref": "#/components/schemas/PromptBranchCriteria"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "criteria_type",
+ "mapping": {
+ "jinja2_template": "#/components/schemas/JinjaBranchCriteria",
+ "prompt": "#/components/schemas/PromptBranchCriteria"
+ }
+ }
},
{
"type": "null"
}
],
- "title": "Data Schema"
+ "title": "Criteria"
},
- "error_code_mapping": {
+ "next_block_label": {
"anyOf": [
{
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Error Code Mapping"
- },
- "max_retries": {
- "type": "integer",
- "title": "Max Retries",
- "default": 0
+ "title": "Next Block Label"
},
- "max_steps_per_run": {
+ "description": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"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/AzureSecretParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
- },
- {
- "$ref": "#/components/schemas/OnePasswordCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/AzureVaultCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/OutputParameter"
- },
- {
- "$ref": "#/components/schemas/CredentialParameter"
- }
- ],
- "discriminator": {
- "propertyName": "parameter_type",
- "mapping": {
- "aws_secret": "#/components/schemas/AWSSecretParameter",
- "azure_secret": "#/components/schemas/AzureSecretParameter",
- "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
- "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
- "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
- "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
- "context": "#/components/schemas/ContextParameter",
- "credential": "#/components/schemas/CredentialParameter",
- "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
- "output": "#/components/schemas/OutputParameter",
- "workflow": "#/components/schemas/WorkflowParameter"
- }
- }
- },
- "type": "array",
- "title": "Parameters",
- "default": []
+ "title": "Description"
},
- "complete_on_download": {
+ "is_default": {
"type": "boolean",
- "title": "Complete On Download",
+ "title": "Is Default",
"default": false
- },
- "download_suffix": {
+ }
+ },
+ "type": "object",
+ "title": "BranchCondition",
+ "description": "Represents a single conditional branch edge within a ConditionalBlock."
+ },
+ "BranchConditionYAML": {
+ "properties": {
+ "criteria": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/BranchCriteriaYAML"
},
{
"type": "null"
}
- ],
- "title": "Download Suffix"
+ ]
},
- "totp_verification_url": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -8199,9 +10921,9 @@
"type": "null"
}
],
- "title": "Totp Verification Url"
+ "title": "Next Block Label"
},
- "totp_identifier": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -8210,35 +10932,33 @@
"type": "null"
}
],
- "title": "Totp Identifier"
- },
- "complete_verification": {
- "type": "boolean",
- "title": "Complete Verification",
- "default": true
+ "title": "Description"
},
- "include_action_history_in_verification": {
+ "is_default": {
"type": "boolean",
- "title": "Include Action History In Verification",
+ "title": "Is Default",
"default": false
- },
- "download_timeout": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
+ }
+ },
+ "type": "object",
+ "title": "BranchConditionYAML"
+ },
+ "BranchCriteriaYAML": {
+ "properties": {
+ "criteria_type": {
+ "type": "string",
+ "enum": [
+ "jinja2_template",
+ "prompt"
],
- "title": "Download Timeout"
+ "title": "Criteria Type",
+ "default": "jinja2_template"
},
- "include_extracted_text": {
- "type": "boolean",
- "title": "Include Extracted Text",
- "default": true
+ "expression": {
+ "type": "string",
+ "title": "Expression"
},
- "selector": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -8247,73 +10967,41 @@
"type": "null"
}
],
- "title": "Selector"
- },
- "ai_fallback": {
- "$ref": "#/components/schemas/AIFallbackMode",
- "default": "fallback"
+ "title": "Description"
}
},
"type": "object",
"required": [
- "label",
- "output_parameter"
+ "expression"
],
- "title": "ActionBlock"
+ "title": "BranchCriteriaYAML"
},
- "ActionBlockYAML": {
+ "BrowserProfile": {
"properties": {
- "block_type": {
+ "browser_profile_id": {
"type": "string",
- "const": "action",
- "title": "Block Type",
- "default": "action"
+ "title": "Browser Profile Id"
},
- "label": {
+ "organization_id": {
"type": "string",
- "title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
- },
- "next_block_label": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
+ "title": "Organization Id"
},
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "name": {
+ "type": "string",
+ "title": "Name"
},
- "model": {
+ "description": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
- },
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
+ "title": "Description"
},
- "url": {
+ "source_browser_type": {
"anyOf": [
{
"type": "string"
@@ -8322,29 +11010,27 @@
"type": "null"
}
],
- "title": "Url"
- },
- "title": {
- "type": "string",
- "title": "Title",
- "default": ""
- },
- "engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "title": "Source Browser Type"
},
- "navigation_goal": {
+ "proxy_location": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/ProxyLocation"
+ },
+ {
+ "$ref": "#/components/schemas/GeoTarget"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Navigation Goal"
+ "title": "Proxy Location"
},
- "selector": {
+ "proxy_session_id": {
"anyOf": [
{
"type": "string"
@@ -8353,73 +11039,70 @@
"type": "null"
}
],
- "title": "Selector"
+ "title": "Proxy Session Id"
},
- "ai_fallback": {
- "$ref": "#/components/schemas/AIFallbackMode",
- "default": "fallback"
+ "is_managed": {
+ "type": "boolean",
+ "title": "Is Managed",
+ "default": false
},
- "error_code_mapping": {
+ "workflow_permanent_id": {
"anyOf": [
{
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Error Code Mapping"
- },
- "max_retries": {
- "type": "integer",
- "title": "Max Retries",
- "default": 0
+ "title": "Workflow Permanent Id"
},
- "parameter_keys": {
+ "browser_profile_key_digest": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Parameter Keys"
+ "title": "Browser Profile Key Digest"
},
- "complete_on_download": {
- "type": "boolean",
- "title": "Complete On Download",
- "default": false
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
},
- "download_suffix": {
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
+ },
+ "deleted_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Download Suffix"
+ "title": "Deleted At"
},
- "totp_verification_url": {
+ "last_verified_login_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Totp Verification Url"
+ "title": "Last Verified Login At"
},
- "totp_identifier": {
+ "linked_credential_name": {
"anyOf": [
{
"type": "string"
@@ -8428,93 +11111,135 @@
"type": "null"
}
],
- "title": "Totp Identifier"
+ "title": "Linked Credential Name"
+ }
+ },
+ "type": "object",
+ "required": [
+ "browser_profile_id",
+ "organization_id",
+ "name",
+ "created_at",
+ "modified_at"
+ ],
+ "title": "BrowserProfile"
+ },
+ "BrowserProfileUsage": {
+ "properties": {
+ "workflows": {
+ "items": {
+ "$ref": "#/components/schemas/BrowserProfileUsageWorkflow"
+ },
+ "type": "array",
+ "title": "Workflows",
+ "default": []
},
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
+ "credentials": {
+ "items": {
+ "$ref": "#/components/schemas/BrowserProfileUsageCredential"
+ },
+ "type": "array",
+ "title": "Credentials",
+ "default": []
+ },
+ "recent_seeded_run_count": {
+ "type": "integer",
+ "title": "Recent Seeded Run Count",
+ "default": 0
+ }
+ },
+ "type": "object",
+ "title": "BrowserProfileUsage"
+ },
+ "BrowserProfileUsageCredential": {
+ "properties": {
+ "credential_id": {
+ "type": "string",
+ "title": "Credential Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
}
},
"type": "object",
"required": [
- "label"
+ "credential_id",
+ "name"
],
- "title": "ActionBlockYAML"
+ "title": "BrowserProfileUsageCredential"
},
- "ActionStatus": {
- "type": "string",
- "enum": [
- "pending",
- "skipped",
- "failed",
- "completed"
+ "BrowserProfileUsageWorkflow": {
+ "properties": {
+ "workflow_permanent_id": {
+ "type": "string",
+ "title": "Workflow Permanent Id"
+ },
+ "title": {
+ "type": "string",
+ "title": "Title"
+ },
+ "via": {
+ "type": "string",
+ "title": "Via"
+ }
+ },
+ "type": "object",
+ "required": [
+ "workflow_permanent_id",
+ "title",
+ "via"
],
- "title": "ActionStatus"
+ "title": "BrowserProfileUsageWorkflow"
},
- "ActionType": {
+ "BrowserSeedSource": {
"type": "string",
"enum": [
- "click",
- "input_text",
- "upload_file",
- "download_file",
- "select_option",
- "checkbox",
- "wait",
- "hover",
- "null_action",
- "solve_captcha",
- "terminate",
- "complete",
- "reload_page",
- "close_page",
- "new_tab",
- "switch_tab",
- "extract",
- "verification_code",
- "goto_url",
- "go_back",
- "go_forward",
- "scroll",
- "keypress",
- "move",
- "drag",
- "left_mouse",
- "execute_js"
+ "override",
+ "picked",
+ "own_memory",
+ "credential",
+ "fresh",
+ "degraded_fresh"
],
- "title": "ActionType"
+ "title": "BrowserSeedSource",
+ "description": "Which layer of the seed-precedence chain seeded a run's browser (provenance).\n\nResolved once at run setup, before any browser creation, for all run types (C-semantics).\n- override: explicit request browser_profile_id (one-run-only pick via API)\n- picked: the workflow's explicit profile pick (workflows.browser_profile_id) — \"always start here\"\n- own_memory: the workflow's own auto-profile (no pick + persist_browser_session)\n- credential: the run's selected credential's profile (rotation-aware; also the empty-own boot)\n- fresh: no seed profile\n- degraded_fresh: a resolved profile failed to load; ran fresh"
},
- "Artifact": {
+ "BrowserSessionResponse": {
"properties": {
- "created_at": {
+ "browser_session_id": {
"type": "string",
- "title": "Created At",
- "description": "The creation datetime of the task.",
+ "title": "Browser Session Id",
+ "description": "Unique identifier for the browser session. browser_session_id starts with `pbs_`.",
"examples": [
- "2023-01-01T00:00:00Z"
+ "pbs_123456"
]
},
- "modified_at": {
+ "organization_id": {
"type": "string",
- "title": "Modified At",
- "description": "The modification datetime of the task.",
+ "title": "Organization Id",
+ "description": "ID of the organization that owns this session"
+ },
+ "status": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Status",
+ "description": "Current status of the browser session",
"examples": [
- "2023-01-01T00:00:00Z"
+ "created",
+ "running",
+ "completed",
+ "failed",
+ "timeout"
]
},
- "artifact_id": {
- "type": "string",
- "title": "Artifact Id"
- },
- "artifact_type": {
- "$ref": "#/components/schemas/ArtifactType"
- },
- "uri": {
- "type": "string",
- "title": "Uri"
- },
- "bundle_key": {
+ "runnable_type": {
"anyOf": [
{
"type": "string"
@@ -8523,9 +11248,14 @@
"type": "null"
}
],
- "title": "Bundle Key"
+ "title": "Runnable Type",
+ "description": "Type of the current runnable associated with this session (workflow, task etc)",
+ "examples": [
+ "task",
+ "workflow_run"
+ ]
},
- "checksum": {
+ "runnable_id": {
"anyOf": [
{
"type": "string"
@@ -8534,9 +11264,14 @@
"type": "null"
}
],
- "title": "Checksum"
+ "title": "Runnable Id",
+ "description": "ID of the current runnable",
+ "examples": [
+ "tsk_123456",
+ "wr_123456"
+ ]
},
- "file_size": {
+ "timeout": {
"anyOf": [
{
"type": "integer"
@@ -8545,9 +11280,14 @@
"type": "null"
}
],
- "title": "File Size"
+ "title": "Timeout",
+ "description": "Timeout in minutes for the session. Timeout is applied after the session is started. Defaults to 60 minutes.",
+ "examples": [
+ 60,
+ 120
+ ]
},
- "task_id": {
+ "browser_address": {
"anyOf": [
{
"type": "string"
@@ -8556,9 +11296,14 @@
"type": "null"
}
],
- "title": "Task Id"
+ "title": "Browser Address",
+ "description": "Url for connecting to the browser",
+ "examples": [
+ "http://localhost:9222",
+ "https://3.12.10.11/browser/123456"
+ ]
},
- "step_id": {
+ "app_url": {
"anyOf": [
{
"type": "string"
@@ -8567,31 +11312,39 @@
"type": "null"
}
],
- "title": "Step Id"
+ "title": "App Url",
+ "description": "Url for the browser session page",
+ "examples": [
+ "https://app.skyvern.com/browser-session/pbs_123456"
+ ]
},
- "workflow_run_id": {
+ "extensions": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "$ref": "#/components/schemas/Extensions"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Workflow Run Id"
+ "title": "Extensions",
+ "description": "A list of extensions installed in the browser session."
},
- "workflow_run_block_id": {
+ "browser_type": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/PersistentBrowserType"
},
{
"type": "null"
}
],
- "title": "Workflow Run Block Id"
+ "description": "The type of browser used for the session."
},
- "run_id": {
+ "browser_profile_id": {
"anyOf": [
{
"type": "string"
@@ -8600,31 +11353,44 @@
"type": "null"
}
],
- "title": "Run Id"
+ "title": "Browser Profile Id",
+ "description": "ID of the browser profile loaded into this session, if any. browser_profile_id starts with `bp_`."
},
- "browser_session_id": {
+ "generate_browser_profile": {
+ "type": "boolean",
+ "title": "Generate Browser Profile",
+ "description": "Whether this session's browser profile will be saved when it ends so it can become a reusable browser profile.",
+ "default": false
+ },
+ "browser_settings": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/BrowserSettings"
},
{
"type": "null"
}
],
- "title": "Browser Session Id"
+ "description": "Browser settings requested when the session was created."
},
- "observer_cruise_id": {
+ "browser_settings_receipt": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/BrowserSettingsReceipt"
},
{
"type": "null"
}
],
- "title": "Observer Cruise Id"
+ "description": "What the browser reported after launch for the requested settings. Null until it is measured, and always null when no settings were requested."
},
- "observer_thought_id": {
+ "vnc_streaming_supported": {
+ "type": "boolean",
+ "title": "Vnc Streaming Supported",
+ "description": "Whether the browser session supports VNC streaming",
+ "default": false
+ },
+ "stream_transport": {
"anyOf": [
{
"type": "string"
@@ -8633,9 +11399,14 @@
"type": "null"
}
],
- "title": "Observer Thought Id"
+ "title": "Stream Transport",
+ "description": "Live-view transport for this session: \"vnc\" or \"cdp\". Resolved on the single-session fetch only; null elsewhere.",
+ "examples": [
+ "vnc",
+ "cdp"
+ ]
},
- "ai_suggestion_id": {
+ "download_path": {
"anyOf": [
{
"type": "string"
@@ -8644,132 +11415,40 @@
"type": "null"
}
],
- "title": "Ai Suggestion Id"
+ "title": "Download Path",
+ "description": "The path where the browser session downloads files"
},
- "signed_url": {
+ "downloaded_files": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "$ref": "#/components/schemas/FileInfo"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Signed Url"
- },
- "archived": {
- "type": "boolean",
- "title": "Archived",
- "default": false
- },
- "organization_id": {
- "type": "string",
- "title": "Organization Id"
- }
- },
- "type": "object",
- "required": [
- "created_at",
- "modified_at",
- "artifact_id",
- "artifact_type",
- "uri",
- "organization_id"
- ],
- "title": "Artifact"
- },
- "ArtifactType": {
- "type": "string",
- "enum": [
- "recording",
- "audio",
- "session_replay",
- "eval_score",
- "eval_trajectory",
- "eval_rubrics",
- "browser_console_log",
- "browser_session_action_log",
- "skyvern_log",
- "skyvern_log_raw",
- "screenshot",
- "screenshot_llm",
- "screenshot_action",
- "screenshot_final",
- "screenshot_proxy",
- "screenshot_pre_submit",
- "llm_prompt",
- "llm_request",
- "llm_response",
- "llm_response_parsed",
- "llm_response_rendered",
- "visible_elements_id_css_map",
- "visible_elements_id_frame_map",
- "visible_elements_tree",
- "visible_elements_tree_trimmed",
- "visible_elements_tree_in_prompt",
- "hashed_href_map",
- "visible_elements_id_xpath_map",
- "html",
- "html_scrape",
- "html_action",
- "html_pre_submit",
- "trace",
- "har",
- "script_file",
- "pdf",
- "step_archive",
- "task_archive",
- "download",
- "unknown"
- ],
- "title": "ArtifactType"
- },
- "AzureSecretParameter": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "azure_secret",
- "title": "Parameter Type",
- "default": "azure_secret"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "title": "Downloaded Files",
+ "description": "The list of files downloaded by the browser session"
},
- "description": {
+ "recordings": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "$ref": "#/components/schemas/FileInfo"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Description"
- },
- "azure_secret_parameter_id": {
- "type": "string",
- "title": "Azure Secret Parameter Id"
- },
- "workflow_id": {
- "type": "string",
- "title": "Workflow Id"
- },
- "azure_key": {
- "type": "string",
- "title": "Azure Key"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
- },
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "title": "Recordings",
+ "description": "The list of video recordings from the browser session"
},
- "deleted_at": {
+ "started_at": {
"anyOf": [
{
"type": "string",
@@ -8779,64 +11458,23 @@
"type": "null"
}
],
- "title": "Deleted At"
- }
- },
- "type": "object",
- "required": [
- "key",
- "azure_secret_parameter_id",
- "workflow_id",
- "azure_key",
- "created_at",
- "modified_at"
- ],
- "title": "AzureSecretParameter"
- },
- "AzureVaultCredentialParameter": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "azure_vault_credential",
- "title": "Parameter Type",
- "default": "azure_vault_credential"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "title": "Started At",
+ "description": "Timestamp when the session was started"
},
- "description": {
+ "completed_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Description"
- },
- "azure_vault_credential_parameter_id": {
- "type": "string",
- "title": "Azure Vault Credential Parameter Id"
- },
- "workflow_id": {
- "type": "string",
- "title": "Workflow Id"
- },
- "vault_name": {
- "type": "string",
- "title": "Vault Name"
- },
- "username_key": {
- "type": "string",
- "title": "Username Key"
- },
- "password_key": {
- "type": "string",
- "title": "Password Key"
+ "title": "Completed At",
+ "description": "Timestamp when the session was completed"
},
- "totp_secret_key": {
+ "created_by": {
"anyOf": [
{
"type": "string"
@@ -8845,17 +11483,20 @@
"type": "null"
}
],
- "title": "Totp Secret Key"
+ "title": "Created By",
+ "description": "ID of the user who created the session"
},
"created_at": {
"type": "string",
"format": "date-time",
- "title": "Created At"
+ "title": "Created At",
+ "description": "Timestamp when the session was created (the timestamp for the initial request)"
},
"modified_at": {
"type": "string",
"format": "date-time",
- "title": "Modified At"
+ "title": "Modified At",
+ "description": "Timestamp when the session was last modified"
},
"deleted_at": {
"anyOf": [
@@ -8867,35 +11508,61 @@
"type": "null"
}
],
- "title": "Deleted At"
+ "title": "Deleted At",
+ "description": "Timestamp when the session was deleted, if applicable"
+ },
+ "warning": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Warning",
+ "description": "Advisory message about how the request was adjusted, if it was. Set when a requested timeout above the maximum was capped at creation, when an extension was granted less than it asked for, or when an extension was accepted but not yet confirmed; null otherwise."
}
},
"type": "object",
"required": [
- "key",
- "azure_vault_credential_parameter_id",
- "workflow_id",
- "vault_name",
- "username_key",
- "password_key",
+ "browser_session_id",
+ "organization_id",
"created_at",
"modified_at"
],
- "title": "AzureVaultCredentialParameter"
+ "title": "BrowserSessionResponse",
+ "description": "Response model for browser session information."
},
- "AzureVaultCredentialParameterYAML": {
+ "BrowserSettings": {
"properties": {
- "parameter_type": {
- "type": "string",
- "const": "azure_vault_credential",
- "title": "Parameter Type",
- "default": "azure_vault_credential"
- },
- "key": {
+ "timezone_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Timezone Id",
+ "description": "IANA timezone the browser reports to pages, for example `America/New_York`. Applied when a browser is created and takes precedence over any timezone implied by the proxy location. Offsets such as `+03:00` are rejected. Omit or set to null to keep the default behavior.",
+ "examples": [
+ "America/New_York"
+ ]
+ }
+ },
+ "type": "object",
+ "title": "BrowserSettings"
+ },
+ "BrowserSettingsReceipt": {
+ "properties": {
+ "requested_timezone_id": {
"type": "string",
- "title": "Key"
+ "title": "Requested Timezone Id",
+ "description": "The timezone that was requested."
},
- "description": {
+ "actual_timezone_id": {
"anyOf": [
{
"type": "string"
@@ -8904,21 +11571,18 @@
"type": "null"
}
],
- "title": "Description"
- },
- "vault_name": {
- "type": "string",
- "title": "Vault Name"
+ "title": "Actual Timezone Id",
+ "description": "The timezone the browser reported when measured, or null when it could not be measured."
},
- "username_key": {
- "type": "string",
- "title": "Username Key"
+ "source": {
+ "$ref": "#/components/schemas/BrowserSettingsSource",
+ "description": "Where the requested setting came from."
},
- "password_key": {
- "type": "string",
- "title": "Password Key"
+ "status": {
+ "$ref": "#/components/schemas/BrowserSettingsStatus",
+ "description": "`verified` when the browser reported the requested timezone or an IANA alias of it (Chromium reports `Asia/Calcutta` for `Asia/Kolkata`), `mismatch` when it reported another zone, `unapplied` when the browser already existed and was left unchanged, `unknown` when it could not be measured."
},
- "totp_secret_key": {
+ "warning": {
"anyOf": [
{
"type": "string"
@@ -8927,31 +11591,122 @@
"type": "null"
}
],
- "title": "Totp Secret Key"
+ "title": "Warning"
}
},
"type": "object",
"required": [
- "key",
- "vault_name",
- "username_key",
- "password_key"
+ "requested_timezone_id",
+ "source",
+ "status"
],
- "title": "AzureVaultCredentialParameterYAML"
+ "title": "BrowserSettingsReceipt"
},
- "BitwardenCreditCardDataParameter": {
+ "BrowserSettingsSource": {
+ "type": "string",
+ "enum": [
+ "workflow_version",
+ "session_request",
+ "existing_session"
+ ],
+ "title": "BrowserSettingsSource"
+ },
+ "BrowserSettingsStatus": {
+ "type": "string",
+ "enum": [
+ "verified",
+ "mismatch",
+ "unapplied",
+ "unknown"
+ ],
+ "title": "BrowserSettingsStatus"
+ },
+ "BrowserTypeOption": {
"properties": {
- "parameter_type": {
+ "value": {
"type": "string",
- "const": "bitwarden_credit_card_data",
- "title": "Parameter Type",
- "default": "bitwarden_credit_card_data"
+ "title": "Value"
},
- "key": {
+ "label": {
"type": "string",
- "title": "Key"
+ "title": "Label"
+ }
+ },
+ "type": "object",
+ "required": [
+ "value",
+ "label"
+ ],
+ "title": "BrowserTypeOption"
+ },
+ "BulkCancelRunsRequest": {
+ "properties": {
+ "run_ids": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "maxItems": 100,
+ "title": "Run Ids",
+ "description": "List of run IDs to cancel"
+ }
+ },
+ "type": "object",
+ "required": [
+ "run_ids"
+ ],
+ "title": "BulkCancelRunsRequest"
+ },
+ "BulkCancelRunsResponse": {
+ "properties": {
+ "cancelled": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Cancelled",
+ "description": "Run IDs that were successfully cancelled"
},
- "description": {
+ "failed": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Failed",
+ "description": "Run IDs that could not be cancelled"
+ }
+ },
+ "type": "object",
+ "required": [
+ "cancelled",
+ "failed"
+ ],
+ "title": "BulkCancelRunsResponse"
+ },
+ "ClearOrganizationAuthTokenResponse": {
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "Success",
+ "description": "Whether the token was cleared successfully"
+ }
+ },
+ "type": "object",
+ "required": [
+ "success"
+ ],
+ "title": "ClearOrganizationAuthTokenResponse",
+ "description": "Response model for clearing an organization auth token."
+ },
+ "ClickAction": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "const": "ai_click",
+ "title": "Type",
+ "default": "ai_click"
+ },
+ "selector": {
"anyOf": [
{
"type": "string"
@@ -8960,142 +11715,90 @@
"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"
+ "title": "Selector",
+ "description": "CSS selector for the element",
+ "default": ""
},
- "bitwarden_item_id": {
+ "intention": {
"type": "string",
- "title": "Bitwarden Item Id"
+ "title": "Intention",
+ "description": "The intention or goal of the click",
+ "default": ""
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
+ "data": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data",
+ "description": "Additional context data"
},
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "timeout": {
+ "type": "number",
+ "title": "Timeout",
+ "description": "Timeout in milliseconds",
+ "default": 10000
+ }
+ },
+ "type": "object",
+ "title": "ClickAction",
+ "description": "Click action parameters."
+ },
+ "ClickContext": {
+ "properties": {
+ "thought": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Thought"
},
- "deleted_at": {
+ "single_option_click": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "boolean"
},
{
"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"
- },
- "BitwardenCreditCardDataParameterYAML": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "bitwarden_credit_card_data",
- "title": "Parameter Type",
- "default": "bitwarden_credit_card_data"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "title": "Single Option Click"
},
- "description": {
+ "desired_state": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Description"
- },
- "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"
+ "title": "Desired State"
}
},
"type": "object",
- "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"
+ "title": "ClickContext"
},
- "BitwardenLoginCredentialParameter": {
+ "CodeBlock": {
"properties": {
- "parameter_type": {
- "type": "string",
- "const": "bitwarden_login_credential",
- "title": "Parameter Type",
- "default": "bitwarden_login_credential"
- },
- "key": {
+ "label": {
"type": "string",
- "title": "Key"
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
},
- "description": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -9104,51 +11807,127 @@
"type": "null"
}
],
- "title": "Description"
- },
- "bitwarden_login_credential_parameter_id": {
- "type": "string",
- "title": "Bitwarden Login Credential Parameter Id"
- },
- "workflow_id": {
- "type": "string",
- "title": "Workflow Id"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "bitwarden_client_id_aws_secret_key": {
+ "block_type": {
"type": "string",
- "title": "Bitwarden Client Id Aws Secret Key"
+ "const": "code",
+ "title": "Block Type",
+ "default": "code"
},
- "bitwarden_client_secret_aws_secret_key": {
- "type": "string",
- "title": "Bitwarden Client Secret Aws Secret Key"
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
},
- "bitwarden_master_password_aws_secret_key": {
- "type": "string",
- "title": "Bitwarden Master Password Aws Secret Key"
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
},
- "url_parameter_key": {
+ "model": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Url Parameter Key"
+ "title": "Model"
},
- "bitwarden_collection_id": {
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop 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/AzureSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "parameter_type",
+ "mapping": {
+ "aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
+ "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
+ "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
+ "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
+ "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
+ "context": "#/components/schemas/ContextParameter",
+ "credential": "#/components/schemas/CredentialParameter",
+ "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
+ "output": "#/components/schemas/OutputParameter",
+ "workflow": "#/components/schemas/WorkflowParameter"
+ }
+ }
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
+ },
+ "error_code_mapping": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Bitwarden Collection Id"
+ "title": "Error Code Mapping"
},
- "bitwarden_item_id": {
+ "prompt": {
"anyOf": [
{
"type": "string"
@@ -9157,58 +11936,32 @@
"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"
+ "title": "Prompt"
},
- "deleted_at": {
+ "steps": {
"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"
- },
- "BitwardenLoginCredentialParameterYAML": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "bitwarden_login_credential",
- "title": "Parameter Type",
- "default": "bitwarden_login_credential"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "items": {
+ "$ref": "#/components/schemas/CodeBlockStep"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Steps"
},
- "description": {
+ "data_schema": {
"anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
{
"type": "string"
},
@@ -9216,75 +11969,52 @@
"type": "null"
}
],
- "title": "Description"
- },
- "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"
+ "title": "Data Schema"
},
- "url_parameter_key": {
+ "user_owned_goal": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Url Parameter Key"
+ "title": "User Owned Goal"
},
- "bitwarden_collection_id": {
+ "goal_needs_regeneration": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Bitwarden Collection Id"
+ "title": "Goal Needs Regeneration"
},
- "bitwarden_item_id": {
+ "code_edited_by_hand": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Bitwarden Item Id"
+ "title": "Code Edited By Hand"
}
},
"type": "object",
"required": [
- "key",
- "bitwarden_client_id_aws_secret_key",
- "bitwarden_client_secret_aws_secret_key",
- "bitwarden_master_password_aws_secret_key"
+ "label",
+ "output_parameter",
+ "code"
],
- "title": "BitwardenLoginCredentialParameterYAML"
+ "title": "CodeBlock"
},
- "BitwardenSensitiveInformationParameter": {
+ "CodeBlockStep": {
"properties": {
- "parameter_type": {
- "type": "string",
- "const": "bitwarden_sensitive_information",
- "title": "Parameter Type",
- "default": "bitwarden_sensitive_information"
- },
- "key": {
- "type": "string",
- "title": "Key"
- },
"description": {
"anyOf": [
{
@@ -9296,92 +12026,38 @@
],
"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"
+ "action_type": {
+ "$ref": "#/components/schemas/ActionType",
+ "default": "null_action"
},
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "line_start": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Line Start"
},
- "deleted_at": {
+ "line_end": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Deleted At"
+ "title": "Line End"
}
},
"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"
+ "title": "CodeBlockStep"
},
- "BitwardenSensitiveInformationParameterYAML": {
+ "CodeBlockStepYAML": {
"properties": {
- "parameter_type": {
- "type": "string",
- "const": "bitwarden_sensitive_information",
- "title": "Parameter Type",
- "default": "bitwarden_sensitive_information"
- },
- "key": {
- "type": "string",
- "title": "Key"
- },
"description": {
"anyOf": [
{
@@ -9393,172 +12069,122 @@
],
"title": "Description"
},
- "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": {
+ "action_type": {
"type": "string",
- "title": "Bitwarden Collection Id"
+ "title": "Action Type",
+ "default": "null_action"
},
- "bitwarden_identity_key": {
- "type": "string",
- "title": "Bitwarden Identity Key"
+ "line_start": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Line Start"
},
- "bitwarden_identity_fields": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Bitwarden Identity Fields"
- }
- },
- "type": "object",
- "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"
- },
- "BlockType": {
- "type": "string",
- "enum": [
- "task",
- "task_v2",
- "for_loop",
- "while_loop",
- "conditional",
- "code",
- "text_prompt",
- "download_to_s3",
- "upload_to_s3",
- "file_upload",
- "send_email",
- "file_url_parser",
- "validation",
- "action",
- "navigation",
- "extraction",
- "login",
- "wait",
- "file_download",
- "goto_url",
- "pdf_parser",
- "http_request",
- "human_interaction",
- "print_page",
- "workflow_trigger",
- "google_sheets_read",
- "google_sheets_write",
- "pdf_fill",
- "split_pdf",
- "email_inbox"
- ],
- "title": "BlockType"
- },
- "Body_upload_file_v1_upload_file_post": {
- "properties": {
- "file": {
- "type": "string",
- "contentMediaType": "application/octet-stream",
- "title": "File"
+ "line_end": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Line End"
}
},
"type": "object",
- "required": [
- "file"
- ],
- "title": "Body_upload_file_v1_upload_file_post"
+ "title": "CodeBlockStepYAML"
},
- "BranchCondition": {
+ "CodeBlockYAML": {
"properties": {
- "id": {
+ "block_type": {
"type": "string",
- "title": "Id"
+ "const": "code",
+ "title": "Block Type",
+ "default": "code"
},
- "criteria": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
+ },
+ "next_block_label": {
"anyOf": [
{
- "oneOf": [
- {
- "$ref": "#/components/schemas/JinjaBranchCriteria"
- },
- {
- "$ref": "#/components/schemas/PromptBranchCriteria"
- }
- ],
- "discriminator": {
- "propertyName": "criteria_type",
- "mapping": {
- "jinja2_template": "#/components/schemas/JinjaBranchCriteria",
- "prompt": "#/components/schemas/PromptBranchCriteria"
- }
- }
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Criteria"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
},
- "next_block_label": {
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Next Block Label"
+ "title": "Model"
},
- "description": {
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "code": {
+ "type": "string",
+ "title": "Code"
+ },
+ "error_code_mapping": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Description"
+ "title": "Error Code Mapping"
},
- "is_default": {
- "type": "boolean",
- "title": "Is Default",
- "default": false
- }
- },
- "type": "object",
- "title": "BranchCondition",
- "description": "Represents a single conditional branch edge within a ConditionalBlock."
- },
- "BranchConditionYAML": {
- "properties": {
- "criteria": {
+ "parameter_keys": {
"anyOf": [
{
- "$ref": "#/components/schemas/BranchCriteriaYAML"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Parameter Keys"
},
- "next_block_label": {
+ "prompt": {
"anyOf": [
{
"type": "string"
@@ -9567,10 +12193,34 @@
"type": "null"
}
],
- "title": "Next Block Label"
+ "title": "Prompt",
+ "description": "Plain-language goal of this code block, shown as the block's Goal in the editor"
},
- "description": {
+ "steps": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/CodeBlockStepYAML"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Steps",
+ "description": "Plain-language step outline mapped to code line ranges; always rebuilt from the code on save, so any value sent is ignored"
+ },
+ "data_schema": {
"anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
{
"type": "string"
},
@@ -9578,65 +12228,61 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Data Schema",
+ "description": "JSON schema of the object this block's return produces; keys match the return keys; null when the block returns nothing"
},
- "is_default": {
- "type": "boolean",
- "title": "Is Default",
- "default": false
- }
- },
- "type": "object",
- "title": "BranchConditionYAML"
- },
- "BranchCriteriaYAML": {
- "properties": {
- "criteria_type": {
- "type": "string",
- "enum": [
- "jinja2_template",
- "prompt"
+ "user_owned_goal": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
],
- "title": "Criteria Type",
- "default": "jinja2_template"
+ "title": "User Owned Goal",
+ "description": "True when a person wrote this block's Goal, so copilot regenerations keep their text. Set by the editor or the workflow API; a value the copilot submits is ignored in favour of the stored one"
},
- "expression": {
- "type": "string",
- "title": "Expression"
+ "goal_needs_regeneration": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Goal Needs Regeneration",
+ "description": "True when a person edited the Goal and the code has not been rebuilt from it yet. Set by the editor or the workflow API; a value the copilot submits is ignored in favour of the stored one"
},
- "description": {
+ "code_edited_by_hand": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Description"
+ "title": "Code Edited By Hand",
+ "description": "True when a person edited this block's code in the editor's code field since the Goal was last confirmed, so the Goal may no longer describe the code. Set by the editor; a value the copilot submits is ignored in favour of the stored one"
}
},
"type": "object",
"required": [
- "expression"
+ "label",
+ "code"
],
- "title": "BranchCriteriaYAML"
+ "title": "CodeBlockYAML"
},
- "BrowserProfile": {
+ "ConditionalBlock": {
"properties": {
- "browser_profile_id": {
- "type": "string",
- "title": "Browser Profile Id"
- },
- "organization_id": {
- "type": "string",
- "title": "Organization Id"
- },
- "name": {
+ "label": {
"type": "string",
- "title": "Name"
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
},
- "description": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -9645,27 +12291,25 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "source_browser_type": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Source Browser Type"
+ "block_type": {
+ "type": "string",
+ "const": "conditional",
+ "title": "Block Type",
+ "default": "conditional"
},
- "proxy_location": {
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
- {
- "$ref": "#/components/schemas/ProxyLocation"
- },
- {
- "$ref": "#/components/schemas/GeoTarget"
- },
{
"additionalProperties": true,
"type": "object"
@@ -9674,9 +12318,53 @@
"type": "null"
}
],
- "title": "Proxy Location"
+ "title": "Model"
+ },
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "branch_conditions": {
+ "items": {
+ "$ref": "#/components/schemas/BranchCondition"
+ },
+ "type": "array",
+ "title": "Branch Conditions"
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "output_parameter"
+ ],
+ "title": "ConditionalBlock",
+ "description": "Branching block that selects the next block label based on list-ordered conditions."
+ },
+ "ConditionalBlockYAML": {
+ "properties": {
+ "block_type": {
+ "type": "string",
+ "const": "conditional",
+ "title": "Block Type",
+ "default": "conditional"
},
- "proxy_session_id": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
+ },
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -9685,84 +12373,63 @@
"type": "null"
}
],
- "title": "Proxy Session Id"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
},
- "is_managed": {
+ "continue_on_failure": {
"type": "boolean",
- "title": "Is Managed",
+ "title": "Continue On Failure",
"default": false
},
- "workflow_permanent_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Workflow Permanent Id"
- },
- "browser_profile_key_digest": {
+ "model": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Browser Profile Key Digest"
+ "title": "Model"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
},
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
},
- "deleted_at": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "Deleted At"
+ "branch_conditions": {
+ "items": {
+ "$ref": "#/components/schemas/BranchConditionYAML"
+ },
+ "type": "array",
+ "title": "Branch Conditions"
}
},
"type": "object",
"required": [
- "browser_profile_id",
- "organization_id",
- "name",
- "created_at",
- "modified_at"
+ "label"
],
- "title": "BrowserProfile"
+ "title": "ConditionalBlockYAML"
},
- "BrowserSessionResponse": {
+ "ContextParameter": {
"properties": {
- "browser_session_id": {
+ "parameter_type": {
"type": "string",
- "title": "Browser Session Id",
- "description": "Unique identifier for the browser session. browser_session_id starts with `pbs_`.",
- "examples": [
- "pbs_123456"
- ]
+ "const": "context",
+ "title": "Parameter Type",
+ "default": "context"
},
- "organization_id": {
+ "key": {
"type": "string",
- "title": "Organization Id",
- "description": "ID of the organization that owns this session"
+ "title": "Key"
},
- "status": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -9771,146 +12438,95 @@
"type": "null"
}
],
- "title": "Status",
- "description": "Current status of the browser session",
- "examples": [
- "created",
- "running",
- "completed",
- "failed",
- "timeout"
- ]
+ "title": "Description"
},
- "runnable_type": {
+ "source": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/WorkflowParameter"
},
{
- "type": "null"
- }
- ],
- "title": "Runnable Type",
- "description": "Type of the current runnable associated with this session (workflow, task etc)",
- "examples": [
- "task",
- "workflow_run"
- ]
- },
- "runnable_id": {
- "anyOf": [
+ "$ref": "#/components/schemas/ContextParameter"
+ },
{
- "type": "string"
+ "$ref": "#/components/schemas/AWSSecretParameter"
},
{
- "type": "null"
- }
- ],
- "title": "Runnable Id",
- "description": "ID of the current runnable",
- "examples": [
- "tsk_123456",
- "wr_123456"
- ]
- },
- "timeout": {
- "anyOf": [
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
- "type": "integer"
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
- "type": "null"
- }
- ],
- "title": "Timeout",
- "description": "Timeout in minutes for the session. Timeout is applied after the session is started. Defaults to 60 minutes.",
- "examples": [
- 60,
- 120
- ]
- },
- "browser_address": {
- "anyOf": [
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
{
- "type": "string"
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
},
{
- "type": "null"
- }
- ],
- "title": "Browser Address",
- "description": "Url for connecting to the browser",
- "examples": [
- "http://localhost:9222",
- "https://3.12.10.11/browser/123456"
- ]
- },
- "app_url": {
- "anyOf": [
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
{
- "type": "string"
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
}
],
- "title": "App Url",
- "description": "Url for the browser session page",
- "examples": [
- "https://app.skyvern.com/browser-session/pbs_123456"
- ]
+ "title": "Source"
},
- "extensions": {
+ "value": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/Extensions"
- },
- "type": "array"
+ "type": "string"
},
{
- "type": "null"
- }
- ],
- "title": "Extensions",
- "description": "A list of extensions installed in the browser session."
- },
- "browser_type": {
- "anyOf": [
+ "type": "integer"
+ },
{
- "$ref": "#/components/schemas/PersistentBrowserType"
+ "type": "number"
},
{
- "type": "null"
- }
- ],
- "description": "The type of browser used for the session."
- },
- "browser_profile_id": {
- "anyOf": [
+ "type": "boolean"
+ },
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Browser Profile Id",
- "description": "ID of the browser profile loaded into this session, if any. browser_profile_id starts with `bp_`."
- },
- "generate_browser_profile": {
- "type": "boolean",
- "title": "Generate Browser Profile",
- "description": "Whether this session's browser profile will be saved when it ends so it can become a reusable browser profile.",
- "default": false
- },
- "vnc_streaming_supported": {
- "type": "boolean",
- "title": "Vnc Streaming Supported",
- "description": "Whether the browser session supports VNC streaming",
- "default": false
+ "title": "Value"
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "source"
+ ],
+ "title": "ContextParameter"
+ },
+ "ContextParameterYAML": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "context",
+ "title": "Parameter Type",
+ "default": "context"
},
- "download_path": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -9919,169 +12535,107 @@
"type": "null"
}
],
- "title": "Download Path",
- "description": "The path where the browser session downloads files"
+ "title": "Description"
},
- "downloaded_files": {
+ "source_parameter_key": {
+ "type": "string",
+ "title": "Source Parameter Key"
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "source_parameter_key"
+ ],
+ "title": "ContextParameterYAML"
+ },
+ "CreateBrowserProfileRequest": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "title": "Name",
+ "description": "Name for the browser profile"
+ },
+ "description": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/FileInfo"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Downloaded Files",
- "description": "The list of files downloaded by the browser session"
+ "title": "Description",
+ "description": "Optional profile description"
},
- "recordings": {
+ "browser_session_id": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/FileInfo"
- },
- "type": "array"
+ "type": "string",
+ "minLength": 1
},
{
"type": "null"
}
],
- "title": "Recordings",
- "description": "The list of video recordings from the browser session"
+ "title": "Browser Session Id",
+ "description": "Persistent browser session to convert into a profile. Omit for a blank profile."
},
- "started_at": {
+ "workflow_run_id": {
"anyOf": [
{
"type": "string",
- "format": "date-time"
+ "minLength": 1
},
{
"type": "null"
}
],
- "title": "Started At",
- "description": "Timestamp when the session was started"
+ "title": "Workflow Run Id",
+ "description": "Workflow run whose persisted session should be captured. Omit for a blank profile."
},
- "completed_at": {
+ "proxy_location": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "$ref": "#/components/schemas/ProxyLocation"
+ },
+ {
+ "$ref": "#/components/schemas/GeoTarget"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Completed At",
- "description": "Timestamp when the session was completed"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At",
- "description": "Timestamp when the session was created (the timestamp for the initial request)"
- },
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At",
- "description": "Timestamp when the session was last modified"
+ "title": "Proxy Location",
+ "description": "Optional proxy location for this profile's pinned proxy identity."
},
- "deleted_at": {
+ "proxy_session_id": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"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."
- },
- "BulkCancelRunsRequest": {
- "properties": {
- "run_ids": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "maxItems": 100,
- "title": "Run Ids",
- "description": "List of run IDs to cancel"
- }
- },
- "type": "object",
- "required": [
- "run_ids"
- ],
- "title": "BulkCancelRunsRequest"
- },
- "BulkCancelRunsResponse": {
- "properties": {
- "cancelled": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Cancelled",
- "description": "Run IDs that were successfully cancelled"
- },
- "failed": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Failed",
- "description": "Run IDs that could not be cancelled"
- }
- },
- "type": "object",
- "required": [
- "cancelled",
- "failed"
- ],
- "title": "BulkCancelRunsResponse"
- },
- "ClearOrganizationAuthTokenResponse": {
- "properties": {
- "success": {
- "type": "boolean",
- "title": "Success",
- "description": "Whether the token was cleared successfully"
+ "title": "Proxy Session Id",
+ "description": "Explicit sticky-session id for this profile's pinned proxy identity."
}
},
"type": "object",
"required": [
- "success"
+ "name"
],
- "title": "ClearOrganizationAuthTokenResponse",
- "description": "Response model for clearing an organization auth token."
+ "title": "CreateBrowserProfileRequest"
},
- "ClickAction": {
+ "CreateBrowserSessionRequest": {
"properties": {
- "type": {
- "type": "string",
- "const": "ai_click",
- "title": "Type",
- "default": "ai_click"
- },
- "selector": {
+ "url": {
"anyOf": [
{
"type": "string"
@@ -10090,20 +12644,30 @@
"type": "null"
}
],
- "title": "Selector",
- "description": "CSS selector for the element",
- "default": ""
+ "title": "Url",
+ "description": "Optional URL to open when the standalone browser session starts."
},
- "intention": {
- "type": "string",
- "title": "Intention",
- "description": "The intention or goal of the click",
- "default": ""
+ "timeout": {
+ "anyOf": [
+ {
+ "type": "integer",
+ "minimum": 5
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Timeout",
+ "description": "Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 240. Defaults to 60.",
+ "default": 60
},
- "data": {
+ "proxy_location": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/ProxyLocation"
+ },
+ {
+ "$ref": "#/components/schemas/GeoTarget"
},
{
"additionalProperties": true,
@@ -10113,23 +12677,10 @@
"type": "null"
}
],
- "title": "Data",
- "description": "Additional context data"
+ "title": "Proxy Location",
+ "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_KR: South Korea\n- RESIDENTIAL_SA: Saudi Arabia\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_BR: Brazil\n- RESIDENTIAL_TR: Turkey\n- RESIDENTIAL_CA: Canada\n- RESIDENTIAL_MX: Mexico\n- RESIDENTIAL_IT: Italy\n- RESIDENTIAL_NL: Netherlands\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n\nFor self-hosted deployments, you can pass a custom proxy URL as a dict: {\"url\": \"http://user:[email protected]:8080\"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool.\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}, or a custom proxy URL dict for self-hosted deployments: {\"url\": \"http://user:[email protected]:8080\"}"
},
- "timeout": {
- "type": "number",
- "title": "Timeout",
- "description": "Timeout in milliseconds",
- "default": 10000
- }
- },
- "type": "object",
- "title": "ClickAction",
- "description": "Click action parameters."
- },
- "ClickContext": {
- "properties": {
- "thought": {
+ "proxy_session_id": {
"anyOf": [
{
"type": "string"
@@ -10138,213 +12689,147 @@
"type": "null"
}
],
- "title": "Thought"
+ "title": "Proxy Session Id",
+ "description": "Opaque Skyvern-managed proxy sticky-session id for pinned Residential ISP sessions."
},
- "single_option_click": {
+ "extensions": {
"anyOf": [
{
- "type": "boolean"
+ "items": {
+ "$ref": "#/components/schemas/Extensions"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Single Option Click"
+ "title": "Extensions",
+ "description": "A list of extensions to install in the browser session."
},
- "desired_state": {
+ "browser_type": {
"anyOf": [
{
- "type": "boolean"
+ "$ref": "#/components/schemas/PersistentBrowserType"
},
{
"type": "null"
}
],
- "title": "Desired State"
- }
- },
- "type": "object",
- "title": "ClickContext"
- },
- "CodeBlock": {
- "properties": {
- "label": {
- "type": "string",
- "title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "description": "The type of browser to use for the session."
},
- "next_block_label": {
+ "browser_profile_id": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "pattern": "^bp_"
},
{
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
- },
- "block_type": {
- "type": "string",
- "const": "code",
- "title": "Block Type",
- "default": "code"
- },
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
+ "title": "Browser Profile Id",
+ "description": "ID of a browser profile to load into this session (restores cookies, localStorage, etc.). browser_profile_id starts with `bp_`."
},
- "continue_on_failure": {
+ "generate_browser_profile": {
"type": "boolean",
- "title": "Continue On Failure",
+ "title": "Generate Browser Profile",
+ "description": "When true, the session's browser profile (cookies, localStorage, etc.) is saved to storage when the session ends so it can be turned into a reusable browser profile. Defaults to false to avoid storing profiles for sessions that never need them. Sessions started with a browser_profile_id always persist their profile regardless of this flag.",
"default": false
},
- "model": {
+ "browser_settings": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "$ref": "#/components/schemas/BrowserSettings"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "description": "Settings applied when the session's browser is created. A timezone_id here takes precedence over the timezone implied by proxy_location."
},
- "next_loop_on_failure": {
+ "needs_live_view": {
"type": "boolean",
- "title": "Next Loop On Failure",
+ "title": "Needs Live View",
+ "description": "Whether a person will watch this session's browser live. Defaults to false, which suits unattended automation; the Skyvern app sets it because a session opened in the UI is watched. It requests a capability, not a particular browser, and cannot be used to select where the session runs.",
"default": false
- },
- "code": {
+ }
+ },
+ "type": "object",
+ "title": "CreateBrowserSessionRequest"
+ },
+ "CreateCredentialRequest": {
+ "properties": {
+ "name": {
"type": "string",
- "title": "Code"
+ "title": "Name",
+ "description": "Name of the credential",
+ "examples": [
+ "Amazon Login"
+ ]
},
- "parameters": {
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/WorkflowParameter"
- },
- {
- "$ref": "#/components/schemas/ContextParameter"
- },
- {
- "$ref": "#/components/schemas/AWSSecretParameter"
- },
- {
- "$ref": "#/components/schemas/AzureSecretParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
- },
- {
- "$ref": "#/components/schemas/OnePasswordCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/AzureVaultCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/OutputParameter"
- },
- {
- "$ref": "#/components/schemas/CredentialParameter"
- }
- ],
- "discriminator": {
- "propertyName": "parameter_type",
- "mapping": {
- "aws_secret": "#/components/schemas/AWSSecretParameter",
- "azure_secret": "#/components/schemas/AzureSecretParameter",
- "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
- "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
- "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
- "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
- "context": "#/components/schemas/ContextParameter",
- "credential": "#/components/schemas/CredentialParameter",
- "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
- "output": "#/components/schemas/OutputParameter",
- "workflow": "#/components/schemas/WorkflowParameter"
- }
- }
- },
- "type": "array",
- "title": "Parameters",
- "default": []
+ "credential_type": {
+ "$ref": "#/components/schemas/skyvern__forge__sdk__schemas__credentials__CredentialType",
+ "description": "Type of credential to create"
},
- "prompt": {
+ "credential": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/NonEmptyPasswordCredential"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/NonEmptyCreditCardCredential"
+ },
+ {
+ "$ref": "#/components/schemas/SecretCredential"
}
],
- "title": "Prompt"
+ "title": "Credential",
+ "description": "The credential data to store",
+ "examples": [
+ {
+ "password": "securepassword123",
+ "username": "[email protected]"
+ }
+ ]
},
- "steps": {
+ "vault_type": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/CodeBlockStep"
- },
- "type": "array"
+ "$ref": "#/components/schemas/CredentialVaultType"
},
{
"type": "null"
}
],
- "title": "Steps"
+ "description": "Which vault to store this credential in. If omitted, uses the instance default. Use this to mix Skyvern-hosted and custom credentials within the same organization.",
+ "examples": [
+ "skyvern",
+ "custom",
+ "azure_vault",
+ "bitwarden"
+ ]
},
- "data_schema": {
+ "proxy_location": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "$ref": "#/components/schemas/ProxyLocation"
},
{
- "items": {},
- "type": "array"
+ "$ref": "#/components/schemas/GeoTarget"
},
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Data Schema",
- "description": "JSON schema of the object this block's return produces; keys match the return keys; null when the block returns nothing"
- }
- },
- "type": "object",
- "required": [
- "label",
- "output_parameter",
- "code"
- ],
- "title": "CodeBlock"
- },
- "CodeBlockStep": {
- "properties": {
- "title": {
+ "title": "Proxy Location",
+ "description": "Optional proxy location for this credential's pinned proxy identity."
+ },
+ "proxy_session_id": {
"anyOf": [
{
"type": "string"
@@ -10353,9 +12838,16 @@
"type": "null"
}
],
- "title": "Title"
+ "title": "Proxy Session Id",
+ "description": "Optional advanced reuse key for this credential's pinned proxy identity."
},
- "description": {
+ "rotate_proxy_session_id": {
+ "type": "boolean",
+ "title": "Rotate Proxy Session Id",
+ "description": "Rotate the Skyvern-managed proxy sticky-session id when updating this credential.",
+ "default": false
+ },
+ "browser_profile_id": {
"anyOf": [
{
"type": "string"
@@ -10364,41 +12856,46 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Browser Profile Id",
+ "description": "Optional plain browser profile to link as this credential's saved profile. Must be an unmanaged profile in your organization that no other credential already owns."
},
- "action_type": {
- "$ref": "#/components/schemas/ActionType",
- "default": "null_action"
+ "auto_profile_disabled": {
+ "type": "boolean",
+ "title": "Auto Profile Disabled",
+ "description": "Disable automatic saving and reuse of this credential's browser profile.",
+ "default": false
},
- "line_start": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Line Start"
+ "pin_saved_session_ip": {
+ "type": "boolean",
+ "title": "Pin Saved Session Ip",
+ "description": "Keep the same IP across sign-ins that reuse this credential's saved profile.",
+ "default": false
},
- "line_end": {
+ "tested_url": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Line End"
+ "title": "Tested Url",
+ "description": "Login page URL used during the credential test"
}
},
"type": "object",
- "title": "CodeBlockStep"
+ "required": [
+ "name",
+ "credential_type",
+ "credential"
+ ],
+ "title": "CreateCredentialRequest",
+ "description": "Request model for creating a new credential."
},
- "CodeBlockStepYAML": {
+ "CreateScriptRequest": {
"properties": {
- "title": {
+ "workflow_id": {
"anyOf": [
{
"type": "string"
@@ -10407,9 +12904,10 @@
"type": "null"
}
],
- "title": "Title"
+ "title": "Workflow Id",
+ "description": "Associated workflow ID"
},
- "description": {
+ "run_id": {
"anyOf": [
{
"type": "string"
@@ -10418,53 +12916,61 @@
"type": "null"
}
],
- "title": "Description"
- },
- "action_type": {
- "type": "string",
- "title": "Action Type",
- "default": "null_action"
- },
- "line_start": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Line Start"
+ "title": "Run Id",
+ "description": "Associated run ID"
},
- "line_end": {
+ "files": {
"anyOf": [
{
- "type": "integer"
+ "items": {
+ "$ref": "#/components/schemas/ScriptFileCreate"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Line End"
+ "title": "Files",
+ "description": "Array of files to include in the script",
+ "examples": [
+ {
+ "content": "cHJpbnQoIkhlbGxvLCBXb3JsZCEiKQ==",
+ "encoding": "base64",
+ "mime_type": "text/x-python",
+ "path": "main.py"
+ },
+ {
+ "content": "cmVxdWVzdHM9PTIuMjguMQ==",
+ "encoding": "base64",
+ "mime_type": "text/plain",
+ "path": "requirements.txt"
+ }
+ ]
}
},
"type": "object",
- "title": "CodeBlockStepYAML"
+ "title": "CreateScriptRequest"
},
- "CodeBlockYAML": {
+ "CreateScriptResponse": {
"properties": {
- "block_type": {
+ "script_id": {
"type": "string",
- "const": "code",
- "title": "Block Type",
- "default": "code"
+ "title": "Script Id",
+ "description": "Unique script identifier",
+ "examples": [
+ "s_abc123"
+ ]
},
- "label": {
- "type": "string",
- "title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
+ "version": {
+ "type": "integer",
+ "title": "Version",
+ "description": "Script version number",
+ "examples": [
+ 1
+ ]
},
- "next_block_label": {
+ "run_id": {
"anyOf": [
{
"type": "string"
@@ -10473,41 +12979,75 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
+ "title": "Run Id",
+ "description": "ID of the workflow run or task run that generated this script"
},
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "file_count": {
+ "type": "integer",
+ "title": "File Count",
+ "description": "Total number of files in the script"
},
- "model": {
+ "file_tree": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/FileNode"
+ },
+ "type": "object",
+ "title": "File Tree",
+ "description": "Hierarchical file tree structure"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At",
+ "description": "Timestamp when the script was created"
+ }
+ },
+ "type": "object",
+ "required": [
+ "script_id",
+ "version",
+ "file_count",
+ "file_tree",
+ "created_at"
+ ],
+ "title": "CreateScriptResponse"
+ },
+ "CredentialParameter": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "credential",
+ "title": "Parameter Type",
+ "default": "credential"
+ },
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
+ "title": "Description"
},
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "credential_parameter_id": {
+ "type": "string",
+ "title": "Credential Parameter Id"
},
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
+ "workflow_id": {
+ "type": "string",
+ "title": "Workflow Id"
},
- "code": {
+ "credential_id": {
"type": "string",
- "title": "Code"
+ "title": "Credential Id"
},
- "parameter_keys": {
+ "credential_ids": {
"anyOf": [
{
"items": {
@@ -10519,9 +13059,9 @@
"type": "null"
}
],
- "title": "Parameter Keys"
+ "title": "Credential Ids"
},
- "prompt": {
+ "selection_strategy": {
"anyOf": [
{
"type": "string"
@@ -10530,13 +13070,13 @@
"type": "null"
}
],
- "title": "Prompt"
+ "title": "Selection Strategy"
},
- "steps": {
+ "fallback_credential_ids": {
"anyOf": [
{
"items": {
- "$ref": "#/components/schemas/CodeBlockStepYAML"
+ "type": "string"
},
"type": "array"
},
@@ -10544,44 +13084,66 @@
"type": "null"
}
],
- "title": "Steps"
+ "title": "Fallback Credential Ids"
},
- "data_schema": {
+ "fallback_trigger": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
- "items": {},
- "type": "array"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Fallback Trigger"
+ },
+ "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"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Data Schema",
- "description": "JSON schema of the object this block's return produces; keys match the return keys; null when the block returns nothing"
+ "title": "Deleted At"
}
},
"type": "object",
"required": [
- "label",
- "code"
+ "key",
+ "credential_parameter_id",
+ "workflow_id",
+ "credential_id",
+ "created_at",
+ "modified_at"
],
- "title": "CodeBlockYAML"
+ "title": "CredentialParameter"
},
- "ConditionalBlock": {
+ "CredentialParameterYAML": {
"properties": {
- "label": {
+ "parameter_type": {
"type": "string",
- "title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "const": "credential",
+ "title": "Parameter Type",
+ "default": "credential"
},
- "next_block_label": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -10590,80 +13152,27 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ "title": "Description"
},
- "block_type": {
+ "credential_id": {
"type": "string",
- "const": "conditional",
- "title": "Block Type",
- "default": "conditional"
- },
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "title": "Credential Id"
},
- "model": {
+ "credential_ids": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
- ],
- "title": "Model"
- },
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
- },
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
- },
- "branch_conditions": {
- "items": {
- "$ref": "#/components/schemas/BranchCondition"
- },
- "type": "array",
- "title": "Branch Conditions"
- }
- },
- "type": "object",
- "required": [
- "label",
- "output_parameter"
- ],
- "title": "ConditionalBlock",
- "description": "Branching block that selects the next block label based on list-ordered conditions."
- },
- "ConditionalBlockYAML": {
- "properties": {
- "block_type": {
- "type": "string",
- "const": "conditional",
- "title": "Block Type",
- "default": "conditional"
- },
- "label": {
- "type": "string",
- "title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
+ ],
+ "title": "Credential Ids"
},
- "next_block_label": {
+ "selection_strategy": {
"anyOf": [
{
"type": "string"
@@ -10672,160 +13181,268 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "title": "Selection Strategy"
},
- "model": {
+ "fallback_credential_ids": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
- },
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
+ "title": "Fallback Credential Ids"
},
- "branch_conditions": {
- "items": {
- "$ref": "#/components/schemas/BranchConditionYAML"
- },
- "type": "array",
- "title": "Branch Conditions"
+ "fallback_trigger": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Fallback Trigger"
}
},
"type": "object",
"required": [
- "label"
+ "key",
+ "credential_id"
],
- "title": "ConditionalBlockYAML"
+ "title": "CredentialParameterYAML"
},
- "ContextParameter": {
+ "CredentialResponse": {
"properties": {
- "parameter_type": {
+ "credential_id": {
"type": "string",
- "const": "context",
- "title": "Parameter Type",
- "default": "context"
+ "title": "Credential Id",
+ "description": "Unique identifier for the credential",
+ "examples": [
+ "cred_1234567890"
+ ]
},
- "key": {
+ "credential": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/PasswordCredentialResponse"
+ },
+ {
+ "$ref": "#/components/schemas/CreditCardCredentialResponse"
+ },
+ {
+ "$ref": "#/components/schemas/SecretCredentialResponse"
+ }
+ ],
+ "title": "Credential",
+ "description": "The credential data"
+ },
+ "credential_type": {
+ "$ref": "#/components/schemas/CredentialType-Output",
+ "description": "Type of the credential"
+ },
+ "name": {
"type": "string",
- "title": "Key"
+ "title": "Name",
+ "description": "Name of the credential",
+ "examples": [
+ "Amazon Login"
+ ]
},
- "description": {
+ "vault_type": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/CredentialVaultType"
},
{
"type": "null"
}
],
- "title": "Description"
+ "description": "Which vault stores this credential (e.g., 'skyvern', 'bitwarden', 'azure_vault', 'custom')"
},
- "source": {
+ "browser_profile_id": {
"anyOf": [
{
- "$ref": "#/components/schemas/WorkflowParameter"
- },
- {
- "$ref": "#/components/schemas/ContextParameter"
+ "type": "string"
},
{
- "$ref": "#/components/schemas/AWSSecretParameter"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Browser Profile Id",
+ "description": "Browser profile ID linked to this credential"
+ },
+ "auto_profile_disabled": {
+ "anyOf": [
{
- "$ref": "#/components/schemas/AzureSecretParameter"
+ "type": "boolean"
},
{
- "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Auto Profile Disabled",
+ "description": "Whether automatic saving and reuse of this credential's browser profile is disabled."
+ },
+ "pin_saved_session_ip": {
+ "type": "boolean",
+ "title": "Pin Saved Session Ip",
+ "description": "Whether sign-ins reusing this credential's saved profile keep the same IP",
+ "default": false
+ },
+ "tested_url": {
+ "anyOf": [
{
- "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ "type": "string"
},
{
- "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Tested Url",
+ "description": "Login page URL used during the credential test"
+ },
+ "user_context": {
+ "anyOf": [
{
- "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ "type": "string"
},
{
- "$ref": "#/components/schemas/AzureVaultCredentialParameter"
- },
+ "type": "null"
+ }
+ ],
+ "title": "User Context",
+ "description": "User-provided context describing the login sequence (e.g., 'click SSO button first')"
+ },
+ "save_browser_session_intent": {
+ "anyOf": [
{
- "$ref": "#/components/schemas/OutputParameter"
+ "type": "boolean"
},
{
- "$ref": "#/components/schemas/CredentialParameter"
+ "type": "null"
}
],
- "title": "Source"
+ "title": "Save Browser Session Intent",
+ "description": "Whether the user intends to save a browser session, regardless of test outcome"
},
- "value": {
+ "run_sequentially": {
+ "type": "boolean",
+ "title": "Run Sequentially",
+ "default": false
+ },
+ "folder_id": {
"anyOf": [
{
"type": "string"
},
{
- "type": "integer"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Folder Id",
+ "description": "ID of the credential folder this credential belongs to, if any",
+ "examples": [
+ "cfld_1234567890"
+ ]
+ },
+ "proxy_location": {
+ "anyOf": [
{
- "type": "number"
+ "$ref": "#/components/schemas/ProxyLocation"
},
{
- "type": "boolean"
+ "$ref": "#/components/schemas/GeoTarget"
},
{
"additionalProperties": true,
"type": "object"
},
{
- "items": {},
- "type": "array"
+ "type": "null"
+ }
+ ],
+ "title": "Proxy Location",
+ "description": "Optional proxy location used for the credential's pinned proxy identity."
+ },
+ "proxy_session_id": {
+ "anyOf": [
+ {
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Value"
+ "title": "Proxy Session Id",
+ "description": "Opaque Skyvern-managed proxy sticky-session id."
+ },
+ "created_by": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created By",
+ "description": "ID of the user who created the credential"
}
},
"type": "object",
"required": [
- "key",
- "source"
+ "credential_id",
+ "credential",
+ "credential_type",
+ "name"
],
- "title": "ContextParameter"
+ "title": "CredentialResponse",
+ "description": "Response model for credential operations."
},
- "ContextParameterYAML": {
+ "CredentialType-Output": {
+ "type": "string",
+ "enum": [
+ "password",
+ "credit_card",
+ "secret"
+ ],
+ "title": "CredentialType",
+ "description": "Type of credential stored in the system."
+ },
+ "CredentialVaultType": {
+ "type": "string",
+ "enum": [
+ "skyvern",
+ "bitwarden",
+ "azure_vault",
+ "gcp",
+ "custom"
+ ],
+ "title": "CredentialVaultType"
+ },
+ "CreditCardBillingAddress": {
"properties": {
- "parameter_type": {
- "type": "string",
- "const": "context",
- "title": "Parameter Type",
- "default": "context"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "line1": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Line1",
+ "description": "Billing address line 1",
+ "examples": [
+ "123 Main St"
+ ]
},
- "description": {
+ "line2": {
"anyOf": [
{
"type": "string"
@@ -10834,29 +13451,13 @@
"type": "null"
}
],
- "title": "Description"
- },
- "source_parameter_key": {
- "type": "string",
- "title": "Source Parameter Key"
- }
- },
- "type": "object",
- "required": [
- "key",
- "source_parameter_key"
- ],
- "title": "ContextParameterYAML"
- },
- "CreateBrowserProfileRequest": {
- "properties": {
- "name": {
- "type": "string",
- "minLength": 1,
- "title": "Name",
- "description": "Name for the browser profile"
+ "title": "Line2",
+ "description": "Billing address line 2",
+ "examples": [
+ "Apt 4B"
+ ]
},
- "description": {
+ "city": {
"anyOf": [
{
"type": "string"
@@ -10865,55 +13466,73 @@
"type": "null"
}
],
- "title": "Description",
- "description": "Optional profile description"
+ "title": "City",
+ "description": "Billing city",
+ "examples": [
+ "San Francisco"
+ ]
},
- "browser_session_id": {
+ "state": {
"anyOf": [
{
- "type": "string",
- "minLength": 1
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Browser Session Id",
- "description": "Persistent browser session to convert into a profile. Omit for a blank profile."
+ "title": "State",
+ "description": "Billing state or region",
+ "examples": [
+ "California"
+ ]
},
- "workflow_run_id": {
+ "state_code": {
"anyOf": [
{
- "type": "string",
- "minLength": 1
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Workflow Run Id",
- "description": "Workflow run whose persisted session should be captured. Omit for a blank profile."
+ "title": "State Code",
+ "description": "Billing state or region code",
+ "examples": [
+ "CA"
+ ]
},
- "proxy_location": {
+ "postal_code": {
"anyOf": [
{
- "$ref": "#/components/schemas/ProxyLocation"
+ "type": "string"
},
{
- "$ref": "#/components/schemas/GeoTarget"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Postal Code",
+ "description": "Billing postal code",
+ "examples": [
+ "94105"
+ ]
+ },
+ "country": {
+ "anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Proxy Location",
- "description": "Optional proxy location for this profile's pinned proxy identity."
+ "title": "Country",
+ "description": "Billing country",
+ "examples": [
+ "United States"
+ ]
},
- "proxy_session_id": {
+ "country_code": {
"anyOf": [
{
"type": "string"
@@ -10922,184 +13541,293 @@
"type": "null"
}
],
- "title": "Proxy Session Id",
- "description": "Explicit sticky-session id for this profile's pinned proxy identity."
+ "title": "Country Code",
+ "description": "ISO 3166-1 alpha-2 billing country code",
+ "examples": [
+ "US"
+ ]
+ }
+ },
+ "type": "object",
+ "title": "CreditCardBillingAddress",
+ "description": "Optional billing address fields associated with a credit card credential."
+ },
+ "CreditCardCredentialResponse": {
+ "properties": {
+ "last_four": {
+ "type": "string",
+ "title": "Last Four",
+ "description": "Last four digits of the credit card number",
+ "examples": [
+ "1234"
+ ]
+ },
+ "brand": {
+ "type": "string",
+ "title": "Brand",
+ "description": "Brand of the credit card",
+ "examples": [
+ "visa"
+ ]
}
},
"type": "object",
"required": [
- "name"
+ "last_four",
+ "brand"
],
- "title": "CreateBrowserProfileRequest"
+ "title": "CreditCardCredentialResponse",
+ "description": "Response model for credit card credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include full card number, CVV, expiration date, card holder name,\nbilling fields, or metadata."
},
- "CreateBrowserSessionRequest": {
+ "CustomLLM": {
"properties": {
- "url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Url",
- "description": "Optional URL to open when the standalone browser session starts."
+ "id": {
+ "type": "string",
+ "title": "Id"
},
- "timeout": {
+ "organization_id": {
+ "type": "string",
+ "title": "Organization Id"
+ },
+ "config": {
+ "$ref": "#/components/schemas/CustomLLMConfig"
+ },
+ "created_at": {
+ "type": "string",
+ "title": "Created At"
+ },
+ "modified_at": {
+ "type": "string",
+ "title": "Modified At"
+ },
+ "valid": {
+ "type": "boolean",
+ "title": "Valid"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "organization_id",
+ "config",
+ "created_at",
+ "modified_at",
+ "valid"
+ ],
+ "title": "CustomLLM"
+ },
+ "CustomLLMConfig": {
+ "properties": {
+ "display_name": {
+ "type": "string",
+ "maxLength": 120,
+ "minLength": 1,
+ "title": "Display Name"
+ },
+ "provider": {
+ "$ref": "#/components/schemas/CustomLLMProvider"
+ },
+ "model_name": {
+ "type": "string",
+ "maxLength": 250,
+ "minLength": 1,
+ "title": "Model Name"
+ },
+ "api_base": {
"anyOf": [
{
- "type": "integer",
- "minimum": 5
+ "type": "string",
+ "maxLength": 500
},
{
"type": "null"
}
],
- "title": "Timeout",
- "description": "Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 240. Defaults to 60.",
- "default": 60
+ "title": "Api Base"
},
- "proxy_location": {
+ "api_key": {
"anyOf": [
{
- "$ref": "#/components/schemas/ProxyLocation"
- },
- {
- "$ref": "#/components/schemas/GeoTarget"
- },
- {
- "additionalProperties": true,
- "type": "object"
+ "type": "string",
+ "maxLength": 1000
},
{
"type": "null"
}
],
- "title": "Proxy Location",
- "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_KR: South Korea\n- RESIDENTIAL_SA: Saudi Arabia\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_BR: Brazil\n- RESIDENTIAL_TR: Turkey\n- RESIDENTIAL_CA: Canada\n- RESIDENTIAL_MX: Mexico\n- RESIDENTIAL_IT: Italy\n- RESIDENTIAL_NL: Netherlands\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n\nFor self-hosted deployments, you can pass a custom proxy URL as a dict: {\"url\": \"http://user:[email protected]:8080\"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool.\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}, or a custom proxy URL dict for self-hosted deployments: {\"url\": \"http://user:[email protected]:8080\"}"
+ "title": "Api Key"
},
- "proxy_session_id": {
+ "api_version": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 100
},
{
"type": "null"
}
],
- "title": "Proxy Session Id",
- "description": "Opaque Skyvern-managed proxy sticky-session id for pinned Residential ISP sessions."
+ "title": "Api Version"
},
- "extensions": {
+ "supports_vision": {
+ "type": "boolean",
+ "title": "Supports Vision",
+ "default": true
+ },
+ "add_assistant_prefix": {
+ "type": "boolean",
+ "title": "Add Assistant Prefix",
+ "default": false
+ },
+ "max_completion_tokens": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/Extensions"
- },
- "type": "array"
+ "type": "integer",
+ "maximum": 1000000,
+ "minimum": 1
},
{
"type": "null"
}
],
- "title": "Extensions",
- "description": "A list of extensions to install in the browser session."
+ "title": "Max Completion Tokens"
},
- "browser_type": {
+ "temperature": {
"anyOf": [
{
- "$ref": "#/components/schemas/PersistentBrowserType"
+ "type": "number",
+ "maximum": 2,
+ "minimum": 0
},
{
"type": "null"
}
],
- "description": "The type of browser to use for the session."
+ "title": "Temperature"
},
- "browser_profile_id": {
+ "reasoning_effort": {
"anyOf": [
{
"type": "string",
- "pattern": "^bp_"
+ "maxLength": 50
},
{
"type": "null"
}
],
- "title": "Browser Profile Id",
- "description": "ID of a browser profile to load into this session (restores cookies, localStorage, etc.). browser_profile_id starts with `bp_`."
+ "title": "Reasoning Effort"
},
- "generate_browser_profile": {
- "type": "boolean",
- "title": "Generate Browser Profile",
- "description": "When true, the session's browser profile (cookies, localStorage, etc.) is saved to storage when the session ends so it can be turned into a reusable browser profile. Defaults to false to avoid storing profiles for sessions that never need them. Sessions started with a browser_profile_id always persist their profile regardless of this flag.",
- "default": false
+ "extra_parameters": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Extra Parameters"
}
},
"type": "object",
- "title": "CreateBrowserSessionRequest"
+ "required": [
+ "display_name",
+ "provider",
+ "model_name"
+ ],
+ "title": "CustomLLMConfig"
},
- "CreateCredentialRequest": {
+ "CustomLLMCreateRequest": {
"properties": {
- "name": {
+ "config": {
+ "$ref": "#/components/schemas/CustomLLMConfig"
+ }
+ },
+ "type": "object",
+ "required": [
+ "config"
+ ],
+ "title": "CustomLLMCreateRequest"
+ },
+ "CustomLLMListResponse": {
+ "properties": {
+ "custom_llms": {
+ "items": {
+ "$ref": "#/components/schemas/CustomLLM"
+ },
+ "type": "array",
+ "title": "Custom Llms"
+ }
+ },
+ "type": "object",
+ "required": [
+ "custom_llms"
+ ],
+ "title": "CustomLLMListResponse"
+ },
+ "CustomLLMProvider": {
+ "type": "string",
+ "enum": [
+ "openai_compatible",
+ "ollama",
+ "openrouter",
+ "gemini"
+ ],
+ "title": "CustomLLMProvider"
+ },
+ "CustomLLMResponse": {
+ "properties": {
+ "custom_llm": {
+ "$ref": "#/components/schemas/CustomLLM"
+ }
+ },
+ "type": "object",
+ "required": [
+ "custom_llm"
+ ],
+ "title": "CustomLLMResponse"
+ },
+ "CustomLLMUpdateRequest": {
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/CustomLLMConfig"
+ }
+ },
+ "type": "object",
+ "required": [
+ "config"
+ ],
+ "title": "CustomLLMUpdateRequest"
+ },
+ "DataExportBlock": {
+ "properties": {
+ "label": {
"type": "string",
- "title": "Name",
- "description": "Name of the credential",
- "examples": [
- "Amazon Login"
- ]
- },
- "credential_type": {
- "$ref": "#/components/schemas/skyvern__forge__sdk__schemas__credentials__CredentialType",
- "description": "Type of credential to create"
- },
- "credential": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/NonEmptyPasswordCredential"
- },
- {
- "$ref": "#/components/schemas/NonEmptyCreditCardCredential"
- },
- {
- "$ref": "#/components/schemas/SecretCredential"
- }
- ],
- "title": "Credential",
- "description": "The credential data to store",
- "examples": [
- {
- "password": "securepassword123",
- "username": "[email protected]"
- }
- ]
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
},
- "vault_type": {
+ "next_block_label": {
"anyOf": [
{
- "$ref": "#/components/schemas/CredentialVaultType"
+ "type": "string"
},
{
"type": "null"
}
],
- "description": "Which vault to store this credential in. If omitted, uses the instance default. Use this to mix Skyvern-hosted and custom credentials within the same organization.",
- "examples": [
- "skyvern",
- "custom",
- "azure_vault",
- "bitwarden"
- ]
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "proxy_location": {
+ "block_type": {
+ "type": "string",
+ "const": "data_export",
+ "title": "Block Type",
+ "default": "data_export"
+ },
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
- {
- "$ref": "#/components/schemas/ProxyLocation"
- },
- {
- "$ref": "#/components/schemas/GeoTarget"
- },
{
"additionalProperties": true,
"type": "object"
@@ -11108,10 +13836,33 @@
"type": "null"
}
],
- "title": "Proxy Location",
- "description": "Optional proxy location for this credential's pinned proxy identity."
+ "title": "Model"
},
- "proxy_session_id": {
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "data": {
+ "type": "string",
+ "title": "Data"
+ },
+ "data_schema": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Data Schema"
+ },
+ "file_name": {
"anyOf": [
{
"type": "string"
@@ -11120,16 +13871,90 @@
"type": "null"
}
],
- "title": "Proxy Session Id",
- "description": "Optional advanced reuse key for this credential's pinned proxy identity."
+ "title": "File Name"
},
- "rotate_proxy_session_id": {
- "type": "boolean",
- "title": "Rotate Proxy Session Id",
- "description": "Rotate the Skyvern-managed proxy sticky-session id when updating this credential.",
- "default": false
+ "parameters": {
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowParameter"
+ },
+ {
+ "$ref": "#/components/schemas/ContextParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AWSSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "parameter_type",
+ "mapping": {
+ "aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
+ "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
+ "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
+ "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
+ "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
+ "context": "#/components/schemas/ContextParameter",
+ "credential": "#/components/schemas/CredentialParameter",
+ "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
+ "output": "#/components/schemas/OutputParameter",
+ "workflow": "#/components/schemas/WorkflowParameter"
+ }
+ }
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "output_parameter",
+ "data",
+ "data_schema"
+ ],
+ "title": "DataExportBlock"
+ },
+ "DataExportBlockYAML": {
+ "properties": {
+ "block_type": {
+ "type": "string",
+ "const": "data_export",
+ "title": "Block Type",
+ "default": "data_export"
+ },
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
},
- "tested_url": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -11138,34 +13963,46 @@
"type": "null"
}
],
- "title": "Tested Url",
- "description": "Login page URL used during the credential test"
- }
- },
- "type": "object",
- "required": [
- "name",
- "credential_type",
- "credential"
- ],
- "title": "CreateCredentialRequest",
- "description": "Request model for creating a new credential."
- },
- "CreateScriptRequest": {
- "properties": {
- "workflow_id": {
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Workflow Id",
- "description": "Associated workflow ID"
+ "title": "Model"
},
- "run_id": {
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "data": {
+ "type": "string",
+ "title": "Data"
+ },
+ "data_schema": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Data Schema"
+ },
+ "file_name": {
"anyOf": [
{
"type": "string"
@@ -11174,14 +14011,13 @@
"type": "null"
}
],
- "title": "Run Id",
- "description": "Associated run ID"
+ "title": "File Name"
},
- "files": {
+ "parameter_keys": {
"anyOf": [
{
"items": {
- "$ref": "#/components/schemas/ScriptFileCreate"
+ "type": "string"
},
"type": "array"
},
@@ -11189,6 +14025,37 @@
"type": "null"
}
],
+ "title": "Parameter Keys"
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "data",
+ "data_schema"
+ ],
+ "title": "DataExportBlockYAML"
+ },
+ "DeleteScheduleResponse": {
+ "properties": {
+ "ok": {
+ "type": "boolean",
+ "title": "Ok"
+ }
+ },
+ "type": "object",
+ "required": [
+ "ok"
+ ],
+ "title": "DeleteScheduleResponse"
+ },
+ "DeployScriptRequest": {
+ "properties": {
+ "files": {
+ "items": {
+ "$ref": "#/components/schemas/ScriptFileCreate"
+ },
+ "type": "array",
"title": "Files",
"description": "Array of files to include in the script",
"examples": [
@@ -11196,39 +14063,21 @@
"content": "cHJpbnQoIkhlbGxvLCBXb3JsZCEiKQ==",
"encoding": "base64",
"mime_type": "text/x-python",
- "path": "main.py"
- },
- {
- "content": "cmVxdWVzdHM9PTIuMjguMQ==",
- "encoding": "base64",
- "mime_type": "text/plain",
- "path": "requirements.txt"
+ "path": "src/main.py"
}
]
}
},
"type": "object",
- "title": "CreateScriptRequest"
+ "required": [
+ "files"
+ ],
+ "title": "DeployScriptRequest",
+ "description": "Request model for deploying a script with updated files."
},
- "CreateScriptResponse": {
+ "DownloadFilesRequest": {
"properties": {
- "script_id": {
- "type": "string",
- "title": "Script Id",
- "description": "Unique script identifier",
- "examples": [
- "s_abc123"
- ]
- },
- "version": {
- "type": "integer",
- "title": "Version",
- "description": "Script version number",
- "examples": [
- 1
- ]
- },
- "run_id": {
+ "url": {
"anyOf": [
{
"type": "string"
@@ -11237,52 +14086,10 @@
"type": "null"
}
],
- "title": "Run Id",
- "description": "ID of the workflow run or task run that generated this script"
- },
- "file_count": {
- "type": "integer",
- "title": "File Count",
- "description": "Total number of files in the script"
- },
- "file_tree": {
- "additionalProperties": {
- "$ref": "#/components/schemas/FileNode"
- },
- "type": "object",
- "title": "File Tree",
- "description": "Hierarchical file tree structure"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At",
- "description": "Timestamp when the script was created"
- }
- },
- "type": "object",
- "required": [
- "script_id",
- "version",
- "file_count",
- "file_tree",
- "created_at"
- ],
- "title": "CreateScriptResponse"
- },
- "CredentialParameter": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "credential",
- "title": "Parameter Type",
- "default": "credential"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "title": "Url",
+ "description": "Website URL"
},
- "description": {
+ "webhook_url": {
"anyOf": [
{
"type": "string"
@@ -11291,35 +14098,21 @@
"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"
+ "title": "Webhook Url",
+ "description": "Webhook URL to send status updates"
},
- "credential_ids": {
+ "proxy_location": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "$ref": "#/components/schemas/ProxyLocation"
},
{
"type": "null"
}
],
- "title": "Credential Ids"
+ "description": "Proxy location to use"
},
- "selection_strategy": {
+ "totp_identifier": {
"anyOf": [
{
"type": "string"
@@ -11328,55 +14121,55 @@
"type": "null"
}
],
- "title": "Selection Strategy"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
+ "title": "Totp Identifier",
+ "description": "Identifier for TOTP (Time-based One-Time Password) if required"
},
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "totp_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Totp Url",
+ "description": "TOTP URL to fetch one-time passwords"
},
- "deleted_at": {
+ "browser_session_id": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Deleted At"
- }
- },
- "type": "object",
- "required": [
- "key",
- "credential_parameter_id",
- "workflow_id",
- "credential_id",
- "created_at",
- "modified_at"
- ],
- "title": "CredentialParameter"
- },
- "CredentialParameterYAML": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "credential",
- "title": "Parameter Type",
- "default": "credential"
+ "title": "Browser Session Id",
+ "description": "ID of the browser session to use, which is prefixed by `pbs_` e.g. `pbs_123456`",
+ "examples": [
+ "pbs_123456"
+ ]
+ },
+ "browser_profile_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Profile Id",
+ "description": "ID of a browser profile to reuse for this run"
},
- "key": {
- "type": "string",
- "title": "Key"
+ "start_fresh_browser": {
+ "type": "boolean",
+ "title": "Start Fresh Browser",
+ "description": "When true, start this run from a fresh, empty browser and ignore any saved browser memory — no memory is read or written. A verified sign-in during the run still updates the credential's saved login.",
+ "default": false
},
- "description": {
+ "browser_address": {
"anyOf": [
{
"type": "string"
@@ -11385,118 +14178,111 @@
"type": "null"
}
],
- "title": "Description"
- },
- "credential_id": {
- "type": "string",
- "title": "Credential Id"
+ "title": "Browser Address",
+ "description": "The CDP address for the task.",
+ "examples": [
+ "http://127.0.0.1:9222",
+ "ws://127.0.0.1:9222/devtools/browser/1234567890"
+ ]
},
- "credential_ids": {
+ "extra_http_headers": {
"anyOf": [
{
- "items": {
+ "additionalProperties": {
"type": "string"
},
- "type": "array"
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Credential Ids"
+ "title": "Extra Http Headers",
+ "description": "Additional HTTP headers to include in requests"
},
- "selection_strategy": {
+ "cdp_connect_headers": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Selection Strategy"
- }
- },
- "type": "object",
- "required": [
- "key",
- "credential_id"
- ],
- "title": "CredentialParameterYAML"
- },
- "CredentialResponse": {
- "properties": {
- "credential_id": {
- "type": "string",
- "title": "Credential Id",
- "description": "Unique identifier for the credential",
- "examples": [
- "cred_1234567890"
- ]
+ "title": "Cdp Connect Headers",
+ "description": "HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites."
},
- "credential": {
+ "max_screenshot_scrolling_times": {
"anyOf": [
{
- "$ref": "#/components/schemas/PasswordCredentialResponse"
- },
- {
- "$ref": "#/components/schemas/CreditCardCredentialResponse"
+ "type": "integer"
},
{
- "$ref": "#/components/schemas/SecretCredentialResponse"
+ "type": "null"
}
],
- "title": "Credential",
- "description": "The credential data"
- },
- "credential_type": {
- "$ref": "#/components/schemas/CredentialType-Output",
- "description": "Type of the credential"
+ "title": "Max Screenshot Scrolling Times",
+ "description": "Maximum number of times to scroll for screenshots"
},
- "name": {
+ "navigation_goal": {
"type": "string",
- "title": "Name",
- "description": "Name of the credential",
- "examples": [
- "Amazon Login"
- ]
+ "title": "Navigation Goal",
+ "description": "Instructions for navigating to and downloading the file"
},
- "vault_type": {
+ "download_suffix": {
"anyOf": [
{
- "$ref": "#/components/schemas/CredentialVaultType"
+ "type": "string"
},
{
"type": "null"
}
],
- "description": "Which vault stores this credential (e.g., 'skyvern', 'bitwarden', 'azure_vault', 'custom')"
+ "title": "Download Suffix",
+ "description": "Suffix or complete filename for the downloaded file"
},
- "browser_profile_id": {
+ "download_timeout": {
"anyOf": [
{
- "type": "string"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Browser Profile Id",
- "description": "Browser profile ID linked to this credential"
+ "title": "Download Timeout",
+ "description": "Timeout in seconds for the download operation"
},
- "tested_url": {
+ "max_steps_per_run": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Tested Url",
- "description": "Login page URL used during the credential test"
+ "title": "Max Steps Per Run",
+ "description": "Maximum number of steps to execute"
+ }
+ },
+ "type": "object",
+ "required": [
+ "navigation_goal"
+ ],
+ "title": "DownloadFilesRequest"
+ },
+ "DownloadToS3Block": {
+ "properties": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
},
- "user_context": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -11505,22 +14291,77 @@
"type": "null"
}
],
- "title": "User Context",
- "description": "User-provided context describing the login sequence (e.g., 'click SSO button first')"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "save_browser_session_intent": {
+ "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
+ },
+ "model": {
"anyOf": [
{
- "type": "boolean"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Save Browser Session Intent",
- "description": "Whether the user intends to save a browser session, regardless of test outcome"
+ "title": "Model"
},
- "folder_id": {
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "url": {
+ "type": "string",
+ "title": "Url"
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "output_parameter",
+ "url"
+ ],
+ "title": "DownloadToS3Block"
+ },
+ "DownloadToS3BlockYAML": {
+ "properties": {
+ "block_type": {
+ "type": "string",
+ "const": "download_to_s3",
+ "title": "Block Type",
+ "default": "download_to_s3"
+ },
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
+ },
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -11529,20 +14370,16 @@
"type": "null"
}
],
- "title": "Folder Id",
- "description": "ID of the credential folder this credential belongs to, if any",
- "examples": [
- "cfld_1234567890"
- ]
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
},
- "proxy_location": {
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
- {
- "$ref": "#/components/schemas/ProxyLocation"
- },
- {
- "$ref": "#/components/schemas/GeoTarget"
- },
{
"additionalProperties": true,
"type": "object"
@@ -11551,56 +14388,46 @@
"type": "null"
}
],
- "title": "Proxy Location",
- "description": "Optional proxy location used for the credential's pinned proxy identity."
+ "title": "Model"
},
- "proxy_session_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Proxy Session Id",
- "description": "Opaque Skyvern-managed proxy sticky-session id."
- }
- },
- "type": "object",
- "required": [
- "credential_id",
- "credential",
- "credential_type",
- "name"
- ],
- "title": "CredentialResponse",
- "description": "Response model for credential operations."
- },
- "CredentialType-Output": {
- "type": "string",
- "enum": [
- "password",
- "credit_card",
- "secret"
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "url": {
+ "type": "string",
+ "title": "Url"
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "url"
],
- "title": "CredentialType",
- "description": "Type of credential stored in the system."
+ "title": "DownloadToS3BlockYAML"
},
- "CredentialVaultType": {
+ "EmailBodyFormat": {
"type": "string",
"enum": [
- "skyvern",
- "bitwarden",
- "azure_vault",
- "gcp",
- "custom"
+ "text",
+ "html"
],
- "title": "CredentialVaultType"
+ "title": "EmailBodyFormat"
},
- "CreditCardBillingAddress": {
+ "EmailInboxBlock": {
"properties": {
- "line1": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
+ },
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -11609,28 +14436,59 @@
"type": "null"
}
],
- "title": "Line1",
- "description": "Billing address line 1",
- "examples": [
- "123 Main St"
- ]
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "line2": {
+ "block_type": {
+ "type": "string",
+ "const": "email_inbox",
+ "title": "Block Type",
+ "default": "email_inbox"
+ },
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Line2",
- "description": "Billing address line 2",
- "examples": [
- "Apt 4B"
- ]
+ "title": "Model"
},
- "city": {
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "email_client": {
+ "type": "string",
+ "enum": [
+ "gmail",
+ "outlook"
+ ],
+ "title": "Email Client"
+ },
+ "credential_id": {
"anyOf": [
{
"type": "string"
@@ -11639,13 +14497,9 @@
"type": "null"
}
],
- "title": "City",
- "description": "Billing city",
- "examples": [
- "San Francisco"
- ]
+ "title": "Credential Id"
},
- "state": {
+ "folder": {
"anyOf": [
{
"type": "string"
@@ -11654,13 +14508,9 @@
"type": "null"
}
],
- "title": "State",
- "description": "Billing state or region",
- "examples": [
- "California"
- ]
+ "title": "Folder"
},
- "state_code": {
+ "prompt": {
"anyOf": [
{
"type": "string"
@@ -11669,13 +14519,9 @@
"type": "null"
}
],
- "title": "State Code",
- "description": "Billing state or region code",
- "examples": [
- "CA"
- ]
+ "title": "Prompt"
},
- "postal_code": {
+ "sender": {
"anyOf": [
{
"type": "string"
@@ -11684,13 +14530,9 @@
"type": "null"
}
],
- "title": "Postal Code",
- "description": "Billing postal code",
- "examples": [
- "94105"
- ]
+ "title": "Sender"
},
- "country": {
+ "subject": {
"anyOf": [
{
"type": "string"
@@ -11699,309 +14541,367 @@
"type": "null"
}
],
- "title": "Country",
- "description": "Billing country",
- "examples": [
- "United States"
- ]
+ "title": "Subject"
},
- "country_code": {
+ "newer_than_days": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Country Code",
- "description": "ISO 3166-1 alpha-2 billing country code",
- "examples": [
- "US"
- ]
- }
- },
- "type": "object",
- "title": "CreditCardBillingAddress",
- "description": "Optional billing address fields associated with a credit card credential."
- },
- "CreditCardCredentialResponse": {
- "properties": {
- "last_four": {
- "type": "string",
- "title": "Last Four",
- "description": "Last four digits of the credit card number",
- "examples": [
- "1234"
- ]
+ "title": "Newer Than Days"
},
- "brand": {
- "type": "string",
- "title": "Brand",
- "description": "Brand of the credit card",
- "examples": [
- "visa"
- ]
+ "max_results": {
+ "type": "integer",
+ "title": "Max Results",
+ "default": 25
+ },
+ "include_body": {
+ "type": "boolean",
+ "title": "Include Body",
+ "default": true
+ },
+ "parameters": {
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowParameter"
+ },
+ {
+ "$ref": "#/components/schemas/ContextParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AWSSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "parameter_type",
+ "mapping": {
+ "aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
+ "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
+ "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
+ "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
+ "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
+ "context": "#/components/schemas/ContextParameter",
+ "credential": "#/components/schemas/CredentialParameter",
+ "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
+ "output": "#/components/schemas/OutputParameter",
+ "workflow": "#/components/schemas/WorkflowParameter"
+ }
+ }
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
}
},
"type": "object",
"required": [
- "last_four",
- "brand"
+ "label",
+ "output_parameter",
+ "email_client"
],
- "title": "CreditCardCredentialResponse",
- "description": "Response model for credit card credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include full card number, CVV, expiration date, card holder name,\nbilling fields, or metadata."
+ "title": "EmailInboxBlock"
},
- "CustomLLM": {
+ "EmailInboxBlockYAML": {
"properties": {
- "id": {
+ "block_type": {
"type": "string",
- "title": "Id"
+ "const": "email_inbox",
+ "title": "Block Type",
+ "default": "email_inbox"
},
- "organization_id": {
+ "label": {
"type": "string",
- "title": "Organization Id"
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
},
- "config": {
- "$ref": "#/components/schemas/CustomLLMConfig"
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
},
- "created_at": {
- "type": "string",
- "title": "Created At"
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
},
- "modified_at": {
- "type": "string",
- "title": "Modified At"
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
},
- "valid": {
+ "ignore_workflow_system_prompt": {
"type": "boolean",
- "title": "Valid"
- }
- },
- "type": "object",
- "required": [
- "id",
- "organization_id",
- "config",
- "created_at",
- "modified_at",
- "valid"
- ],
- "title": "CustomLLM"
- },
- "CustomLLMConfig": {
- "properties": {
- "display_name": {
- "type": "string",
- "maxLength": 120,
- "minLength": 1,
- "title": "Display Name"
+ "title": "Ignore Workflow System Prompt",
+ "default": false
},
- "provider": {
- "$ref": "#/components/schemas/CustomLLMProvider"
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
},
- "model_name": {
+ "email_client": {
"type": "string",
- "maxLength": 250,
- "minLength": 1,
- "title": "Model Name"
+ "enum": [
+ "gmail",
+ "outlook"
+ ],
+ "title": "Email Client"
},
- "api_base": {
+ "credential_id": {
"anyOf": [
{
- "type": "string",
- "maxLength": 500
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Api Base"
+ "title": "Credential Id"
},
- "api_key": {
+ "folder": {
"anyOf": [
{
- "type": "string",
- "maxLength": 1000
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Api Key"
+ "title": "Folder"
},
- "api_version": {
+ "prompt": {
"anyOf": [
{
- "type": "string",
- "maxLength": 100
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Api Version"
- },
- "supports_vision": {
- "type": "boolean",
- "title": "Supports Vision",
- "default": true
+ "title": "Prompt"
},
- "add_assistant_prefix": {
- "type": "boolean",
- "title": "Add Assistant Prefix",
- "default": false
+ "sender": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sender"
},
- "max_completion_tokens": {
+ "subject": {
"anyOf": [
{
- "type": "integer",
- "maximum": 1000000,
- "minimum": 1
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Max Completion Tokens"
+ "title": "Subject"
},
- "temperature": {
+ "newer_than_days": {
"anyOf": [
{
- "type": "number",
- "maximum": 2,
- "minimum": 0
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Temperature"
+ "title": "Newer Than Days"
},
- "reasoning_effort": {
+ "max_results": {
+ "type": "integer",
+ "title": "Max Results",
+ "default": 25
+ },
+ "include_body": {
+ "type": "boolean",
+ "title": "Include Body",
+ "default": true
+ },
+ "parameter_keys": {
"anyOf": [
{
- "type": "string",
- "maxLength": 50
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Reasoning Effort"
- }
- },
- "type": "object",
- "required": [
- "display_name",
- "provider",
- "model_name"
- ],
- "title": "CustomLLMConfig"
- },
- "CustomLLMCreateRequest": {
- "properties": {
- "config": {
- "$ref": "#/components/schemas/CustomLLMConfig"
+ "title": "Parameter Keys"
}
},
"type": "object",
"required": [
- "config"
+ "label",
+ "email_client"
],
- "title": "CustomLLMCreateRequest"
+ "title": "EmailInboxBlockYAML"
},
- "CustomLLMListResponse": {
+ "ExtendBrowserSessionRequest": {
"properties": {
- "custom_llms": {
- "items": {
- "$ref": "#/components/schemas/CustomLLM"
- },
- "type": "array",
- "title": "Custom Llms"
+ "additional_minutes": {
+ "type": "integer",
+ "minimum": 1,
+ "title": "Additional Minutes",
+ "description": "Minutes to add to the session's current deadline. A session can be extended, one or more times, up to a total lifetime of 360 minutes (6 hours) counted from when it started; a request for more than the remaining headroom is granted the remainder and the response carries a warning."
}
},
"type": "object",
"required": [
- "custom_llms"
+ "additional_minutes"
],
- "title": "CustomLLMListResponse"
+ "title": "ExtendBrowserSessionRequest"
},
- "CustomLLMProvider": {
+ "Extensions": {
"type": "string",
"enum": [
- "openai_compatible",
- "ollama",
- "openrouter"
- ],
- "title": "CustomLLMProvider"
- },
- "CustomLLMResponse": {
- "properties": {
- "custom_llm": {
- "$ref": "#/components/schemas/CustomLLM"
- }
- },
- "type": "object",
- "required": [
- "custom_llm"
- ],
- "title": "CustomLLMResponse"
- },
- "CustomLLMUpdateRequest": {
- "properties": {
- "config": {
- "$ref": "#/components/schemas/CustomLLMConfig"
- }
- },
- "type": "object",
- "required": [
- "config"
- ],
- "title": "CustomLLMUpdateRequest"
- },
- "DeleteScheduleResponse": {
- "properties": {
- "ok": {
- "type": "boolean",
- "title": "Ok"
- }
- },
- "type": "object",
- "required": [
- "ok"
+ "ad-blocker",
+ "captcha-solver"
],
- "title": "DeleteScheduleResponse"
+ "title": "Extensions"
},
- "DeployScriptRequest": {
+ "ExtractAction": {
"properties": {
- "files": {
- "items": {
- "$ref": "#/components/schemas/ScriptFileCreate"
- },
- "type": "array",
- "title": "Files",
- "description": "Array of files to include in the script",
- "examples": [
+ "type": {
+ "type": "string",
+ "const": "extract",
+ "title": "Type",
+ "default": "extract"
+ },
+ "prompt": {
+ "type": "string",
+ "title": "Prompt",
+ "description": "Extraction prompt",
+ "default": ""
+ },
+ "extract_schema": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Extract Schema",
+ "description": "Schema for extraction"
+ },
+ "error_code_mapping": {
+ "anyOf": [
{
- "content": "cHJpbnQoIkhlbGxvLCBXb3JsZCEiKQ==",
- "encoding": "base64",
- "mime_type": "text/x-python",
- "path": "src/main.py"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
}
- ]
+ ],
+ "title": "Error Code Mapping",
+ "description": "Error code mapping for extraction"
+ },
+ "intention": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Intention",
+ "description": "The intention or goal of the extraction"
+ },
+ "data": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data",
+ "description": "Additional context data"
}
},
"type": "object",
- "required": [
- "files"
- ],
- "title": "DeployScriptRequest",
- "description": "Request model for deploying a script with updated files."
+ "title": "ExtractAction",
+ "description": "Extract data action parameters."
},
- "DownloadFilesRequest": {
+ "ExtractionBlock": {
"properties": {
- "url": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
+ },
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -12010,45 +14910,87 @@
"type": "null"
}
],
- "title": "Url",
- "description": "Website URL"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "webhook_url": {
+ "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
+ },
+ "model": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Webhook Url",
- "description": "Webhook URL to send status updates"
+ "title": "Model"
},
- "proxy_location": {
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "task_type": {
+ "type": "string",
+ "title": "Task Type",
+ "default": "general"
+ },
+ "url": {
"anyOf": [
{
- "$ref": "#/components/schemas/ProxyLocation"
+ "type": "string"
},
{
"type": "null"
}
],
- "description": "Proxy location to use"
+ "title": "Url"
},
- "totp_identifier": {
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "default": ""
+ },
+ "engine": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/RunEngine"
},
{
"type": "null"
}
- ],
- "title": "Totp Identifier",
- "description": "Identifier for TOTP (Time-based One-Time Password) if required"
+ ]
},
- "totp_url": {
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
+ },
+ "complete_criterion": {
"anyOf": [
{
"type": "string"
@@ -12057,10 +14999,14 @@
"type": "null"
}
],
- "title": "Totp Url",
- "description": "TOTP URL to fetch one-time passwords"
+ "title": "Complete Criterion"
},
- "browser_session_id": {
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
+ "terminate_criterion": {
"anyOf": [
{
"type": "string"
@@ -12069,13 +15015,9 @@
"type": "null"
}
],
- "title": "Browser Session Id",
- "description": "ID of the browser session to use, which is prefixed by `pbs_` e.g. `pbs_123456`",
- "examples": [
- "pbs_123456"
- ]
+ "title": "Terminate Criterion"
},
- "browser_profile_id": {
+ "navigation_goal": {
"anyOf": [
{
"type": "string"
@@ -12084,11 +15026,22 @@
"type": "null"
}
],
- "title": "Browser Profile Id",
- "description": "ID of a browser profile to reuse for this run"
+ "title": "Navigation Goal"
},
- "browser_address": {
+ "data_extraction_goal": {
+ "type": "string",
+ "title": "Data Extraction Goal"
+ },
+ "data_schema": {
"anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
{
"type": "string"
},
@@ -12096,14 +15049,9 @@
"type": "null"
}
],
- "title": "Browser Address",
- "description": "The CDP address for the task.",
- "examples": [
- "http://127.0.0.1:9222",
- "ws://127.0.0.1:9222/devtools/browser/1234567890"
- ]
+ "title": "Data Schema"
},
- "extra_http_headers": {
+ "error_code_mapping": {
"anyOf": [
{
"additionalProperties": {
@@ -12115,42 +15063,110 @@
"type": "null"
}
],
- "title": "Extra Http Headers",
- "description": "Additional HTTP headers to include in requests"
+ "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/AzureSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "parameter_type",
+ "mapping": {
+ "aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
+ "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
+ "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
+ "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
+ "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
+ "context": "#/components/schemas/ContextParameter",
+ "credential": "#/components/schemas/CredentialParameter",
+ "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
+ "output": "#/components/schemas/OutputParameter",
+ "workflow": "#/components/schemas/WorkflowParameter"
+ }
+ }
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
},
- "cdp_connect_headers": {
+ "complete_on_download": {
+ "type": "boolean",
+ "title": "Complete On Download",
+ "default": false
+ },
+ "download_suffix": {
"anyOf": [
{
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Cdp Connect Headers",
- "description": "HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites."
+ "title": "Download Suffix"
},
- "max_screenshot_scrolling_times": {
+ "totp_verification_url": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Max Screenshot Scrolling Times",
- "description": "Maximum number of times to scroll for screenshots"
- },
- "navigation_goal": {
- "type": "string",
- "title": "Navigation Goal",
- "description": "Instructions for navigating to and downloading the file"
+ "title": "Totp Verification Url"
},
- "download_suffix": {
+ "totp_identifier": {
"anyOf": [
{
"type": "string"
@@ -12159,8 +15175,17 @@
"type": "null"
}
],
- "title": "Download Suffix",
- "description": "Suffix or complete filename for the downloaded file"
+ "title": "Totp Identifier"
+ },
+ "complete_verification": {
+ "type": "boolean",
+ "title": "Complete Verification",
+ "default": true
+ },
+ "include_action_history_in_verification": {
+ "type": "boolean",
+ "title": "Include Action History In Verification",
+ "default": false
},
"download_timeout": {
"anyOf": [
@@ -12171,36 +15196,31 @@
"type": "null"
}
],
- "title": "Download Timeout",
- "description": "Timeout in seconds for the download operation"
+ "title": "Download Timeout"
},
- "max_steps_per_run": {
+ "include_extracted_text": {
+ "type": "boolean",
+ "title": "Include Extracted Text",
+ "default": false
+ },
+ "export_enabled": {
+ "type": "boolean",
+ "title": "Export Enabled",
+ "default": false
+ },
+ "export_data_schema": {
"anyOf": [
{
- "type": "integer"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Max Steps Per Run",
- "description": "Maximum number of steps to execute"
- }
- },
- "type": "object",
- "required": [
- "navigation_goal"
- ],
- "title": "DownloadFilesRequest"
- },
- "DownloadToS3Block": {
- "properties": {
- "label": {
- "type": "string",
- "title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "title": "Export Data Schema"
},
- "next_block_label": {
+ "export_file_name": {
"anyOf": [
{
"type": "string"
@@ -12209,70 +15229,35 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
- },
- "block_type": {
- "type": "string",
- "const": "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
+ "title": "Export File Name"
},
- "model": {
+ "export_records": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
- },
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
- },
- "url": {
- "type": "string",
- "title": "Url"
+ "title": "Export Records"
}
},
"type": "object",
"required": [
"label",
"output_parameter",
- "url"
+ "data_extraction_goal"
],
- "title": "DownloadToS3Block"
+ "title": "ExtractionBlock"
},
- "DownloadToS3BlockYAML": {
+ "ExtractionBlockYAML": {
"properties": {
"block_type": {
"type": "string",
- "const": "download_to_s3",
+ "const": "extraction",
"title": "Block Type",
- "default": "download_to_s3"
+ "default": "extraction"
},
"label": {
"type": "string",
@@ -12318,26 +15303,11 @@
"title": "Next Loop On Failure",
"default": false
},
- "url": {
- "type": "string",
- "title": "Url"
- }
- },
- "type": "object",
- "required": [
- "label",
- "url"
- ],
- "title": "DownloadToS3BlockYAML"
- },
- "EmailInboxBlock": {
- "properties": {
- "label": {
+ "data_extraction_goal": {
"type": "string",
- "title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "title": "Data Extraction Goal"
},
- "next_block_label": {
+ "url": {
"anyOf": [
{
"type": "string"
@@ -12346,71 +15316,39 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ "title": "Url"
},
- "block_type": {
+ "title": {
"type": "string",
- "const": "email_inbox",
- "title": "Block Type",
- "default": "email_inbox"
- },
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "title": "Title",
+ "default": ""
},
- "model": {
+ "engine": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "$ref": "#/components/schemas/RunEngine"
},
{
"type": "null"
}
- ],
- "title": "Model"
- },
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ ]
},
- "next_loop_on_failure": {
+ "engine_pinned": {
"type": "boolean",
- "title": "Next Loop On Failure",
+ "title": "Engine Pinned",
+ "description": "Set to true only when skyvern-1.0 was explicitly chosen for this block; leave it unset otherwise.",
"default": false
},
- "email_client": {
- "type": "string",
- "enum": [
- "gmail",
- "outlook"
- ],
- "title": "Email Client"
- },
- "credential_id": {
+ "data_schema": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
- "type": "null"
- }
- ],
- "title": "Credential Id"
- },
- "folder": {
- "anyOf": [
+ "items": {},
+ "type": "array"
+ },
{
"type": "string"
},
@@ -12418,141 +15356,96 @@
"type": "null"
}
],
- "title": "Folder"
+ "title": "Data Schema"
},
- "prompt": {
+ "max_retries": {
+ "type": "integer",
+ "title": "Max Retries",
+ "default": 0
+ },
+ "max_steps_per_run": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Prompt"
+ "title": "Max Steps Per Run"
},
- "sender": {
+ "parameter_keys": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Sender"
+ "title": "Parameter Keys"
},
- "subject": {
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "export_enabled": {
+ "type": "boolean",
+ "title": "Export Enabled",
+ "default": false
+ },
+ "export_data_schema": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Subject"
+ "title": "Export Data Schema"
},
- "newer_than_days": {
+ "export_file_name": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
- ],
- "title": "Newer Than Days"
- },
- "max_results": {
- "type": "integer",
- "title": "Max Results",
- "default": 25
- },
- "include_body": {
- "type": "boolean",
- "title": "Include Body",
- "default": true
+ ],
+ "title": "Export File Name"
},
- "parameters": {
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/WorkflowParameter"
- },
- {
- "$ref": "#/components/schemas/ContextParameter"
- },
- {
- "$ref": "#/components/schemas/AWSSecretParameter"
- },
- {
- "$ref": "#/components/schemas/AzureSecretParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
- },
- {
- "$ref": "#/components/schemas/OnePasswordCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/AzureVaultCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/OutputParameter"
- },
- {
- "$ref": "#/components/schemas/CredentialParameter"
- }
- ],
- "discriminator": {
- "propertyName": "parameter_type",
- "mapping": {
- "aws_secret": "#/components/schemas/AWSSecretParameter",
- "azure_secret": "#/components/schemas/AzureSecretParameter",
- "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
- "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
- "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
- "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
- "context": "#/components/schemas/ContextParameter",
- "credential": "#/components/schemas/CredentialParameter",
- "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
- "output": "#/components/schemas/OutputParameter",
- "workflow": "#/components/schemas/WorkflowParameter"
- }
+ "export_records": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- },
- "type": "array",
- "title": "Parameters",
- "default": []
+ ],
+ "title": "Export Records"
}
},
"type": "object",
"required": [
"label",
- "output_parameter",
- "email_client"
+ "data_extraction_goal"
],
- "title": "EmailInboxBlock"
+ "title": "ExtractionBlockYAML"
},
- "EmailInboxBlockYAML": {
+ "FileDownloadBlock": {
"properties": {
- "block_type": {
- "type": "string",
- "const": "email_inbox",
- "title": "Block Type",
- "default": "email_inbox"
- },
"label": {
"type": "string",
"title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
+ "description": "Author-facing identifier for a block; unique within a workflow."
},
"next_block_label": {
"anyOf": [
@@ -12564,7 +15457,16 @@
}
],
"title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ },
+ "block_type": {
+ "type": "string",
+ "const": "file_download",
+ "title": "Block Type",
+ "default": "file_download"
+ },
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
},
"continue_on_failure": {
"type": "boolean",
@@ -12583,6 +15485,11 @@
],
"title": "Model"
},
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
"ignore_workflow_system_prompt": {
"type": "boolean",
"title": "Ignore Workflow System Prompt",
@@ -12593,15 +15500,18 @@
"title": "Next Loop On Failure",
"default": false
},
- "email_client": {
- "type": "string",
- "enum": [
- "gmail",
- "outlook"
+ "s3_bucket": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
],
- "title": "Email Client"
+ "title": "S3 Bucket"
},
- "credential_id": {
+ "aws_access_key_id": {
"anyOf": [
{
"type": "string"
@@ -12610,9 +15520,9 @@
"type": "null"
}
],
- "title": "Credential Id"
+ "title": "Aws Access Key Id"
},
- "folder": {
+ "aws_secret_access_key": {
"anyOf": [
{
"type": "string"
@@ -12621,9 +15531,9 @@
"type": "null"
}
],
- "title": "Folder"
+ "title": "Aws Secret Access Key"
},
- "prompt": {
+ "region_name": {
"anyOf": [
{
"type": "string"
@@ -12632,9 +15542,9 @@
"type": "null"
}
],
- "title": "Prompt"
+ "title": "Region Name"
},
- "sender": {
+ "endpoint_url": {
"anyOf": [
{
"type": "string"
@@ -12643,9 +15553,9 @@
"type": "null"
}
],
- "title": "Sender"
+ "title": "Endpoint Url"
},
- "subject": {
+ "azure_storage_account_name": {
"anyOf": [
{
"type": "string"
@@ -12654,98 +15564,98 @@
"type": "null"
}
],
- "title": "Subject"
+ "title": "Azure Storage Account Name"
},
- "newer_than_days": {
+ "azure_storage_account_key": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Newer Than Days"
+ "title": "Azure Storage Account Key"
},
- "max_results": {
- "type": "integer",
- "title": "Max Results",
- "default": 25
+ "azure_blob_container_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Blob Container Name"
},
- "include_body": {
- "type": "boolean",
- "title": "Include Body",
- "default": true
+ "google_credential_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Google Credential Id"
},
- "parameter_keys": {
+ "google_drive_folder_id": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Parameter Keys"
- }
- },
- "type": "object",
- "required": [
- "label",
- "email_client"
- ],
- "title": "EmailInboxBlockYAML"
- },
- "ExtendBrowserSessionRequest": {
- "properties": {
- "additional_minutes": {
- "type": "integer",
- "minimum": 1.0,
- "title": "Additional Minutes",
- "description": "Minutes to add to the session's current deadline. A session can be extended, one or more times, up to a total lifetime of 360 minutes (6 hours) counted from when it started; a request for more than the remaining headroom is granted the remainder and the response carries a warning."
- }
- },
- "type": "object",
- "required": [
- "additional_minutes"
- ],
- "title": "ExtendBrowserSessionRequest"
- },
- "Extensions": {
- "type": "string",
- "enum": [
- "ad-blocker",
- "captcha-solver"
- ],
- "title": "Extensions"
- },
- "ExtractAction": {
- "properties": {
- "type": {
- "type": "string",
- "const": "extract",
- "title": "Type",
- "default": "extract"
+ "title": "Google Drive Folder Id"
},
- "prompt": {
- "type": "string",
- "title": "Prompt",
- "description": "Extraction prompt",
- "default": ""
+ "sftp_host": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Host"
},
- "extract_schema": {
+ "sftp_port": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "integer"
},
{
- "items": {},
- "type": "array"
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Port"
+ },
+ "sftp_username": {
+ "anyOf": [
+ {
+ "type": "string"
},
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Username"
+ },
+ "sftp_password": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Password"
+ },
+ "sftp_private_key": {
+ "anyOf": [
{
"type": "string"
},
@@ -12753,25 +15663,20 @@
"type": "null"
}
],
- "title": "Extract Schema",
- "description": "Schema for extraction"
+ "title": "Sftp Private Key"
},
- "error_code_mapping": {
+ "sftp_private_key_passphrase": {
"anyOf": [
{
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Error Code Mapping",
- "description": "Error code mapping for extraction"
+ "title": "Sftp Private Key Passphrase"
},
- "intention": {
+ "sftp_remote_path": {
"anyOf": [
{
"type": "string"
@@ -12780,38 +15685,20 @@
"type": "null"
}
],
- "title": "Intention",
- "description": "The intention or goal of the extraction"
+ "title": "Sftp Remote Path"
},
- "data": {
+ "sftp_host_key": {
"anyOf": [
{
"type": "string"
},
- {
- "additionalProperties": true,
- "type": "object"
- },
{
"type": "null"
}
],
- "title": "Data",
- "description": "Additional context data"
- }
- },
- "type": "object",
- "title": "ExtractAction",
- "description": "Extract data action parameters."
- },
- "ExtractionBlock": {
- "properties": {
- "label": {
- "type": "string",
- "title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "title": "Sftp Host Key"
},
- "next_block_label": {
+ "prompt": {
"anyOf": [
{
"type": "string"
@@ -12820,48 +15707,24 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
- },
- "block_type": {
- "type": "string",
- "const": "extraction",
- "title": "Block Type",
- "default": "extraction"
- },
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "title": "Prompt",
+ "description": "Optional natural-language control over which downloaded files are uploaded; empty means upload all."
},
- "model": {
+ "path": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "title": "Path"
},
- "next_loop_on_failure": {
+ "continue_on_empty": {
"type": "boolean",
- "title": "Next Loop On Failure",
+ "title": "Continue On Empty",
+ "description": "When the run download directory has no files, allow the empty upload only after confirming no registered, browser-session, or alternate candidate downloads exist (False, default). Set True to always allow an empty upload.",
"default": false
},
"task_type": {
@@ -12886,8 +15749,19 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
},
"complete_criterion": {
"anyOf": [
@@ -12900,6 +15774,11 @@
],
"title": "Complete Criterion"
},
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
"terminate_criterion": {
"anyOf": [
{
@@ -12923,7 +15802,14 @@
"title": "Navigation Goal"
},
"data_extraction_goal": {
- "type": "string",
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Data Extraction Goal"
},
"data_schema": {
@@ -13058,198 +15944,69 @@
"type": "null"
}
],
- "title": "Totp Verification Url"
- },
- "totp_identifier": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Totp Identifier"
- },
- "complete_verification": {
- "type": "boolean",
- "title": "Complete Verification",
- "default": true
- },
- "include_action_history_in_verification": {
- "type": "boolean",
- "title": "Include Action History In Verification",
- "default": false
- },
- "download_timeout": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Download Timeout"
- },
- "include_extracted_text": {
- "type": "boolean",
- "title": "Include Extracted Text",
- "default": false
- }
- },
- "type": "object",
- "required": [
- "label",
- "output_parameter",
- "data_extraction_goal"
- ],
- "title": "ExtractionBlock"
- },
- "ExtractionBlockYAML": {
- "properties": {
- "block_type": {
- "type": "string",
- "const": "extraction",
- "title": "Block Type",
- "default": "extraction"
- },
- "label": {
- "type": "string",
- "title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
- },
- "next_block_label": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
- },
- "model": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
- },
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
- },
- "data_extraction_goal": {
- "type": "string",
- "title": "Data Extraction Goal"
- },
- "url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Url"
- },
- "title": {
- "type": "string",
- "title": "Title",
- "default": ""
- },
- "engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
- },
- "data_schema": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "items": {},
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Data Schema"
- },
- "max_retries": {
- "type": "integer",
- "title": "Max Retries",
- "default": 0
+ "title": "Totp Verification Url"
},
- "max_steps_per_run": {
+ "totp_identifier": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Max Steps Per Run"
+ "title": "Totp Identifier"
},
- "parameter_keys": {
+ "complete_verification": {
+ "type": "boolean",
+ "title": "Complete Verification",
+ "default": true
+ },
+ "include_action_history_in_verification": {
+ "type": "boolean",
+ "title": "Include Action History In Verification",
+ "default": false
+ },
+ "download_timeout": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Parameter Keys"
+ "title": "Download Timeout"
},
- "disable_cache": {
+ "include_extracted_text": {
"type": "boolean",
- "title": "Disable Cache",
- "default": false
+ "title": "Include Extracted Text",
+ "default": true
+ },
+ "download_target": {
+ "$ref": "#/components/schemas/FileDownloadTarget",
+ "default": "website"
}
},
"type": "object",
"required": [
"label",
- "data_extraction_goal"
+ "output_parameter"
],
- "title": "ExtractionBlockYAML"
+ "title": "FileDownloadBlock"
},
- "FileDownloadBlock": {
+ "FileDownloadBlockYAML": {
"properties": {
+ "block_type": {
+ "type": "string",
+ "const": "file_download",
+ "title": "Block Type",
+ "default": "file_download"
+ },
"label": {
"type": "string",
"title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "description": "Author-facing identifier; must be unique per workflow."
},
"next_block_label": {
"anyOf": [
@@ -13261,16 +16018,7 @@
}
],
"title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
- },
- "block_type": {
- "type": "string",
- "const": "file_download",
- "title": "Block Type",
- "default": "file_download"
- },
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
},
"continue_on_failure": {
"type": "boolean",
@@ -13289,11 +16037,6 @@
],
"title": "Model"
},
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
"ignore_workflow_system_prompt": {
"type": "boolean",
"title": "Ignore Workflow System Prompt",
@@ -13304,12 +16047,11 @@
"title": "Next Loop On Failure",
"default": false
},
- "task_type": {
- "type": "string",
- "title": "Task Type",
- "default": "general"
+ "download_target": {
+ "$ref": "#/components/schemas/FileDownloadTarget",
+ "default": "website"
},
- "url": {
+ "s3_bucket": {
"anyOf": [
{
"type": "string"
@@ -13318,18 +16060,20 @@
"type": "null"
}
],
- "title": "Url"
- },
- "title": {
- "type": "string",
- "title": "Title",
- "default": ""
+ "title": "S3 Bucket"
},
- "engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "aws_access_key_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Aws Access Key Id"
},
- "complete_criterion": {
+ "aws_secret_access_key": {
"anyOf": [
{
"type": "string"
@@ -13338,9 +16082,9 @@
"type": "null"
}
],
- "title": "Complete Criterion"
+ "title": "Aws Secret Access Key"
},
- "terminate_criterion": {
+ "region_name": {
"anyOf": [
{
"type": "string"
@@ -13349,9 +16093,9 @@
"type": "null"
}
],
- "title": "Terminate Criterion"
+ "title": "Region Name"
},
- "navigation_goal": {
+ "endpoint_url": {
"anyOf": [
{
"type": "string"
@@ -13360,9 +16104,9 @@
"type": "null"
}
],
- "title": "Navigation Goal"
+ "title": "Endpoint Url"
},
- "data_extraction_goal": {
+ "azure_storage_account_name": {
"anyOf": [
{
"type": "string"
@@ -13371,18 +16115,32 @@
"type": "null"
}
],
- "title": "Data Extraction Goal"
+ "title": "Azure Storage Account Name"
},
- "data_schema": {
+ "azure_storage_account_key": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
- "items": {},
- "type": "array"
+ "type": "null"
+ }
+ ],
+ "title": "Azure Storage Account Key"
+ },
+ "azure_blob_container_name": {
+ "anyOf": [
+ {
+ "type": "string"
},
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Blob Container Name"
+ },
+ "google_credential_id": {
+ "anyOf": [
{
"type": "string"
},
@@ -13390,28 +16148,31 @@
"type": "null"
}
],
- "title": "Data Schema"
+ "title": "Google Credential Id"
},
- "error_code_mapping": {
+ "google_drive_folder_id": {
"anyOf": [
{
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Error Code Mapping"
+ "title": "Google Drive Folder Id"
},
- "max_retries": {
- "type": "integer",
- "title": "Max Retries",
- "default": 0
+ "sftp_host": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Host"
},
- "max_steps_per_run": {
+ "sftp_port": {
"anyOf": [
{
"type": "integer"
@@ -13420,72 +16181,20 @@
"type": "null"
}
],
- "title": "Max Steps Per Run"
+ "title": "Sftp Port"
},
- "parameters": {
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/WorkflowParameter"
- },
- {
- "$ref": "#/components/schemas/ContextParameter"
- },
- {
- "$ref": "#/components/schemas/AWSSecretParameter"
- },
- {
- "$ref": "#/components/schemas/AzureSecretParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
- },
- {
- "$ref": "#/components/schemas/OnePasswordCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/AzureVaultCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/OutputParameter"
- },
- {
- "$ref": "#/components/schemas/CredentialParameter"
- }
- ],
- "discriminator": {
- "propertyName": "parameter_type",
- "mapping": {
- "aws_secret": "#/components/schemas/AWSSecretParameter",
- "azure_secret": "#/components/schemas/AzureSecretParameter",
- "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
- "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
- "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
- "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
- "context": "#/components/schemas/ContextParameter",
- "credential": "#/components/schemas/CredentialParameter",
- "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
- "output": "#/components/schemas/OutputParameter",
- "workflow": "#/components/schemas/WorkflowParameter"
- }
+ "sftp_username": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- },
- "type": "array",
- "title": "Parameters",
- "default": []
- },
- "complete_on_download": {
- "type": "boolean",
- "title": "Complete On Download",
- "default": false
+ ],
+ "title": "Sftp Username"
},
- "download_suffix": {
+ "sftp_password": {
"anyOf": [
{
"type": "string"
@@ -13494,9 +16203,9 @@
"type": "null"
}
],
- "title": "Download Suffix"
+ "title": "Sftp Password"
},
- "totp_verification_url": {
+ "sftp_private_key": {
"anyOf": [
{
"type": "string"
@@ -13505,9 +16214,9 @@
"type": "null"
}
],
- "title": "Totp Verification Url"
+ "title": "Sftp Private Key"
},
- "totp_identifier": {
+ "sftp_private_key_passphrase": {
"anyOf": [
{
"type": "string"
@@ -13516,56 +16225,31 @@
"type": "null"
}
],
- "title": "Totp Identifier"
- },
- "complete_verification": {
- "type": "boolean",
- "title": "Complete Verification",
- "default": true
+ "title": "Sftp Private Key Passphrase"
},
- "include_action_history_in_verification": {
- "type": "boolean",
- "title": "Include Action History In Verification",
- "default": false
+ "sftp_remote_path": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Remote Path"
},
- "download_timeout": {
+ "sftp_host_key": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Download Timeout"
- },
- "include_extracted_text": {
- "type": "boolean",
- "title": "Include Extracted Text",
- "default": true
- }
- },
- "type": "object",
- "required": [
- "label",
- "output_parameter"
- ],
- "title": "FileDownloadBlock"
- },
- "FileDownloadBlockYAML": {
- "properties": {
- "block_type": {
- "type": "string",
- "const": "file_download",
- "title": "Block Type",
- "default": "file_download"
- },
- "label": {
- "type": "string",
- "title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
+ "title": "Sftp Host Key"
},
- "next_block_label": {
+ "path": {
"anyOf": [
{
"type": "string"
@@ -13574,34 +16258,22 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "title": "Path"
},
- "model": {
+ "prompt": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "title": "Prompt"
},
- "next_loop_on_failure": {
+ "continue_on_empty": {
"type": "boolean",
- "title": "Next Loop On Failure",
+ "title": "Continue On Empty",
"default": false
},
"navigation_goal": {
@@ -13625,8 +16297,20 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "description": "Set to true only when skyvern-1.0 was explicitly chosen for this block; leave it unset otherwise.",
+ "default": false
},
"error_code_mapping": {
"anyOf": [
@@ -13729,6 +16413,17 @@
],
"title": "FileDownloadBlockYAML"
},
+ "FileDownloadTarget": {
+ "type": "string",
+ "enum": [
+ "website",
+ "s3",
+ "azure",
+ "google_drive",
+ "sftp"
+ ],
+ "title": "FileDownloadTarget"
+ },
"FileEncoding": {
"type": "string",
"enum": [
@@ -13966,6 +16661,17 @@
}
],
"title": "Json Schema"
+ },
+ "worksheet": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Worksheet"
}
},
"type": "object",
@@ -14047,6 +16753,17 @@
}
],
"title": "Json Schema"
+ },
+ "worksheet": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Worksheet"
}
},
"type": "object",
@@ -14139,10 +16856,6 @@
"title": "Next Loop On Failure",
"default": false
},
- "storage_type": {
- "$ref": "#/components/schemas/FileStorageType",
- "default": "s3"
- },
"s3_bucket": {
"anyOf": [
{
@@ -14187,6 +16900,17 @@
],
"title": "Region Name"
},
+ "endpoint_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Endpoint Url"
+ },
"azure_storage_account_name": {
"anyOf": [
{
@@ -14358,6 +17082,10 @@
"title": "Continue On Empty",
"description": "When the run download directory has no files, allow the empty upload only after confirming no registered, browser-session, or alternate candidate downloads exist (False, default). Set True to always allow an empty upload.",
"default": false
+ },
+ "storage_type": {
+ "$ref": "#/components/schemas/FileStorageType",
+ "default": "s3"
}
},
"type": "object",
@@ -14467,6 +17195,17 @@
],
"title": "Region Name"
},
+ "endpoint_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Endpoint Url"
+ },
"azure_storage_account_name": {
"anyOf": [
{
@@ -14902,6 +17641,9 @@
{
"$ref": "#/components/schemas/HttpRequestBlock"
},
+ {
+ "$ref": "#/components/schemas/WebSearchBlock"
+ },
{
"$ref": "#/components/schemas/PrintPageBlock"
},
@@ -14922,6 +17664,12 @@
},
{
"$ref": "#/components/schemas/SplitPdfBlock"
+ },
+ {
+ "$ref": "#/components/schemas/DataExportBlock"
+ },
+ {
+ "$ref": "#/components/schemas/TerminateBlock"
}
],
"discriminator": {
@@ -14930,6 +17678,7 @@
"action": "#/components/schemas/ActionBlock",
"code": "#/components/schemas/CodeBlock",
"conditional": "#/components/schemas/ConditionalBlock",
+ "data_export": "#/components/schemas/DataExportBlock",
"download_to_s3": "#/components/schemas/DownloadToS3Block",
"email_inbox": "#/components/schemas/EmailInboxBlock",
"extraction": "#/components/schemas/ExtractionBlock",
@@ -14951,10 +17700,12 @@
"split_pdf": "#/components/schemas/SplitPdfBlock",
"task": "#/components/schemas/TaskBlock",
"task_v2": "#/components/schemas/TaskV2Block",
+ "terminate": "#/components/schemas/TerminateBlock",
"text_prompt": "#/components/schemas/TextPromptBlock",
"upload_to_s3": "#/components/schemas/UploadToS3Block",
"validation": "#/components/schemas/ValidationBlock",
"wait": "#/components/schemas/WaitBlock",
+ "web_search": "#/components/schemas/WebSearchBlock",
"while_loop": "#/components/schemas/WhileLoopBlock",
"workflow_trigger": "#/components/schemas/WorkflowTriggerBlock"
}
@@ -15173,6 +17924,12 @@
{
"$ref": "#/components/schemas/FileDownloadBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/DataExportBlockYAML"
+ },
+ {
+ "$ref": "#/components/schemas/TerminateBlockYAML"
+ },
{
"$ref": "#/components/schemas/UrlBlockYAML"
},
@@ -15185,6 +17942,9 @@
{
"$ref": "#/components/schemas/HttpRequestBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/WebSearchBlockYAML"
+ },
{
"$ref": "#/components/schemas/ConditionalBlockYAML"
},
@@ -15310,6 +18070,12 @@
"London",
"Berlin"
]
+ },
+ "isISP": {
+ "type": "boolean",
+ "title": "Isisp",
+ "description": "Whether this geo target is marked as an ISP proxy location.",
+ "default": false
}
},
"type": "object",
@@ -16431,9 +19197,21 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ],
"default": "skyvern-1.0"
},
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
+ },
"complete_criterion": {
"anyOf": [
{
@@ -16445,6 +19223,11 @@
],
"title": "Complete Criterion"
},
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
"terminate_criterion": {
"anyOf": [
{
@@ -16691,6 +19474,10 @@
"type": "string",
"title": "Body",
"default": "Your interaction is required for a workflow run!"
+ },
+ "body_format": {
+ "$ref": "#/components/schemas/EmailBodyFormat",
+ "default": "text"
}
},
"type": "object",
@@ -16794,6 +19581,10 @@
"type": "string",
"title": "Body",
"default": "Your interaction is required for a workflow run!"
+ },
+ "body_format": {
+ "$ref": "#/components/schemas/EmailBodyFormat",
+ "default": "text"
}
},
"type": "object",
@@ -17000,7 +19791,150 @@
"type": "string",
"title": "Expression"
},
- "description": {
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Description"
+ }
+ },
+ "type": "object",
+ "required": [
+ "expression"
+ ],
+ "title": "JinjaBranchCriteria",
+ "description": "Jinja2-templated branch criteria (only supported criteria type for now)."
+ },
+ "JobRecipeOutcome": {
+ "type": "string",
+ "enum": [
+ "completed",
+ "canceled",
+ "job_unavailable",
+ "login_required",
+ "application_refused",
+ "blocked_by_site",
+ "invalid_input",
+ "insufficient_credits",
+ "incomplete",
+ "failed"
+ ],
+ "title": "JobRecipeOutcome"
+ },
+ "JobRecipeRunListResponse": {
+ "properties": {
+ "runs": {
+ "items": {
+ "$ref": "#/components/schemas/JobRecipeRunSummary"
+ },
+ "type": "array",
+ "title": "Runs"
+ },
+ "page": {
+ "type": "integer",
+ "title": "Page"
+ },
+ "page_size": {
+ "type": "integer",
+ "title": "Page Size"
+ },
+ "has_next": {
+ "type": "boolean",
+ "title": "Has Next"
+ }
+ },
+ "additionalProperties": false,
+ "type": "object",
+ "required": [
+ "runs",
+ "page",
+ "page_size",
+ "has_next"
+ ],
+ "title": "JobRecipeRunListResponse"
+ },
+ "JobRecipeRunResponse": {
+ "properties": {
+ "workflow_run_id": {
+ "type": "string",
+ "pattern": "^wr_",
+ "title": "Workflow Run Id"
+ }
+ },
+ "additionalProperties": false,
+ "type": "object",
+ "required": [
+ "workflow_run_id"
+ ],
+ "title": "JobRecipeRunResponse"
+ },
+ "JobRecipeRunSummary": {
+ "properties": {
+ "workflow_run_id": {
+ "type": "string",
+ "pattern": "^wr_",
+ "title": "Workflow Run Id"
+ },
+ "workflow_permanent_id": {
+ "type": "string",
+ "title": "Workflow Permanent Id"
+ },
+ "recipe": {
+ "type": "string",
+ "enum": [
+ "apply",
+ "extract"
+ ],
+ "title": "Recipe"
+ },
+ "status": {
+ "type": "string",
+ "title": "Status"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ },
+ "job_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Job Url"
+ },
+ "failure_reason": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Failure Reason"
+ },
+ "outcome": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/JobRecipeOutcome"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Typed result of a finished run; null while it is still running. Apply failures name their cause (job_unavailable, login_required, application_refused, blocked_by_site, invalid_input, insufficient_credits, incomplete); a cause Skyvern cannot classify is failed, and so is every Extract failure except one Skyvern itself reports, such as running out of credits."
+ },
+ "next_step": {
"anyOf": [
{
"type": "string"
@@ -17009,15 +19943,24 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Next Step",
+ "description": "What to do about an unsuccessful outcome; null for completed, canceled, and running runs."
}
},
+ "additionalProperties": false,
"type": "object",
"required": [
- "expression"
+ "workflow_run_id",
+ "workflow_permanent_id",
+ "recipe",
+ "status",
+ "created_at",
+ "job_url",
+ "failure_reason",
+ "outcome",
+ "next_step"
],
- "title": "JinjaBranchCriteria",
- "description": "Jinja2-templated branch criteria (only supported criteria type for now)."
+ "title": "JobRecipeRunSummary"
},
"LocateElementAction": {
"properties": {
@@ -17120,8 +20063,19 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
},
"complete_criterion": {
"anyOf": [
@@ -17134,6 +20088,11 @@
],
"title": "Complete Criterion"
},
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
"terminate_criterion": {
"anyOf": [
{
@@ -17420,8 +20379,20 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "description": "Set to true only when skyvern-1.0 was explicitly chosen for this block; leave it unset otherwise.",
+ "default": false
},
"navigation_goal": {
"anyOf": [
@@ -17532,6 +20503,11 @@
"title": "Complete Verification",
"default": true
},
+ "include_action_history_in_verification": {
+ "type": "boolean",
+ "title": "Include Action History In Verification",
+ "default": false
+ },
"skip_saved_profile": {
"type": "boolean",
"title": "Skip Saved Profile",
@@ -17632,6 +20608,12 @@
"title": "Browser Profile Id",
"description": "ID of a browser profile to reuse for this run"
},
+ "start_fresh_browser": {
+ "type": "boolean",
+ "title": "Start Fresh Browser",
+ "description": "When true, start this run from a fresh, empty browser and ignore any saved browser memory — no memory is read or written. A verified sign-in during the run still updates the credential's saved login.",
+ "default": false
+ },
"browser_address": {
"anyOf": [
{
@@ -17769,6 +20751,18 @@
"title": "Onepassword Item Id",
"description": "1Password item ID"
},
+ "onepassword_totp_field_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Onepassword Totp Field Name",
+ "description": "1Password item field id or label to treat as the TOTP secret, overriding 1Password's own field-type detection"
+ },
"azure_vault_name": {
"anyOf": [
{
@@ -17906,8 +20900,19 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
},
"complete_criterion": {
"anyOf": [
@@ -17920,6 +20925,11 @@
],
"title": "Complete Criterion"
},
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
"terminate_criterion": {
"anyOf": [
{
@@ -18199,8 +21209,20 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "description": "Set to true only when skyvern-1.0 was explicitly chosen for this block; leave it unset otherwise.",
+ "default": false
},
"error_code_mapping": {
"anyOf": [
@@ -18300,6 +21322,11 @@
],
"title": "Complete Criterion"
},
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
"terminate_criterion": {
"anyOf": [
{
@@ -18452,9 +21479,9 @@
"properties": {
"password": {
"type": "string",
- "minLength": 1,
"title": "Password",
- "description": "The password value (must not be empty)",
+ "description": "The password value; may be empty or omitted for logins that have no password",
+ "default": "",
"examples": [
"securepassword123"
]
@@ -18506,15 +21533,29 @@
"+14155550123"
]
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Metadata",
+ "description": "Optional additional password credential metadata fields"
}
},
"type": "object",
"required": [
- "password",
"username"
],
"title": "NonEmptyPasswordCredential",
- "description": "Password credential model that requires non-empty values."
+ "description": "Password credential model for API writes: non-empty username, optionally empty password."
},
"OTPType": {
"type": "string",
@@ -18563,6 +21604,28 @@
"type": "string",
"title": "Item Id"
},
+ "totp_field_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Totp Field Name"
+ },
+ "totp_identifier": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Totp Identifier"
+ },
"created_at": {
"type": "string",
"format": "date-time",
@@ -18628,6 +21691,28 @@
"item_id": {
"type": "string",
"title": "Item Id"
+ },
+ "totp_field_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Totp Field Name"
+ },
+ "totp_identifier": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Totp Identifier"
}
},
"type": "object",
@@ -18638,6 +21723,16 @@
],
"title": "OnePasswordCredentialParameterYAML"
},
+ "OneTimeDispatchStatus": {
+ "type": "string",
+ "enum": [
+ "pending",
+ "fired",
+ "canceled",
+ "failed"
+ ],
+ "title": "OneTimeDispatchStatus"
+ },
"OrganizationScheduleItem": {
"properties": {
"workflow_schedule_id": {
@@ -19132,6 +22227,12 @@
"+14155550123"
]
+ },
+ "has_totp": {
+ "type": "boolean",
+ "title": "Has Totp",
+ "description": "Whether the stored password credential includes a non-empty TOTP seed. Legacy rows with an unknown value report false until the credential is updated.",
+ "default": false
}
},
"type": "object",
@@ -19992,6 +23093,40 @@
],
"title": "RunTagHistoryResponse"
},
+ "RunTagSuggestionsResponse": {
+ "properties": {
+ "keys": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Keys",
+ "description": "Distinct grouped tag keys seen on runs."
+ },
+ "values_by_key": {
+ "additionalProperties": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "object",
+ "title": "Values By Key",
+ "description": "Values seen for each grouped key."
+ },
+ "labels": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Labels",
+ "description": "Distinct standalone (keyless) labels seen on runs."
+ }
+ },
+ "type": "object",
+ "title": "RunTagSuggestionsResponse",
+ "description": "Response for ``GET /v1/run-tag-suggestions``: distinct (key, value) pairs\never set on a run for the org, sourced from the event log rather than the\ntag-key/tag-value registry so reserved ``skyvern.*`` system keys (never\nregistered) reach the pickers too."
+ },
"RunTagsBatchRequest": {
"properties": {
"workflow_run_ids": {
@@ -20562,6 +23697,10 @@
"type": "string",
"title": "Body"
},
+ "body_format": {
+ "$ref": "#/components/schemas/EmailBodyFormat",
+ "default": "text"
+ },
"file_attachments": {
"items": {
"type": "string"
@@ -20585,8 +23724,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 65535.0,
- "minimum": 1.0
+ "maximum": 65535,
+ "minimum": 1
},
{
"type": "null"
@@ -20743,8 +23882,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 65535.0,
- "minimum": 1.0
+ "maximum": 65535,
+ "minimum": 1
},
{
"type": "null"
@@ -20793,6 +23932,10 @@
"type": "string",
"title": "Body"
},
+ "body_format": {
+ "$ref": "#/components/schemas/EmailBodyFormat",
+ "default": "text"
+ },
"file_attachments": {
"anyOf": [
{
@@ -21708,6 +24851,39 @@
"title": "TagValue",
"description": "Tag-value color registry entry: the palette color assigned to a grouped\n(key, value) pair."
},
+ "TagValueCreate": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "Key",
+ "description": "Tag key (group) for the new label."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "Tag value (label) to register under the key."
+ },
+ "color": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Color",
+ "description": "Palette color name for the label; a random palette color when omitted."
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "value"
+ ],
+ "title": "TagValueCreate",
+ "description": "Body for ``POST /v1/tag-values``: register a grouped label before any\nworkflow uses it. The label shows a zero workflow count until applied."
+ },
"TagValueDelete": {
"properties": {
"value": {
@@ -21932,8 +25108,19 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
},
"complete_criterion": {
"anyOf": [
@@ -21946,6 +25133,11 @@
],
"title": "Complete Criterion"
},
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
"terminate_criterion": {
"anyOf": [
{
@@ -22227,8 +25419,20 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "description": "Set to true only when skyvern-1.0 was explicitly chosen for this block; leave it unset otherwise.",
+ "default": false
},
"navigation_goal": {
"anyOf": [
@@ -22479,12 +25683,24 @@
"trigger_type": {
"anyOf": [
{
- "$ref": "#/components/schemas/WorkflowRunTriggerType"
+ "$ref": "#/components/schemas/WorkflowRunTriggerType"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "created_by": {
+ "anyOf": [
+ {
+ "type": "string"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Created By",
+ "description": "ID of the user who started the run"
}
},
"type": "object",
@@ -22686,6 +25902,24 @@
"pbs_123"
]
},
+ "browser_profile_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Profile Id",
+ "description": "ID of a browser profile to reuse for this task"
+ },
+ "start_fresh_browser": {
+ "type": "boolean",
+ "title": "Start Fresh Browser",
+ "description": "When true, start this run from a fresh, empty browser and ignore any saved browser memory — no memory is read or written. A verified sign-in during the run still updates the credential's saved login.",
+ "default": false
+ },
"model": {
"anyOf": [
{
@@ -22792,6 +26026,27 @@
"agent",
"code"
]
+ },
+ "file_ids": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "maxItems": 50
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File Ids",
+ "description": "\nIds of files uploaded through `POST /v1/upload_file` to attach to this run. Skyvern deletes an attached file as soon as the run finishes, so there is nothing to clean up afterwards. Reference an attached file by its id anywhere a file URL is accepted (for example in `parameters` or in the prompt) and no presigned URL is ever created for it. A file can be attached to one run at a time, and must not already be deleted.\n",
+ "examples": [
+ [
+ "file_123456789"
+ ]
+ ]
}
},
"type": "object",
@@ -22988,6 +26243,24 @@
"pbs_123"
]
},
+ "browser_profile_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Profile Id",
+ "description": "ID of a browser profile to reuse for this task"
+ },
+ "start_fresh_browser": {
+ "type": "boolean",
+ "title": "Start Fresh Browser",
+ "description": "When true, start this run from a fresh, empty browser and ignore any saved browser memory — no memory is read or written. A verified sign-in during the run still updates the credential's saved login.",
+ "default": false
+ },
"model": {
"anyOf": [
{
@@ -23094,6 +26367,27 @@
"agent",
"code"
]
+ },
+ "file_ids": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "maxItems": 50
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File Ids",
+ "description": "\nIds of files uploaded through `POST /v1/upload_file` to attach to this run. Skyvern deletes an attached file as soon as the run finishes, so there is nothing to clean up afterwards. Reference an attached file by its id anywhere a file URL is accepted (for example in `parameters` or in the prompt) and no presigned URL is ever created for it. A file can be attached to one run at a time, and must not already be deleted.\n",
+ "examples": [
+ [
+ "file_123456789"
+ ]
+ ]
}
},
"type": "object",
@@ -23121,6 +26415,7 @@
"created",
"queued",
"running",
+ "paused",
"timed_out",
"failed",
"terminated",
@@ -23626,6 +26921,238 @@
],
"title": "TaskV2BlockYAML"
},
+ "TelInputOutcome": {
+ "properties": {
+ "flag_enabled": {
+ "type": "boolean",
+ "title": "Flag Enabled"
+ },
+ "final_element_id": {
+ "type": "string",
+ "title": "Final Element Id"
+ },
+ "strategy": {
+ "$ref": "#/components/schemas/TelInputStrategy"
+ },
+ "expected_digit_count": {
+ "type": "integer",
+ "title": "Expected Digit Count"
+ },
+ "actual_digit_count": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Actual Digit Count"
+ },
+ "browser_valid": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Valid"
+ },
+ "attempt_count": {
+ "type": "integer",
+ "title": "Attempt Count"
+ },
+ "retargeted": {
+ "type": "boolean",
+ "title": "Retargeted"
+ }
+ },
+ "type": "object",
+ "required": [
+ "flag_enabled",
+ "final_element_id",
+ "strategy",
+ "expected_digit_count",
+ "attempt_count",
+ "retargeted"
+ ],
+ "title": "TelInputOutcome"
+ },
+ "TelInputStrategy": {
+ "type": "string",
+ "enum": [
+ "legacy_sequential",
+ "formatted_sequential",
+ "sequential_national",
+ "atomic_national",
+ "atomic_e164"
+ ],
+ "title": "TelInputStrategy"
+ },
+ "TerminateBlock": {
+ "properties": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
+ },
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ },
+ "block_type": {
+ "type": "string",
+ "const": "terminate",
+ "title": "Block Type",
+ "default": "terminate"
+ },
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
+ },
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "reason": {
+ "type": "string",
+ "title": "Reason"
+ },
+ "error_code": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error Code"
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "output_parameter",
+ "reason"
+ ],
+ "title": "TerminateBlock"
+ },
+ "TerminateBlockYAML": {
+ "properties": {
+ "block_type": {
+ "type": "string",
+ "const": "terminate",
+ "title": "Block Type",
+ "default": "terminate"
+ },
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
+ },
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "reason": {
+ "type": "string",
+ "minLength": 1,
+ "title": "Reason",
+ "description": "Why the run ends here; supports Jinja templating."
+ },
+ "error_code": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error Code",
+ "description": "Optional error code added to the run's error codes; supports Jinja templating. A literal code must be at most 128 characters. The rendered code must be at most 128 characters and may contain only ASCII letters, digits, underscores, periods, colons, and hyphens."
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "reason"
+ ],
+ "title": "TerminateBlockYAML"
+ },
"TextPromptBlock": {
"properties": {
"label": {
@@ -24323,6 +27850,31 @@
"type": "string",
"title": "Presigned Url",
"description": "Presigned URL to access the uploaded file"
+ },
+ "file_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File Id",
+ "description": "Identifier for this upload. Pass it to DELETE /v1/files/{file_id} to delete the file."
+ },
+ "expires_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Expires At",
+ "description": "When the file will be deleted, if a retention_days was supplied. Null means the file has no expiry of its own and follows the organization's data retention policy."
}
},
"type": "object",
@@ -24556,9 +28108,21 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ],
"default": "skyvern-1.0"
},
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
+ },
"complete_criterion": {
"anyOf": [
{
@@ -24570,6 +28134,11 @@
],
"title": "Complete Criterion"
},
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
"terminate_criterion": {
"anyOf": [
{
@@ -24994,8 +28563,19 @@
"default": ""
},
"engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "default": false
},
"complete_criterion": {
"anyOf": [
@@ -25008,6 +28588,11 @@
],
"title": "Complete Criterion"
},
+ "complete_criterion_is_untrusted": {
+ "type": "boolean",
+ "title": "Complete Criterion Is Untrusted",
+ "default": false
+ },
"terminate_criterion": {
"anyOf": [
{
@@ -25277,6 +28862,22 @@
"title": "Next Loop On Failure",
"default": false
},
+ "engine": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "engine_pinned": {
+ "type": "boolean",
+ "title": "Engine Pinned",
+ "description": "Set to true only when skyvern-1.0 was explicitly chosen for this block; leave it unset otherwise.",
+ "default": false
+ },
"complete_criterion": {
"anyOf": [
{
@@ -25313,6 +28914,17 @@
],
"title": "Error Code Mapping"
},
+ "max_steps_per_run": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Max Steps Per Run"
+ },
"parameter_keys": {
"anyOf": [
{
@@ -25378,13 +28990,208 @@
},
"type": "object",
"required": [
- "loc",
- "msg",
- "type"
+ "loc",
+ "msg",
+ "type"
+ ],
+ "title": "ValidationError"
+ },
+ "WaitBlock": {
+ "properties": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
+ },
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ },
+ "block_type": {
+ "type": "string",
+ "const": "wait",
+ "title": "Block Type",
+ "default": "wait"
+ },
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
+ },
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop 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/AzureSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "parameter_type",
+ "mapping": {
+ "aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
+ "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
+ "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
+ "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
+ "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
+ "context": "#/components/schemas/ContextParameter",
+ "credential": "#/components/schemas/CredentialParameter",
+ "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
+ "output": "#/components/schemas/OutputParameter",
+ "workflow": "#/components/schemas/WorkflowParameter"
+ }
+ }
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "output_parameter",
+ "wait_sec"
+ ],
+ "title": "WaitBlock"
+ },
+ "WaitBlockYAML": {
+ "properties": {
+ "block_type": {
+ "type": "string",
+ "const": "wait",
+ "title": "Block Type",
+ "default": "wait"
+ },
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
+ },
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "wait_sec": {
+ "type": "integer",
+ "title": "Wait Sec",
+ "default": 0
+ }
+ },
+ "type": "object",
+ "required": [
+ "label"
],
- "title": "ValidationError"
+ "title": "WaitBlockYAML"
},
- "WaitBlock": {
+ "WebSearchBlock": {
"properties": {
"label": {
"type": "string",
@@ -25405,9 +29212,9 @@
},
"block_type": {
"type": "string",
- "const": "wait",
+ "const": "web_search",
"title": "Block Type",
- "default": "wait"
+ "default": "web_search"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
@@ -25444,9 +29251,94 @@
"title": "Next Loop On Failure",
"default": false
},
- "wait_sec": {
+ "query": {
+ "type": "string",
+ "minLength": 1,
+ "title": "Query"
+ },
+ "provider": {
+ "type": "string",
+ "enum": [
+ "auto",
+ "google",
+ "exa"
+ ],
+ "title": "Provider",
+ "default": "auto"
+ },
+ "num_results": {
"type": "integer",
- "title": "Wait Sec"
+ "maximum": 100,
+ "minimum": 1,
+ "title": "Num Results",
+ "default": 10
+ },
+ "no_results_error_code": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "No Results Error Code",
+ "description": "Deprecated. Use error_code_mapping.",
+ "deprecated": true
+ },
+ "no_match_error_code": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "No Match Error Code",
+ "description": "Deprecated. Use error_code_mapping.",
+ "deprecated": true
+ },
+ "error_code_mapping": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error Code Mapping"
+ },
+ "prompt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Prompt"
+ },
+ "json_schema": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Json Schema"
},
"parameters": {
"items": {
@@ -25511,17 +29403,17 @@
"required": [
"label",
"output_parameter",
- "wait_sec"
+ "query"
],
- "title": "WaitBlock"
+ "title": "WebSearchBlock"
},
- "WaitBlockYAML": {
+ "WebSearchBlockYAML": {
"properties": {
"block_type": {
"type": "string",
- "const": "wait",
+ "const": "web_search",
"title": "Block Type",
- "default": "wait"
+ "default": "web_search"
},
"label": {
"type": "string",
@@ -25567,17 +29459,116 @@
"title": "Next Loop On Failure",
"default": false
},
- "wait_sec": {
+ "query": {
+ "type": "string",
+ "minLength": 1,
+ "title": "Query"
+ },
+ "provider": {
+ "type": "string",
+ "enum": [
+ "auto",
+ "google",
+ "exa"
+ ],
+ "title": "Provider",
+ "default": "auto"
+ },
+ "num_results": {
"type": "integer",
- "title": "Wait Sec",
- "default": 0
+ "maximum": 100,
+ "minimum": 1,
+ "title": "Num Results",
+ "default": 10
+ },
+ "no_results_error_code": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "No Results Error Code",
+ "description": "Deprecated. Use error_code_mapping.",
+ "deprecated": true
+ },
+ "no_match_error_code": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "No Match Error Code",
+ "description": "Deprecated. Use error_code_mapping.",
+ "deprecated": true
+ },
+ "error_code_mapping": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error Code Mapping"
+ },
+ "prompt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Prompt"
+ },
+ "json_schema": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Json Schema"
+ },
+ "parameter_keys": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Parameter Keys"
}
},
"type": "object",
"required": [
- "label"
+ "label",
+ "query"
],
- "title": "WaitBlockYAML"
+ "title": "WebSearchBlockYAML"
},
"WhileLoopBlock": {
"properties": {
@@ -25711,6 +29702,9 @@
{
"$ref": "#/components/schemas/HttpRequestBlock"
},
+ {
+ "$ref": "#/components/schemas/WebSearchBlock"
+ },
{
"$ref": "#/components/schemas/PrintPageBlock"
},
@@ -25731,6 +29725,12 @@
},
{
"$ref": "#/components/schemas/SplitPdfBlock"
+ },
+ {
+ "$ref": "#/components/schemas/DataExportBlock"
+ },
+ {
+ "$ref": "#/components/schemas/TerminateBlock"
}
],
"discriminator": {
@@ -25739,6 +29739,7 @@
"action": "#/components/schemas/ActionBlock",
"code": "#/components/schemas/CodeBlock",
"conditional": "#/components/schemas/ConditionalBlock",
+ "data_export": "#/components/schemas/DataExportBlock",
"download_to_s3": "#/components/schemas/DownloadToS3Block",
"email_inbox": "#/components/schemas/EmailInboxBlock",
"extraction": "#/components/schemas/ExtractionBlock",
@@ -25760,10 +29761,12 @@
"split_pdf": "#/components/schemas/SplitPdfBlock",
"task": "#/components/schemas/TaskBlock",
"task_v2": "#/components/schemas/TaskV2Block",
+ "terminate": "#/components/schemas/TerminateBlock",
"text_prompt": "#/components/schemas/TextPromptBlock",
"upload_to_s3": "#/components/schemas/UploadToS3Block",
"validation": "#/components/schemas/ValidationBlock",
"wait": "#/components/schemas/WaitBlock",
+ "web_search": "#/components/schemas/WebSearchBlock",
"while_loop": "#/components/schemas/WhileLoopBlock",
"workflow_trigger": "#/components/schemas/WorkflowTriggerBlock"
}
@@ -25799,7 +29802,7 @@
"condition"
],
"title": "WhileLoopBlock",
- "description": "Loop block driven by a runtime condition. Iterates while ``condition`` evaluates truthy.\n\nTop-of-loop semantics: the condition is evaluated *before* each iteration (including the\nfirst). If the condition is false on the first check, the body never runs and the block\nreturns success with an empty output list.\n\nSafety: the loop is capped at ``DEFAULT_MAX_LOOP_ITERATIONS`` (500). Reaching the cap is\ntreated as a failure so that a misbehaving condition can never spin forever."
+ "description": "Loop block driven by a runtime condition. Iterates while ``condition`` evaluates truthy.\n\nTop-of-loop semantics: the condition is evaluated *before* each iteration (including the\nfirst). If the condition is false on the first check, the body never runs and the block\nreturns success with an empty output list.\n\nSafety: the loop is capped at ``DEFAULT_MAX_LOOP_ITERATIONS`` (1000). Reaching the cap is\ntreated as a failure so that a misbehaving condition can never spin forever."
},
"WhileLoopBlockYAML": {
"properties": {
@@ -25910,6 +29913,12 @@
{
"$ref": "#/components/schemas/FileDownloadBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/DataExportBlockYAML"
+ },
+ {
+ "$ref": "#/components/schemas/TerminateBlockYAML"
+ },
{
"$ref": "#/components/schemas/UrlBlockYAML"
},
@@ -25922,6 +29931,9 @@
{
"$ref": "#/components/schemas/HttpRequestBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/WebSearchBlockYAML"
+ },
{
"$ref": "#/components/schemas/ConditionalBlockYAML"
},
@@ -26064,6 +30076,16 @@
"title": "Persist Browser Session",
"default": false
},
+ "reuse_browser_session": {
+ "type": "boolean",
+ "title": "Reuse Browser Session",
+ "default": false
+ },
+ "mask_secrets": {
+ "type": "boolean",
+ "title": "Mask Secrets",
+ "default": false
+ },
"pin_saved_session_ip": {
"type": "boolean",
"title": "Pin Saved Session Ip",
@@ -26162,6 +30184,17 @@
"title": "Run With",
"default": "agent"
},
+ "browser_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Type"
+ },
"ai_fallback": {
"type": "boolean",
"title": "Ai Fallback",
@@ -26275,6 +30308,42 @@
"title": "Copilot Authored",
"default": false
},
+ "effective_default_engine": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/RunEngine"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The engine a task block with no `engine` set runs on in this agent, or null when engine routing decides it. Populated by the detail endpoint only."
+ },
+ "original_created_by": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Original Created By",
+ "description": "Who created the agent's first version. Populated by the list endpoint only."
+ },
+ "original_created_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Original Created At",
+ "description": "When the agent's first version was created. Populated by the list endpoint only."
+ },
"created_at": {
"type": "string",
"format": "date-time",
@@ -26325,6 +30394,18 @@
"type": "string",
"title": "Title"
},
+ "recording_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Recording Id",
+ "description": "Durable browser recording to attach to the workflow version created by this save."
+ },
"description": {
"anyOf": [
{
@@ -26352,7 +30433,8 @@
"type": "null"
}
],
- "title": "Proxy Location"
+ "title": "Proxy Location",
+ "description": "On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it."
},
"webhook_callback_url": {
"anyOf": [
@@ -26363,7 +30445,8 @@
"type": "null"
}
],
- "title": "Webhook Callback Url"
+ "title": "Webhook Callback Url",
+ "description": "On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it. URL validation errors identify the field and failure class without returning the URL or host."
},
"totp_verification_url": {
"anyOf": [
@@ -26374,23 +30457,42 @@
"type": "null"
}
],
- "title": "Totp Verification Url"
+ "title": "Totp Verification Url",
+ "description": "On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it. URL validation errors identify the field and failure class without returning the URL or host."
+ },
+ "totp_identifier": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Totp Identifier",
+ "description": "On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it."
+ },
+ "persist_browser_session": {
+ "type": "boolean",
+ "title": "Persist Browser Session",
+ "default": false
},
- "totp_identifier": {
+ "reuse_browser_session": {
+ "type": "boolean",
+ "title": "Reuse Browser Session",
+ "default": false
+ },
+ "mask_secrets": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Totp Identifier"
- },
- "persist_browser_session": {
- "type": "boolean",
- "title": "Persist Browser Session",
- "default": false
+ "title": "Mask Secrets",
+ "description": "Mask secret values across this workflow's runs: hide them while they are typed (screenshots, recordings, live view) and redact them from stored artifacts, network logs, and LLM-bound text."
},
"pin_saved_session_ip": {
"type": "boolean",
@@ -26475,7 +30577,8 @@
"type": "null"
}
],
- "title": "Extra Http Headers"
+ "title": "Extra Http Headers",
+ "description": "On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it. An empty object ({}) clears the header map. Values, including ***, are literal."
},
"cdp_connect_headers": {
"anyOf": [
@@ -26489,7 +30592,8 @@
"type": "null"
}
],
- "title": "Cdp Connect Headers"
+ "title": "Cdp Connect Headers",
+ "description": "On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it. An empty object ({}) clears the header map; each masked *** entry keeps the stored value for that key."
},
"status": {
"$ref": "#/components/schemas/WorkflowStatus",
@@ -26500,6 +30604,18 @@
"title": "Run With",
"default": "agent"
},
+ "browser_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Type",
+ "description": "Browser engine for runs of this workflow, one of the supported browser types (e.g. msedge, chrome, stealth-chromium). A workflow-run setting overrides this. Null means the system default."
+ },
"ai_fallback": {
"type": "boolean",
"title": "Ai Fallback",
@@ -26722,6 +30838,9 @@
{
"$ref": "#/components/schemas/HttpRequestBlock"
},
+ {
+ "$ref": "#/components/schemas/WebSearchBlock"
+ },
{
"$ref": "#/components/schemas/PrintPageBlock"
},
@@ -26742,6 +30861,12 @@
},
{
"$ref": "#/components/schemas/SplitPdfBlock"
+ },
+ {
+ "$ref": "#/components/schemas/DataExportBlock"
+ },
+ {
+ "$ref": "#/components/schemas/TerminateBlock"
}
],
"discriminator": {
@@ -26750,6 +30875,7 @@
"action": "#/components/schemas/ActionBlock",
"code": "#/components/schemas/CodeBlock",
"conditional": "#/components/schemas/ConditionalBlock",
+ "data_export": "#/components/schemas/DataExportBlock",
"download_to_s3": "#/components/schemas/DownloadToS3Block",
"email_inbox": "#/components/schemas/EmailInboxBlock",
"extraction": "#/components/schemas/ExtractionBlock",
@@ -26771,10 +30897,12 @@
"split_pdf": "#/components/schemas/SplitPdfBlock",
"task": "#/components/schemas/TaskBlock",
"task_v2": "#/components/schemas/TaskV2Block",
+ "terminate": "#/components/schemas/TerminateBlock",
"text_prompt": "#/components/schemas/TextPromptBlock",
"upload_to_s3": "#/components/schemas/UploadToS3Block",
"validation": "#/components/schemas/ValidationBlock",
"wait": "#/components/schemas/WaitBlock",
+ "web_search": "#/components/schemas/WebSearchBlock",
"while_loop": "#/components/schemas/WhileLoopBlock",
"workflow_trigger": "#/components/schemas/WorkflowTriggerBlock"
}
@@ -26808,6 +30936,17 @@
],
"title": "Error Code Mapping"
},
+ "retry_policy": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowRetryPolicy"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Optional policy for retrying eligible terminal workflow runs"
+ },
"workflow_system_prompt": {
"anyOf": [
{
@@ -26818,6 +30957,30 @@
}
],
"title": "Workflow System Prompt"
+ },
+ "completion_contract": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Completion Contract",
+ "description": "Copilot-managed: what a run of this workflow must produce, graded at run finalization. Derived from the request when a workflow is accepted; not intended to be authored by hand."
+ },
+ "browser_settings": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BrowserSettings"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Settings applied to every browser this workflow version creates."
}
},
"type": "object",
@@ -26950,6 +31113,12 @@
{
"$ref": "#/components/schemas/FileDownloadBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/DataExportBlockYAML"
+ },
+ {
+ "$ref": "#/components/schemas/TerminateBlockYAML"
+ },
{
"$ref": "#/components/schemas/UrlBlockYAML"
},
@@ -26962,6 +31131,9 @@
{
"$ref": "#/components/schemas/HttpRequestBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/WebSearchBlockYAML"
+ },
{
"$ref": "#/components/schemas/ConditionalBlockYAML"
},
@@ -26993,6 +31165,7 @@
"action": "#/components/schemas/ActionBlockYAML",
"code": "#/components/schemas/CodeBlockYAML",
"conditional": "#/components/schemas/ConditionalBlockYAML",
+ "data_export": "#/components/schemas/DataExportBlockYAML",
"download_to_s3": "#/components/schemas/DownloadToS3BlockYAML",
"email_inbox": "#/components/schemas/EmailInboxBlockYAML",
"extraction": "#/components/schemas/ExtractionBlockYAML",
@@ -27014,10 +31187,12 @@
"split_pdf": "#/components/schemas/SplitPdfBlockYAML",
"task": "#/components/schemas/TaskBlockYAML",
"task_v2": "#/components/schemas/TaskV2BlockYAML",
+ "terminate": "#/components/schemas/TerminateBlockYAML",
"text_prompt": "#/components/schemas/TextPromptBlockYAML",
"upload_to_s3": "#/components/schemas/UploadToS3BlockYAML",
"validation": "#/components/schemas/ValidationBlockYAML",
"wait": "#/components/schemas/WaitBlockYAML",
+ "web_search": "#/components/schemas/WebSearchBlockYAML",
"while_loop": "#/components/schemas/WhileLoopBlockYAML",
"workflow_trigger": "#/components/schemas/WorkflowTriggerBlockYAML"
}
@@ -27051,6 +31226,17 @@
],
"title": "Error Code Mapping"
},
+ "retry_policy": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowRetryPolicy"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Optional policy for retrying eligible terminal workflow runs"
+ },
"workflow_system_prompt": {
"anyOf": [
{
@@ -27061,6 +31247,30 @@
}
],
"title": "Workflow System Prompt"
+ },
+ "completion_contract": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Completion Contract",
+ "description": "Copilot-managed: what a run of this workflow must produce, graded at run finalization. Derived from the request when a workflow is accepted; not intended to be authored by hand."
+ },
+ "browser_settings": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BrowserSettings"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Settings applied to every browser this workflow version creates. Omit to keep the previous version's settings; set to null to clear them."
}
},
"type": "object",
@@ -27270,6 +31480,87 @@
"type": "object",
"title": "WorkflowRequest"
},
+ "WorkflowRetryPolicy": {
+ "properties": {
+ "max_retries": {
+ "type": "integer",
+ "maximum": 5,
+ "minimum": 1,
+ "title": "Max Retries",
+ "description": "Maximum number of retries after the initial attempt",
+ "default": 1
+ },
+ "delay_seconds": {
+ "type": "integer",
+ "maximum": 3600,
+ "minimum": 0,
+ "title": "Delay Seconds",
+ "description": "Fixed delay before the next attempt, in seconds",
+ "default": 0
+ },
+ "webhook_on_retry": {
+ "type": "string",
+ "enum": [
+ "final_only",
+ "every_attempt"
+ ],
+ "title": "Webhook On Retry",
+ "description": "Whether to send a webhook for every attempt or only the final attempt",
+ "default": "final_only"
+ },
+ "retry_on": {
+ "items": {
+ "$ref": "#/components/schemas/WorkflowRetryRule"
+ },
+ "type": "array",
+ "minItems": 1,
+ "title": "Retry On",
+ "description": "Terminal status rules that enable retries"
+ }
+ },
+ "type": "object",
+ "required": [
+ "retry_on"
+ ],
+ "title": "WorkflowRetryPolicy"
+ },
+ "WorkflowRetryRule": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "completed",
+ "failed",
+ "terminated",
+ "canceled",
+ "timed_out"
+ ],
+ "title": "Status",
+ "description": "Terminal status that triggers a retry rule; canceled is accepted for forward compatibility, but a canceled run never retries in the current runtime, including explicit API/UI cancels."
+ },
+ "error_codes": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string",
+ "minLength": 1
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error Codes",
+ "description": "Optional error codes. The rule matches when any listed code is present."
+ }
+ },
+ "type": "object",
+ "required": [
+ "status"
+ ],
+ "title": "WorkflowRetryRule"
+ },
"WorkflowRun": {
"properties": {
"workflow_run_id": {
@@ -27310,6 +31601,49 @@
],
"title": "Browser Profile Id"
},
+ "browser_seed_source": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BrowserSeedSource"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "browser_sink_profile_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Sink Profile Id"
+ },
+ "start_fresh_browser": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Start Fresh Browser"
+ },
+ "reuse_browser_session": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Reuse Browser Session"
+ },
"debug_session_id": {
"anyOf": [
{
@@ -27324,6 +31658,39 @@
"status": {
"$ref": "#/components/schemas/WorkflowRunStatus"
},
+ "attempt": {
+ "type": "integer",
+ "title": "Attempt",
+ "description": "One-based number of the current workflow run attempt",
+ "default": 1
+ },
+ "retry_pending": {
+ "type": "boolean",
+ "title": "Retry Pending",
+ "description": "Whether another attempt is scheduled for this workflow run",
+ "default": false
+ },
+ "next_attempt_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Attempt At",
+ "description": "Timestamp when the next workflow run attempt is scheduled"
+ },
+ "attempts": {
+ "items": {
+ "$ref": "#/components/schemas/WorkflowRunAttempt"
+ },
+ "type": "array",
+ "title": "Attempts",
+ "description": "Attempts recorded for this workflow run"
+ },
"extra_http_headers": {
"anyOf": [
{
@@ -27440,6 +31807,28 @@
],
"title": "Failure Category"
},
+ "retried_from_workflow_run_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Retried From Workflow Run Id"
+ },
+ "fallback_attempt": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Fallback Attempt"
+ },
"parent_workflow_run_id": {
"anyOf": [
{
@@ -27506,6 +31895,38 @@
],
"title": "Run With"
},
+ "browser_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Type"
+ },
+ "browser_settings": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BrowserSettings"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Browser settings copied from the workflow version when the run was created"
+ },
+ "browser_settings_receipt": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BrowserSettingsReceipt"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
"script_run": {
"anyOf": [
{
@@ -27549,6 +31970,17 @@
],
"title": "Sequential Key"
},
+ "sequential_credential_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sequential Credential Id"
+ },
"ai_fallback": {
"anyOf": [
{
@@ -27597,7 +32029,18 @@
"title": "Ignore Inherited Workflow System Prompt",
"default": false
},
- "copilot_session_id": {
+ "copilot_session_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Copilot Session Id"
+ },
+ "created_by": {
"anyOf": [
{
"type": "string"
@@ -27606,7 +32049,8 @@
"type": "null"
}
],
- "title": "Copilot Session Id"
+ "title": "Created By",
+ "description": "ID of the user who started the run"
},
"credits_used": {
"type": "integer",
@@ -27677,6 +32121,121 @@
],
"title": "WorkflowRun"
},
+ "WorkflowRunAttempt": {
+ "properties": {
+ "attempt_number": {
+ "type": "integer",
+ "title": "Attempt Number",
+ "description": "One-based number of this workflow run attempt"
+ },
+ "status": {
+ "$ref": "#/components/schemas/RunStatus",
+ "description": "Status of this workflow run attempt"
+ },
+ "failure_reason": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Failure Reason",
+ "description": "Reason for failure, if the attempt failed"
+ },
+ "error_codes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Error Codes",
+ "description": "Error codes reported by this attempt"
+ },
+ "started_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Started At",
+ "description": "Timestamp when this attempt started"
+ },
+ "finished_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Finished At",
+ "description": "Timestamp when this attempt finished"
+ },
+ "retry_decision": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Retry Decision",
+ "description": "Retry decision recorded for this attempt"
+ },
+ "decision_reason": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Decision Reason",
+ "description": "Reason recorded for the retry decision"
+ },
+ "next_attempt_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Attempt At",
+ "description": "Timestamp when the next attempt is scheduled"
+ },
+ "webhook_sent_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Webhook Sent At",
+ "description": "Timestamp when the webhook for this attempt was sent"
+ }
+ },
+ "type": "object",
+ "required": [
+ "attempt_number",
+ "status"
+ ],
+ "title": "WorkflowRunAttempt"
+ },
"WorkflowRunBlock": {
"properties": {
"workflow_run_block_id": {
@@ -27698,6 +32257,17 @@
"type": "string",
"title": "Workflow Run Id"
},
+ "attempt_number": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Attempt Number"
+ },
"organization_id": {
"type": "string",
"title": "Organization Id"
@@ -27824,6 +32394,28 @@
],
"title": "Url"
},
+ "final_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Final Url"
+ },
+ "finish_reason": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Finish Reason"
+ },
"navigation_goal": {
"anyOf": [
{
@@ -28268,6 +32860,18 @@
"title": "Browser Session Id",
"description": "ID of a Skyvern browser session to reuse, having it continue from the current screen state"
},
+ "reuse_browser_session": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Reuse Browser Session",
+ "description": "Override whether this run reuses the workflow's managed browser session. Null inherits the workflow setting. Without login credentials, a browser profile key, or a sequential key, reuse is workflow-scoped: every run shares one browser and its signed-in state, so treat the workflow as single-account."
+ },
"browser_profile_id": {
"anyOf": [
{
@@ -28280,6 +32884,12 @@
"title": "Browser Profile Id",
"description": "ID of a browser profile to reuse for this workflow run"
},
+ "start_fresh_browser": {
+ "type": "boolean",
+ "title": "Start Fresh Browser",
+ "description": "When true, start this run from a fresh, empty browser and ignore any saved browser memory — no memory is read or written. A verified sign-in during the run still updates the credential's saved login.",
+ "default": false
+ },
"max_screenshot_scrolls": {
"anyOf": [
{
@@ -28380,6 +32990,21 @@
"code"
]
},
+ "browser_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Type",
+ "description": "Browser engine for this run, one of the supported browser types (e.g. msedge, chrome, stealth-chromium). Overrides the workflow-level setting. Null inherits from the workflow.",
+ "examples": [
+ "chrome"
+ ]
+ },
"run_metadata": {
"anyOf": [
{
@@ -28394,6 +33019,27 @@
],
"title": "Run Metadata",
"description": "String key/value metadata to attach to this workflow run for analytics tag filtering."
+ },
+ "file_ids": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "maxItems": 50
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File Ids",
+ "description": "\nIds of files uploaded through `POST /v1/upload_file` to attach to this run. Skyvern deletes an attached file as soon as the run finishes, so there is nothing to clean up afterwards. Reference an attached file by its id anywhere a file URL is accepted (for example in `parameters` or in the prompt) and no presigned URL is ever created for it. A file can be attached to one run at a time, and must not already be deleted.\n",
+ "examples": [
+ [
+ "file_123456789"
+ ]
+ ]
}
},
"type": "object",
@@ -28513,6 +33159,18 @@
"title": "Browser Session Id",
"description": "ID of a Skyvern browser session to reuse, having it continue from the current screen state"
},
+ "reuse_browser_session": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Reuse Browser Session",
+ "description": "Override whether this run reuses the workflow's managed browser session. Null inherits the workflow setting. Without login credentials, a browser profile key, or a sequential key, reuse is workflow-scoped: every run shares one browser and its signed-in state, so treat the workflow as single-account."
+ },
"browser_profile_id": {
"anyOf": [
{
@@ -28525,6 +33183,12 @@
"title": "Browser Profile Id",
"description": "ID of a browser profile to reuse for this workflow run"
},
+ "start_fresh_browser": {
+ "type": "boolean",
+ "title": "Start Fresh Browser",
+ "description": "When true, start this run from a fresh, empty browser and ignore any saved browser memory — no memory is read or written. A verified sign-in during the run still updates the credential's saved login.",
+ "default": false
+ },
"max_screenshot_scrolls": {
"anyOf": [
{
@@ -28625,6 +33289,21 @@
"code"
]
},
+ "browser_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Type",
+ "description": "Browser engine for this run, one of the supported browser types (e.g. msedge, chrome, stealth-chromium). Overrides the workflow-level setting. Null inherits from the workflow.",
+ "examples": [
+ "chrome"
+ ]
+ },
"run_metadata": {
"anyOf": [
{
@@ -28639,6 +33318,27 @@
],
"title": "Run Metadata",
"description": "String key/value metadata to attach to this workflow run for analytics tag filtering."
+ },
+ "file_ids": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "maxItems": 50
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File Ids",
+ "description": "\nIds of files uploaded through `POST /v1/upload_file` to attach to this run. Skyvern deletes an attached file as soon as the run finishes, so there is nothing to clean up afterwards. Reference an attached file by its id anywhere a file URL is accepted (for example in `parameters` or in the prompt) and no presigned URL is ever created for it. A file can be attached to one run at a time, and must not already be deleted.\n",
+ "examples": [
+ [
+ "file_123456789"
+ ]
+ ]
}
},
"type": "object",
@@ -28666,6 +33366,7 @@
"created",
"queued",
"running",
+ "paused",
"timed_out",
"failed",
"terminated",
@@ -28913,6 +33614,39 @@
"title": "Run Type",
"description": "Type of run - always workflow_run for workflow runs"
},
+ "attempt": {
+ "type": "integer",
+ "title": "Attempt",
+ "description": "One-based number of the current workflow run attempt",
+ "default": 1
+ },
+ "retry_pending": {
+ "type": "boolean",
+ "title": "Retry Pending",
+ "description": "Whether another attempt is scheduled for this workflow run",
+ "default": false
+ },
+ "next_attempt_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Attempt At",
+ "description": "Timestamp when the next workflow run attempt is scheduled"
+ },
+ "attempts": {
+ "items": {
+ "$ref": "#/components/schemas/WorkflowRunAttempt"
+ },
+ "type": "array",
+ "title": "Attempts",
+ "description": "Attempts recorded for this workflow run"
+ },
"run_with": {
"type": "string",
"title": "Run With",
@@ -28947,6 +33681,33 @@
"title": "Script Id",
"description": "ID of the cached script used for this workflow run, if any."
},
+ "browser_seed_source": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BrowserSeedSource"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Which layer of the seed-precedence chain seeded this run's browser (provenance).",
+ "examples": [
+ "credential",
+ "own_memory",
+ "fresh"
+ ]
+ },
+ "browser_settings_receipt": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BrowserSettingsReceipt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The timezone the run's browser reported against the one its workflow version requested. Null when the version requests no browser settings or the browser has not been measured yet."
+ },
"run_request": {
"anyOf": [
{
@@ -28989,6 +33750,11 @@
"type": {
"$ref": "#/components/schemas/WorkflowRunTimelineType"
},
+ "attempt": {
+ "type": "integer",
+ "title": "Attempt",
+ "default": 1
+ },
"block": {
"anyOf": [
{
@@ -29051,10 +33817,12 @@
"mcp",
"api",
"scheduled",
- "webhook"
+ "webhook",
+ "job_recipe_extract",
+ "job_recipe_apply"
],
"title": "WorkflowRunTriggerType",
- "description": "How a workflow run was initiated.\n\n- manual: User clicked \"Run\" in the UI\n- mcp: First-party MCP client request\n- api: Direct API call to the run endpoint\n- scheduled: Triggered by a cron schedule\n- webhook: Triggered by an external system via the webhook endpoint"
+ "description": "How a workflow run was initiated.\n\n- manual: User clicked \"Run\" in the UI\n- mcp: First-party MCP client request\n- api: Direct API call to the run endpoint\n- scheduled: Triggered by a cron schedule\n- webhook: Triggered by an external system via the webhook endpoint\n- job_recipe_extract: Launched by a job recipe extract request\n- job_recipe_apply: Launched by a job recipe apply request"
},
"WorkflowSchedule": {
"properties": {
@@ -29278,8 +34046,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 2147483647.0,
- "minimum": 300.0
+ "maximum": 2147483647,
+ "minimum": 300
},
{
"type": "null"
@@ -29711,16 +34479,14 @@
"azure_vault"
],
"title": "CredentialType"
- },
- "OneTimeDispatchStatus": {
- "type": "string",
- "enum": [
- "pending",
- "fired",
- "canceled",
- "failed"
- ],
- "title": "OneTimeDispatchStatus"
+ }
+ },
+ "securitySchemes": {
+ "ApiKeyAuth": {
+ "type": "apiKey",
+ "description": "Your Skyvern API key from https://app.skyvern.com/settings.",
+ "in": "header",
+ "name": "x-api-key"
}
}
},
@@ -29738,4 +34504,4 @@
"x-fern-server-name": "Local"
}
]
-}
+}
\ No newline at end of file