mirror of
https://github.com/Skyvern-AI/skyvern.git
synced 2026-07-09 16:09:13 +00:00
26964 lines
802 KiB
JSON
26964 lines
802 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "Skyvern API",
|
|
"description": "API for Skyvern",
|
|
"version": "1.0.0"
|
|
},
|
|
"paths": {
|
|
"/v1/run/tasks": {
|
|
"post": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Run a task",
|
|
"description": "Run a task",
|
|
"operationId": "run_task_v1_run_tasks_post",
|
|
"parameters": [
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"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",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "X-User-Agent"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TaskRunRequest-Input"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully run task",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TaskRunResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid agent engine"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-hidden": true,
|
|
"x-fern-sdk-method-name": "run_task",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.run_task(prompt=\"What's the top post on hackernews?\")\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.runTask({\n body: {\n prompt: \"Find the top 3 posts on Hacker News.\"\n }\n})\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/run/agents": {
|
|
"post": {
|
|
"tags": [
|
|
"Runs"
|
|
],
|
|
"summary": "Run an agent",
|
|
"description": "Run an agent",
|
|
"operationId": "run_workflow_v1_run_agents_post",
|
|
"parameters": [
|
|
{
|
|
"name": "template",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"title": "Template"
|
|
}
|
|
},
|
|
{
|
|
"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."
|
|
},
|
|
{
|
|
"name": "x-max-steps-override",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "X-Max-Steps-Override"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-user-agent",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "X-User-Agent"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowRunRequest-Input"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully ran agent",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowRunResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid agent run request"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "run_workflow",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.run_workflow(workflow_id=\"wpid_123\", parameters={\"parameter1\": \"value1\", \"parameter2\": \"value2\"})\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.runWorkflow({\n body: {\n workflow_id: \"wpid_123\",\n parameters: { parameter1: \"value1\", parameter2: \"value2\" }\n }\n});\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/runs/{run_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Runs"
|
|
],
|
|
"summary": "Get run info by id",
|
|
"description": "Get run information (task run, workflow run)",
|
|
"operationId": "get_run_v1_runs__run_id__get",
|
|
"parameters": [
|
|
{
|
|
"name": "run_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The id of the task run or the workflow run.",
|
|
"examples": [
|
|
"tsk_123",
|
|
"tsk_v2_123",
|
|
"wr_123"
|
|
],
|
|
"title": "Run Id"
|
|
},
|
|
"description": "The id of the task run or the workflow run."
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"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 got run",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TaskRunResponse"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowRunResponse"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "run_type",
|
|
"mapping": {
|
|
"task_v1": "#/components/schemas/TaskRunResponse",
|
|
"task_v2": "#/components/schemas/TaskRunResponse",
|
|
"openai_cua": "#/components/schemas/TaskRunResponse",
|
|
"anthropic_cua": "#/components/schemas/TaskRunResponse",
|
|
"ui_tars": "#/components/schemas/TaskRunResponse",
|
|
"yutori_navigator": "#/components/schemas/TaskRunResponse",
|
|
"workflow_run": "#/components/schemas/WorkflowRunResponse"
|
|
}
|
|
},
|
|
"title": "Response Get Run V1 Runs Run Id Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Run not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_run",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nrun = await skyvern.get_run(run_id=\"tsk_v2_123\")\nprint(run)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst run = await skyvern.getRun(\"tsk_v2_123\");\nconsole.log(run);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/runs/{run_id}/cancel": {
|
|
"post": {
|
|
"tags": [
|
|
"Runs"
|
|
],
|
|
"summary": "Cancel a run by id",
|
|
"description": "Cancel a run (task or workflow)",
|
|
"operationId": "cancel_run_v1_runs__run_id__cancel_post",
|
|
"parameters": [
|
|
{
|
|
"name": "run_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The id of the task run or the workflow run to cancel.",
|
|
"title": "Run Id"
|
|
},
|
|
"description": "The id of the task run or the workflow run to cancel."
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "cancel_run",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.cancel_run(run_id=\"tsk_v2_123\")\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.cancelRun(\"tsk_v2_123\");\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/runs/cancel": {
|
|
"post": {
|
|
"tags": [
|
|
"Runs"
|
|
],
|
|
"summary": "Bulk cancel runs",
|
|
"description": "Cancel multiple runs (tasks or workflows) in a single request",
|
|
"operationId": "bulk_cancel_runs_v1_runs_cancel_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/BulkCancelRunsRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BulkCancelRunsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "bulk_cancel_runs",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.bulk_cancel_runs(run_ids=[\"tsk_v2_123\", \"wr_456\"])\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.bulkCancelRuns({ run_ids: [\"tsk_v2_123\", \"wr_456\"] });\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/agents": {
|
|
"post": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Create a new agent",
|
|
"description": "Create a new agent",
|
|
"operationId": "create_workflow_v1_agents_post",
|
|
"parameters": [
|
|
{
|
|
"name": "folder_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional folder ID to assign the workflow to",
|
|
"title": "Folder Id"
|
|
},
|
|
"description": "Optional folder ID to assign the workflow to"
|
|
},
|
|
{
|
|
"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/WorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully created agent",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Workflow"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Invalid agent definition"
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "create_workflow",
|
|
"x-fern-examples": [
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Get all agents",
|
|
"description": "Get all workflows with the latest version for the organization.\n\nSearch semantics:\n- If `search_key` is provided, its value is used as a unified search term for\n `workflows.title`, `folders.title`, and workflow parameter metadata (key, description, and default_value for\n `WorkflowParameterModel`).\n- Falls back to deprecated `title` (title-only search) if `search_key` is not provided.\n- Parameter metadata search excludes soft-deleted parameter rows across all parameter tables.",
|
|
"operationId": "get_workflows_v1_workflows_get",
|
|
"parameters": [
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1,
|
|
"title": "Page"
|
|
}
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 10,
|
|
"title": "Page Size"
|
|
}
|
|
},
|
|
{
|
|
"name": "only_saved_tasks",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"title": "Only Saved Tasks"
|
|
}
|
|
},
|
|
{
|
|
"name": "only_workflows",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"title": "Only Workflows"
|
|
}
|
|
},
|
|
{
|
|
"name": "only_templates",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"title": "Only Templates"
|
|
}
|
|
},
|
|
{
|
|
"name": "search_key",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring search across: workflow title, folder name, and parameter metadata (key, description, default_value). A workflow is returned if any of these fields match. Soft-deleted parameter definitions are excluded. Takes precedence over the deprecated `title` parameter.",
|
|
"examples": [
|
|
"my_workflow",
|
|
"login_url",
|
|
"production"
|
|
],
|
|
"title": "Search Key"
|
|
},
|
|
"description": "Case-insensitive substring search across: workflow title, folder name, and parameter metadata (key, description, default_value). A workflow is returned if any of these fields match. Soft-deleted parameter definitions are excluded. Takes precedence over the deprecated `title` parameter."
|
|
},
|
|
{
|
|
"name": "title",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Deprecated: use search_key instead. Falls back to title-only search if search_key is not provided.",
|
|
"deprecated": true,
|
|
"default": "",
|
|
"title": "Title"
|
|
},
|
|
"description": "Deprecated: use search_key instead. Falls back to title-only search if search_key is not provided.",
|
|
"deprecated": true
|
|
},
|
|
{
|
|
"name": "folder_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter workflows by folder ID",
|
|
"title": "Folder Id"
|
|
},
|
|
"description": "Filter workflows by folder ID"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowStatus"
|
|
}
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Status"
|
|
}
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"maxItems": 20
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter by 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. Not supported with `template=true`.",
|
|
"examples": [
|
|
"env:prod",
|
|
"production",
|
|
"env:*",
|
|
"customer:acme,env:prod"
|
|
],
|
|
"title": "Tags"
|
|
},
|
|
"description": "Filter by 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. Not supported with `template=true`."
|
|
},
|
|
{
|
|
"name": "template",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"title": "Template"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Workflow"
|
|
},
|
|
"title": "Response Get Workflows V1 Workflows Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_workflows",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nworkflows = await skyvern.get_workflows()\nprint(workflows)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst workflows = await skyvern.getWorkflows();\nconsole.log(workflows);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_id}": {
|
|
"post": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Update an agent",
|
|
"description": "Update an agent",
|
|
"operationId": "update_workflow_v1_agents__workflow_id__post",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The ID of the agent to update. Starts with `wpid_`.",
|
|
"examples": [
|
|
"wpid_123"
|
|
],
|
|
"title": "Workflow Id"
|
|
},
|
|
"description": "The ID of the agent to update. Starts with `wpid_`."
|
|
},
|
|
{
|
|
"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/WorkflowRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully updated agent",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Workflow"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Invalid agent definition"
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "update_workflow",
|
|
"x-fern-examples": [
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_id}/delete": {
|
|
"post": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Delete an agent",
|
|
"description": "Delete an agent",
|
|
"operationId": "delete_workflow_v1_agents__workflow_id__delete_post",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The ID of the agent to delete. Starts with `wpid_`.",
|
|
"examples": [
|
|
"wpid_123"
|
|
],
|
|
"title": "Workflow Id"
|
|
},
|
|
"description": "The ID of the agent to delete. Starts with `wpid_`."
|
|
},
|
|
{
|
|
"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 deleted agent",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "delete_workflow",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.delete_workflow(workflow_id=\"wpid_123\")\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.deleteWorkflow(\"wpid_123\");\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/folders": {
|
|
"post": {
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"summary": "Create folder",
|
|
"description": "Create a new folder to organize workflows",
|
|
"operationId": "create_folder_v1_folders_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/FolderCreate"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully created folder",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Folder"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid request"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "create_folder"
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"summary": "Get folders",
|
|
"description": "Get all folders for the organization",
|
|
"operationId": "get_folders_v1_folders_get",
|
|
"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": 500,
|
|
"minimum": 1,
|
|
"description": "Number of folders per page",
|
|
"default": 100,
|
|
"title": "Page Size"
|
|
},
|
|
"description": "Number of folders per page"
|
|
},
|
|
{
|
|
"name": "search",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Search folders by title or description",
|
|
"title": "Search"
|
|
},
|
|
"description": "Search folders by title or description"
|
|
},
|
|
{
|
|
"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 folders",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Folder"
|
|
},
|
|
"title": "Response Get Folders V1 Folders Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_folders"
|
|
}
|
|
},
|
|
"/v1/folders/{folder_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"summary": "Get folder",
|
|
"description": "Get a specific folder by ID",
|
|
"operationId": "get_folder_v1_folders__folder_id__get",
|
|
"parameters": [
|
|
{
|
|
"name": "folder_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Folder ID",
|
|
"examples": [
|
|
"fld_123"
|
|
],
|
|
"title": "Folder Id"
|
|
},
|
|
"description": "Folder ID"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully retrieved folder",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Folder"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Folder not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_folder"
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"summary": "Update folder",
|
|
"description": "Update a folder's title or description",
|
|
"operationId": "update_folder_v1_folders__folder_id__put",
|
|
"parameters": [
|
|
{
|
|
"name": "folder_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Folder ID",
|
|
"examples": [
|
|
"fld_123"
|
|
],
|
|
"title": "Folder Id"
|
|
},
|
|
"description": "Folder ID"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/FolderUpdate"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully updated folder",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Folder"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Folder not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "update_folder"
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"summary": "Delete folder",
|
|
"description": "Delete a folder. Optionally delete all workflows in the folder.",
|
|
"operationId": "delete_folder_v1_folders__folder_id__delete",
|
|
"parameters": [
|
|
{
|
|
"name": "folder_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Folder ID",
|
|
"examples": [
|
|
"fld_123"
|
|
],
|
|
"title": "Folder Id"
|
|
},
|
|
"description": "Folder ID"
|
|
},
|
|
{
|
|
"name": "delete_workflows",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"description": "If true, also delete all workflows in this folder",
|
|
"default": false,
|
|
"title": "Delete Workflows"
|
|
},
|
|
"description": "If true, also delete all workflows in this folder"
|
|
},
|
|
{
|
|
"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 deleted folder",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": true,
|
|
"title": "Response Delete Folder V1 Folders Folder Id Delete"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Folder not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "delete_folder"
|
|
}
|
|
},
|
|
"/v1/tag-keys": {
|
|
"get": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "List tag keys",
|
|
"description": "List all tag keys registered for the organization with their descriptions.",
|
|
"operationId": "list_tag_keys_v1_tag_keys_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 tag keys",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TagKey"
|
|
},
|
|
"title": "Response List Tag Keys V1 Tag Keys Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "list_tag_keys"
|
|
}
|
|
},
|
|
"/v1/tag-keys/{key}": {
|
|
"patch": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Update tag key",
|
|
"description": "Update the description for a tag key.",
|
|
"operationId": "update_tag_key_v1_tag_keys__key__patch",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Tag key to update",
|
|
"title": "Key"
|
|
},
|
|
"description": "Tag key to update"
|
|
},
|
|
{
|
|
"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/TagKeyUpdate"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully updated tag key",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagKey"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Tag key not found"
|
|
},
|
|
"422": {
|
|
"description": "Description too long"
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "update_tag_key"
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Delete tag key",
|
|
"description": "Delete a tag key from the organization registry and remove that tag from every workflow that currently has it (cascade). Returns how many workflows the tag was removed from.",
|
|
"operationId": "delete_tag_key_v1_tag_keys__key__delete",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Tag key to delete",
|
|
"examples": [
|
|
"env"
|
|
],
|
|
"title": "Key"
|
|
},
|
|
"description": "Tag key to delete"
|
|
},
|
|
{
|
|
"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 deleted tag key",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagKeyDeleteResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Tag key not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "delete_tag_key"
|
|
}
|
|
},
|
|
"/v1/tag-values": {
|
|
"get": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "List tag values",
|
|
"description": "List the palette color and current workflow usage count for each grouped tag (key, value) for the organization. The frontend joins these onto tags by (key, value); workflow_count is the number of non-deleted workflows carrying the label and powers the per-label usage and delete blast-radius warnings.",
|
|
"operationId": "list_tag_values_v1_tag_values_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 tag values",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TagValue"
|
|
},
|
|
"title": "Response List Tag Values V1 Tag Values Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "list_tag_values"
|
|
}
|
|
},
|
|
"/v1/tag-values/{key}": {
|
|
"patch": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Update tag value color",
|
|
"description": "Recolor a grouped tag (key, value). The value is supplied in the body so values containing '/' stay addressable. The new color must be a palette name.",
|
|
"operationId": "update_tag_value_v1_tag_values__key__patch",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Tag key (group)",
|
|
"examples": [
|
|
"env"
|
|
],
|
|
"title": "Key"
|
|
},
|
|
"description": "Tag key (group)"
|
|
},
|
|
{
|
|
"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/TagValueUpdate"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully recolored tag value",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagValue"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Tag value not found"
|
|
},
|
|
"422": {
|
|
"description": "Invalid palette color"
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "update_tag_value"
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Delete tag value",
|
|
"description": "Soft-delete a grouped tag (key, value) and remove that label from every workflow carrying it (cascade). The value rides in the body so values containing '/' stay addressable. Returns how many workflows the label was removed from.",
|
|
"operationId": "delete_tag_value_v1_tag_values__key__delete",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Tag key (group)",
|
|
"examples": [
|
|
"env"
|
|
],
|
|
"title": "Key"
|
|
},
|
|
"description": "Tag key (group)"
|
|
},
|
|
{
|
|
"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/TagValueDelete"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully deleted tag value",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagValueDeleteResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Tag value not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "delete_tag_value"
|
|
}
|
|
},
|
|
"/v1/tag-values/{key}/rename": {
|
|
"patch": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Rename tag value",
|
|
"description": "Rename a grouped tag (key, value) to (key, new_value). The cascade re-tags every workflow carrying the old label; the new label inherits the old color. Both values ride in the body so values containing '/' stay addressable. Rejects with 409 when the new value already exists for the key.",
|
|
"operationId": "rename_tag_value_v1_tag_values__key__rename_patch",
|
|
"parameters": [
|
|
{
|
|
"name": "key",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Tag key (group)",
|
|
"examples": [
|
|
"env"
|
|
],
|
|
"title": "Key"
|
|
},
|
|
"description": "Tag key (group)"
|
|
},
|
|
{
|
|
"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/TagValueRename"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully renamed tag value",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagValueRenameResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Tag value not found"
|
|
},
|
|
"409": {
|
|
"description": "Target value already exists for this key"
|
|
},
|
|
"422": {
|
|
"description": "Invalid value"
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "rename_tag_value"
|
|
}
|
|
},
|
|
"/v1/workflow-tags": {
|
|
"get": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Batch get agent tags",
|
|
"description": "Batch fetch current tags for many workflows. Avoids N+1 on the workflows-list page.",
|
|
"operationId": "batch_get_workflow_tags_v1_workflow_tags_get",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_ids",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Comma-separated workflow permanent IDs",
|
|
"examples": [
|
|
"wpid_123,wpid_456"
|
|
],
|
|
"title": "Workflow Permanent Ids"
|
|
},
|
|
"description": "Comma-separated workflow permanent IDs"
|
|
},
|
|
{
|
|
"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 tags",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowTagsBatchResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Too many workflow IDs requested"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-hidden": true,
|
|
"x-fern-sdk-method-name": "batch_get_workflow_tags"
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Batch get agent tags (POST)",
|
|
"description": "Batch fetch current tags for many workflows (POST variant for id lists exceeding URL length).",
|
|
"operationId": "batch_get_workflow_tags_post_v1_workflow_tags_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/WorkflowTagsBatchRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully retrieved tags",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowTagsBatchResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Too many workflow IDs requested"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-hidden": true,
|
|
"x-fern-sdk-method-name": "batch_get_workflow_tags_post"
|
|
}
|
|
},
|
|
"/v1/artifacts/{artifact_id}/content": {
|
|
"get": {
|
|
"tags": [
|
|
"Artifacts"
|
|
],
|
|
"summary": "Get artifact content",
|
|
"description": "Download the raw content of an artifact (supports bundled artifacts).",
|
|
"operationId": "get_artifact_content_v1_artifacts__artifact_id__content_get",
|
|
"parameters": [
|
|
{
|
|
"name": "artifact_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Artifact Id"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Raw artifact content",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"206": {
|
|
"description": "Partial artifact content (Range request)"
|
|
},
|
|
"403": {
|
|
"description": "Invalid or expired artifact URL"
|
|
},
|
|
"404": {
|
|
"description": "Artifact not found or content unavailable"
|
|
},
|
|
"416": {
|
|
"description": "Range not satisfiable"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/runs/{run_id}/artifacts": {
|
|
"get": {
|
|
"tags": [
|
|
"Artifacts"
|
|
],
|
|
"summary": "Get artifacts for a run",
|
|
"description": "Get artifacts for a run",
|
|
"operationId": "get_run_artifacts_v1_runs__run_id__artifacts_get",
|
|
"parameters": [
|
|
{
|
|
"name": "run_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The id of the task run or the workflow run.",
|
|
"title": "Run Id"
|
|
},
|
|
"description": "The id of the task run or the workflow run."
|
|
},
|
|
{
|
|
"name": "artifact_type",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ArtifactType"
|
|
}
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Artifact Type"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Artifact"
|
|
},
|
|
"title": "Response Get Run Artifacts V1 Runs Run Id Artifacts Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_run_artifacts"
|
|
}
|
|
},
|
|
"/v1/runs/{run_id}/retry_webhook": {
|
|
"post": {
|
|
"tags": [
|
|
"Runs"
|
|
],
|
|
"summary": "Replay a run webhook",
|
|
"description": "Retry sending the webhook for a run",
|
|
"operationId": "retry_run_webhook_v1_runs__run_id__retry_webhook_post",
|
|
"parameters": [
|
|
{
|
|
"name": "run_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The id of the task run or the workflow run.",
|
|
"examples": [
|
|
"tsk_123",
|
|
"wr_123"
|
|
],
|
|
"title": "Run Id"
|
|
},
|
|
"description": "The id of the task run or the workflow run."
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"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": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RetryRunWebhookRequest"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Request"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RunWebhookReplayResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "retry_run_webhook",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.retry_run_webhook(run_id=\"tsk_v2_123\")\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.retryRunWebhook(\"tsk_v2_123\");\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/runs/{run_id}/timeline": {
|
|
"get": {
|
|
"tags": [
|
|
"Runs"
|
|
],
|
|
"summary": "Get run timeline",
|
|
"description": "Get timeline for a run (workflow run or task_v2 run)",
|
|
"operationId": "get_run_timeline_v1_runs__run_id__timeline_get",
|
|
"parameters": [
|
|
{
|
|
"name": "run_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The id of the workflow run or task_v2 run.",
|
|
"examples": [
|
|
"wr_123",
|
|
"tsk_v2_123"
|
|
],
|
|
"title": "Run Id"
|
|
},
|
|
"description": "The id of the workflow run or task_v2 run."
|
|
},
|
|
{
|
|
"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 timeline",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowRunTimeline"
|
|
},
|
|
"title": "Response Get Run Timeline V1 Runs Run Id Timeline Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Run not found"
|
|
},
|
|
"400": {
|
|
"description": "Timeline not available for this run type"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_run_timeline",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\n# Get timeline for a workflow run\ntimeline = await skyvern.get_run_timeline(run_id=\"wr_123\")\nprint(timeline)\n\n# Get timeline for a task_v2 run\ntimeline = await skyvern.get_run_timeline(run_id=\"tsk_v2_123\")\nprint(timeline)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n// Get timeline for a workflow run\nconst timeline = await skyvern.getRunTimeline(\"wr_123\");\nconsole.log(timeline);\n\n// Get timeline for a task_v2 run\nconst timeline2 = await skyvern.getRunTimeline(\"tsk_v2_123\");\nconsole.log(timeline2);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/version": {
|
|
"get": {
|
|
"tags": [
|
|
"Server"
|
|
],
|
|
"summary": "Get server version",
|
|
"description": "Returns the current Skyvern server version (git SHA for official builds).",
|
|
"operationId": "get_version_v1_version_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Current server version",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object",
|
|
"title": "Response Get Version V1 Version Get"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_version"
|
|
}
|
|
},
|
|
"/v1/runs": {
|
|
"get": {
|
|
"tags": [
|
|
"agent"
|
|
],
|
|
"summary": "Get Runs V2",
|
|
"operationId": "get_runs_v2_v1_runs_get",
|
|
"parameters": [
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"default": 1,
|
|
"title": "Page"
|
|
}
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"default": 10,
|
|
"title": "Page Size"
|
|
}
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/RunStatus"
|
|
}
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Status"
|
|
}
|
|
},
|
|
{
|
|
"name": "search_key",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"minLength": 3
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring search (min 3 chars for trigram index).",
|
|
"examples": [
|
|
"login_url",
|
|
"wr_abc123"
|
|
],
|
|
"title": "Search Key"
|
|
},
|
|
"description": "Case-insensitive substring search (min 3 chars for trigram index)."
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TaskRunListItem"
|
|
},
|
|
"title": "Response Get Runs V2 V1 Runs Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-hidden": true,
|
|
"x-fern-sdk-method-name": "get_runs_v2"
|
|
}
|
|
},
|
|
"/v1/upload_file": {
|
|
"post": {
|
|
"tags": [
|
|
"Files"
|
|
],
|
|
"summary": "Upload File",
|
|
"operationId": "upload_file_v1_upload_file_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": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Body_upload_file_v1_upload_file_post"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UploadFileResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "upload_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": [
|
|
{
|
|
"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/CreateBrowserProfileRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully created browser profile",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BrowserProfile"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid request - source not found or source archive unavailable"
|
|
},
|
|
"409": {
|
|
"description": "Browser profile name already exists"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "create_browser_profile",
|
|
"x-fern-examples": [
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Browser Profiles"
|
|
],
|
|
"summary": "List browser profiles",
|
|
"description": "Get all browser profiles for the organization",
|
|
"operationId": "list_browser_profiles_v1_browser_profiles_get",
|
|
"parameters": [
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1,
|
|
"title": "Page"
|
|
}
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 10,
|
|
"title": "Page Size"
|
|
}
|
|
},
|
|
{
|
|
"name": "include_deleted",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"description": "Include deleted browser profiles",
|
|
"default": false,
|
|
"title": "Include Deleted"
|
|
},
|
|
"description": "Include deleted browser profiles"
|
|
},
|
|
{
|
|
"name": "search_key",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches.",
|
|
"examples": [
|
|
"my_profile",
|
|
"production"
|
|
],
|
|
"title": "Search Key"
|
|
},
|
|
"description": "Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches."
|
|
},
|
|
{
|
|
"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 profiles",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/BrowserProfile"
|
|
},
|
|
"title": "Response List Browser Profiles V1 Browser Profiles Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "list_browser_profiles",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_profiles = await skyvern.browser_profiles.list_browser_profiles()\nprint(browser_profiles)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst browserProfiles = await skyvern.browserProfiles.listBrowserProfiles();\nconsole.log(browserProfiles);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/browser_profiles/{profile_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Browser Profiles"
|
|
],
|
|
"summary": "Get browser profile",
|
|
"description": "Get a specific browser profile by ID",
|
|
"operationId": "get_browser_profile_v1_browser_profiles__profile_id__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",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BrowserProfile"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_profile = await skyvern.browser_profiles.get_browser_profile(\"bp_123\")\nprint(browser_profile)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst browserProfile = await skyvern.browserProfiles.getBrowserProfile(\"bp_123\");\nconsole.log(browserProfile);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Browser Profiles"
|
|
],
|
|
"summary": "Update browser profile",
|
|
"description": "Update a browser profile's name and/or description",
|
|
"operationId": "update_browser_profile_v1_browser_profiles__profile_id__patch",
|
|
"parameters": [
|
|
{
|
|
"name": "profile_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The ID of the browser profile to update. browser_profile_id starts with `bp_`",
|
|
"examples": [
|
|
"bp_123456"
|
|
],
|
|
"title": "Profile Id"
|
|
},
|
|
"description": "The ID of the browser profile to update. 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."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UpdateBrowserProfileRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully updated browser profile",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BrowserProfile"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Browser profile not found"
|
|
},
|
|
"409": {
|
|
"description": "Browser profile name already exists"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "update_browser_profile",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_profile = await skyvern.browser_profiles.update_browser_profile(\n \"bp_123\",\n name=\"Renamed Profile\",\n description=\"Updated description\",\n)\nprint(browser_profile)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst browserProfile = await skyvern.browserProfiles.updateBrowserProfile(\"bp_123\", {\n name: \"Renamed Profile\",\n description: \"Updated description\",\n});\nconsole.log(browserProfile);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Browser Profiles"
|
|
],
|
|
"summary": "Delete browser profile",
|
|
"description": "Delete a browser profile (soft delete)",
|
|
"operationId": "delete_browser_profile_v1_browser_profiles__profile_id__delete",
|
|
"parameters": [
|
|
{
|
|
"name": "profile_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The ID of the browser profile to delete. browser_profile_id starts with `bp_`",
|
|
"examples": [
|
|
"bp_123456"
|
|
],
|
|
"title": "Profile Id"
|
|
},
|
|
"description": "The ID of the browser profile to delete. 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": {
|
|
"204": {
|
|
"description": "Successfully deleted browser profile"
|
|
},
|
|
"404": {
|
|
"description": "Browser profile not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "delete_browser_profile",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.browser_profiles.delete_browser_profile(\"bp_123\")\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.browserProfiles.deleteBrowserProfile(\"bp_123\");\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/browser_sessions": {
|
|
"post": {
|
|
"tags": [
|
|
"Browser Sessions"
|
|
],
|
|
"summary": "Create a session",
|
|
"description": "Create a browser session that persists across multiple runs",
|
|
"operationId": "create_browser_session_v1_browser_sessions_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": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateBrowserSessionRequest",
|
|
"default": {
|
|
"timeout": 60,
|
|
"generate_browser_profile": false
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully created browser session",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BrowserSessionResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Unauthorized - Invalid or missing authentication"
|
|
},
|
|
"404": {
|
|
"description": "Browser profile not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "create_browser_session",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_session = await skyvern.create_browser_session(timeout=60)\nprint(browser_session)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst browserSession = await skyvern.createBrowserSession({\n timeout: 60\n});\nconsole.log(browserSession);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Browser Sessions"
|
|
],
|
|
"summary": "Get active browser sessions",
|
|
"description": "Get all active browser sessions for the organization",
|
|
"operationId": "get_browser_sessions_v1_browser_sessions_get",
|
|
"parameters": [
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"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 all active browser sessions",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/BrowserSessionResponse"
|
|
},
|
|
"title": "Response Get Browser Sessions V1 Browser Sessions Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Unauthorized - Invalid or missing authentication"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_browser_sessions",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_sessions = await skyvern.get_browser_sessions()\nprint(browser_sessions)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst browserSessions = await skyvern.getBrowserSessions();\nconsole.log(browserSessions);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/browser_sessions/{browser_session_id}/close": {
|
|
"post": {
|
|
"tags": [
|
|
"Browser Sessions"
|
|
],
|
|
"summary": "Close a session",
|
|
"description": "Close a session. Once closed, the session cannot be used again.",
|
|
"operationId": "close_browser_session_v1_browser_sessions__browser_session_id__close_post",
|
|
"parameters": [
|
|
{
|
|
"name": "browser_session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The ID of the browser session to close. completed_at will be set when the browser session is closed. browser_session_id starts with `pbs_`",
|
|
"examples": [
|
|
"pbs_123456"
|
|
],
|
|
"title": "Browser Session Id"
|
|
},
|
|
"description": "The ID of the browser session to close. completed_at will be set when the browser session is closed. browser_session_id starts with `pbs_`"
|
|
},
|
|
{
|
|
"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 closed browser session",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Unauthorized - Invalid or missing authentication"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "close_browser_session",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.close_browser_session(browser_session_id=\"pbs_123\")\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.closeBrowserSession(\"pbs_123\");\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/browser_sessions/{browser_session_id}": {
|
|
"patch": {
|
|
"tags": [
|
|
"Browser Sessions"
|
|
],
|
|
"summary": "Update a session",
|
|
"description": "Update a live browser session. Currently supports toggling generate_browser_profile, which is read when the session ends to decide whether to save its browser profile.",
|
|
"operationId": "update_browser_session_v1_browser_sessions__browser_session_id__patch",
|
|
"parameters": [
|
|
{
|
|
"name": "browser_session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The ID of the browser session. browser_session_id starts with `pbs_`",
|
|
"examples": [
|
|
"pbs_123456"
|
|
],
|
|
"title": "Browser Session Id"
|
|
},
|
|
"description": "The ID of the browser session. browser_session_id starts with `pbs_`"
|
|
},
|
|
{
|
|
"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/UpdateBrowserSessionRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully updated browser session",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BrowserSessionResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Browser session not found"
|
|
},
|
|
"403": {
|
|
"description": "Unauthorized - Invalid or missing authentication"
|
|
},
|
|
"409": {
|
|
"description": "Conflict - browser session has already ended and can no longer be updated"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "update_browser_session"
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Browser Sessions"
|
|
],
|
|
"summary": "Get a session",
|
|
"description": "Get details about a specific browser session, including the browser address for cdp connection.",
|
|
"operationId": "get_browser_session_v1_browser_sessions__browser_session_id__get",
|
|
"parameters": [
|
|
{
|
|
"name": "browser_session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The ID of the browser session. browser_session_id starts with `pbs_`",
|
|
"examples": [
|
|
"pbs_123456"
|
|
],
|
|
"title": "Browser Session Id"
|
|
},
|
|
"description": "The ID of the browser session. browser_session_id starts with `pbs_`"
|
|
},
|
|
{
|
|
"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 session details",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BrowserSessionResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Browser session not found"
|
|
},
|
|
"403": {
|
|
"description": "Unauthorized - Invalid or missing authentication"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_browser_session",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_session = await skyvern.get_browser_session(browser_session_id=\"pbs_123\")\nprint(browser_session)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst browserSession = await skyvern.getBrowserSession(\"pbs_123\");\nconsole.log(browserSession);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/credentials/totp": {
|
|
"post": {
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"summary": "Send TOTP code",
|
|
"description": "Forward a TOTP (2FA, MFA) email or sms message containing the code to Skyvern. This endpoint stores the code in database so that Skyvern can use it while running tasks/workflows.",
|
|
"operationId": "send_totp_code_v1_credentials_totp_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/TOTPCodeCreate"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TOTPCode"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "send_totp_code",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.send_totp_code(\n totp_identifier=\"john.doe@example.com\",\n content=\"Hello, your verification code is 123456\"\n)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.sendTotpCode({\n totp_identifier: \"john.doe@example.com\",\n content: \"Hello, your verification code is 123456\"\n});\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/credentials": {
|
|
"post": {
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"summary": "Create credential",
|
|
"description": "Creates a new credential for the current organization",
|
|
"operationId": "create_credential_v1_credentials_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/CreateCredentialRequest",
|
|
"description": "The credential data to create",
|
|
"examples": [
|
|
{
|
|
"name": "My Credential",
|
|
"credential_type": "PASSWORD",
|
|
"credential": {
|
|
"username": "user@example.com",
|
|
"password": "securepassword123",
|
|
"totp": "JBSWY3DPEHPK3PXP"
|
|
}
|
|
}
|
|
],
|
|
"openapi_extra": {
|
|
"x-fern-sdk-parameter-name": "data"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CredentialResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "create_credential",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.create_credential(\n name=\"My Credential\",\n credential_type=\"password\",\n credential={\"username\": \"username\", \"password\": \"password\"},\n)\n"
|
|
},
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.create_credential(\n name=\"My Credit Card\",\n credential_type=\"credit_card\",\n credential={\n \"card_number\": \"4242424242424242\",\n \"card_cvv\": \"424\",\n \"card_exp_month\": \"12\",\n \"card_exp_year\": \"2028\",\n \"card_brand\": \"visa\",\n \"card_holder_name\": \"John Doe\",\n \"billing_address\": {\n \"line1\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state_code\": \"CA\",\n \"postal_code\": \"94105\",\n \"country_code\": \"US\",\n },\n \"billing_email\": \"billing@example.com\",\n \"metadata\": {\"checkout_profile\": \"default\"},\n },\n)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.createCredential({\n name: \"My Credential\",\n credential_type: \"password\",\n credential: { username: \"username\", password: \"password\" }\n});\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.createCredential({\n name: \"My Credit Card\",\n credential_type: \"credit_card\",\n credential: {\n card_number: \"4242424242424242\",\n card_cvv: \"424\",\n card_exp_month: \"12\",\n card_exp_year: \"2028\",\n card_brand: \"visa\",\n card_holder_name: \"John Doe\",\n billing_address: {\n line1: \"123 Main St\",\n city: \"San Francisco\",\n state_code: \"CA\",\n postal_code: \"94105\",\n country_code: \"US\",\n },\n billing_email: \"billing@example.com\",\n metadata: { checkout_profile: \"default\" }\n }\n});\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"summary": "Get all credentials",
|
|
"description": "Retrieves a paginated list of credentials for the current organization",
|
|
"operationId": "get_credentials_v1_credentials_get",
|
|
"parameters": [
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Page number for pagination",
|
|
"examples": [
|
|
1
|
|
],
|
|
"openapi_extra": {
|
|
"x-fern-sdk-parameter-name": "page"
|
|
},
|
|
"default": 1,
|
|
"title": "Page"
|
|
},
|
|
"description": "Page number for pagination"
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Number of items per page",
|
|
"examples": [
|
|
10
|
|
],
|
|
"openapi_extra": {
|
|
"x-fern-sdk-parameter-name": "page_size"
|
|
},
|
|
"default": 10,
|
|
"title": "Page Size"
|
|
},
|
|
"description": "Number of items per page"
|
|
},
|
|
{
|
|
"name": "vault_type",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CredentialVaultType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter credentials by vault type (e.g. 'custom', 'bitwarden', 'azure_vault')",
|
|
"title": "Vault Type"
|
|
},
|
|
"description": "Filter credentials by vault type (e.g. 'custom', 'bitwarden', 'azure_vault')"
|
|
},
|
|
{
|
|
"name": "credential_type",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/skyvern__forge__sdk__schemas__credentials__CredentialType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter credentials by type (e.g. 'password', 'credit_card', 'secret')",
|
|
"title": "Credential Type"
|
|
},
|
|
"description": "Filter credentials by type (e.g. 'password', 'credit_card', 'secret')"
|
|
},
|
|
{
|
|
"name": "search",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 200
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive search across credential name, username, secret label, and card details",
|
|
"title": "Search"
|
|
},
|
|
"description": "Case-insensitive search across credential name, username, secret label, and card details"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/CredentialResponse"
|
|
},
|
|
"title": "Response Get Credentials V1 Credentials Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_credentials",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\ncredentials = await skyvern.get_credentials()\nprint(credentials)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst credentials = await skyvern.getCredentials();\nconsole.log(credentials);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/credentials/{credential_id}/update": {
|
|
"post": {
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"summary": "Update credential",
|
|
"description": "Overwrites the stored credential data (e.g. username/password) while keeping the same credential_id.",
|
|
"operationId": "update_credential_v1_credentials__credential_id__update_post",
|
|
"parameters": [
|
|
{
|
|
"name": "credential_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The unique identifier of the credential to update",
|
|
"examples": [
|
|
"cred_1234567890"
|
|
],
|
|
"openapi_extra": {
|
|
"x-fern-sdk-parameter-name": "credential_id"
|
|
},
|
|
"title": "Credential Id"
|
|
},
|
|
"description": "The unique identifier of the credential to update"
|
|
},
|
|
{
|
|
"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/CreateCredentialRequest",
|
|
"description": "The new credential data to store",
|
|
"examples": [
|
|
{
|
|
"name": "My Credential",
|
|
"credential_type": "PASSWORD",
|
|
"credential": {
|
|
"username": "user@example.com",
|
|
"password": "newpassword123"
|
|
}
|
|
}
|
|
],
|
|
"openapi_extra": {
|
|
"x-fern-sdk-parameter-name": "data"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CredentialResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "update_credential",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nupdated = await skyvern.update_credential(\n credential_id=\"cred_123\",\n name=\"My Credential\",\n credential_type=\"password\",\n credential={\"username\": \"user@example.com\", \"password\": \"newpassword123\"},\n)\nprint(updated)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst updated = await skyvern.updateCredential(\"cred_123\", {\n name: \"My Credential\",\n credential_type: \"password\",\n credential: { username: \"user@example.com\", password: \"newpassword123\" }\n});\nconsole.log(updated);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/credentials/{credential_id}/delete": {
|
|
"post": {
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"summary": "Delete credential",
|
|
"description": "Deletes a specific credential by its ID",
|
|
"operationId": "delete_credential_v1_credentials__credential_id__delete_post",
|
|
"parameters": [
|
|
{
|
|
"name": "credential_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The unique identifier of the credential to delete",
|
|
"examples": [
|
|
"cred_1234567890"
|
|
],
|
|
"openapi_extra": {
|
|
"x-fern-sdk-parameter-name": "credential_id"
|
|
},
|
|
"title": "Credential Id"
|
|
},
|
|
"description": "The unique identifier of the credential to delete"
|
|
},
|
|
{
|
|
"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_credential",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.delete_credential(credential_id=\"cred_123\")\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.deleteCredential(\"cred_123\");\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/credentials/{credential_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"summary": "Get credential by ID",
|
|
"description": "Retrieves a specific credential by its ID",
|
|
"operationId": "get_credential_v1_credentials__credential_id__get",
|
|
"parameters": [
|
|
{
|
|
"name": "credential_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The unique identifier of the credential",
|
|
"examples": [
|
|
"cred_1234567890"
|
|
],
|
|
"openapi_extra": {
|
|
"x-fern-sdk-parameter-name": "credential_id"
|
|
},
|
|
"title": "Credential Id"
|
|
},
|
|
"description": "The unique identifier of the credential"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CredentialResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_credential",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\ncredential = await skyvern.get_credential(credential_id=\"cred_123\")\nprint(credential)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nconst credential = await skyvern.getCredential(\"cred_123\");\nconsole.log(credential);\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/run/tasks/login": {
|
|
"post": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Login Task",
|
|
"description": "Log in to a website using either credential stored in Skyvern, Bitwarden, 1Password, or Azure Vault",
|
|
"operationId": "login_v1_run_tasks_login_post",
|
|
"parameters": [
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
},
|
|
{
|
|
"name": "x-user-agent",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "X-User-Agent"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/LoginRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowRunResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-hidden": true,
|
|
"x-excluded": true,
|
|
"x-fern-sdk-method-name": "login",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "# Login with password saved in Skyvern\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"skyvern\",\n credential_id=\"cred_123\"),\n)\n"
|
|
},
|
|
{
|
|
"sdk": "python",
|
|
"code": "# Login with password saved in Bitwarden\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\n# Login with a Bitwarden collection and website url filter\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"bitwarden\",\n bitwarden_collection_id=\"BITWARDEN COLLECTION ID\",\n)\n\n# Login with a Bitwarden item\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"bitwarden\",\n bitwarden_item_id=\"BITWARDEN ITEM ID\",\n)\n"
|
|
},
|
|
{
|
|
"sdk": "python",
|
|
"code": "# Login with password saved in 1Password\nfrom skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.login(\n url=\"https://example.com\",\n credential_type=\"onepassword\",\n onepassword_vault_id=\"1PASSWORD VAULT ID\",\n onepassword_item_id=\"1PASSWORD ITEM ID\",\n)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "// Login with password saved in Skyvern\nimport { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.login({\n url: \"https://example.com\",\n credential_type: \"skyvern\",\n credential_id: \"cred_123\"\n});\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "// Login with password saved in Bitwarden\nimport { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n// Login with a Bitwarden collection and website url filter\nawait skyvern.login({\n url: \"https://example.com\",\n credential_type: \"bitwarden\",\n bitwarden_collection_id: \"BITWARDEN COLLECTION ID\"\n});\n\n// Login with a Bitwarden item\nawait skyvern.login({\n url: \"https://example.com\",\n credential_type: \"bitwarden\",\n bitwarden_item_id: \"BITWARDEN ITEM ID\"\n});\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "// Login with password saved in 1Password\nimport { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.login({\n url: \"https://example.com\",\n credential_type: \"onepassword\",\n onepassword_vault_id: \"1PASSWORD VAULT ID\",\n onepassword_item_id: \"1PASSWORD ITEM ID\"\n});\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/run/tasks/download_files": {
|
|
"post": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "File Download Task",
|
|
"description": "Download a file from a website by navigating and clicking download buttons",
|
|
"operationId": "download_files_v1_run_tasks_download_files_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."
|
|
},
|
|
{
|
|
"name": "x-user-agent",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "X-User-Agent"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DownloadFilesRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowRunResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-hidden": true,
|
|
"x-excluded": true,
|
|
"x-fern-sdk-method-name": "download_files",
|
|
"x-fern-examples": [
|
|
{
|
|
"code-samples": [
|
|
{
|
|
"sdk": "python",
|
|
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.download_files(\n url=\"https://example.com/downloads\",\n navigation_goal=\"Navigate to the downloads page and click the 'Download PDF' button\",\n download_suffix=\"report.pdf\"\n)\n"
|
|
},
|
|
{
|
|
"sdk": "typescript",
|
|
"code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.downloadFiles({\n url: \"https://example.com/downloads\",\n navigation_goal: \"Navigate to the downloads page and click the 'Download PDF' button\",\n download_suffix: \"report.pdf\"\n});\n"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/scripts": {
|
|
"post": {
|
|
"tags": [
|
|
"Scripts"
|
|
],
|
|
"summary": "Create script",
|
|
"description": "Create a new script with optional files and metadata",
|
|
"operationId": "create_script_v1_scripts_post",
|
|
"parameters": [
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateScriptRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateScriptResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "create_script"
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Scripts"
|
|
],
|
|
"summary": "Get all scripts",
|
|
"description": "Retrieves a paginated list of scripts for the current organization",
|
|
"operationId": "get_scripts_v1_scripts_get",
|
|
"parameters": [
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Page number for pagination",
|
|
"examples": [
|
|
1
|
|
],
|
|
"default": 1,
|
|
"title": "Page"
|
|
},
|
|
"description": "Page number for pagination"
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Number of items per page",
|
|
"examples": [
|
|
10
|
|
],
|
|
"default": 10,
|
|
"title": "Page Size"
|
|
},
|
|
"description": "Number of items per page"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Script"
|
|
},
|
|
"title": "Response Get Scripts V1 Scripts Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_scripts"
|
|
}
|
|
},
|
|
"/v1/scripts/{script_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Scripts"
|
|
],
|
|
"summary": "Get script by ID",
|
|
"description": "Retrieves a specific script by its ID",
|
|
"operationId": "get_script_v1_scripts__script_id__get",
|
|
"parameters": [
|
|
{
|
|
"name": "script_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The unique identifier of the script",
|
|
"examples": [
|
|
"s_abc123"
|
|
],
|
|
"title": "Script Id"
|
|
},
|
|
"description": "The unique identifier of the script"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Script"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_script"
|
|
}
|
|
},
|
|
"/v1/scripts/{script_id}/deploy": {
|
|
"post": {
|
|
"tags": [
|
|
"Scripts"
|
|
],
|
|
"summary": "Deploy script",
|
|
"description": "Deploy a script with updated files, creating a new version",
|
|
"operationId": "deploy_script_v1_scripts__script_id__deploy_post",
|
|
"parameters": [
|
|
{
|
|
"name": "script_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The unique identifier of the script",
|
|
"examples": [
|
|
"s_abc123"
|
|
],
|
|
"title": "Script Id"
|
|
},
|
|
"description": "The unique identifier of the script"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"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/DeployScriptRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateScriptResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "deploy_script"
|
|
}
|
|
},
|
|
"/v1/scripts/{script_id}/run": {
|
|
"post": {
|
|
"tags": [
|
|
"Scripts"
|
|
],
|
|
"summary": "Run script",
|
|
"description": "Run a script",
|
|
"operationId": "run_script_v1_scripts__script_id__run_post",
|
|
"parameters": [
|
|
{
|
|
"name": "script_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The unique identifier of the script",
|
|
"examples": [
|
|
"s_abc123"
|
|
],
|
|
"title": "Script Id"
|
|
},
|
|
"description": "The unique identifier of the script"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/sdk/run_action": {
|
|
"post": {
|
|
"tags": [
|
|
"SDK"
|
|
],
|
|
"summary": "Run an SDK action",
|
|
"description": "Execute a single SDK action with the specified parameters",
|
|
"operationId": "run_sdk_action_v1_sdk_run_action_post",
|
|
"parameters": [
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RunSdkActionRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RunSdkActionResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-excluded": true,
|
|
"x-fern-sdk-method-name": "run_sdk_action"
|
|
}
|
|
},
|
|
"/v1/schedules": {
|
|
"get": {
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "List all schedules for the organization",
|
|
"operationId": "schedules_list_all",
|
|
"parameters": [
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1,
|
|
"title": "Page"
|
|
}
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"default": 10,
|
|
"title": "Page Size"
|
|
}
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"active",
|
|
"paused"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter by status: 'active' or 'paused'",
|
|
"title": "Status"
|
|
},
|
|
"description": "Filter by status: 'active' or 'paused'"
|
|
},
|
|
{
|
|
"name": "search",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Search by workflow title or schedule name",
|
|
"title": "Search"
|
|
},
|
|
"description": "Search by workflow title or schedule name"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OrganizationScheduleListResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/folder": {
|
|
"put": {
|
|
"tags": [
|
|
"Folders"
|
|
],
|
|
"summary": "Update agent folder",
|
|
"description": "Update a workflow's folder assignment for the latest version",
|
|
"operationId": "update_workflow_folder_v1_workflows__workflow_permanent_id__folder_put",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Workflow permanent ID",
|
|
"examples": [
|
|
"wpid_123"
|
|
],
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"description": "Workflow permanent ID"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UpdateWorkflowFolderRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully updated workflow folder",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Workflow"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Workflow not found"
|
|
},
|
|
"400": {
|
|
"description": "Folder not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "update_workflow_folder"
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/tags": {
|
|
"post": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Apply agent tags",
|
|
"description": "Atomically apply tag changes to a workflow. Sets and deletes happen in one transaction; same-key collisions resolve set-wins.",
|
|
"operationId": "apply_workflow_tags_v1_workflows__workflow_permanent_id__tags_post",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Workflow permanent ID",
|
|
"examples": [
|
|
"wpid_123"
|
|
],
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"description": "Workflow permanent ID"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagApplyRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully applied tag changes",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Workflow not found"
|
|
},
|
|
"422": {
|
|
"description": "Invalid tag key or value"
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "apply_workflow_tags"
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Get agent tags",
|
|
"description": "Get the current tag state for a workflow.",
|
|
"operationId": "get_workflow_tags_v1_workflows__workflow_permanent_id__tags_get",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Workflow permanent ID",
|
|
"examples": [
|
|
"wpid_123"
|
|
],
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"description": "Workflow permanent ID"
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully retrieved tags",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Workflow not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_workflow_tags"
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/tags/{key}": {
|
|
"delete": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Delete agent tag",
|
|
"description": "Soft-delete a single tag from a workflow. Writes a DELETE event row.",
|
|
"operationId": "delete_workflow_tag_v1_workflows__workflow_permanent_id__tags__key__delete",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Workflow permanent ID",
|
|
"examples": [
|
|
"wpid_123"
|
|
],
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"description": "Workflow permanent ID"
|
|
},
|
|
{
|
|
"name": "key",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Tag key to delete",
|
|
"examples": [
|
|
"env"
|
|
],
|
|
"title": "Key"
|
|
},
|
|
"description": "Tag key to delete"
|
|
},
|
|
{
|
|
"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 deleted tag (or no-op if absent)",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Workflow not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "delete_workflow_tag"
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/tags/history": {
|
|
"get": {
|
|
"tags": [
|
|
"Tags"
|
|
],
|
|
"summary": "Get agent tag history",
|
|
"description": "Chronological tag-event log for a workflow (newest first). Includes SET and DELETE events.",
|
|
"operationId": "get_workflow_tag_history_v1_workflows__workflow_permanent_id__tags_history_get",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Workflow permanent ID",
|
|
"examples": [
|
|
"wpid_123"
|
|
],
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"description": "Workflow permanent ID"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"maximum": 500,
|
|
"minimum": 1,
|
|
"description": "Max events to return",
|
|
"default": 100,
|
|
"title": "Limit"
|
|
},
|
|
"description": "Max events to return"
|
|
},
|
|
{
|
|
"name": "since",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Only return events at or after this timestamp",
|
|
"title": "Since"
|
|
},
|
|
"description": "Only return events at or after this timestamp"
|
|
},
|
|
{
|
|
"name": "key",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter to events for a single tag key",
|
|
"title": "Key"
|
|
},
|
|
"description": "Filter to events for a single tag key"
|
|
},
|
|
{
|
|
"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 tag history",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TagHistoryResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Workflow not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_workflow_tag_history"
|
|
}
|
|
},
|
|
"/v1/agents/runs/{workflow_run_id}/retry": {
|
|
"post": {
|
|
"tags": [
|
|
"Runs"
|
|
],
|
|
"summary": "Retry a run",
|
|
"description": "Retry a workflow run using the original run parameters.",
|
|
"operationId": "retry_workflow_run_v1_workflows_runs__workflow_run_id__retry_post",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_run_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The id of the workflow run to retry.",
|
|
"examples": [
|
|
"wr_123"
|
|
],
|
|
"title": "Workflow Run Id"
|
|
},
|
|
"description": "The id of the workflow run to retry."
|
|
},
|
|
{
|
|
"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."
|
|
},
|
|
{
|
|
"name": "x-max-steps-override",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "X-Max-Steps-Override"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-user-agent",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "X-User-Agent"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successfully retried workflow run",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowRunResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Workflow run is not retryable"
|
|
},
|
|
"404": {
|
|
"description": "Workflow run not found"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "retry_workflow_run"
|
|
}
|
|
},
|
|
"/v1/agents/runs": {
|
|
"get": {
|
|
"tags": [
|
|
"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",
|
|
"operationId": "get_workflow_runs_v1_workflows_runs_get",
|
|
"parameters": [
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Page number for pagination.",
|
|
"default": 1,
|
|
"title": "Page"
|
|
},
|
|
"description": "Page number for pagination."
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Number of runs to return per page.",
|
|
"default": 10,
|
|
"title": "Page Size"
|
|
},
|
|
"description": "Number of runs to return per page."
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowRunStatus"
|
|
}
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter by one or more run statuses.",
|
|
"title": "Status"
|
|
},
|
|
"description": "Filter by one or more run statuses."
|
|
},
|
|
{
|
|
"name": "search_key",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 500
|
|
},
|
|
{
|
|
"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.",
|
|
"examples": [
|
|
"login_url",
|
|
"credential_value",
|
|
"wr_abc123"
|
|
],
|
|
"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."
|
|
},
|
|
{
|
|
"name": "error_code",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 500
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact-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. Error codes are user-defined strings set during workflow execution.",
|
|
"examples": [
|
|
"INVALID_CREDENTIALS",
|
|
"LOGIN_FAILED",
|
|
"CAPTCHA_DETECTED"
|
|
],
|
|
"title": "Error Code"
|
|
},
|
|
"description": "Exact-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. Error codes are user-defined strings set during workflow execution."
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowRun"
|
|
},
|
|
"title": "Response Get Workflow Runs V1 Workflows Runs Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_workflow_runs"
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_id}/runs": {
|
|
"get": {
|
|
"tags": [
|
|
"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`.",
|
|
"operationId": "get_workflow_runs_by_id_v1_workflows__workflow_id__runs_get",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Page number for pagination.",
|
|
"default": 1,
|
|
"title": "Page"
|
|
},
|
|
"description": "Page number for pagination."
|
|
},
|
|
{
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"description": "Number of runs to return per page.",
|
|
"default": 10,
|
|
"title": "Page Size"
|
|
},
|
|
"description": "Number of runs to return per page."
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowRunStatus"
|
|
}
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filter by one or more run statuses.",
|
|
"title": "Status"
|
|
},
|
|
"description": "Filter by one or more run statuses."
|
|
},
|
|
{
|
|
"name": "search_key",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 500
|
|
},
|
|
{
|
|
"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.",
|
|
"examples": [
|
|
"login_url",
|
|
"credential_value",
|
|
"wr_abc123"
|
|
],
|
|
"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."
|
|
},
|
|
{
|
|
"name": "error_code",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 500
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact-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. Error codes are user-defined strings set during workflow execution.",
|
|
"examples": [
|
|
"INVALID_CREDENTIALS",
|
|
"LOGIN_FAILED",
|
|
"CAPTCHA_DETECTED"
|
|
],
|
|
"title": "Error Code"
|
|
},
|
|
"description": "Exact-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. Error codes are user-defined strings set during workflow execution."
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowRun"
|
|
},
|
|
"title": "Response Get Workflow Runs By Id V1 Workflows Workflow Id Runs Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_workflow_runs_by_id"
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Get an agent by id",
|
|
"operationId": "get_workflow_v1_workflows__workflow_permanent_id__get",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "version",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Version"
|
|
}
|
|
},
|
|
{
|
|
"name": "template",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"title": "Template"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Workflow"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_workflow"
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/versions": {
|
|
"get": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Get agent versions",
|
|
"description": "Get all versions of a workflow by its permanent ID.",
|
|
"operationId": "get_workflow_versions_v1_workflows__workflow_permanent_id__versions_get",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "template",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"title": "Template"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Workflow"
|
|
},
|
|
"title": "Response Get Workflow Versions V1 Workflows Workflow Permanent Id Versions Get"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-fern-sdk-method-name": "get_workflow_versions"
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/browser_session/reset_profile": {
|
|
"post": {
|
|
"tags": [
|
|
"Agents"
|
|
],
|
|
"summary": "Reset persisted browser profile",
|
|
"description": "Clear the persisted browser profile for a workflow that uses `Save & Reuse Session`. The next run will start from a fresh browser state. Use when a saved profile is corrupted.",
|
|
"operationId": "reset_workflow_browser_profile",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The permanent ID of the workflow. Starts with `wpid_`.",
|
|
"examples": [
|
|
"wpid_123"
|
|
],
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"description": "The permanent ID of the workflow. Starts with `wpid_`."
|
|
},
|
|
{
|
|
"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": "Successfully cleared persisted browser profile"
|
|
},
|
|
"404": {
|
|
"description": "Workflow not found"
|
|
},
|
|
"500": {
|
|
"description": "Storage deletion failed; retry"
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-hidden": true
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/schedules": {
|
|
"post": {
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Create a schedule for an agent",
|
|
"operationId": "schedules_create",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowScheduleUpsertRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowScheduleResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "List schedules for an agent",
|
|
"operationId": "schedules_list",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowScheduleListResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Get an agent schedule by id",
|
|
"operationId": "schedules_get",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "workflow_schedule_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Schedule Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowScheduleResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Update an agent schedule",
|
|
"operationId": "schedules_update",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "workflow_schedule_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Schedule Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowScheduleUpsertRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowScheduleResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Delete an agent schedule",
|
|
"operationId": "schedules_delete",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "workflow_schedule_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Schedule Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DeleteScheduleResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/enable": {
|
|
"post": {
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Enable an agent schedule",
|
|
"operationId": "schedules_enable",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "workflow_schedule_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Schedule Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowScheduleResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/disable": {
|
|
"post": {
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Disable an agent schedule",
|
|
"operationId": "schedules_disable",
|
|
"parameters": [
|
|
{
|
|
"name": "workflow_permanent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "workflow_schedule_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Workflow Schedule Id"
|
|
}
|
|
},
|
|
{
|
|
"name": "x-api-key",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
|
"title": "X-Api-Key"
|
|
},
|
|
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WorkflowScheduleResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Validation Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HTTPValidationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"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": {
|
|
"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
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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"
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title",
|
|
"default": ""
|
|
},
|
|
"engine": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"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
|
|
},
|
|
"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",
|
|
"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",
|
|
"title": "Created At",
|
|
"description": "The creation datetime of the task.",
|
|
"examples": [
|
|
"2023-01-01T00:00:00Z"
|
|
]
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"title": "Modified At",
|
|
"description": "The modification datetime of the task.",
|
|
"examples": [
|
|
"2023-01-01T00:00:00Z"
|
|
]
|
|
},
|
|
"artifact_id": {
|
|
"type": "string",
|
|
"title": "Artifact Id"
|
|
},
|
|
"artifact_type": {
|
|
"$ref": "#/components/schemas/ArtifactType"
|
|
},
|
|
"uri": {
|
|
"type": "string",
|
|
"title": "Uri"
|
|
},
|
|
"bundle_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Bundle Key"
|
|
},
|
|
"checksum": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Checksum"
|
|
},
|
|
"file_size": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "File Size"
|
|
},
|
|
"task_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Task Id"
|
|
},
|
|
"step_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Step Id"
|
|
},
|
|
"workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Run Id"
|
|
},
|
|
"workflow_run_block_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Run Block Id"
|
|
},
|
|
"run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run Id"
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id"
|
|
},
|
|
"observer_cruise_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Observer Cruise Id"
|
|
},
|
|
"observer_thought_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Observer Thought Id"
|
|
},
|
|
"ai_suggestion_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Ai Suggestion Id"
|
|
},
|
|
"signed_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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",
|
|
"browser_console_log",
|
|
"skyvern_log",
|
|
"skyvern_log_raw",
|
|
"screenshot",
|
|
"screenshot_llm",
|
|
"screenshot_action",
|
|
"screenshot_final",
|
|
"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",
|
|
"trace",
|
|
"har",
|
|
"script_file",
|
|
"pdf",
|
|
"step_archive",
|
|
"task_archive",
|
|
"download"
|
|
],
|
|
"title": "ArtifactType"
|
|
},
|
|
"AzureSecretParameter": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "azure_secret",
|
|
"title": "Parameter Type",
|
|
"default": "azure_secret"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"azure_secret_parameter_id": {
|
|
"type": "string",
|
|
"title": "Azure Secret Parameter Id"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"azure_key": {
|
|
"type": "string",
|
|
"title": "Azure Key"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"azure_secret_parameter_id",
|
|
"workflow_id",
|
|
"azure_key",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "AzureSecretParameter"
|
|
},
|
|
"AzureVaultCredentialParameter": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "azure_vault_credential",
|
|
"title": "Parameter Type",
|
|
"default": "azure_vault_credential"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
"totp_secret_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Secret Key"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"azure_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"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"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"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"bitwarden_credit_card_data_parameter_id": {
|
|
"type": "string",
|
|
"title": "Bitwarden Credit Card Data Parameter Id"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"bitwarden_client_id_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Client Id Aws Secret Key"
|
|
},
|
|
"bitwarden_client_secret_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Client Secret Aws Secret Key"
|
|
},
|
|
"bitwarden_master_password_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Master Password Aws Secret Key"
|
|
},
|
|
"bitwarden_collection_id": {
|
|
"type": "string",
|
|
"title": "Bitwarden Collection Id"
|
|
},
|
|
"bitwarden_item_id": {
|
|
"type": "string",
|
|
"title": "Bitwarden Item Id"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"bitwarden_credit_card_data_parameter_id",
|
|
"workflow_id",
|
|
"bitwarden_client_id_aws_secret_key",
|
|
"bitwarden_client_secret_aws_secret_key",
|
|
"bitwarden_master_password_aws_secret_key",
|
|
"bitwarden_collection_id",
|
|
"bitwarden_item_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "BitwardenCreditCardDataParameter"
|
|
},
|
|
"BitwardenCreditCardDataParameterYAML": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "bitwarden_credit_card_data",
|
|
"title": "Parameter Type",
|
|
"default": "bitwarden_credit_card_data"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"bitwarden_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": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"bitwarden_login_credential_parameter_id": {
|
|
"type": "string",
|
|
"title": "Bitwarden Login Credential Parameter Id"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"bitwarden_client_id_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Client Id Aws Secret Key"
|
|
},
|
|
"bitwarden_client_secret_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Client Secret Aws Secret Key"
|
|
},
|
|
"bitwarden_master_password_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Master Password Aws Secret Key"
|
|
},
|
|
"url_parameter_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url Parameter Key"
|
|
},
|
|
"bitwarden_collection_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Bitwarden Collection Id"
|
|
},
|
|
"bitwarden_item_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Bitwarden Item Id"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"bitwarden_login_credential_parameter_id",
|
|
"workflow_id",
|
|
"bitwarden_client_id_aws_secret_key",
|
|
"bitwarden_client_secret_aws_secret_key",
|
|
"bitwarden_master_password_aws_secret_key",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "BitwardenLoginCredentialParameter"
|
|
},
|
|
"BitwardenLoginCredentialParameterYAML": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "bitwarden_login_credential",
|
|
"title": "Parameter Type",
|
|
"default": "bitwarden_login_credential"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"bitwarden_client_id_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Client Id Aws Secret Key"
|
|
},
|
|
"bitwarden_client_secret_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Client Secret Aws Secret Key"
|
|
},
|
|
"bitwarden_master_password_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Master Password Aws Secret Key"
|
|
},
|
|
"url_parameter_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url Parameter Key"
|
|
},
|
|
"bitwarden_collection_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Bitwarden Collection Id"
|
|
},
|
|
"bitwarden_item_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Bitwarden Item Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"bitwarden_client_id_aws_secret_key",
|
|
"bitwarden_client_secret_aws_secret_key",
|
|
"bitwarden_master_password_aws_secret_key"
|
|
],
|
|
"title": "BitwardenLoginCredentialParameterYAML"
|
|
},
|
|
"BitwardenSensitiveInformationParameter": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "bitwarden_sensitive_information",
|
|
"title": "Parameter Type",
|
|
"default": "bitwarden_sensitive_information"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"bitwarden_sensitive_information_parameter_id": {
|
|
"type": "string",
|
|
"title": "Bitwarden Sensitive Information Parameter Id"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"bitwarden_client_id_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Client Id Aws Secret Key"
|
|
},
|
|
"bitwarden_client_secret_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Client Secret Aws Secret Key"
|
|
},
|
|
"bitwarden_master_password_aws_secret_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Master Password Aws Secret Key"
|
|
},
|
|
"bitwarden_collection_id": {
|
|
"type": "string",
|
|
"title": "Bitwarden Collection Id"
|
|
},
|
|
"bitwarden_identity_key": {
|
|
"type": "string",
|
|
"title": "Bitwarden Identity Key"
|
|
},
|
|
"bitwarden_identity_fields": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Bitwarden Identity Fields"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"bitwarden_sensitive_information_parameter_id",
|
|
"workflow_id",
|
|
"bitwarden_client_id_aws_secret_key",
|
|
"bitwarden_client_secret_aws_secret_key",
|
|
"bitwarden_master_password_aws_secret_key",
|
|
"bitwarden_collection_id",
|
|
"bitwarden_identity_key",
|
|
"bitwarden_identity_fields",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "BitwardenSensitiveInformationParameter"
|
|
},
|
|
"BitwardenSensitiveInformationParameterYAML": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "bitwarden_sensitive_information",
|
|
"title": "Parameter Type",
|
|
"default": "bitwarden_sensitive_information"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"bitwarden_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",
|
|
"human_interaction",
|
|
"print_page",
|
|
"workflow_trigger",
|
|
"google_sheets_read",
|
|
"google_sheets_write",
|
|
"pdf_fill"
|
|
],
|
|
"title": "BlockType"
|
|
},
|
|
"Body_upload_file_v1_upload_file_post": {
|
|
"properties": {
|
|
"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"
|
|
},
|
|
"criteria": {
|
|
"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": "null"
|
|
}
|
|
],
|
|
"title": "Criteria"
|
|
},
|
|
"next_block_label": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Next Block Label"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"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": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BranchCriteriaYAML"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"next_block_label": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Next Block Label"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"is_default": {
|
|
"type": "boolean",
|
|
"title": "Is Default",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "BranchConditionYAML"
|
|
},
|
|
"BranchCriteriaYAML": {
|
|
"properties": {
|
|
"criteria_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"jinja2_template",
|
|
"prompt"
|
|
],
|
|
"title": "Criteria Type",
|
|
"default": "jinja2_template"
|
|
},
|
|
"expression": {
|
|
"type": "string",
|
|
"title": "Expression"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"expression"
|
|
],
|
|
"title": "BranchCriteriaYAML"
|
|
},
|
|
"BrowserProfile": {
|
|
"properties": {
|
|
"browser_profile_id": {
|
|
"type": "string",
|
|
"title": "Browser Profile Id"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"source_browser_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Source Browser Type"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Location"
|
|
},
|
|
"proxy_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Session Id"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"browser_profile_id",
|
|
"organization_id",
|
|
"name",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "BrowserProfile"
|
|
},
|
|
"BrowserSessionResponse": {
|
|
"properties": {
|
|
"browser_session_id": {
|
|
"type": "string",
|
|
"title": "Browser Session Id",
|
|
"description": "Unique identifier for the browser session. browser_session_id starts with `pbs_`.",
|
|
"examples": [
|
|
"pbs_123456"
|
|
]
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"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": [
|
|
"created",
|
|
"running",
|
|
"completed",
|
|
"failed",
|
|
"timeout"
|
|
]
|
|
},
|
|
"runnable_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Runnable Id",
|
|
"description": "ID of the current runnable",
|
|
"examples": [
|
|
"tsk_123456",
|
|
"wr_123456"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "App Url",
|
|
"description": "Url for the browser session page",
|
|
"examples": [
|
|
"https://app.skyvern.com/browser-session/pbs_123456"
|
|
]
|
|
},
|
|
"extensions": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/Extensions"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extensions",
|
|
"description": "A list of extensions installed in the browser session."
|
|
},
|
|
"browser_type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PersistentBrowserType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "The type of browser used for the session."
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
"download_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Download Path",
|
|
"description": "The path where the browser session downloads files"
|
|
},
|
|
"downloaded_files": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/FileInfo"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Downloaded Files",
|
|
"description": "The list of files downloaded by the browser session"
|
|
},
|
|
"recordings": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/FileInfo"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Recordings",
|
|
"description": "The list of video recordings from the browser session"
|
|
},
|
|
"started_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Started At",
|
|
"description": "Timestamp when the session was started"
|
|
},
|
|
"completed_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Completed At",
|
|
"description": "Timestamp when the session was completed"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At",
|
|
"description": "Timestamp when the session was created (the timestamp for the initial request)"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At",
|
|
"description": "Timestamp when the session was last modified"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At",
|
|
"description": "Timestamp when the session was deleted, if applicable"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"browser_session_id",
|
|
"organization_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "BrowserSessionResponse",
|
|
"description": "Response model for browser session information."
|
|
},
|
|
"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"
|
|
},
|
|
"ClickAction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "ai_click",
|
|
"title": "Type",
|
|
"default": "ai_click"
|
|
},
|
|
"selector": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Selector",
|
|
"description": "CSS selector for the element",
|
|
"default": ""
|
|
},
|
|
"intention": {
|
|
"type": "string",
|
|
"title": "Intention",
|
|
"description": "The intention or goal of the click",
|
|
"default": ""
|
|
},
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data",
|
|
"description": "Additional context data"
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"title": "Timeout",
|
|
"description": "Timeout in milliseconds",
|
|
"default": 5000
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ClickAction",
|
|
"description": "Click action parameters."
|
|
},
|
|
"ClickContext": {
|
|
"properties": {
|
|
"thought": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Thought"
|
|
},
|
|
"single_option_click": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Single Option Click"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ClickContext"
|
|
},
|
|
"CodeBlock": {
|
|
"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": "code",
|
|
"title": "Block Type",
|
|
"default": "code"
|
|
},
|
|
"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
|
|
},
|
|
"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": []
|
|
},
|
|
"prompt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Prompt"
|
|
},
|
|
"steps": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/CodeBlockStep"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Steps"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"code"
|
|
],
|
|
"title": "CodeBlock"
|
|
},
|
|
"CodeBlockStep": {
|
|
"properties": {
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"action_type": {
|
|
"$ref": "#/components/schemas/ActionType",
|
|
"default": "null_action"
|
|
},
|
|
"line_start": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Line Start"
|
|
},
|
|
"line_end": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Line End"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "CodeBlockStep"
|
|
},
|
|
"CodeBlockStepYAML": {
|
|
"properties": {
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"action_type": {
|
|
"type": "string",
|
|
"title": "Action Type",
|
|
"default": "null_action"
|
|
},
|
|
"line_start": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Line Start"
|
|
},
|
|
"line_end": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Line End"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "CodeBlockStepYAML"
|
|
},
|
|
"CodeBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "code",
|
|
"title": "Block Type",
|
|
"default": "code"
|
|
},
|
|
"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
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"title": "Code"
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
},
|
|
"prompt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Prompt"
|
|
},
|
|
"steps": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/CodeBlockStepYAML"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Steps"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"code"
|
|
],
|
|
"title": "CodeBlockYAML"
|
|
},
|
|
"ConditionalBlock": {
|
|
"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": "conditional",
|
|
"title": "Block Type",
|
|
"default": "conditional"
|
|
},
|
|
"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
|
|
},
|
|
"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."
|
|
},
|
|
"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
|
|
},
|
|
"branch_conditions": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/BranchConditionYAML"
|
|
},
|
|
"type": "array",
|
|
"title": "Branch Conditions"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label"
|
|
],
|
|
"title": "ConditionalBlockYAML"
|
|
},
|
|
"ContextParameter": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "context",
|
|
"title": "Parameter Type",
|
|
"default": "context"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowParameter"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ContextParameter"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AWSSecretParameter"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/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"
|
|
}
|
|
],
|
|
"title": "Source"
|
|
},
|
|
"value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Value"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"source"
|
|
],
|
|
"title": "ContextParameter"
|
|
},
|
|
"ContextParameterYAML": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "context",
|
|
"title": "Parameter Type",
|
|
"default": "context"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"source_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": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description",
|
|
"description": "Optional profile description"
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id",
|
|
"description": "Persistent browser session to convert into a profile. Omit for a blank profile."
|
|
},
|
|
"workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Run Id",
|
|
"description": "Workflow run whose persisted session should be captured. Omit for a blank profile."
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Location",
|
|
"description": "Optional proxy location for this profile's pinned proxy identity."
|
|
},
|
|
"proxy_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Session Id",
|
|
"description": "Explicit sticky-session id for this profile's pinned proxy identity."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"name"
|
|
],
|
|
"title": "CreateBrowserProfileRequest"
|
|
},
|
|
"CreateBrowserSessionRequest": {
|
|
"properties": {
|
|
"timeout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"maximum": 1440.0,
|
|
"minimum": 5.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Timeout",
|
|
"description": "Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 1440. Defaults to 60.",
|
|
"default": 60
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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:password@proxy.example.com: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:password@proxy.example.com:8080\"}"
|
|
},
|
|
"proxy_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Session Id",
|
|
"description": "Opaque Skyvern-managed proxy sticky-session id for pinned Residential ISP sessions."
|
|
},
|
|
"extensions": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/Extensions"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extensions",
|
|
"description": "A list of extensions to install in the browser session."
|
|
},
|
|
"browser_type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PersistentBrowserType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "The type of browser to use for the session."
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"pattern": "^bp_"
|
|
},
|
|
{
|
|
"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_`."
|
|
},
|
|
"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
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "CreateBrowserSessionRequest"
|
|
},
|
|
"CreateCredentialRequest": {
|
|
"properties": {
|
|
"name": {
|
|
"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": "user@example.com"
|
|
}
|
|
]
|
|
},
|
|
"vault_type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CredentialVaultType"
|
|
},
|
|
{
|
|
"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": [
|
|
"custom",
|
|
"azure_vault",
|
|
"bitwarden"
|
|
]
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Location",
|
|
"description": "Optional proxy location for this credential's pinned proxy identity."
|
|
},
|
|
"proxy_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Session Id",
|
|
"description": "Optional advanced reuse key for this credential's pinned proxy identity."
|
|
},
|
|
"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
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"credential_type",
|
|
"credential"
|
|
],
|
|
"title": "CreateCredentialRequest",
|
|
"description": "Request model for creating a new credential."
|
|
},
|
|
"CreateScriptRequest": {
|
|
"properties": {
|
|
"workflow_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Id",
|
|
"description": "Associated workflow ID"
|
|
},
|
|
"run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run Id",
|
|
"description": "Associated run ID"
|
|
},
|
|
"files": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/ScriptFileCreate"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"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": "CreateScriptRequest"
|
|
},
|
|
"CreateScriptResponse": {
|
|
"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": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"credential_parameter_id": {
|
|
"type": "string",
|
|
"title": "Credential Parameter Id"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"credential_id": {
|
|
"type": "string",
|
|
"title": "Credential Id"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"credential_parameter_id",
|
|
"workflow_id",
|
|
"credential_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "CredentialParameter"
|
|
},
|
|
"CredentialParameterYAML": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "credential",
|
|
"title": "Parameter Type",
|
|
"default": "credential"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"credential_id": {
|
|
"type": "string",
|
|
"title": "Credential Id"
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
},
|
|
"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": "Name",
|
|
"description": "Name of the credential",
|
|
"examples": [
|
|
"Amazon Login"
|
|
]
|
|
},
|
|
"vault_type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CredentialVaultType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Which vault stores this credential (e.g., 'bitwarden', 'azure_vault', 'custom')"
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id",
|
|
"description": "Browser profile ID linked to this credential"
|
|
},
|
|
"tested_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Tested Url",
|
|
"description": "Login page URL used during the credential test"
|
|
},
|
|
"user_context": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "User Context",
|
|
"description": "User-provided context describing the login sequence (e.g., 'click SSO button first')"
|
|
},
|
|
"save_browser_session_intent": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Save Browser Session Intent",
|
|
"description": "Whether the user intends to save a browser session, regardless of test outcome"
|
|
},
|
|
"folder_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Folder Id",
|
|
"description": "ID of the credential folder this credential belongs to, if any",
|
|
"examples": [
|
|
"cfld_1234567890"
|
|
]
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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": "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"
|
|
],
|
|
"title": "CredentialType",
|
|
"description": "Type of credential stored in the system."
|
|
},
|
|
"CredentialVaultType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"bitwarden",
|
|
"azure_vault",
|
|
"gcp",
|
|
"custom"
|
|
],
|
|
"title": "CredentialVaultType"
|
|
},
|
|
"CreditCardBillingAddress": {
|
|
"properties": {
|
|
"line1": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Line1",
|
|
"description": "Billing address line 1",
|
|
"examples": [
|
|
"123 Main St"
|
|
]
|
|
},
|
|
"line2": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Line2",
|
|
"description": "Billing address line 2",
|
|
"examples": [
|
|
"Apt 4B"
|
|
]
|
|
},
|
|
"city": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "City",
|
|
"description": "Billing city",
|
|
"examples": [
|
|
"San Francisco"
|
|
]
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "State",
|
|
"description": "Billing state or region",
|
|
"examples": [
|
|
"California"
|
|
]
|
|
},
|
|
"state_code": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "State Code",
|
|
"description": "Billing state or region code",
|
|
"examples": [
|
|
"CA"
|
|
]
|
|
},
|
|
"postal_code": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Postal Code",
|
|
"description": "Billing postal code",
|
|
"examples": [
|
|
"94105"
|
|
]
|
|
},
|
|
"country": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Country",
|
|
"description": "Billing country",
|
|
"examples": [
|
|
"United States"
|
|
]
|
|
},
|
|
"country_code": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"brand": {
|
|
"type": "string",
|
|
"title": "Brand",
|
|
"description": "Brand of the credit card",
|
|
"examples": [
|
|
"visa"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"last_four",
|
|
"brand"
|
|
],
|
|
"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."
|
|
},
|
|
"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": [
|
|
{
|
|
"content": "cHJpbnQoIkhlbGxvLCBXb3JsZCEiKQ==",
|
|
"encoding": "base64",
|
|
"mime_type": "text/x-python",
|
|
"path": "src/main.py"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"files"
|
|
],
|
|
"title": "DeployScriptRequest",
|
|
"description": "Request model for deploying a script with updated files."
|
|
},
|
|
"DownloadFilesRequest": {
|
|
"properties": {
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url",
|
|
"description": "Website URL"
|
|
},
|
|
"webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Url",
|
|
"description": "Webhook URL to send status updates"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Proxy location to use"
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "Identifier for TOTP (Time-based One-Time Password) if required"
|
|
},
|
|
"totp_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Url",
|
|
"description": "TOTP URL to fetch one-time passwords"
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id",
|
|
"description": "ID of a browser profile to reuse for this run"
|
|
},
|
|
"browser_address": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers",
|
|
"description": "Additional HTTP headers to include in requests"
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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."
|
|
},
|
|
"max_screenshot_scrolling_times": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
"download_suffix": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Download Suffix",
|
|
"description": "Suffix or complete filename for the downloaded file"
|
|
},
|
|
"download_timeout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Download Timeout",
|
|
"description": "Timeout in seconds for the download operation"
|
|
},
|
|
"max_steps_per_run": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"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."
|
|
},
|
|
"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": "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": [
|
|
{
|
|
"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
|
|
},
|
|
"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"
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"title": "Url"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"url"
|
|
],
|
|
"title": "DownloadToS3BlockYAML"
|
|
},
|
|
"Extensions": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ad-blocker",
|
|
"captcha-solver"
|
|
],
|
|
"title": "Extensions"
|
|
},
|
|
"ExtractAction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "extract",
|
|
"title": "Type",
|
|
"default": "extract"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt",
|
|
"description": "Extraction prompt",
|
|
"default": ""
|
|
},
|
|
"extract_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extract Schema",
|
|
"description": "Schema for extraction"
|
|
},
|
|
"error_code_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Error Code Mapping",
|
|
"description": "Error code mapping for extraction"
|
|
},
|
|
"intention": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Intention",
|
|
"description": "The intention or goal of the extraction"
|
|
},
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data",
|
|
"description": "Additional context data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ExtractAction",
|
|
"description": "Extract data action parameters."
|
|
},
|
|
"ExtractionBlock": {
|
|
"properties": {
|
|
"label": {
|
|
"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": "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": [
|
|
{
|
|
"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": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"type": "string",
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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": 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
|
|
},
|
|
"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"
|
|
},
|
|
"disable_cache": {
|
|
"type": "boolean",
|
|
"title": "Disable Cache",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"data_extraction_goal"
|
|
],
|
|
"title": "ExtractionBlockYAML"
|
|
},
|
|
"FileDownloadBlock": {
|
|
"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": "file_download",
|
|
"title": "Block Type",
|
|
"default": "file_download"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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
|
|
}
|
|
},
|
|
"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."
|
|
},
|
|
"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
|
|
},
|
|
"navigation_goal": {
|
|
"type": "string",
|
|
"title": "Navigation Goal"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title",
|
|
"default": ""
|
|
},
|
|
"engine": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"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"
|
|
},
|
|
"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
|
|
},
|
|
"download_timeout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Download Timeout"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"navigation_goal"
|
|
],
|
|
"title": "FileDownloadBlockYAML"
|
|
},
|
|
"FileEncoding": {
|
|
"type": "string",
|
|
"enum": [
|
|
"base64",
|
|
"utf-8"
|
|
],
|
|
"title": "FileEncoding",
|
|
"description": "Supported file content encodings."
|
|
},
|
|
"FileInfo": {
|
|
"properties": {
|
|
"url": {
|
|
"type": "string",
|
|
"title": "Url",
|
|
"description": "URL to access the file"
|
|
},
|
|
"checksum": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Checksum",
|
|
"description": "SHA-256 checksum of the file"
|
|
},
|
|
"filename": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Filename",
|
|
"description": "Original filename"
|
|
},
|
|
"file_size": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "File Size",
|
|
"description": "Size of the file in bytes"
|
|
},
|
|
"modified_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Modified At",
|
|
"description": "Modified time of the file"
|
|
},
|
|
"artifact_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Artifact Id",
|
|
"description": "Artifact row id for refresh-on-read"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"url"
|
|
],
|
|
"title": "FileInfo",
|
|
"description": "Information about a downloaded file, including URL and checksum."
|
|
},
|
|
"FileNode": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"title": "Type",
|
|
"description": "Type of node: 'file' or 'directory'"
|
|
},
|
|
"size": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Size",
|
|
"description": "File size in bytes"
|
|
},
|
|
"mime_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Mime Type",
|
|
"description": "MIME type of the file"
|
|
},
|
|
"content_hash": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Content Hash",
|
|
"description": "SHA256 hash of file content"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At",
|
|
"description": "Timestamp when the file was created"
|
|
},
|
|
"children": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"$ref": "#/components/schemas/FileNode"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Children",
|
|
"description": "Child nodes for directories"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"created_at"
|
|
],
|
|
"title": "FileNode",
|
|
"description": "Model representing a file or directory in the file tree."
|
|
},
|
|
"FileParserBlock": {
|
|
"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": "file_url_parser",
|
|
"title": "Block Type",
|
|
"default": "file_url_parser"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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
|
|
},
|
|
"file_url": {
|
|
"type": "string",
|
|
"title": "File Url"
|
|
},
|
|
"file_type": {
|
|
"$ref": "#/components/schemas/FileType",
|
|
"default": "auto_detect"
|
|
},
|
|
"json_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Json Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"file_url"
|
|
],
|
|
"title": "FileParserBlock"
|
|
},
|
|
"FileParserBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "file_url_parser",
|
|
"title": "Block Type",
|
|
"default": "file_url_parser"
|
|
},
|
|
"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
|
|
},
|
|
"file_url": {
|
|
"type": "string",
|
|
"title": "File Url"
|
|
},
|
|
"file_type": {
|
|
"$ref": "#/components/schemas/FileType",
|
|
"default": "auto_detect"
|
|
},
|
|
"json_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Json Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"file_url"
|
|
],
|
|
"title": "FileParserBlockYAML"
|
|
},
|
|
"FileStorageType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"s3",
|
|
"azure",
|
|
"google_drive"
|
|
],
|
|
"title": "FileStorageType"
|
|
},
|
|
"FileType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"auto_detect",
|
|
"csv",
|
|
"excel",
|
|
"pdf",
|
|
"image",
|
|
"docx"
|
|
],
|
|
"title": "FileType"
|
|
},
|
|
"FileUploadBlock": {
|
|
"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": "file_upload",
|
|
"title": "Block Type",
|
|
"default": "file_upload"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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
|
|
},
|
|
"storage_type": {
|
|
"$ref": "#/components/schemas/FileStorageType",
|
|
"default": "s3"
|
|
},
|
|
"s3_bucket": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "S3 Bucket"
|
|
},
|
|
"aws_access_key_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Aws Access Key Id"
|
|
},
|
|
"aws_secret_access_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Aws Secret Access Key"
|
|
},
|
|
"region_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Region Name"
|
|
},
|
|
"azure_storage_account_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Storage Account Name"
|
|
},
|
|
"azure_storage_account_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Storage Account Key"
|
|
},
|
|
"azure_blob_container_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Blob Container Name"
|
|
},
|
|
"google_credential_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Google Credential Id"
|
|
},
|
|
"google_drive_folder_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Google Drive Folder Id"
|
|
},
|
|
"path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Path"
|
|
},
|
|
"continue_on_empty": {
|
|
"type": "boolean",
|
|
"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
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter"
|
|
],
|
|
"title": "FileUploadBlock"
|
|
},
|
|
"FileUploadBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "file_upload",
|
|
"title": "Block Type",
|
|
"default": "file_upload"
|
|
},
|
|
"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
|
|
},
|
|
"storage_type": {
|
|
"$ref": "#/components/schemas/FileStorageType",
|
|
"default": "s3"
|
|
},
|
|
"s3_bucket": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "S3 Bucket"
|
|
},
|
|
"aws_access_key_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Aws Access Key Id"
|
|
},
|
|
"aws_secret_access_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Aws Secret Access Key"
|
|
},
|
|
"region_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Region Name"
|
|
},
|
|
"azure_storage_account_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Storage Account Name"
|
|
},
|
|
"azure_storage_account_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Storage Account Key"
|
|
},
|
|
"azure_blob_container_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Blob Container Name"
|
|
},
|
|
"azure_folder_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Folder Path"
|
|
},
|
|
"google_credential_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Google Credential Id"
|
|
},
|
|
"google_drive_folder_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Google Drive Folder Id"
|
|
},
|
|
"path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Path"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label"
|
|
],
|
|
"title": "FileUploadBlockYAML"
|
|
},
|
|
"Folder": {
|
|
"properties": {
|
|
"title": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"title": "Title",
|
|
"description": "Folder title"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description",
|
|
"description": "Folder description"
|
|
},
|
|
"folder_id": {
|
|
"type": "string",
|
|
"title": "Folder Id"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id"
|
|
},
|
|
"workflow_count": {
|
|
"type": "integer",
|
|
"title": "Workflow Count",
|
|
"description": "Number of workflows in this folder",
|
|
"default": 0
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"title",
|
|
"folder_id",
|
|
"organization_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "Folder",
|
|
"description": "Response model for a folder"
|
|
},
|
|
"FolderCreate": {
|
|
"properties": {
|
|
"title": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"title": "Title",
|
|
"description": "Folder title"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description",
|
|
"description": "Folder description"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"title"
|
|
],
|
|
"title": "FolderCreate",
|
|
"description": "Request model for creating a folder"
|
|
},
|
|
"FolderUpdate": {
|
|
"properties": {
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"minLength": 1
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title",
|
|
"description": "Folder title"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description",
|
|
"description": "Folder description"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "FolderUpdate",
|
|
"description": "Request model for updating a folder"
|
|
},
|
|
"ForLoopBlock": {
|
|
"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": "for_loop",
|
|
"title": "Block Type",
|
|
"default": "for_loop"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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
|
|
},
|
|
"loop_blocks": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ForLoopBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WhileLoopBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CodeBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextPromptBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DownloadToS3Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UploadToS3Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SendEmailBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileParserBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PDFParserBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ValidationBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ActionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/NavigationBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ExtractionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LoginBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WaitBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HumanInteractionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileDownloadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UrlBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskV2Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileUploadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HttpRequestBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PrintPageBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowTriggerBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsReadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsWriteBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PdfFillBlock"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "block_type",
|
|
"mapping": {
|
|
"action": "#/components/schemas/ActionBlock",
|
|
"code": "#/components/schemas/CodeBlock",
|
|
"conditional": "#/components/schemas/ConditionalBlock",
|
|
"download_to_s3": "#/components/schemas/DownloadToS3Block",
|
|
"extraction": "#/components/schemas/ExtractionBlock",
|
|
"file_download": "#/components/schemas/FileDownloadBlock",
|
|
"file_upload": "#/components/schemas/FileUploadBlock",
|
|
"file_url_parser": "#/components/schemas/FileParserBlock",
|
|
"for_loop": "#/components/schemas/ForLoopBlock",
|
|
"google_sheets_read": "#/components/schemas/GoogleSheetsReadBlock",
|
|
"google_sheets_write": "#/components/schemas/GoogleSheetsWriteBlock",
|
|
"goto_url": "#/components/schemas/UrlBlock",
|
|
"http_request": "#/components/schemas/HttpRequestBlock",
|
|
"human_interaction": "#/components/schemas/HumanInteractionBlock",
|
|
"login": "#/components/schemas/LoginBlock",
|
|
"navigation": "#/components/schemas/NavigationBlock",
|
|
"pdf_fill": "#/components/schemas/PdfFillBlock",
|
|
"pdf_parser": "#/components/schemas/PDFParserBlock",
|
|
"print_page": "#/components/schemas/PrintPageBlock",
|
|
"send_email": "#/components/schemas/SendEmailBlock",
|
|
"task": "#/components/schemas/TaskBlock",
|
|
"task_v2": "#/components/schemas/TaskV2Block",
|
|
"text_prompt": "#/components/schemas/TextPromptBlock",
|
|
"upload_to_s3": "#/components/schemas/UploadToS3Block",
|
|
"validation": "#/components/schemas/ValidationBlock",
|
|
"wait": "#/components/schemas/WaitBlock",
|
|
"while_loop": "#/components/schemas/WhileLoopBlock",
|
|
"workflow_trigger": "#/components/schemas/WorkflowTriggerBlock"
|
|
}
|
|
}
|
|
},
|
|
"type": "array",
|
|
"title": "Loop Blocks"
|
|
},
|
|
"loop_over": {
|
|
"anyOf": [
|
|
{
|
|
"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": "null"
|
|
}
|
|
],
|
|
"title": "Loop Over"
|
|
},
|
|
"loop_variable_reference": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Loop Variable Reference"
|
|
},
|
|
"complete_if_empty": {
|
|
"type": "boolean",
|
|
"title": "Complete If Empty",
|
|
"default": false
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"loop_blocks"
|
|
],
|
|
"title": "ForLoopBlock"
|
|
},
|
|
"ForLoopBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "for_loop",
|
|
"title": "Block Type",
|
|
"default": "for_loop"
|
|
},
|
|
"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
|
|
},
|
|
"loop_blocks": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TaskBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ForLoopBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WhileLoopBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CodeBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextPromptBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DownloadToS3BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UploadToS3BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileUploadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SendEmailBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileParserBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ValidationBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ActionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/NavigationBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ExtractionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LoginBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WaitBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HumanInteractionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileDownloadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UrlBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PDFParserBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskV2BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HttpRequestBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PrintPageBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PdfFillBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowTriggerBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsReadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsWriteBlockYAML"
|
|
}
|
|
]
|
|
},
|
|
"type": "array",
|
|
"title": "Loop Blocks"
|
|
},
|
|
"loop_over_parameter_key": {
|
|
"type": "string",
|
|
"title": "Loop Over Parameter Key",
|
|
"default": ""
|
|
},
|
|
"loop_variable_reference": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Loop Variable Reference"
|
|
},
|
|
"complete_if_empty": {
|
|
"type": "boolean",
|
|
"title": "Complete If Empty",
|
|
"default": false
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"loop_blocks"
|
|
],
|
|
"title": "ForLoopBlockYAML"
|
|
},
|
|
"GeoTarget": {
|
|
"properties": {
|
|
"country": {
|
|
"type": "string",
|
|
"maxLength": 2,
|
|
"minLength": 2,
|
|
"title": "Country",
|
|
"description": "ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE')",
|
|
"examples": [
|
|
"US",
|
|
"GB",
|
|
"DE",
|
|
"FR"
|
|
]
|
|
},
|
|
"subdivision": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Subdivision",
|
|
"description": "ISO 3166-2 subdivision code without country prefix (e.g., 'CA' for California, 'NY' for New York)",
|
|
"examples": [
|
|
"CA",
|
|
"NY",
|
|
"TX",
|
|
"ENG"
|
|
]
|
|
},
|
|
"city": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"maxLength": 100
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "City",
|
|
"description": "City name in English from GeoNames (e.g., 'New York', 'Los Angeles', 'London')",
|
|
"examples": [
|
|
"New York",
|
|
"Los Angeles",
|
|
"London",
|
|
"Berlin"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"country"
|
|
],
|
|
"title": "GeoTarget",
|
|
"description": "Granular proxy geo-targeting request with country, optional subdivision, and optional city."
|
|
},
|
|
"GoogleSheetsReadBlock": {
|
|
"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": "google_sheets_read",
|
|
"title": "Block Type",
|
|
"default": "google_sheets_read"
|
|
},
|
|
"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
|
|
},
|
|
"spreadsheet_url": {
|
|
"type": "string",
|
|
"title": "Spreadsheet Url"
|
|
},
|
|
"sheet_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Sheet Name"
|
|
},
|
|
"range": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Range"
|
|
},
|
|
"credential_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Credential Id"
|
|
},
|
|
"has_header_row": {
|
|
"type": "boolean",
|
|
"title": "Has Header Row",
|
|
"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": [
|
|
"label",
|
|
"output_parameter",
|
|
"spreadsheet_url"
|
|
],
|
|
"title": "GoogleSheetsReadBlock"
|
|
},
|
|
"GoogleSheetsReadBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "google_sheets_read",
|
|
"title": "Block Type",
|
|
"default": "google_sheets_read"
|
|
},
|
|
"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
|
|
},
|
|
"spreadsheet_url": {
|
|
"type": "string",
|
|
"title": "Spreadsheet Url"
|
|
},
|
|
"sheet_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Sheet Name"
|
|
},
|
|
"range": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Range"
|
|
},
|
|
"credential_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Credential Id"
|
|
},
|
|
"has_header_row": {
|
|
"type": "boolean",
|
|
"title": "Has Header Row",
|
|
"default": true
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"spreadsheet_url"
|
|
],
|
|
"title": "GoogleSheetsReadBlockYAML"
|
|
},
|
|
"GoogleSheetsWriteBlock": {
|
|
"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": "google_sheets_write",
|
|
"title": "Block Type",
|
|
"default": "google_sheets_write"
|
|
},
|
|
"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
|
|
},
|
|
"spreadsheet_url": {
|
|
"type": "string",
|
|
"title": "Spreadsheet Url"
|
|
},
|
|
"sheet_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Sheet Name"
|
|
},
|
|
"range": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Range"
|
|
},
|
|
"credential_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Credential Id"
|
|
},
|
|
"write_mode": {
|
|
"type": "string",
|
|
"enum": [
|
|
"append",
|
|
"update"
|
|
],
|
|
"title": "Write Mode",
|
|
"default": "append"
|
|
},
|
|
"values": {
|
|
"type": "string",
|
|
"title": "Values",
|
|
"default": ""
|
|
},
|
|
"column_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Column Mapping"
|
|
},
|
|
"create_sheet_if_missing": {
|
|
"type": "boolean",
|
|
"title": "Create Sheet If Missing",
|
|
"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",
|
|
"spreadsheet_url"
|
|
],
|
|
"title": "GoogleSheetsWriteBlock"
|
|
},
|
|
"GoogleSheetsWriteBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "google_sheets_write",
|
|
"title": "Block Type",
|
|
"default": "google_sheets_write"
|
|
},
|
|
"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
|
|
},
|
|
"spreadsheet_url": {
|
|
"type": "string",
|
|
"title": "Spreadsheet Url"
|
|
},
|
|
"sheet_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Sheet Name"
|
|
},
|
|
"range": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Range"
|
|
},
|
|
"credential_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Credential Id"
|
|
},
|
|
"write_mode": {
|
|
"type": "string",
|
|
"enum": [
|
|
"append",
|
|
"update"
|
|
],
|
|
"title": "Write Mode",
|
|
"default": "append"
|
|
},
|
|
"values": {
|
|
"type": "string",
|
|
"title": "Values",
|
|
"default": ""
|
|
},
|
|
"column_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Column Mapping"
|
|
},
|
|
"create_sheet_if_missing": {
|
|
"type": "boolean",
|
|
"title": "Create Sheet If Missing",
|
|
"default": false
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"spreadsheet_url"
|
|
],
|
|
"title": "GoogleSheetsWriteBlockYAML"
|
|
},
|
|
"HTTPValidationError": {
|
|
"properties": {
|
|
"detail": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ValidationError"
|
|
},
|
|
"type": "array",
|
|
"title": "Detail"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "HTTPValidationError"
|
|
},
|
|
"HttpRequestBlock": {
|
|
"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": "http_request",
|
|
"title": "Block Type",
|
|
"default": "http_request"
|
|
},
|
|
"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
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"title": "Method",
|
|
"default": "GET"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Headers"
|
|
},
|
|
"body": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Body"
|
|
},
|
|
"files": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Files"
|
|
},
|
|
"timeout": {
|
|
"type": "integer",
|
|
"title": "Timeout",
|
|
"default": 30
|
|
},
|
|
"follow_redirects": {
|
|
"type": "boolean",
|
|
"title": "Follow Redirects",
|
|
"default": true
|
|
},
|
|
"download_filename": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Download Filename"
|
|
},
|
|
"save_response_as_file": {
|
|
"type": "boolean",
|
|
"title": "Save Response As File",
|
|
"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"
|
|
],
|
|
"title": "HttpRequestBlock"
|
|
},
|
|
"HttpRequestBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "http_request",
|
|
"title": "Block Type",
|
|
"default": "http_request"
|
|
},
|
|
"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
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"title": "Method",
|
|
"default": "GET"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Headers"
|
|
},
|
|
"body": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Body"
|
|
},
|
|
"files": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Files"
|
|
},
|
|
"timeout": {
|
|
"type": "integer",
|
|
"title": "Timeout",
|
|
"default": 30
|
|
},
|
|
"follow_redirects": {
|
|
"type": "boolean",
|
|
"title": "Follow Redirects",
|
|
"default": true
|
|
},
|
|
"download_filename": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Download Filename"
|
|
},
|
|
"save_response_as_file": {
|
|
"type": "boolean",
|
|
"title": "Save Response As File",
|
|
"default": false
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label"
|
|
],
|
|
"title": "HttpRequestBlockYAML"
|
|
},
|
|
"HumanInteractionBlock": {
|
|
"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": "human_interaction",
|
|
"title": "Block Type",
|
|
"default": "human_interaction"
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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
|
|
},
|
|
"instructions": {
|
|
"type": "string",
|
|
"title": "Instructions",
|
|
"default": "Please review and approve or reject to continue the workflow."
|
|
},
|
|
"positive_descriptor": {
|
|
"type": "string",
|
|
"title": "Positive Descriptor",
|
|
"default": "Approve"
|
|
},
|
|
"negative_descriptor": {
|
|
"type": "string",
|
|
"title": "Negative Descriptor",
|
|
"default": "Reject"
|
|
},
|
|
"timeout_seconds": {
|
|
"type": "integer",
|
|
"title": "Timeout Seconds",
|
|
"default": 7200
|
|
},
|
|
"sender": {
|
|
"type": "string",
|
|
"title": "Sender",
|
|
"default": "hello@skyvern.com"
|
|
},
|
|
"recipients": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Recipients",
|
|
"default": []
|
|
},
|
|
"subject": {
|
|
"type": "string",
|
|
"title": "Subject",
|
|
"default": "Human interaction required for workflow run"
|
|
},
|
|
"body": {
|
|
"type": "string",
|
|
"title": "Body",
|
|
"default": "Your interaction is required for a workflow run!"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter"
|
|
],
|
|
"title": "HumanInteractionBlock",
|
|
"description": "A block for human/agent interaction.\n\nFor the first pass at this, the implicit behaviour is that the user is given a single binary\nchoice (a go//no-go).\n\nIf the human:\n - chooses positively, the workflow continues\n - chooses negatively, the workflow is terminated\n - does not respond within the timeout period, the workflow terminates"
|
|
},
|
|
"HumanInteractionBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "human_interaction",
|
|
"title": "Block Type",
|
|
"default": "human_interaction"
|
|
},
|
|
"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
|
|
},
|
|
"instructions": {
|
|
"type": "string",
|
|
"title": "Instructions",
|
|
"default": "Please review and approve or reject to continue the workflow."
|
|
},
|
|
"positive_descriptor": {
|
|
"type": "string",
|
|
"title": "Positive Descriptor",
|
|
"default": "Approve"
|
|
},
|
|
"negative_descriptor": {
|
|
"type": "string",
|
|
"title": "Negative Descriptor",
|
|
"default": "Reject"
|
|
},
|
|
"timeout_seconds": {
|
|
"type": "integer",
|
|
"title": "Timeout Seconds"
|
|
},
|
|
"sender": {
|
|
"type": "string",
|
|
"title": "Sender"
|
|
},
|
|
"recipients": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Recipients"
|
|
},
|
|
"subject": {
|
|
"type": "string",
|
|
"title": "Subject"
|
|
},
|
|
"body": {
|
|
"type": "string",
|
|
"title": "Body"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"timeout_seconds",
|
|
"sender",
|
|
"recipients",
|
|
"subject",
|
|
"body"
|
|
],
|
|
"title": "HumanInteractionBlockYAML"
|
|
},
|
|
"InputOrSelectContext": {
|
|
"properties": {
|
|
"intention": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Intention"
|
|
},
|
|
"field": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Field"
|
|
},
|
|
"is_required": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Is Required"
|
|
},
|
|
"is_search_bar": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Is Search Bar"
|
|
},
|
|
"is_location_input": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Is Location Input"
|
|
},
|
|
"is_date_related": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Is Date Related"
|
|
},
|
|
"date_format": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Date Format"
|
|
},
|
|
"is_text_captcha": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Is Text Captcha"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "InputOrSelectContext"
|
|
},
|
|
"InputTextAction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "ai_input_text",
|
|
"title": "Type",
|
|
"default": "ai_input_text"
|
|
},
|
|
"selector": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Selector",
|
|
"description": "CSS selector for the element",
|
|
"default": ""
|
|
},
|
|
"value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Value",
|
|
"description": "Value to input",
|
|
"default": ""
|
|
},
|
|
"intention": {
|
|
"type": "string",
|
|
"title": "Intention",
|
|
"description": "The intention or goal of the input",
|
|
"default": ""
|
|
},
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data",
|
|
"description": "Additional context data"
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "TOTP identifier for input_text actions"
|
|
},
|
|
"totp_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Url",
|
|
"description": "TOTP URL for input_text actions"
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"title": "Timeout",
|
|
"description": "Timeout in milliseconds",
|
|
"default": 5000
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "InputTextAction",
|
|
"description": "Input text action parameters."
|
|
},
|
|
"JinjaBranchCriteria": {
|
|
"properties": {
|
|
"criteria_type": {
|
|
"type": "string",
|
|
"const": "jinja2_template",
|
|
"title": "Criteria Type",
|
|
"default": "jinja2_template"
|
|
},
|
|
"expression": {
|
|
"type": "string",
|
|
"title": "Expression"
|
|
},
|
|
"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)."
|
|
},
|
|
"LocateElementAction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "locate_element",
|
|
"title": "Type",
|
|
"default": "locate_element"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt",
|
|
"description": "Natural language prompt to locate an element",
|
|
"default": ""
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "LocateElementAction",
|
|
"description": "Locate element action parameters."
|
|
},
|
|
"LoginBlock": {
|
|
"properties": {
|
|
"label": {
|
|
"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": "login",
|
|
"title": "Block Type",
|
|
"default": "login"
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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
|
|
},
|
|
"skip_saved_profile": {
|
|
"type": "boolean",
|
|
"title": "Skip Saved Profile",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter"
|
|
],
|
|
"title": "LoginBlock"
|
|
},
|
|
"LoginBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "login",
|
|
"title": "Block Type",
|
|
"default": "login"
|
|
},
|
|
"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
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title",
|
|
"default": ""
|
|
},
|
|
"engine": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"error_code_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Error Code Mapping"
|
|
},
|
|
"max_retries": {
|
|
"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"
|
|
},
|
|
"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
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"complete_verification": {
|
|
"type": "boolean",
|
|
"title": "Complete Verification",
|
|
"default": true
|
|
},
|
|
"skip_saved_profile": {
|
|
"type": "boolean",
|
|
"title": "Skip Saved Profile",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label"
|
|
],
|
|
"title": "LoginBlockYAML"
|
|
},
|
|
"LoginRequest": {
|
|
"properties": {
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url",
|
|
"description": "Website URL"
|
|
},
|
|
"webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Url",
|
|
"description": "Webhook URL to send status updates"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Proxy location to use"
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "Identifier for TOTP (Time-based One-Time Password) if required"
|
|
},
|
|
"totp_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Url",
|
|
"description": "TOTP URL to fetch one-time passwords"
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id",
|
|
"description": "ID of a browser profile to reuse for this run"
|
|
},
|
|
"browser_address": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers",
|
|
"description": "Additional HTTP headers to include in requests"
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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."
|
|
},
|
|
"max_screenshot_scrolling_times": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolling Times",
|
|
"description": "Maximum number of times to scroll for screenshots"
|
|
},
|
|
"credential_type": {
|
|
"$ref": "#/components/schemas/skyvern__schemas__credential_type__CredentialType",
|
|
"description": "Where to get the credential from"
|
|
},
|
|
"prompt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Prompt",
|
|
"description": "Login instructions. Skyvern has default prompt/instruction for login if this field is not provided."
|
|
},
|
|
"credential_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Credential Id",
|
|
"description": "ID of the Skyvern credential to use for login.",
|
|
"examples": [
|
|
"cred_123"
|
|
]
|
|
},
|
|
"bitwarden_collection_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Bitwarden Collection Id",
|
|
"description": "Bitwarden collection ID. You can find it in the Bitwarden collection URL. e.g. `https://vault.bitwarden.com/vaults/collection_id/items`"
|
|
},
|
|
"bitwarden_item_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Bitwarden Item Id",
|
|
"description": "Bitwarden item ID"
|
|
},
|
|
"onepassword_vault_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Onepassword Vault Id",
|
|
"description": "1Password vault ID"
|
|
},
|
|
"onepassword_item_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Onepassword Item Id",
|
|
"description": "1Password item ID"
|
|
},
|
|
"azure_vault_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Vault Name",
|
|
"description": "Azure Vault Name"
|
|
},
|
|
"azure_vault_username_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Vault Username Key",
|
|
"description": "Azure Vault username key"
|
|
},
|
|
"azure_vault_password_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Vault Password Key",
|
|
"description": "Azure Vault password key"
|
|
},
|
|
"azure_vault_totp_secret_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Azure Vault Totp Secret Key",
|
|
"description": "Azure Vault TOTP secret key"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"credential_type"
|
|
],
|
|
"title": "LoginRequest"
|
|
},
|
|
"NavigationBlock": {
|
|
"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": "navigation",
|
|
"title": "Block Type",
|
|
"default": "navigation"
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"type": "string",
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"navigation_goal"
|
|
],
|
|
"title": "NavigationBlock"
|
|
},
|
|
"NavigationBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "navigation",
|
|
"title": "Block Type",
|
|
"default": "navigation"
|
|
},
|
|
"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
|
|
},
|
|
"navigation_goal": {
|
|
"type": "string",
|
|
"title": "Navigation Goal"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title",
|
|
"default": ""
|
|
},
|
|
"engine": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"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
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"complete_verification": {
|
|
"type": "boolean",
|
|
"title": "Complete Verification",
|
|
"default": true
|
|
},
|
|
"include_action_history_in_verification": {
|
|
"type": "boolean",
|
|
"title": "Include Action History In Verification",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"navigation_goal"
|
|
],
|
|
"title": "NavigationBlockYAML"
|
|
},
|
|
"NonEmptyCreditCardCredential": {
|
|
"properties": {
|
|
"card_number": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Card Number",
|
|
"description": "The full credit card number (must not be empty)",
|
|
"examples": [
|
|
"4111111111111111"
|
|
]
|
|
},
|
|
"card_cvv": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Card Cvv",
|
|
"description": "The card's CVV (must not be empty)",
|
|
"examples": [
|
|
"123"
|
|
]
|
|
},
|
|
"card_exp_month": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Card Exp Month",
|
|
"description": "The card's expiration month (must not be empty)",
|
|
"examples": [
|
|
"12"
|
|
]
|
|
},
|
|
"card_exp_year": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Card Exp Year",
|
|
"description": "The card's expiration year (must not be empty)",
|
|
"examples": [
|
|
"2025"
|
|
]
|
|
},
|
|
"card_brand": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Card Brand",
|
|
"description": "The card's brand (must not be empty)",
|
|
"examples": [
|
|
"visa"
|
|
]
|
|
},
|
|
"card_holder_name": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Card Holder Name",
|
|
"description": "The name of the card holder (must not be empty)",
|
|
"examples": [
|
|
"John Doe"
|
|
]
|
|
},
|
|
"billing_address": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreditCardBillingAddress"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional billing address associated with the card"
|
|
},
|
|
"billing_email": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Billing Email",
|
|
"description": "Optional billing email address"
|
|
},
|
|
"billing_phone": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Billing Phone",
|
|
"description": "Optional billing phone number"
|
|
},
|
|
"metadata": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Metadata",
|
|
"description": "Optional additional credit card metadata fields"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"card_number",
|
|
"card_cvv",
|
|
"card_exp_month",
|
|
"card_exp_year",
|
|
"card_brand",
|
|
"card_holder_name"
|
|
],
|
|
"title": "NonEmptyCreditCardCredential",
|
|
"description": "Credit card credential model that requires non-empty values."
|
|
},
|
|
"NonEmptyPasswordCredential": {
|
|
"properties": {
|
|
"password": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Password",
|
|
"description": "The password value (must not be empty)",
|
|
"examples": [
|
|
"securepassword123"
|
|
]
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Username",
|
|
"description": "The username associated with the credential (must not be empty)",
|
|
"examples": [
|
|
"user@example.com"
|
|
]
|
|
},
|
|
"totp": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp",
|
|
"description": "Optional TOTP (Time-based One-Time Password) string used to generate 2FA codes",
|
|
"examples": [
|
|
"JBSWY3DPEHPK3PXP"
|
|
]
|
|
},
|
|
"totp_type": {
|
|
"$ref": "#/components/schemas/TotpType",
|
|
"description": "Type of 2FA method used for this credential",
|
|
"default": "none",
|
|
"examples": [
|
|
"authenticator"
|
|
]
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "Identifier (email or phone number) used to fetch TOTP codes",
|
|
"examples": [
|
|
"user@example.com",
|
|
"+14155550123"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"password",
|
|
"username"
|
|
],
|
|
"title": "NonEmptyPasswordCredential",
|
|
"description": "Password credential model that requires non-empty values."
|
|
},
|
|
"OTPType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"totp",
|
|
"magic_link"
|
|
],
|
|
"title": "OTPType"
|
|
},
|
|
"OnePasswordCredentialParameter": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "onepassword",
|
|
"title": "Parameter Type",
|
|
"default": "onepassword"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"onepassword_credential_parameter_id": {
|
|
"type": "string",
|
|
"title": "Onepassword Credential Parameter Id"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"vault_id": {
|
|
"type": "string",
|
|
"title": "Vault Id"
|
|
},
|
|
"item_id": {
|
|
"type": "string",
|
|
"title": "Item Id"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"onepassword_credential_parameter_id",
|
|
"workflow_id",
|
|
"vault_id",
|
|
"item_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "OnePasswordCredentialParameter"
|
|
},
|
|
"OnePasswordCredentialParameterYAML": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "onepassword",
|
|
"title": "Parameter Type",
|
|
"default": "onepassword"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"vault_id": {
|
|
"type": "string",
|
|
"title": "Vault Id"
|
|
},
|
|
"item_id": {
|
|
"type": "string",
|
|
"title": "Item Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"vault_id",
|
|
"item_id"
|
|
],
|
|
"title": "OnePasswordCredentialParameterYAML"
|
|
},
|
|
"OrganizationScheduleItem": {
|
|
"properties": {
|
|
"workflow_schedule_id": {
|
|
"type": "string",
|
|
"title": "Workflow Schedule Id"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id"
|
|
},
|
|
"workflow_permanent_id": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"workflow_title": {
|
|
"type": "string",
|
|
"title": "Workflow Title"
|
|
},
|
|
"cron_expression": {
|
|
"type": "string",
|
|
"title": "Cron Expression"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"title": "Timezone"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"title": "Enabled"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameters"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Name"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"next_run": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Next Run"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_schedule_id",
|
|
"organization_id",
|
|
"workflow_permanent_id",
|
|
"workflow_title",
|
|
"cron_expression",
|
|
"timezone",
|
|
"enabled",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "OrganizationScheduleItem",
|
|
"description": "Compact schedule projection for the org-wide list endpoint.\n\nIntentionally omits `backend_schedule_id` — the list view is for browsing\nschedules in the dashboard, not for managing the underlying execution-backend\nbinding. Callers that need the backend id should fetch the individual\nschedule via the per-workflow get endpoint."
|
|
},
|
|
"OrganizationScheduleListResponse": {
|
|
"properties": {
|
|
"schedules": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OrganizationScheduleItem"
|
|
},
|
|
"type": "array",
|
|
"title": "Schedules"
|
|
},
|
|
"total_count": {
|
|
"type": "integer",
|
|
"title": "Total Count"
|
|
},
|
|
"page": {
|
|
"type": "integer",
|
|
"title": "Page"
|
|
},
|
|
"page_size": {
|
|
"type": "integer",
|
|
"title": "Page Size"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"schedules",
|
|
"total_count",
|
|
"page",
|
|
"page_size"
|
|
],
|
|
"title": "OrganizationScheduleListResponse"
|
|
},
|
|
"OutputParameter": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "output",
|
|
"title": "Parameter Type",
|
|
"default": "output"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"output_parameter_id": {
|
|
"type": "string",
|
|
"title": "Output Parameter Id"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"output_parameter_id",
|
|
"workflow_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "OutputParameter"
|
|
},
|
|
"OutputParameterYAML": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "output",
|
|
"title": "Parameter Type",
|
|
"default": "output"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key"
|
|
],
|
|
"title": "OutputParameterYAML"
|
|
},
|
|
"PDFFormat": {
|
|
"type": "string",
|
|
"enum": [
|
|
"A4",
|
|
"Letter",
|
|
"Legal",
|
|
"Tabloid"
|
|
],
|
|
"title": "PDFFormat"
|
|
},
|
|
"PDFParserBlock": {
|
|
"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": "pdf_parser",
|
|
"title": "Block Type",
|
|
"default": "pdf_parser"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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
|
|
},
|
|
"file_url": {
|
|
"type": "string",
|
|
"title": "File Url"
|
|
},
|
|
"json_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Json Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"file_url"
|
|
],
|
|
"title": "PDFParserBlock",
|
|
"description": "DEPRECATED: Use FileParserBlock with file_type=FileType.PDF instead.\nThis block will be removed in a future version."
|
|
},
|
|
"PDFParserBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "pdf_parser",
|
|
"title": "Block Type",
|
|
"default": "pdf_parser"
|
|
},
|
|
"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
|
|
},
|
|
"file_url": {
|
|
"type": "string",
|
|
"title": "File Url"
|
|
},
|
|
"json_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Json Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"file_url"
|
|
],
|
|
"title": "PDFParserBlockYAML"
|
|
},
|
|
"PasswordCredentialResponse": {
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"title": "Username",
|
|
"description": "The username associated with the credential",
|
|
"examples": [
|
|
"user@example.com"
|
|
]
|
|
},
|
|
"totp_type": {
|
|
"$ref": "#/components/schemas/TotpType",
|
|
"description": "Type of 2FA method used for this credential",
|
|
"default": "none",
|
|
"examples": [
|
|
"authenticator"
|
|
]
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "Identifier (email or phone number) used to fetch TOTP codes",
|
|
"examples": [
|
|
"user@example.com",
|
|
"+14155550123"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"username"
|
|
],
|
|
"title": "PasswordCredentialResponse",
|
|
"description": "Response model for password credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include password or TOTP secret."
|
|
},
|
|
"PdfFillBlock": {
|
|
"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": "pdf_fill",
|
|
"title": "Block Type",
|
|
"default": "pdf_fill"
|
|
},
|
|
"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
|
|
},
|
|
"file_url": {
|
|
"type": "string",
|
|
"title": "File Url"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt"
|
|
},
|
|
"payload": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Payload"
|
|
},
|
|
"llm_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Llm Key"
|
|
},
|
|
"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",
|
|
"file_url",
|
|
"prompt"
|
|
],
|
|
"title": "PdfFillBlock"
|
|
},
|
|
"PdfFillBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "pdf_fill",
|
|
"title": "Block Type",
|
|
"default": "pdf_fill"
|
|
},
|
|
"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
|
|
},
|
|
"file_url": {
|
|
"type": "string",
|
|
"title": "File Url"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt"
|
|
},
|
|
"payload": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Payload"
|
|
},
|
|
"llm_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Llm Key"
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"file_url",
|
|
"prompt"
|
|
],
|
|
"title": "PdfFillBlockYAML"
|
|
},
|
|
"PersistentBrowserType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"msedge",
|
|
"chrome",
|
|
"stealth-chromium"
|
|
],
|
|
"title": "PersistentBrowserType"
|
|
},
|
|
"PrintPageBlock": {
|
|
"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": "print_page",
|
|
"title": "Block Type",
|
|
"default": "print_page"
|
|
},
|
|
"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
|
|
},
|
|
"include_timestamp": {
|
|
"type": "boolean",
|
|
"title": "Include Timestamp",
|
|
"default": true
|
|
},
|
|
"custom_filename": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Custom Filename"
|
|
},
|
|
"format": {
|
|
"type": "string",
|
|
"title": "Format",
|
|
"default": "A4"
|
|
},
|
|
"landscape": {
|
|
"type": "boolean",
|
|
"title": "Landscape",
|
|
"default": false
|
|
},
|
|
"print_background": {
|
|
"type": "boolean",
|
|
"title": "Print Background",
|
|
"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": [
|
|
"label",
|
|
"output_parameter"
|
|
],
|
|
"title": "PrintPageBlock"
|
|
},
|
|
"PrintPageBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "print_page",
|
|
"title": "Block Type",
|
|
"default": "print_page"
|
|
},
|
|
"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
|
|
},
|
|
"include_timestamp": {
|
|
"type": "boolean",
|
|
"title": "Include Timestamp",
|
|
"default": true
|
|
},
|
|
"custom_filename": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Custom Filename"
|
|
},
|
|
"format": {
|
|
"$ref": "#/components/schemas/PDFFormat",
|
|
"default": "A4"
|
|
},
|
|
"landscape": {
|
|
"type": "boolean",
|
|
"title": "Landscape",
|
|
"default": false
|
|
},
|
|
"print_background": {
|
|
"type": "boolean",
|
|
"title": "Print Background",
|
|
"default": true
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label"
|
|
],
|
|
"title": "PrintPageBlockYAML"
|
|
},
|
|
"PromptAction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "prompt",
|
|
"title": "Type",
|
|
"default": "prompt"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt",
|
|
"description": "The prompt to send to the LLM"
|
|
},
|
|
"response_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Response Schema",
|
|
"description": "Optional JSON schema to structure the response"
|
|
},
|
|
"model": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Model",
|
|
"description": "Optional model configuration"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"prompt"
|
|
],
|
|
"title": "PromptAction",
|
|
"description": "Prompt action parameters."
|
|
},
|
|
"PromptBranchCriteria": {
|
|
"properties": {
|
|
"criteria_type": {
|
|
"type": "string",
|
|
"const": "prompt",
|
|
"title": "Criteria Type",
|
|
"default": "prompt"
|
|
},
|
|
"expression": {
|
|
"type": "string",
|
|
"title": "Expression"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"expression"
|
|
],
|
|
"title": "PromptBranchCriteria",
|
|
"description": "Natural language branch criteria."
|
|
},
|
|
"ProxyLocation": {
|
|
"type": "string",
|
|
"enum": [
|
|
"RESIDENTIAL",
|
|
"US-CA",
|
|
"US-NY",
|
|
"US-TX",
|
|
"US-FL",
|
|
"US-WA",
|
|
"RESIDENTIAL_ES",
|
|
"RESIDENTIAL_IE",
|
|
"RESIDENTIAL_GB",
|
|
"RESIDENTIAL_IN",
|
|
"RESIDENTIAL_JP",
|
|
"RESIDENTIAL_FR",
|
|
"RESIDENTIAL_DE",
|
|
"RESIDENTIAL_NZ",
|
|
"RESIDENTIAL_ZA",
|
|
"RESIDENTIAL_AR",
|
|
"RESIDENTIAL_AU",
|
|
"RESIDENTIAL_BR",
|
|
"RESIDENTIAL_TR",
|
|
"RESIDENTIAL_CA",
|
|
"RESIDENTIAL_MX",
|
|
"RESIDENTIAL_IT",
|
|
"RESIDENTIAL_NL",
|
|
"RESIDENTIAL_PH",
|
|
"RESIDENTIAL_KR",
|
|
"RESIDENTIAL_SA",
|
|
"RESIDENTIAL_ISP",
|
|
"NONE"
|
|
],
|
|
"title": "ProxyLocation"
|
|
},
|
|
"RetryRunWebhookRequest": {
|
|
"properties": {
|
|
"webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Url",
|
|
"description": "Optional webhook URL to send the payload to instead of the stored configuration"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "RetryRunWebhookRequest"
|
|
},
|
|
"RunEngine": {
|
|
"type": "string",
|
|
"enum": [
|
|
"skyvern-1.0",
|
|
"skyvern-2.0",
|
|
"openai-cua",
|
|
"anthropic-cua",
|
|
"ui-tars",
|
|
"yutori-navigator"
|
|
],
|
|
"title": "RunEngine"
|
|
},
|
|
"RunSdkActionRequest": {
|
|
"properties": {
|
|
"url": {
|
|
"type": "string",
|
|
"title": "Url",
|
|
"description": "The URL where the action should be executed"
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id",
|
|
"description": "The browser session ID"
|
|
},
|
|
"browser_address": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Address",
|
|
"description": "The browser address"
|
|
},
|
|
"workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Run Id",
|
|
"description": "Optional workflow run ID to continue an existing workflow run"
|
|
},
|
|
"action": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ClickAction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/InputTextAction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SelectOptionAction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UploadFileAction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ActAction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ExtractAction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LocateElementAction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ValidateAction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PromptAction"
|
|
}
|
|
],
|
|
"title": "Action",
|
|
"description": "The action to execute with its specific parameters",
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"ai_act": "#/components/schemas/ActAction",
|
|
"ai_click": "#/components/schemas/ClickAction",
|
|
"ai_input_text": "#/components/schemas/InputTextAction",
|
|
"ai_select_option": "#/components/schemas/SelectOptionAction",
|
|
"ai_upload_file": "#/components/schemas/UploadFileAction",
|
|
"extract": "#/components/schemas/ExtractAction",
|
|
"locate_element": "#/components/schemas/LocateElementAction",
|
|
"prompt": "#/components/schemas/PromptAction",
|
|
"validate": "#/components/schemas/ValidateAction"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"url",
|
|
"action"
|
|
],
|
|
"title": "RunSdkActionRequest",
|
|
"description": "Request to run a single SDK action."
|
|
},
|
|
"RunSdkActionResponse": {
|
|
"properties": {
|
|
"workflow_run_id": {
|
|
"type": "string",
|
|
"title": "Workflow Run Id",
|
|
"description": "The workflow run ID used for this action"
|
|
},
|
|
"result": {
|
|
"anyOf": [
|
|
{},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Result",
|
|
"description": "The result from the action (e.g., selector, value, extracted data)"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_run_id"
|
|
],
|
|
"title": "RunSdkActionResponse",
|
|
"description": "Response from running an SDK action."
|
|
},
|
|
"RunStatus": {
|
|
"type": "string",
|
|
"enum": [
|
|
"created",
|
|
"queued",
|
|
"running",
|
|
"timed_out",
|
|
"failed",
|
|
"terminated",
|
|
"completed",
|
|
"canceled"
|
|
],
|
|
"title": "RunStatus"
|
|
},
|
|
"RunWebhookReplayResponse": {
|
|
"properties": {
|
|
"run_id": {
|
|
"type": "string",
|
|
"title": "Run Id",
|
|
"description": "Identifier of the run that was replayed"
|
|
},
|
|
"run_type": {
|
|
"type": "string",
|
|
"title": "Run Type",
|
|
"description": "Run type associated with the payload"
|
|
},
|
|
"default_webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Default Webhook Url",
|
|
"description": "Webhook URL stored on the original run configuration"
|
|
},
|
|
"target_webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Target Webhook Url",
|
|
"description": "Webhook URL that the replay attempted to reach"
|
|
},
|
|
"payload": {
|
|
"type": "string",
|
|
"title": "Payload",
|
|
"description": "JSON payload that was delivered during the replay attempt"
|
|
},
|
|
"headers": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object",
|
|
"title": "Headers",
|
|
"description": "Signed headers that were generated for the replay attempt"
|
|
},
|
|
"status_code": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Status Code",
|
|
"description": "HTTP status code returned by the webhook receiver, if available"
|
|
},
|
|
"latency_ms": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Latency Ms",
|
|
"description": "Round-trip latency in milliseconds for the replay attempt"
|
|
},
|
|
"response_body": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Response Body",
|
|
"description": "Body returned by the webhook receiver (truncated to 2KB)"
|
|
},
|
|
"error": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Error",
|
|
"description": "Error message if the replay attempt failed"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"run_id",
|
|
"run_type",
|
|
"payload",
|
|
"headers"
|
|
],
|
|
"title": "RunWebhookReplayResponse"
|
|
},
|
|
"Script": {
|
|
"properties": {
|
|
"script_revision_id": {
|
|
"type": "string",
|
|
"title": "Script Revision Id",
|
|
"description": "Unique identifier for this specific script revision"
|
|
},
|
|
"script_id": {
|
|
"type": "string",
|
|
"title": "Script Id",
|
|
"description": "User-facing script identifier, consistent across versions"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id",
|
|
"description": "ID of the organization that owns this script"
|
|
},
|
|
"run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run Id",
|
|
"description": "ID of the workflow run or task run that generated this script"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"title": "Version",
|
|
"description": "Version number of the script"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At",
|
|
"description": "Timestamp when the script was created"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At",
|
|
"description": "Timestamp when the script was last modified"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At",
|
|
"description": "Timestamp when the script was soft deleted"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"script_revision_id",
|
|
"script_id",
|
|
"organization_id",
|
|
"version",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "Script"
|
|
},
|
|
"ScriptFileCreate": {
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"title": "Path",
|
|
"description": "File path relative to script root",
|
|
"examples": [
|
|
"src/main.py"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"title": "Content",
|
|
"description": "Base64 encoded file content"
|
|
},
|
|
"encoding": {
|
|
"$ref": "#/components/schemas/FileEncoding",
|
|
"description": "Content encoding",
|
|
"default": "base64"
|
|
},
|
|
"mime_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Mime Type",
|
|
"description": "MIME type (auto-detected if not provided)"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"path",
|
|
"content"
|
|
],
|
|
"title": "ScriptFileCreate",
|
|
"description": "Model representing a file in a script."
|
|
},
|
|
"ScriptRunResponse": {
|
|
"properties": {
|
|
"ai_fallback_triggered": {
|
|
"type": "boolean",
|
|
"title": "Ai Fallback Triggered",
|
|
"default": false
|
|
},
|
|
"script_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Script Id"
|
|
},
|
|
"script_revision_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Script Revision Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ScriptRunResponse"
|
|
},
|
|
"SecretCredential": {
|
|
"properties": {
|
|
"secret_value": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"title": "Secret Value",
|
|
"description": "The secret value",
|
|
"examples": [
|
|
"sk-abc123"
|
|
]
|
|
},
|
|
"secret_label": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Secret Label",
|
|
"description": "Optional label describing the secret"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"secret_value"
|
|
],
|
|
"title": "SecretCredential",
|
|
"description": "Generic secret credential."
|
|
},
|
|
"SecretCredentialResponse": {
|
|
"properties": {
|
|
"secret_label": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Secret Label",
|
|
"description": "Optional label for the stored secret"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "SecretCredentialResponse",
|
|
"description": "Response model for secret credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include the secret_value."
|
|
},
|
|
"SelectOption": {
|
|
"properties": {
|
|
"label": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Label"
|
|
},
|
|
"value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Value"
|
|
},
|
|
"index": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Index"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "SelectOption"
|
|
},
|
|
"SelectOptionAction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "ai_select_option",
|
|
"title": "Type",
|
|
"default": "ai_select_option"
|
|
},
|
|
"selector": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Selector",
|
|
"description": "CSS selector for the element",
|
|
"default": ""
|
|
},
|
|
"value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Value",
|
|
"description": "Value to select",
|
|
"default": ""
|
|
},
|
|
"intention": {
|
|
"type": "string",
|
|
"title": "Intention",
|
|
"description": "The intention or goal of the selection",
|
|
"default": ""
|
|
},
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data",
|
|
"description": "Additional context data"
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"title": "Timeout",
|
|
"description": "Timeout in milliseconds",
|
|
"default": 5000
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "SelectOptionAction",
|
|
"description": "Select option action parameters."
|
|
},
|
|
"SendEmailBlock": {
|
|
"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": "send_email",
|
|
"title": "Block Type",
|
|
"default": "send_email"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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
|
|
},
|
|
"smtp_host": {
|
|
"$ref": "#/components/schemas/AWSSecretParameter"
|
|
},
|
|
"smtp_port": {
|
|
"$ref": "#/components/schemas/AWSSecretParameter"
|
|
},
|
|
"smtp_username": {
|
|
"$ref": "#/components/schemas/AWSSecretParameter"
|
|
},
|
|
"smtp_password": {
|
|
"$ref": "#/components/schemas/AWSSecretParameter"
|
|
},
|
|
"sender": {
|
|
"type": "string",
|
|
"title": "Sender"
|
|
},
|
|
"recipients": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Recipients"
|
|
},
|
|
"subject": {
|
|
"type": "string",
|
|
"title": "Subject"
|
|
},
|
|
"body": {
|
|
"type": "string",
|
|
"title": "Body"
|
|
},
|
|
"file_attachments": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "File Attachments",
|
|
"default": []
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"smtp_host",
|
|
"smtp_port",
|
|
"smtp_username",
|
|
"smtp_password",
|
|
"sender",
|
|
"recipients",
|
|
"subject",
|
|
"body"
|
|
],
|
|
"title": "SendEmailBlock"
|
|
},
|
|
"SendEmailBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "send_email",
|
|
"title": "Block Type",
|
|
"default": "send_email"
|
|
},
|
|
"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
|
|
},
|
|
"smtp_host_secret_parameter_key": {
|
|
"type": "string",
|
|
"title": "Smtp Host Secret Parameter Key"
|
|
},
|
|
"smtp_port_secret_parameter_key": {
|
|
"type": "string",
|
|
"title": "Smtp Port Secret Parameter Key"
|
|
},
|
|
"smtp_username_secret_parameter_key": {
|
|
"type": "string",
|
|
"title": "Smtp Username Secret Parameter Key"
|
|
},
|
|
"smtp_password_secret_parameter_key": {
|
|
"type": "string",
|
|
"title": "Smtp Password Secret Parameter Key"
|
|
},
|
|
"sender": {
|
|
"type": "string",
|
|
"title": "Sender"
|
|
},
|
|
"recipients": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Recipients"
|
|
},
|
|
"subject": {
|
|
"type": "string",
|
|
"title": "Subject"
|
|
},
|
|
"body": {
|
|
"type": "string",
|
|
"title": "Body"
|
|
},
|
|
"file_attachments": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "File Attachments"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"smtp_host_secret_parameter_key",
|
|
"smtp_port_secret_parameter_key",
|
|
"smtp_username_secret_parameter_key",
|
|
"smtp_password_secret_parameter_key",
|
|
"sender",
|
|
"recipients",
|
|
"subject",
|
|
"body"
|
|
],
|
|
"title": "SendEmailBlockYAML"
|
|
},
|
|
"TOTPCode": {
|
|
"properties": {
|
|
"totp_identifier": {
|
|
"type": "string",
|
|
"title": "Totp Identifier",
|
|
"description": "The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user.",
|
|
"examples": [
|
|
"john.doe@example.com",
|
|
"4155555555",
|
|
"user_123"
|
|
]
|
|
},
|
|
"task_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Task Id",
|
|
"description": "The task_id the totp code is for. It can be the task_id of the task that the TOTP code is for.",
|
|
"examples": [
|
|
"task_123456"
|
|
]
|
|
},
|
|
"workflow_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Id",
|
|
"description": "The workflow ID the TOTP code is for. It can be the workflow ID of the workflow that the TOTP code is for.",
|
|
"examples": [
|
|
"wpid_123456"
|
|
]
|
|
},
|
|
"workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Run Id",
|
|
"description": "The workflow run id that the TOTP code is for. It can be the workflow run id of the workflow run that the TOTP code is for.",
|
|
"examples": [
|
|
"wr_123456"
|
|
]
|
|
},
|
|
"source": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Source",
|
|
"description": "An optional field. The source of the TOTP code. e.g. email, sms, etc.",
|
|
"examples": [
|
|
"email",
|
|
"sms",
|
|
"app"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"title": "Content",
|
|
"description": "The content of the TOTP code. It can be the email content that contains the TOTP code, or the sms message that contains the TOTP code. Skyvern will automatically extract the TOTP code from the content.",
|
|
"examples": [
|
|
"Hello, your verification code is 123456"
|
|
]
|
|
},
|
|
"expired_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Expired At",
|
|
"description": "The timestamp when the TOTP code expires",
|
|
"examples": [
|
|
"2025-01-01T00:00:00Z"
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OTPType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional. If provided, forces extraction of this specific OTP type (totp or magic_link). Use this when the content contains multiple OTP types and you want to specify which one to extract.",
|
|
"examples": [
|
|
"totp",
|
|
"magic_link"
|
|
]
|
|
},
|
|
"totp_code_id": {
|
|
"type": "string",
|
|
"title": "Totp Code Id",
|
|
"description": "The skyvern ID of the TOTP code."
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"title": "Code",
|
|
"description": "The TOTP code extracted from the content."
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id",
|
|
"description": "The ID of the organization that the TOTP code is for."
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At",
|
|
"description": "The timestamp when the TOTP code was created."
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At",
|
|
"description": "The timestamp when the TOTP code was modified."
|
|
},
|
|
"otp_type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OTPType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "The type of the OTP code."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"totp_identifier",
|
|
"content",
|
|
"totp_code_id",
|
|
"code",
|
|
"organization_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "TOTPCode"
|
|
},
|
|
"TOTPCodeCreate": {
|
|
"properties": {
|
|
"totp_identifier": {
|
|
"type": "string",
|
|
"title": "Totp Identifier",
|
|
"description": "The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user.",
|
|
"examples": [
|
|
"john.doe@example.com",
|
|
"4155555555",
|
|
"user_123"
|
|
]
|
|
},
|
|
"task_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Task Id",
|
|
"description": "The task_id the totp code is for. It can be the task_id of the task that the TOTP code is for.",
|
|
"examples": [
|
|
"task_123456"
|
|
]
|
|
},
|
|
"workflow_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Id",
|
|
"description": "The workflow ID the TOTP code is for. It can be the workflow ID of the workflow that the TOTP code is for.",
|
|
"examples": [
|
|
"wpid_123456"
|
|
]
|
|
},
|
|
"workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Run Id",
|
|
"description": "The workflow run id that the TOTP code is for. It can be the workflow run id of the workflow run that the TOTP code is for.",
|
|
"examples": [
|
|
"wr_123456"
|
|
]
|
|
},
|
|
"source": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Source",
|
|
"description": "An optional field. The source of the TOTP code. e.g. email, sms, etc.",
|
|
"examples": [
|
|
"email",
|
|
"sms",
|
|
"app"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"title": "Content",
|
|
"description": "The content of the TOTP code. It can be the email content that contains the TOTP code, or the sms message that contains the TOTP code. Skyvern will automatically extract the TOTP code from the content.",
|
|
"examples": [
|
|
"Hello, your verification code is 123456"
|
|
]
|
|
},
|
|
"expired_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Expired At",
|
|
"description": "The timestamp when the TOTP code expires",
|
|
"examples": [
|
|
"2025-01-01T00:00:00Z"
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OTPType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional. If provided, forces extraction of this specific OTP type (totp or magic_link). Use this when the content contains multiple OTP types and you want to specify which one to extract.",
|
|
"examples": [
|
|
"totp",
|
|
"magic_link"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"totp_identifier",
|
|
"content"
|
|
],
|
|
"title": "TOTPCodeCreate"
|
|
},
|
|
"TagApplyRequest": {
|
|
"properties": {
|
|
"tags": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TagInput"
|
|
},
|
|
"type": "array",
|
|
"title": "Tags",
|
|
"description": "Tags to set (overwrite). List of {key?, value} objects."
|
|
},
|
|
"tags_to_delete": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TagDeleteInput"
|
|
},
|
|
"type": "array",
|
|
"title": "Tags To Delete",
|
|
"description": "Tags to soft-delete. List of {key?, value?} targets."
|
|
},
|
|
"colors": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Colors",
|
|
"description": "Optional map of grouped tag key to palette color name for the value being set. Keys absent from this map keep their existing color or receive a random palette color."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "TagApplyRequest",
|
|
"description": "Body for ``POST /v1/workflows/{wpid}/tags``. Either field may be empty (both\nempty is a no-op). On a same-identity collision, set wins over delete."
|
|
},
|
|
"TagDeleteInput": {
|
|
"properties": {
|
|
"key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Key",
|
|
"description": "Group (key) to delete. Use for grouped tags."
|
|
},
|
|
"value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Value",
|
|
"description": "Label (value) to delete. Use for standalone labels."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "TagDeleteInput",
|
|
"description": "One tag to soft-delete: a grouped tag by its ``key``, or a standalone label\nby its ``value`` (omit the key)."
|
|
},
|
|
"TagHistoryItem": {
|
|
"properties": {
|
|
"tag_event_id": {
|
|
"type": "string",
|
|
"title": "Tag Event Id"
|
|
},
|
|
"key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Key"
|
|
},
|
|
"value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Value"
|
|
},
|
|
"event_type": {
|
|
"type": "string",
|
|
"title": "Event Type"
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"title": "Source"
|
|
},
|
|
"set_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Set At"
|
|
},
|
|
"set_by": {
|
|
"type": "string",
|
|
"title": "Set By"
|
|
},
|
|
"superseded_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Superseded At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"tag_event_id",
|
|
"key",
|
|
"value",
|
|
"event_type",
|
|
"source",
|
|
"set_at",
|
|
"set_by"
|
|
],
|
|
"title": "TagHistoryItem",
|
|
"description": "One row from ``GET /v1/workflows/{wpid}/tags/history``."
|
|
},
|
|
"TagHistoryResponse": {
|
|
"properties": {
|
|
"workflow_permanent_id": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"events": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TagHistoryItem"
|
|
},
|
|
"type": "array",
|
|
"title": "Events"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_permanent_id",
|
|
"events"
|
|
],
|
|
"title": "TagHistoryResponse"
|
|
},
|
|
"TagInput": {
|
|
"properties": {
|
|
"key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Key",
|
|
"description": "Optional group (key). Omit for a standalone label."
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value",
|
|
"description": "Label (value). Always required."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"value"
|
|
],
|
|
"title": "TagInput",
|
|
"description": "One tag to set. ``value`` is the required label; ``key`` is the optional\ngroup — null for a standalone label, set for a grouped label (e.g. env:prod)."
|
|
},
|
|
"TagItem": {
|
|
"properties": {
|
|
"key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Key"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"value"
|
|
],
|
|
"title": "TagItem",
|
|
"description": "A single tag (key + label) without per-tag attribution. ``key`` is null\nfor a standalone label."
|
|
},
|
|
"TagKey": {
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"workflow_count": {
|
|
"type": "integer",
|
|
"title": "Workflow Count",
|
|
"default": 0
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key"
|
|
],
|
|
"title": "TagKey",
|
|
"description": "Tag-key registry entry."
|
|
},
|
|
"TagKeyDeleteResponse": {
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"removed_from_workflow_count": {
|
|
"type": "integer",
|
|
"title": "Removed From Workflow Count"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"removed_from_workflow_count"
|
|
],
|
|
"title": "TagKeyDeleteResponse",
|
|
"description": "Response for ``DELETE /v1/tag-keys/{key}``."
|
|
},
|
|
"TagKeyUpdate": {
|
|
"properties": {
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description",
|
|
"description": "Free-form description (max 500 chars). Pass null to clear."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "TagKeyUpdate",
|
|
"description": "Body for ``PATCH /v1/tag-keys/{key}``."
|
|
},
|
|
"TagResponse": {
|
|
"properties": {
|
|
"key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Key"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value"
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"title": "Source"
|
|
},
|
|
"set_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Set At"
|
|
},
|
|
"set_by": {
|
|
"type": "string",
|
|
"title": "Set By"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"value",
|
|
"source",
|
|
"set_at",
|
|
"set_by"
|
|
],
|
|
"title": "TagResponse",
|
|
"description": "Current state of one tag (``GET /v1/workflows/{wpid}/tags`` row).\n``key`` is null for a standalone label."
|
|
},
|
|
"TagValue": {
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value"
|
|
},
|
|
"color": {
|
|
"type": "string",
|
|
"title": "Color"
|
|
},
|
|
"workflow_count": {
|
|
"type": "integer",
|
|
"title": "Workflow Count",
|
|
"description": "Number of non-deleted workflows currently carrying this (key, value) label.",
|
|
"default": 0
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"value",
|
|
"color"
|
|
],
|
|
"title": "TagValue",
|
|
"description": "Tag-value color registry entry: the palette color assigned to a grouped\n(key, value) pair."
|
|
},
|
|
"TagValueDelete": {
|
|
"properties": {
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value",
|
|
"description": "Tag value (label) under the key to soft-delete."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"value"
|
|
],
|
|
"title": "TagValueDelete",
|
|
"description": "Body for ``DELETE /v1/tag-values/{key}``. The value rides in the body, not the\npath, so values containing ``/`` stay addressable."
|
|
},
|
|
"TagValueDeleteResponse": {
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value"
|
|
},
|
|
"removed_from_workflow_count": {
|
|
"type": "integer",
|
|
"title": "Removed From Workflow Count"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"value",
|
|
"removed_from_workflow_count"
|
|
],
|
|
"title": "TagValueDeleteResponse",
|
|
"description": "Response for ``DELETE /v1/tag-values/{key}``."
|
|
},
|
|
"TagValueRename": {
|
|
"properties": {
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value",
|
|
"description": "Current tag value (label) under the key to rename."
|
|
},
|
|
"new_value": {
|
|
"type": "string",
|
|
"title": "New Value",
|
|
"description": "New tag value (label) to rename it to."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"value",
|
|
"new_value"
|
|
],
|
|
"title": "TagValueRename",
|
|
"description": "Body for ``PATCH /v1/tag-values/{key}/rename``. Both the current and the new\nvalue ride in the body so values containing ``/`` stay addressable."
|
|
},
|
|
"TagValueRenameResponse": {
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value"
|
|
},
|
|
"color": {
|
|
"type": "string",
|
|
"title": "Color"
|
|
},
|
|
"renamed_workflow_count": {
|
|
"type": "integer",
|
|
"title": "Renamed Workflow Count"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"value",
|
|
"color",
|
|
"renamed_workflow_count"
|
|
],
|
|
"title": "TagValueRenameResponse",
|
|
"description": "Response for ``PATCH /v1/tag-values/{key}/rename``: the renamed label with its\ncarried-over color and the number of workflows re-tagged."
|
|
},
|
|
"TagValueUpdate": {
|
|
"properties": {
|
|
"value": {
|
|
"type": "string",
|
|
"title": "Value",
|
|
"description": "Tag value (label) under the key to recolor."
|
|
},
|
|
"color": {
|
|
"type": "string",
|
|
"title": "Color",
|
|
"description": "Palette color name to assign to this (key, value)."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"value",
|
|
"color"
|
|
],
|
|
"title": "TagValueUpdate",
|
|
"description": "Body for ``PATCH /v1/tag-values/{key}``. The value rides in the body, not the\npath, so values containing ``/`` stay addressable."
|
|
},
|
|
"TagsResponse": {
|
|
"properties": {
|
|
"workflow_permanent_id": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"tags": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TagResponse"
|
|
},
|
|
"type": "array",
|
|
"title": "Tags"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_permanent_id",
|
|
"tags"
|
|
],
|
|
"title": "TagsResponse",
|
|
"description": "Current tags for a workflow. A list (not a key-map) so standalone labels,\nwhich have no key, are representable."
|
|
},
|
|
"TaskBlock": {
|
|
"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": "task",
|
|
"title": "Block Type",
|
|
"default": "task"
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter"
|
|
],
|
|
"title": "TaskBlock"
|
|
},
|
|
"TaskBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "task",
|
|
"title": "Block Type",
|
|
"default": "task"
|
|
},
|
|
"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
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title",
|
|
"default": ""
|
|
},
|
|
"engine": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"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"
|
|
},
|
|
"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
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"complete_verification": {
|
|
"type": "boolean",
|
|
"title": "Complete Verification",
|
|
"default": true
|
|
},
|
|
"include_action_history_in_verification": {
|
|
"type": "boolean",
|
|
"title": "Include Action History In Verification",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label"
|
|
],
|
|
"title": "TaskBlockYAML"
|
|
},
|
|
"TaskRunListItem": {
|
|
"properties": {
|
|
"task_run_id": {
|
|
"type": "string",
|
|
"title": "Task Run Id"
|
|
},
|
|
"run_id": {
|
|
"type": "string",
|
|
"title": "Run Id"
|
|
},
|
|
"task_run_type": {
|
|
"type": "string",
|
|
"title": "Task Run Type"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"title": "Status"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title"
|
|
},
|
|
"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": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"workflow_permanent_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"workflow_deleted": {
|
|
"type": "boolean",
|
|
"title": "Workflow Deleted",
|
|
"default": false
|
|
},
|
|
"script_run": {
|
|
"type": "boolean",
|
|
"title": "Script Run",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"task_run_id",
|
|
"run_id",
|
|
"task_run_type",
|
|
"status",
|
|
"created_at"
|
|
],
|
|
"title": "TaskRunListItem",
|
|
"description": "Lightweight run-history item backed by the task_runs table."
|
|
},
|
|
"TaskRunRequest-Input": {
|
|
"properties": {
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt",
|
|
"description": "\nThe goal or task description for Skyvern to accomplish\n",
|
|
"examples": [
|
|
"Find the top 3 posts on Hacker News.",
|
|
"Go to google finance, extract the \"AAPL\" stock price for me with the date."
|
|
]
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url",
|
|
"description": "\nThe starting URL for the task. If not provided, Skyvern will attempt to determine an appropriate URL\n",
|
|
"examples": [
|
|
"https://www.hackernews.com",
|
|
"https://www.google.com/finance"
|
|
]
|
|
},
|
|
"engine": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"description": "\nThe engine that powers the agent task. The default value is `skyvern-1.0`, which is good for simple tasks like filling a form, or searching for information on Google. `skyvern-2.0` remains available for existing V2 workflows and explicitly requested V2 task runs. The `openai-cua` engine uses OpenAI's CUA model. The `anthropic-cua` uses Anthropic's Claude Sonnet 3.7 model with the computer use tool.\n",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title",
|
|
"description": "The title for the task",
|
|
"examples": [
|
|
"The title of my first skyvern task"
|
|
]
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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:password@proxy.example.com: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\"}",
|
|
"default": "RESIDENTIAL"
|
|
},
|
|
"data_extraction_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Schema",
|
|
"description": "\nThe schema for data to be extracted from the webpage. If you're looking for consistent data schema being returned by the agent, it's highly recommended to use https://json-schema.org/.\n"
|
|
},
|
|
"error_code_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Error Code Mapping",
|
|
"description": "\nCustom mapping of error codes to error messages if Skyvern encounters an error.\n",
|
|
"examples": [
|
|
{
|
|
"login_failed": "The login credentials are incorrect or the account is locked"
|
|
},
|
|
{
|
|
"maintenance_mode": "The website is down for maintenance"
|
|
}
|
|
]
|
|
},
|
|
"max_steps": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Steps",
|
|
"description": "\nMaximum number of steps the task can take. Task will fail if it exceeds this number. Cautions: you are charged per step so please set this number to a reasonable value. Contact sales@skyvern.com for custom pricing.\n",
|
|
"examples": [
|
|
10,
|
|
25
|
|
]
|
|
},
|
|
"webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Url",
|
|
"description": "\nAfter a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.\n",
|
|
"examples": [
|
|
"https://my-site.com/webhook"
|
|
]
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "\nIdentifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://www.skyvern.com/docs/credentials/totp#option-3-push-code-to-skyvern for more details.\n",
|
|
"examples": [
|
|
"john.doe@example.com",
|
|
"4155555555",
|
|
"user_123"
|
|
]
|
|
},
|
|
"totp_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Url",
|
|
"description": "\nURL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://www.skyvern.com/docs/credentials/totp#option-2-get-code-from-your-endpoint for more details.\n",
|
|
"examples": [
|
|
"https://my-totp-service.com/totp"
|
|
]
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id",
|
|
"description": "\nRun the task or workflow in the specific Skyvern browser session. Having a browser session can persist the real-time state of the browser, so that the next run can continue from where the previous run left off.\n",
|
|
"examples": [
|
|
"pbs_123"
|
|
]
|
|
},
|
|
"model": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Model",
|
|
"description": "\nOptional model configuration.\n"
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers",
|
|
"description": "The extra HTTP headers for the requests in browser."
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites."
|
|
},
|
|
"publish_workflow": {
|
|
"type": "boolean",
|
|
"title": "Publish Workflow",
|
|
"description": "Deprecated. Whether to publish a `skyvern-2.0` task as a reusable workflow. For backwards compatibility, this routes the request through the legacy `skyvern-2.0` publish path. Prefer creating reusable workflows through the workflow APIs.",
|
|
"default": false,
|
|
"deprecated": true
|
|
},
|
|
"include_action_history_in_verification": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Include Action History In Verification",
|
|
"description": "Whether to include action history when verifying that the task is complete",
|
|
"default": false
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls",
|
|
"description": "The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot."
|
|
},
|
|
"browser_address": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"run_with": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run With",
|
|
"description": "Whether to run the task with agent or code. Null means use the default.",
|
|
"examples": [
|
|
"agent",
|
|
"code"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"prompt"
|
|
],
|
|
"title": "TaskRunRequest"
|
|
},
|
|
"TaskRunRequest-Output": {
|
|
"properties": {
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt",
|
|
"description": "\nThe goal or task description for Skyvern to accomplish\n",
|
|
"examples": [
|
|
"Find the top 3 posts on Hacker News.",
|
|
"Go to google finance, extract the \"AAPL\" stock price for me with the date."
|
|
]
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url",
|
|
"description": "\nThe starting URL for the task. If not provided, Skyvern will attempt to determine an appropriate URL\n",
|
|
"examples": [
|
|
"https://www.hackernews.com",
|
|
"https://www.google.com/finance"
|
|
]
|
|
},
|
|
"engine": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"description": "\nThe engine that powers the agent task. The default value is `skyvern-1.0`, which is good for simple tasks like filling a form, or searching for information on Google. `skyvern-2.0` remains available for existing V2 workflows and explicitly requested V2 task runs. The `openai-cua` engine uses OpenAI's CUA model. The `anthropic-cua` uses Anthropic's Claude Sonnet 3.7 model with the computer use tool.\n",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title",
|
|
"description": "The title for the task",
|
|
"examples": [
|
|
"The title of my first skyvern task"
|
|
]
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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:password@proxy.example.com: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\"}",
|
|
"default": "RESIDENTIAL"
|
|
},
|
|
"data_extraction_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Schema",
|
|
"description": "\nThe schema for data to be extracted from the webpage. If you're looking for consistent data schema being returned by the agent, it's highly recommended to use https://json-schema.org/.\n"
|
|
},
|
|
"error_code_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Error Code Mapping",
|
|
"description": "\nCustom mapping of error codes to error messages if Skyvern encounters an error.\n",
|
|
"examples": [
|
|
{
|
|
"login_failed": "The login credentials are incorrect or the account is locked"
|
|
},
|
|
{
|
|
"maintenance_mode": "The website is down for maintenance"
|
|
}
|
|
]
|
|
},
|
|
"max_steps": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Steps",
|
|
"description": "\nMaximum number of steps the task can take. Task will fail if it exceeds this number. Cautions: you are charged per step so please set this number to a reasonable value. Contact sales@skyvern.com for custom pricing.\n",
|
|
"examples": [
|
|
10,
|
|
25
|
|
]
|
|
},
|
|
"webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Url",
|
|
"description": "\nAfter a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.\n",
|
|
"examples": [
|
|
"https://my-site.com/webhook"
|
|
]
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "\nIdentifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://www.skyvern.com/docs/credentials/totp#option-3-push-code-to-skyvern for more details.\n",
|
|
"examples": [
|
|
"john.doe@example.com",
|
|
"4155555555",
|
|
"user_123"
|
|
]
|
|
},
|
|
"totp_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Url",
|
|
"description": "\nURL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://www.skyvern.com/docs/credentials/totp#option-2-get-code-from-your-endpoint for more details.\n",
|
|
"examples": [
|
|
"https://my-totp-service.com/totp"
|
|
]
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id",
|
|
"description": "\nRun the task or workflow in the specific Skyvern browser session. Having a browser session can persist the real-time state of the browser, so that the next run can continue from where the previous run left off.\n",
|
|
"examples": [
|
|
"pbs_123"
|
|
]
|
|
},
|
|
"model": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Model",
|
|
"description": "\nOptional model configuration.\n"
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers",
|
|
"description": "The extra HTTP headers for the requests in browser."
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites."
|
|
},
|
|
"publish_workflow": {
|
|
"type": "boolean",
|
|
"title": "Publish Workflow",
|
|
"description": "Deprecated. Whether to publish a `skyvern-2.0` task as a reusable workflow. For backwards compatibility, this routes the request through the legacy `skyvern-2.0` publish path. Prefer creating reusable workflows through the workflow APIs.",
|
|
"default": false,
|
|
"deprecated": true
|
|
},
|
|
"include_action_history_in_verification": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Include Action History In Verification",
|
|
"description": "Whether to include action history when verifying that the task is complete",
|
|
"default": false
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls",
|
|
"description": "The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot."
|
|
},
|
|
"browser_address": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"run_with": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run With",
|
|
"description": "Whether to run the task with agent or code. Null means use the default.",
|
|
"examples": [
|
|
"agent",
|
|
"code"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"prompt"
|
|
],
|
|
"title": "TaskRunRequest"
|
|
},
|
|
"TaskRunResponse": {
|
|
"properties": {
|
|
"run_id": {
|
|
"type": "string",
|
|
"title": "Run Id",
|
|
"description": "Unique identifier for this run. Run ID starts with `tsk_` for task runs and `wr_` for workflow runs.",
|
|
"examples": [
|
|
"tsk_123",
|
|
"tsk_v2_123",
|
|
"wr_123"
|
|
]
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/RunStatus",
|
|
"description": "Current status of the run",
|
|
"examples": [
|
|
"created",
|
|
"queued",
|
|
"running",
|
|
"timed_out",
|
|
"failed",
|
|
"terminated",
|
|
"completed",
|
|
"canceled"
|
|
]
|
|
},
|
|
"output": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Output",
|
|
"description": "Output data from the run, if any. Format/schema depends on the data extracted by the run."
|
|
},
|
|
"downloaded_files": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/FileInfo"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Downloaded Files",
|
|
"description": "List of files downloaded during the run"
|
|
},
|
|
"recording_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Recording Url",
|
|
"description": "URL to the recording of the run"
|
|
},
|
|
"recording_archived": {
|
|
"type": "boolean",
|
|
"title": "Recording Archived",
|
|
"description": "True when the recording exists but has been archived to cold storage and is not currently accessible.",
|
|
"default": false
|
|
},
|
|
"screenshot_urls": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Screenshot Urls",
|
|
"description": "List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot."
|
|
},
|
|
"failure_reason": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Failure Reason",
|
|
"description": "Reason for failure if the run failed or terminated"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At",
|
|
"description": "Timestamp when this run was created",
|
|
"examples": [
|
|
"2025-01-01T00:00:00Z"
|
|
]
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At",
|
|
"description": "Timestamp when this run was last modified",
|
|
"examples": [
|
|
"2025-01-01T00:05:00Z"
|
|
]
|
|
},
|
|
"queued_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Queued At",
|
|
"description": "Timestamp when this run was queued"
|
|
},
|
|
"started_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Started At",
|
|
"description": "Timestamp when this run started execution"
|
|
},
|
|
"finished_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Finished At",
|
|
"description": "Timestamp when this run finished"
|
|
},
|
|
"app_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "App Url",
|
|
"description": "URL to the application UI where the run can be viewed",
|
|
"examples": [
|
|
"https://app.skyvern.com/tasks/tsk_123",
|
|
"https://app.skyvern.com/workflows/wpid_123/wr_123"
|
|
]
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id",
|
|
"description": "ID of the Skyvern persistent browser session used for this run",
|
|
"examples": [
|
|
"pbs_123"
|
|
]
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id",
|
|
"description": "ID of the browser profile used for this run",
|
|
"examples": [
|
|
"bp_123"
|
|
]
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls",
|
|
"description": "The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot"
|
|
},
|
|
"script_run": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ScriptRunResponse"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "The script run result"
|
|
},
|
|
"errors": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Errors",
|
|
"description": "The errors for the run"
|
|
},
|
|
"step_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Step Count",
|
|
"description": "Total number of steps executed in this run"
|
|
},
|
|
"run_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"task_v1",
|
|
"task_v2",
|
|
"openai_cua",
|
|
"anthropic_cua",
|
|
"ui_tars",
|
|
"yutori_navigator"
|
|
],
|
|
"title": "Run Type",
|
|
"description": "Types of a task run - task_v1, task_v2, openai_cua, anthropic_cua, ui_tars"
|
|
},
|
|
"run_request": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TaskRunRequest-Output"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "The original request parameters used to start this task run"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"run_id",
|
|
"status",
|
|
"created_at",
|
|
"modified_at",
|
|
"run_type"
|
|
],
|
|
"title": "TaskRunResponse"
|
|
},
|
|
"TaskV2Block": {
|
|
"properties": {
|
|
"label": {
|
|
"type": "string",
|
|
"title": "Label",
|
|
"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": "task_v2",
|
|
"title": "Block Type",
|
|
"default": "task_v2"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"totp_verification_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Verification Url"
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier"
|
|
},
|
|
"max_iterations": {
|
|
"type": "integer",
|
|
"title": "Max Iterations",
|
|
"default": 50
|
|
},
|
|
"max_steps": {
|
|
"type": "integer",
|
|
"title": "Max Steps",
|
|
"default": 25
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"prompt"
|
|
],
|
|
"title": "TaskV2Block"
|
|
},
|
|
"TaskV2BlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "task_v2",
|
|
"title": "Block Type",
|
|
"default": "task_v2"
|
|
},
|
|
"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
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"totp_verification_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Verification Url"
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier"
|
|
},
|
|
"max_iterations": {
|
|
"type": "integer",
|
|
"title": "Max Iterations",
|
|
"default": 50
|
|
},
|
|
"max_steps": {
|
|
"type": "integer",
|
|
"title": "Max Steps",
|
|
"default": 25
|
|
},
|
|
"disable_cache": {
|
|
"type": "boolean",
|
|
"title": "Disable Cache",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"prompt"
|
|
],
|
|
"title": "TaskV2BlockYAML"
|
|
},
|
|
"TextPromptBlock": {
|
|
"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": "text_prompt",
|
|
"title": "Block Type",
|
|
"default": "text_prompt"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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
|
|
},
|
|
"llm_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Llm Key"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt"
|
|
},
|
|
"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": []
|
|
},
|
|
"json_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Json Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"prompt"
|
|
],
|
|
"title": "TextPromptBlock"
|
|
},
|
|
"TextPromptBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "text_prompt",
|
|
"title": "Block Type",
|
|
"default": "text_prompt"
|
|
},
|
|
"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
|
|
},
|
|
"llm_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Llm Key"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt"
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
},
|
|
"json_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Json Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"prompt"
|
|
],
|
|
"title": "TextPromptBlockYAML"
|
|
},
|
|
"Thought": {
|
|
"properties": {
|
|
"thought_id": {
|
|
"type": "string",
|
|
"title": "Thought Id"
|
|
},
|
|
"task_id": {
|
|
"type": "string",
|
|
"title": "Task Id"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id"
|
|
},
|
|
"workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Run Id"
|
|
},
|
|
"workflow_run_block_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Run Block Id"
|
|
},
|
|
"workflow_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Id"
|
|
},
|
|
"workflow_permanent_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"user_input": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "User Input"
|
|
},
|
|
"observation": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Observation"
|
|
},
|
|
"thought": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Thought"
|
|
},
|
|
"answer": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Answer"
|
|
},
|
|
"thought_type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ThoughtType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "plan"
|
|
},
|
|
"thought_scenario": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ThoughtScenario"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Output"
|
|
},
|
|
"input_token_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Input Token Count"
|
|
},
|
|
"output_token_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Output Token Count"
|
|
},
|
|
"reasoning_token_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Reasoning Token Count"
|
|
},
|
|
"cached_token_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Cached Token Count"
|
|
},
|
|
"thought_cost": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Thought Cost"
|
|
},
|
|
"last_llm_model": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Last Llm Model"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"thought_id",
|
|
"task_id",
|
|
"organization_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "Thought"
|
|
},
|
|
"ThoughtScenario": {
|
|
"type": "string",
|
|
"enum": [
|
|
"generate_plan",
|
|
"user_goal_check",
|
|
"failure_describe",
|
|
"summarization",
|
|
"generate_metadata",
|
|
"extract_loop_values",
|
|
"generate_task_in_loop",
|
|
"generate_general_task",
|
|
"termination"
|
|
],
|
|
"title": "ThoughtScenario",
|
|
"description": "Scenario in which a thought was generated.\n\nNote: Stored as VARCHAR in the database (not a PostgreSQL ENUM), so new values\ncan be added without database migrations. See observer_thoughts.observer_thought_scenario column."
|
|
},
|
|
"ThoughtType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"plan",
|
|
"metadata",
|
|
"user_goal_check",
|
|
"internal_plan",
|
|
"failure_describe",
|
|
"termination"
|
|
],
|
|
"title": "ThoughtType",
|
|
"description": "Type of thought recorded during task execution.\n\nNote: Stored as VARCHAR in the database (not a PostgreSQL ENUM), so new values\ncan be added without database migrations. See observer_thoughts.observer_thought_type column."
|
|
},
|
|
"TotpType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"authenticator",
|
|
"email",
|
|
"text",
|
|
"none"
|
|
],
|
|
"title": "TotpType",
|
|
"description": "Type of 2FA/TOTP method used."
|
|
},
|
|
"UpdateBrowserProfileRequest": {
|
|
"properties": {
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Name",
|
|
"description": "New name for the browser profile"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description",
|
|
"description": "New description for the browser profile"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Location",
|
|
"description": "Optional proxy location for this profile's pinned proxy identity."
|
|
},
|
|
"proxy_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Session Id",
|
|
"description": "Opaque Skyvern-managed proxy sticky-session id."
|
|
},
|
|
"rotate_proxy_session_id": {
|
|
"type": "boolean",
|
|
"title": "Rotate Proxy Session Id",
|
|
"description": "Rotate the Skyvern-managed proxy sticky-session id for this profile.",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "UpdateBrowserProfileRequest"
|
|
},
|
|
"UpdateBrowserSessionRequest": {
|
|
"properties": {
|
|
"generate_browser_profile": {
|
|
"type": "boolean",
|
|
"title": "Generate Browser Profile",
|
|
"description": "Enable or disable saving this session's browser profile when it ends. Can be toggled while the session is still alive; the value is read at session teardown."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"generate_browser_profile"
|
|
],
|
|
"title": "UpdateBrowserSessionRequest"
|
|
},
|
|
"UpdateWorkflowFolderRequest": {
|
|
"properties": {
|
|
"folder_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Folder Id",
|
|
"description": "Folder ID to assign workflow to. Set to null to remove from folder."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "UpdateWorkflowFolderRequest",
|
|
"description": "Request model for updating a workflow's folder assignment"
|
|
},
|
|
"UploadFileAction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "ai_upload_file",
|
|
"title": "Type",
|
|
"default": "ai_upload_file"
|
|
},
|
|
"selector": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Selector",
|
|
"description": "CSS selector for the element",
|
|
"default": ""
|
|
},
|
|
"file_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "File Url",
|
|
"description": "File URL for upload",
|
|
"default": ""
|
|
},
|
|
"intention": {
|
|
"type": "string",
|
|
"title": "Intention",
|
|
"description": "The intention or goal of the upload",
|
|
"default": ""
|
|
},
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data",
|
|
"description": "Additional context data"
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"title": "Timeout",
|
|
"description": "Timeout in milliseconds",
|
|
"default": 5000
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "UploadFileAction",
|
|
"description": "Upload file action parameters."
|
|
},
|
|
"UploadFileResponse": {
|
|
"properties": {
|
|
"s3_uri": {
|
|
"type": "string",
|
|
"title": "S3 Uri",
|
|
"description": "S3 URI where the file was uploaded"
|
|
},
|
|
"presigned_url": {
|
|
"type": "string",
|
|
"title": "Presigned Url",
|
|
"description": "Presigned URL to access the uploaded file"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"s3_uri",
|
|
"presigned_url"
|
|
],
|
|
"title": "UploadFileResponse"
|
|
},
|
|
"UploadToS3Block": {
|
|
"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": "upload_to_s3",
|
|
"title": "Block Type",
|
|
"default": "upload_to_s3"
|
|
},
|
|
"output_parameter": {
|
|
"$ref": "#/components/schemas/OutputParameter"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"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
|
|
},
|
|
"path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Path"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter"
|
|
],
|
|
"title": "UploadToS3Block"
|
|
},
|
|
"UploadToS3BlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "upload_to_s3",
|
|
"title": "Block Type",
|
|
"default": "upload_to_s3"
|
|
},
|
|
"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
|
|
},
|
|
"path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Path"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label"
|
|
],
|
|
"title": "UploadToS3BlockYAML"
|
|
},
|
|
"UrlBlock": {
|
|
"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": "goto_url",
|
|
"title": "Block Type",
|
|
"default": "goto_url"
|
|
},
|
|
"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": {
|
|
"type": "string",
|
|
"title": "Url"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title",
|
|
"default": ""
|
|
},
|
|
"engine": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"url"
|
|
],
|
|
"title": "UrlBlock"
|
|
},
|
|
"UrlBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "goto_url",
|
|
"title": "Block Type",
|
|
"default": "goto_url"
|
|
},
|
|
"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
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"title": "Url"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"url"
|
|
],
|
|
"title": "UrlBlockYAML"
|
|
},
|
|
"UserDefinedError": {
|
|
"properties": {
|
|
"error_code": {
|
|
"type": "string",
|
|
"title": "Error Code"
|
|
},
|
|
"reasoning": {
|
|
"type": "string",
|
|
"title": "Reasoning"
|
|
},
|
|
"confidence_float": {
|
|
"type": "number",
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"title": "Confidence Float"
|
|
},
|
|
"error_type": {
|
|
"type": "string",
|
|
"const": "USER_DEFINED_ERROR",
|
|
"title": "Error Type",
|
|
"default": "USER_DEFINED_ERROR"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"error_code",
|
|
"reasoning",
|
|
"confidence_float"
|
|
],
|
|
"title": "UserDefinedError"
|
|
},
|
|
"ValidateAction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "validate",
|
|
"title": "Type",
|
|
"default": "validate"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt",
|
|
"description": "Validation criteria or condition to check"
|
|
},
|
|
"model": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Model",
|
|
"description": "Optional model configuration"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"prompt"
|
|
],
|
|
"title": "ValidateAction",
|
|
"description": "Validate action parameters."
|
|
},
|
|
"ValidationBlock": {
|
|
"properties": {
|
|
"label": {
|
|
"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": "validation",
|
|
"title": "Block Type",
|
|
"default": "validation"
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/RunEngine",
|
|
"default": "skyvern-1.0"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"data_extraction_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Data Extraction Goal"
|
|
},
|
|
"data_schema": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "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
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter"
|
|
],
|
|
"title": "ValidationBlock"
|
|
},
|
|
"ValidationBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "validation",
|
|
"title": "Block Type",
|
|
"default": "validation"
|
|
},
|
|
"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
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"error_code_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Error Code Mapping"
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
},
|
|
"disable_cache": {
|
|
"type": "boolean",
|
|
"title": "Disable Cache",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label"
|
|
],
|
|
"title": "ValidationBlockYAML"
|
|
},
|
|
"ValidationError": {
|
|
"properties": {
|
|
"loc": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
}
|
|
]
|
|
},
|
|
"type": "array",
|
|
"title": "Location"
|
|
},
|
|
"msg": {
|
|
"type": "string",
|
|
"title": "Message"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"title": "Error Type"
|
|
},
|
|
"input": {
|
|
"title": "Input"
|
|
},
|
|
"ctx": {
|
|
"type": "object",
|
|
"title": "Context"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"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": "WaitBlockYAML"
|
|
},
|
|
"WhileLoopBlock": {
|
|
"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": "while_loop",
|
|
"title": "Block Type",
|
|
"default": "while_loop"
|
|
},
|
|
"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
|
|
},
|
|
"loop_blocks": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ForLoopBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WhileLoopBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CodeBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextPromptBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DownloadToS3Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UploadToS3Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SendEmailBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileParserBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PDFParserBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ValidationBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ActionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/NavigationBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ExtractionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LoginBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WaitBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HumanInteractionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileDownloadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UrlBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskV2Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileUploadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HttpRequestBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PrintPageBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowTriggerBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsReadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsWriteBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PdfFillBlock"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "block_type",
|
|
"mapping": {
|
|
"action": "#/components/schemas/ActionBlock",
|
|
"code": "#/components/schemas/CodeBlock",
|
|
"conditional": "#/components/schemas/ConditionalBlock",
|
|
"download_to_s3": "#/components/schemas/DownloadToS3Block",
|
|
"extraction": "#/components/schemas/ExtractionBlock",
|
|
"file_download": "#/components/schemas/FileDownloadBlock",
|
|
"file_upload": "#/components/schemas/FileUploadBlock",
|
|
"file_url_parser": "#/components/schemas/FileParserBlock",
|
|
"for_loop": "#/components/schemas/ForLoopBlock",
|
|
"google_sheets_read": "#/components/schemas/GoogleSheetsReadBlock",
|
|
"google_sheets_write": "#/components/schemas/GoogleSheetsWriteBlock",
|
|
"goto_url": "#/components/schemas/UrlBlock",
|
|
"http_request": "#/components/schemas/HttpRequestBlock",
|
|
"human_interaction": "#/components/schemas/HumanInteractionBlock",
|
|
"login": "#/components/schemas/LoginBlock",
|
|
"navigation": "#/components/schemas/NavigationBlock",
|
|
"pdf_fill": "#/components/schemas/PdfFillBlock",
|
|
"pdf_parser": "#/components/schemas/PDFParserBlock",
|
|
"print_page": "#/components/schemas/PrintPageBlock",
|
|
"send_email": "#/components/schemas/SendEmailBlock",
|
|
"task": "#/components/schemas/TaskBlock",
|
|
"task_v2": "#/components/schemas/TaskV2Block",
|
|
"text_prompt": "#/components/schemas/TextPromptBlock",
|
|
"upload_to_s3": "#/components/schemas/UploadToS3Block",
|
|
"validation": "#/components/schemas/ValidationBlock",
|
|
"wait": "#/components/schemas/WaitBlock",
|
|
"while_loop": "#/components/schemas/WhileLoopBlock",
|
|
"workflow_trigger": "#/components/schemas/WorkflowTriggerBlock"
|
|
}
|
|
}
|
|
},
|
|
"type": "array",
|
|
"title": "Loop Blocks"
|
|
},
|
|
"condition": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/JinjaBranchCriteria"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PromptBranchCriteria"
|
|
}
|
|
],
|
|
"title": "Condition",
|
|
"discriminator": {
|
|
"propertyName": "criteria_type",
|
|
"mapping": {
|
|
"jinja2_template": "#/components/schemas/JinjaBranchCriteria",
|
|
"prompt": "#/components/schemas/PromptBranchCriteria"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"output_parameter",
|
|
"loop_blocks",
|
|
"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."
|
|
},
|
|
"WhileLoopBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "while_loop",
|
|
"title": "Block Type",
|
|
"default": "while_loop"
|
|
},
|
|
"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
|
|
},
|
|
"loop_blocks": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TaskBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ForLoopBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WhileLoopBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CodeBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextPromptBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DownloadToS3BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UploadToS3BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileUploadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SendEmailBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileParserBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ValidationBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ActionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/NavigationBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ExtractionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LoginBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WaitBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HumanInteractionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileDownloadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UrlBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PDFParserBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskV2BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HttpRequestBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PrintPageBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PdfFillBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowTriggerBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsReadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsWriteBlockYAML"
|
|
}
|
|
]
|
|
},
|
|
"type": "array",
|
|
"title": "Loop Blocks"
|
|
},
|
|
"condition": {
|
|
"$ref": "#/components/schemas/BranchCriteriaYAML"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"loop_blocks",
|
|
"condition"
|
|
],
|
|
"title": "WhileLoopBlockYAML"
|
|
},
|
|
"Workflow": {
|
|
"properties": {
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title"
|
|
},
|
|
"workflow_permanent_id": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"title": "Version"
|
|
},
|
|
"is_saved_task": {
|
|
"type": "boolean",
|
|
"title": "Is Saved Task"
|
|
},
|
|
"is_template": {
|
|
"type": "boolean",
|
|
"title": "Is Template",
|
|
"default": false
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"workflow_definition": {
|
|
"$ref": "#/components/schemas/WorkflowDefinition"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Location"
|
|
},
|
|
"webhook_callback_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Callback Url"
|
|
},
|
|
"totp_verification_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Verification Url"
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier"
|
|
},
|
|
"persist_browser_session": {
|
|
"type": "boolean",
|
|
"title": "Persist Browser Session",
|
|
"default": false
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id"
|
|
},
|
|
"browser_profile_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Key"
|
|
},
|
|
"model": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Model"
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/WorkflowStatus",
|
|
"default": "published"
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls"
|
|
},
|
|
"max_elapsed_time_minutes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Elapsed Time Minutes"
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers"
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Cdp Connect Headers"
|
|
},
|
|
"run_with": {
|
|
"type": "string",
|
|
"title": "Run With",
|
|
"default": "agent"
|
|
},
|
|
"ai_fallback": {
|
|
"type": "boolean",
|
|
"title": "Ai Fallback",
|
|
"default": true
|
|
},
|
|
"cache_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Cache Key"
|
|
},
|
|
"adaptive_caching": {
|
|
"type": "boolean",
|
|
"title": "Adaptive Caching",
|
|
"default": false
|
|
},
|
|
"code_version": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Code Version"
|
|
},
|
|
"generate_script_on_terminal": {
|
|
"type": "boolean",
|
|
"title": "Generate Script On Terminal",
|
|
"default": false
|
|
},
|
|
"run_sequentially": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run Sequentially"
|
|
},
|
|
"sequential_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Sequential Key"
|
|
},
|
|
"folder_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Folder Id"
|
|
},
|
|
"import_error": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Import Error"
|
|
},
|
|
"created_by": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Created By"
|
|
},
|
|
"edited_by": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Edited By"
|
|
},
|
|
"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"
|
|
},
|
|
"agent_id": {
|
|
"type": "string",
|
|
"title": "Agent Id",
|
|
"description": "Alias of `workflow_permanent_id` — the stable agent identifier (starts with `wpid_`).",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_id",
|
|
"organization_id",
|
|
"title",
|
|
"workflow_permanent_id",
|
|
"version",
|
|
"is_saved_task",
|
|
"workflow_definition",
|
|
"created_at",
|
|
"modified_at",
|
|
"agent_id"
|
|
],
|
|
"title": "Workflow"
|
|
},
|
|
"WorkflowCreateYAMLRequest": {
|
|
"properties": {
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Location"
|
|
},
|
|
"webhook_callback_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Callback Url"
|
|
},
|
|
"totp_verification_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Verification Url"
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier"
|
|
},
|
|
"persist_browser_session": {
|
|
"type": "boolean",
|
|
"title": "Persist Browser Session",
|
|
"default": false
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id"
|
|
},
|
|
"browser_profile_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Key"
|
|
},
|
|
"model": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Model"
|
|
},
|
|
"workflow_definition": {
|
|
"$ref": "#/components/schemas/WorkflowDefinitionYAML"
|
|
},
|
|
"is_saved_task": {
|
|
"type": "boolean",
|
|
"title": "Is Saved Task",
|
|
"default": false
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls"
|
|
},
|
|
"max_elapsed_time_minutes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"maximum": 480.0,
|
|
"minimum": 1.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Elapsed Time Minutes"
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers"
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Cdp Connect Headers"
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/WorkflowStatus",
|
|
"default": "published"
|
|
},
|
|
"run_with": {
|
|
"type": "string",
|
|
"title": "Run With",
|
|
"default": "agent"
|
|
},
|
|
"ai_fallback": {
|
|
"type": "boolean",
|
|
"title": "Ai Fallback",
|
|
"default": true
|
|
},
|
|
"cache_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Cache Key",
|
|
"default": "default"
|
|
},
|
|
"adaptive_caching": {
|
|
"type": "boolean",
|
|
"title": "Adaptive Caching",
|
|
"default": false
|
|
},
|
|
"code_version": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"maximum": 2.0,
|
|
"minimum": 1.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Code Version"
|
|
},
|
|
"generate_script_on_terminal": {
|
|
"type": "boolean",
|
|
"title": "Generate Script On Terminal",
|
|
"default": false
|
|
},
|
|
"run_sequentially": {
|
|
"type": "boolean",
|
|
"title": "Prevent Overlapping Runs",
|
|
"default": false
|
|
},
|
|
"sequential_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Sequential Key"
|
|
},
|
|
"folder_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Folder Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"title",
|
|
"workflow_definition"
|
|
],
|
|
"title": "WorkflowCreateYAMLRequest"
|
|
},
|
|
"WorkflowDefinition": {
|
|
"properties": {
|
|
"version": {
|
|
"type": "integer",
|
|
"title": "Version",
|
|
"default": 1
|
|
},
|
|
"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"
|
|
},
|
|
"blocks": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ForLoopBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WhileLoopBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CodeBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextPromptBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DownloadToS3Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UploadToS3Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SendEmailBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileParserBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PDFParserBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ValidationBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ActionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/NavigationBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ExtractionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LoginBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WaitBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HumanInteractionBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileDownloadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UrlBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskV2Block"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileUploadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HttpRequestBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PrintPageBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowTriggerBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsReadBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsWriteBlock"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PdfFillBlock"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "block_type",
|
|
"mapping": {
|
|
"action": "#/components/schemas/ActionBlock",
|
|
"code": "#/components/schemas/CodeBlock",
|
|
"conditional": "#/components/schemas/ConditionalBlock",
|
|
"download_to_s3": "#/components/schemas/DownloadToS3Block",
|
|
"extraction": "#/components/schemas/ExtractionBlock",
|
|
"file_download": "#/components/schemas/FileDownloadBlock",
|
|
"file_upload": "#/components/schemas/FileUploadBlock",
|
|
"file_url_parser": "#/components/schemas/FileParserBlock",
|
|
"for_loop": "#/components/schemas/ForLoopBlock",
|
|
"google_sheets_read": "#/components/schemas/GoogleSheetsReadBlock",
|
|
"google_sheets_write": "#/components/schemas/GoogleSheetsWriteBlock",
|
|
"goto_url": "#/components/schemas/UrlBlock",
|
|
"http_request": "#/components/schemas/HttpRequestBlock",
|
|
"human_interaction": "#/components/schemas/HumanInteractionBlock",
|
|
"login": "#/components/schemas/LoginBlock",
|
|
"navigation": "#/components/schemas/NavigationBlock",
|
|
"pdf_fill": "#/components/schemas/PdfFillBlock",
|
|
"pdf_parser": "#/components/schemas/PDFParserBlock",
|
|
"print_page": "#/components/schemas/PrintPageBlock",
|
|
"send_email": "#/components/schemas/SendEmailBlock",
|
|
"task": "#/components/schemas/TaskBlock",
|
|
"task_v2": "#/components/schemas/TaskV2Block",
|
|
"text_prompt": "#/components/schemas/TextPromptBlock",
|
|
"upload_to_s3": "#/components/schemas/UploadToS3Block",
|
|
"validation": "#/components/schemas/ValidationBlock",
|
|
"wait": "#/components/schemas/WaitBlock",
|
|
"while_loop": "#/components/schemas/WhileLoopBlock",
|
|
"workflow_trigger": "#/components/schemas/WorkflowTriggerBlock"
|
|
}
|
|
}
|
|
},
|
|
"type": "array",
|
|
"title": "Blocks"
|
|
},
|
|
"finally_block_label": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Finally Block Label"
|
|
},
|
|
"error_code_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Error Code Mapping"
|
|
},
|
|
"workflow_system_prompt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow System Prompt"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"parameters",
|
|
"blocks"
|
|
],
|
|
"title": "WorkflowDefinition"
|
|
},
|
|
"WorkflowDefinitionYAML": {
|
|
"properties": {
|
|
"version": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Version"
|
|
},
|
|
"parameters": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AWSSecretParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/BitwardenLoginCredentialParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/BitwardenSensitiveInformationParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/BitwardenCreditCardDataParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OnePasswordCredentialParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AzureVaultCredentialParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ContextParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OutputParameterYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CredentialParameterYAML"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "parameter_type",
|
|
"mapping": {
|
|
"aws_secret": "#/components/schemas/AWSSecretParameterYAML",
|
|
"azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameterYAML",
|
|
"bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameterYAML",
|
|
"bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameterYAML",
|
|
"bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameterYAML",
|
|
"context": "#/components/schemas/ContextParameterYAML",
|
|
"credential": "#/components/schemas/CredentialParameterYAML",
|
|
"onepassword": "#/components/schemas/OnePasswordCredentialParameterYAML",
|
|
"output": "#/components/schemas/OutputParameterYAML",
|
|
"workflow": "#/components/schemas/WorkflowParameterYAML"
|
|
}
|
|
}
|
|
},
|
|
"type": "array",
|
|
"title": "Parameters"
|
|
},
|
|
"blocks": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TaskBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ForLoopBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WhileLoopBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CodeBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextPromptBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DownloadToS3BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UploadToS3BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileUploadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SendEmailBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileParserBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ValidationBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ActionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/NavigationBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ExtractionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/LoginBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WaitBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HumanInteractionBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/FileDownloadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UrlBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PDFParserBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TaskV2BlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/HttpRequestBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ConditionalBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PrintPageBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/PdfFillBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowTriggerBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsReadBlockYAML"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GoogleSheetsWriteBlockYAML"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "block_type",
|
|
"mapping": {
|
|
"action": "#/components/schemas/ActionBlockYAML",
|
|
"code": "#/components/schemas/CodeBlockYAML",
|
|
"conditional": "#/components/schemas/ConditionalBlockYAML",
|
|
"download_to_s3": "#/components/schemas/DownloadToS3BlockYAML",
|
|
"extraction": "#/components/schemas/ExtractionBlockYAML",
|
|
"file_download": "#/components/schemas/FileDownloadBlockYAML",
|
|
"file_upload": "#/components/schemas/FileUploadBlockYAML",
|
|
"file_url_parser": "#/components/schemas/FileParserBlockYAML",
|
|
"for_loop": "#/components/schemas/ForLoopBlockYAML",
|
|
"google_sheets_read": "#/components/schemas/GoogleSheetsReadBlockYAML",
|
|
"google_sheets_write": "#/components/schemas/GoogleSheetsWriteBlockYAML",
|
|
"goto_url": "#/components/schemas/UrlBlockYAML",
|
|
"http_request": "#/components/schemas/HttpRequestBlockYAML",
|
|
"human_interaction": "#/components/schemas/HumanInteractionBlockYAML",
|
|
"login": "#/components/schemas/LoginBlockYAML",
|
|
"navigation": "#/components/schemas/NavigationBlockYAML",
|
|
"pdf_fill": "#/components/schemas/PdfFillBlockYAML",
|
|
"pdf_parser": "#/components/schemas/PDFParserBlockYAML",
|
|
"print_page": "#/components/schemas/PrintPageBlockYAML",
|
|
"send_email": "#/components/schemas/SendEmailBlockYAML",
|
|
"task": "#/components/schemas/TaskBlockYAML",
|
|
"task_v2": "#/components/schemas/TaskV2BlockYAML",
|
|
"text_prompt": "#/components/schemas/TextPromptBlockYAML",
|
|
"upload_to_s3": "#/components/schemas/UploadToS3BlockYAML",
|
|
"validation": "#/components/schemas/ValidationBlockYAML",
|
|
"wait": "#/components/schemas/WaitBlockYAML",
|
|
"while_loop": "#/components/schemas/WhileLoopBlockYAML",
|
|
"workflow_trigger": "#/components/schemas/WorkflowTriggerBlockYAML"
|
|
}
|
|
}
|
|
},
|
|
"type": "array",
|
|
"title": "Blocks"
|
|
},
|
|
"finally_block_label": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Finally Block Label"
|
|
},
|
|
"error_code_mapping": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Error Code Mapping"
|
|
},
|
|
"workflow_system_prompt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow System Prompt"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"parameters",
|
|
"blocks"
|
|
],
|
|
"title": "WorkflowDefinitionYAML"
|
|
},
|
|
"WorkflowParameter": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "workflow",
|
|
"title": "Parameter Type",
|
|
"default": "workflow"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"workflow_parameter_id": {
|
|
"type": "string",
|
|
"title": "Workflow Parameter Id"
|
|
},
|
|
"workflow_parameter_type": {
|
|
"$ref": "#/components/schemas/WorkflowParameterType"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"default_value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Default Value"
|
|
},
|
|
"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",
|
|
"workflow_parameter_id",
|
|
"workflow_parameter_type",
|
|
"workflow_id",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "WorkflowParameter"
|
|
},
|
|
"WorkflowParameterType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"string",
|
|
"integer",
|
|
"float",
|
|
"boolean",
|
|
"json",
|
|
"file_url",
|
|
"credential_id"
|
|
],
|
|
"title": "WorkflowParameterType"
|
|
},
|
|
"WorkflowParameterYAML": {
|
|
"properties": {
|
|
"parameter_type": {
|
|
"type": "string",
|
|
"const": "workflow",
|
|
"title": "Parameter Type",
|
|
"default": "workflow"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"title": "Key"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"workflow_parameter_type": {
|
|
"$ref": "#/components/schemas/WorkflowParameterType"
|
|
},
|
|
"default_value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Default Value"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"key",
|
|
"workflow_parameter_type"
|
|
],
|
|
"title": "WorkflowParameterYAML"
|
|
},
|
|
"WorkflowRequest": {
|
|
"properties": {
|
|
"json_definition": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowCreateYAMLRequest"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow definition in JSON format"
|
|
},
|
|
"yaml_definition": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Yaml Definition",
|
|
"description": "Workflow definition in YAML format"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "WorkflowRequest"
|
|
},
|
|
"WorkflowRun": {
|
|
"properties": {
|
|
"workflow_run_id": {
|
|
"type": "string",
|
|
"title": "Workflow Run Id"
|
|
},
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id"
|
|
},
|
|
"workflow_permanent_id": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id"
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id"
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id"
|
|
},
|
|
"debug_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Debug Session Id"
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/WorkflowRunStatus"
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers"
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Cdp Connect Headers"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Proxy Location"
|
|
},
|
|
"webhook_callback_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Callback Url"
|
|
},
|
|
"webhook_failure_reason": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Failure Reason"
|
|
},
|
|
"totp_verification_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Verification Url"
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier"
|
|
},
|
|
"failure_reason": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Failure Reason"
|
|
},
|
|
"failure_category": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Failure Category"
|
|
},
|
|
"parent_workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parent Workflow Run Id"
|
|
},
|
|
"workflow_title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Title"
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls"
|
|
},
|
|
"max_elapsed_time_minutes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Elapsed Time Minutes"
|
|
},
|
|
"browser_address": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Address"
|
|
},
|
|
"run_with": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run With"
|
|
},
|
|
"script_run": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ScriptRunResponse"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"job_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Job Id"
|
|
},
|
|
"depends_on_workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Depends On Workflow Run Id"
|
|
},
|
|
"sequential_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Sequential Key"
|
|
},
|
|
"ai_fallback": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Ai Fallback"
|
|
},
|
|
"code_gen": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Code Gen"
|
|
},
|
|
"trigger_type": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowRunTriggerType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"workflow_schedule_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Workflow Schedule Id"
|
|
},
|
|
"ignore_inherited_workflow_system_prompt": {
|
|
"type": "boolean",
|
|
"title": "Ignore Inherited Workflow System Prompt",
|
|
"default": false
|
|
},
|
|
"copilot_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Copilot Session Id"
|
|
},
|
|
"credits_used": {
|
|
"type": "integer",
|
|
"title": "Credits Used",
|
|
"default": 0
|
|
},
|
|
"cached_credits_used": {
|
|
"type": "integer",
|
|
"title": "Cached Credits Used",
|
|
"default": 0
|
|
},
|
|
"queued_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Queued At"
|
|
},
|
|
"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": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_run_id",
|
|
"workflow_id",
|
|
"workflow_permanent_id",
|
|
"organization_id",
|
|
"status",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "WorkflowRun"
|
|
},
|
|
"WorkflowRunBlock": {
|
|
"properties": {
|
|
"workflow_run_block_id": {
|
|
"type": "string",
|
|
"title": "Workflow Run Block Id"
|
|
},
|
|
"block_workflow_run_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Block Workflow Run Id"
|
|
},
|
|
"workflow_run_id": {
|
|
"type": "string",
|
|
"title": "Workflow Run Id"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"parent_workflow_run_block_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parent Workflow Run Block Id"
|
|
},
|
|
"block_type": {
|
|
"$ref": "#/components/schemas/BlockType"
|
|
},
|
|
"label": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Label"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Status"
|
|
},
|
|
"output": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Output"
|
|
},
|
|
"continue_on_failure": {
|
|
"type": "boolean",
|
|
"title": "Continue On Failure",
|
|
"default": false
|
|
},
|
|
"failure_reason": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Failure Reason"
|
|
},
|
|
"error_codes": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Error Codes",
|
|
"default": []
|
|
},
|
|
"engine": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RunEngine"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"task_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Task Id"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Url"
|
|
},
|
|
"navigation_goal": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Goal"
|
|
},
|
|
"navigation_payload": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Navigation Payload"
|
|
},
|
|
"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"
|
|
},
|
|
"terminate_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Terminate Criterion"
|
|
},
|
|
"complete_criterion": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Complete Criterion"
|
|
},
|
|
"actions": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Action"
|
|
},
|
|
"type": "array",
|
|
"title": "Actions",
|
|
"default": []
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"include_action_history_in_verification": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Include Action History In Verification",
|
|
"default": false
|
|
},
|
|
"include_extracted_text": {
|
|
"type": "boolean",
|
|
"title": "Include Extracted Text",
|
|
"default": true
|
|
},
|
|
"duration": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Duration"
|
|
},
|
|
"loop_values": {
|
|
"anyOf": [
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Loop Values"
|
|
},
|
|
"current_value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Current Value"
|
|
},
|
|
"current_index": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Current Index"
|
|
},
|
|
"recipients": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Recipients"
|
|
},
|
|
"attachments": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Attachments"
|
|
},
|
|
"subject": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Subject"
|
|
},
|
|
"body": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Body"
|
|
},
|
|
"instructions": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Instructions"
|
|
},
|
|
"positive_descriptor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Positive Descriptor"
|
|
},
|
|
"negative_descriptor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Negative Descriptor"
|
|
},
|
|
"executed_branch_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Executed Branch Id"
|
|
},
|
|
"executed_branch_expression": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Executed Branch Expression"
|
|
},
|
|
"executed_branch_result": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Executed Branch Result"
|
|
},
|
|
"executed_branch_next_block": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Executed Branch Next Block"
|
|
},
|
|
"script_run": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ScriptRunResponse"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"downloaded_file_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Downloaded File Count"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_run_block_id",
|
|
"workflow_run_id",
|
|
"organization_id",
|
|
"block_type",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "WorkflowRunBlock"
|
|
},
|
|
"WorkflowRunRequest-Input": {
|
|
"properties": {
|
|
"agent_id": {
|
|
"type": "string",
|
|
"title": "Agent Id",
|
|
"description": "ID of the agent to run. Starts with `wpid_`. `workflow_id` is accepted as an alias.",
|
|
"examples": [
|
|
"wpid_123"
|
|
]
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameters",
|
|
"description": "Parameters to pass to the workflow"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title",
|
|
"description": "The title for this workflow run"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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:password@proxy.example.com: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\"}",
|
|
"default": "RESIDENTIAL"
|
|
},
|
|
"webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Url",
|
|
"description": "URL to send workflow status updates to after a run is finished. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for webhook questions."
|
|
},
|
|
"totp_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Url",
|
|
"description": "\nURL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://www.skyvern.com/docs/credentials/totp#option-2-get-code-from-your-endpoint for more details.\n",
|
|
"examples": [
|
|
"https://my-totp-service.com/totp"
|
|
]
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "\nIdentifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://www.skyvern.com/docs/credentials/totp#option-3-push-code-to-skyvern for more details.\n",
|
|
"examples": [
|
|
"john.doe@example.com",
|
|
"4155555555",
|
|
"user_123"
|
|
]
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id",
|
|
"description": "ID of a Skyvern browser session to reuse, having it continue from the current screen state"
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id",
|
|
"description": "ID of a browser profile to reuse for this workflow run"
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls",
|
|
"description": "The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot."
|
|
},
|
|
"max_elapsed_time_minutes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"maximum": 480.0,
|
|
"minimum": 1.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Elapsed Time Minutes",
|
|
"description": "Timeout this workflow run after the configured elapsed runtime in minutes. When omitted, the platform default is 240 minutes. The maximum configurable value is 480 minutes."
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers",
|
|
"description": "The extra HTTP headers for the requests in browser."
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites."
|
|
},
|
|
"browser_address": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Address",
|
|
"description": "The CDP address for the workflow run.",
|
|
"examples": [
|
|
"http://127.0.0.1:9222",
|
|
"ws://127.0.0.1:9222/devtools/browser/1234567890"
|
|
]
|
|
},
|
|
"ai_fallback": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Ai Fallback",
|
|
"description": "Whether to fallback to AI if the workflow run fails."
|
|
},
|
|
"run_with": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run With",
|
|
"description": "Whether to run the workflow with agent or code. Null inherits from the workflow setting.",
|
|
"examples": [
|
|
"agent",
|
|
"code"
|
|
]
|
|
},
|
|
"run_metadata": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run Metadata",
|
|
"description": "String key/value metadata to attach to this workflow run for analytics tag filtering."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"agent_id"
|
|
],
|
|
"title": "WorkflowRunRequest"
|
|
},
|
|
"WorkflowRunRequest-Output": {
|
|
"properties": {
|
|
"workflow_id": {
|
|
"type": "string",
|
|
"title": "Workflow Id",
|
|
"description": "ID of the agent to run. Starts with `wpid_`. `workflow_id` is accepted as an alias.",
|
|
"examples": [
|
|
"wpid_123"
|
|
]
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameters",
|
|
"description": "Parameters to pass to the workflow"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Title",
|
|
"description": "The title for this workflow run"
|
|
},
|
|
"proxy_location": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProxyLocation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GeoTarget"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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:password@proxy.example.com: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\"}",
|
|
"default": "RESIDENTIAL"
|
|
},
|
|
"webhook_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Webhook Url",
|
|
"description": "URL to send workflow status updates to after a run is finished. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for webhook questions."
|
|
},
|
|
"totp_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Url",
|
|
"description": "\nURL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://www.skyvern.com/docs/credentials/totp#option-2-get-code-from-your-endpoint for more details.\n",
|
|
"examples": [
|
|
"https://my-totp-service.com/totp"
|
|
]
|
|
},
|
|
"totp_identifier": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Totp Identifier",
|
|
"description": "\nIdentifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://www.skyvern.com/docs/credentials/totp#option-3-push-code-to-skyvern for more details.\n",
|
|
"examples": [
|
|
"john.doe@example.com",
|
|
"4155555555",
|
|
"user_123"
|
|
]
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id",
|
|
"description": "ID of a Skyvern browser session to reuse, having it continue from the current screen state"
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id",
|
|
"description": "ID of a browser profile to reuse for this workflow run"
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls",
|
|
"description": "The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot."
|
|
},
|
|
"max_elapsed_time_minutes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer",
|
|
"maximum": 480.0,
|
|
"minimum": 1.0
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Elapsed Time Minutes",
|
|
"description": "Timeout this workflow run after the configured elapsed runtime in minutes. When omitted, the platform default is 240 minutes. The maximum configurable value is 480 minutes."
|
|
},
|
|
"extra_http_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Extra Http Headers",
|
|
"description": "The extra HTTP headers for the requests in browser."
|
|
},
|
|
"cdp_connect_headers": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"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. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites."
|
|
},
|
|
"browser_address": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Address",
|
|
"description": "The CDP address for the workflow run.",
|
|
"examples": [
|
|
"http://127.0.0.1:9222",
|
|
"ws://127.0.0.1:9222/devtools/browser/1234567890"
|
|
]
|
|
},
|
|
"ai_fallback": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Ai Fallback",
|
|
"description": "Whether to fallback to AI if the workflow run fails."
|
|
},
|
|
"run_with": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run With",
|
|
"description": "Whether to run the workflow with agent or code. Null inherits from the workflow setting.",
|
|
"examples": [
|
|
"agent",
|
|
"code"
|
|
]
|
|
},
|
|
"run_metadata": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Run Metadata",
|
|
"description": "String key/value metadata to attach to this workflow run for analytics tag filtering."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_id"
|
|
],
|
|
"title": "WorkflowRunRequest"
|
|
},
|
|
"WorkflowRunResponse": {
|
|
"properties": {
|
|
"run_id": {
|
|
"type": "string",
|
|
"title": "Run Id",
|
|
"description": "Unique identifier for this run. Run ID starts with `tsk_` for task runs and `wr_` for workflow runs.",
|
|
"examples": [
|
|
"tsk_123",
|
|
"tsk_v2_123",
|
|
"wr_123"
|
|
]
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/RunStatus",
|
|
"description": "Current status of the run",
|
|
"examples": [
|
|
"created",
|
|
"queued",
|
|
"running",
|
|
"timed_out",
|
|
"failed",
|
|
"terminated",
|
|
"completed",
|
|
"canceled"
|
|
]
|
|
},
|
|
"output": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Output",
|
|
"description": "Output data from the run, if any. Format/schema depends on the data extracted by the run."
|
|
},
|
|
"downloaded_files": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/FileInfo"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Downloaded Files",
|
|
"description": "List of files downloaded during the run"
|
|
},
|
|
"recording_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Recording Url",
|
|
"description": "URL to the recording of the run"
|
|
},
|
|
"recording_archived": {
|
|
"type": "boolean",
|
|
"title": "Recording Archived",
|
|
"description": "True when the recording exists but has been archived to cold storage and is not currently accessible.",
|
|
"default": false
|
|
},
|
|
"screenshot_urls": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Screenshot Urls",
|
|
"description": "List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot."
|
|
},
|
|
"failure_reason": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Failure Reason",
|
|
"description": "Reason for failure if the run failed or terminated"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At",
|
|
"description": "Timestamp when this run was created",
|
|
"examples": [
|
|
"2025-01-01T00:00:00Z"
|
|
]
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At",
|
|
"description": "Timestamp when this run was last modified",
|
|
"examples": [
|
|
"2025-01-01T00:05:00Z"
|
|
]
|
|
},
|
|
"queued_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Queued At",
|
|
"description": "Timestamp when this run was queued"
|
|
},
|
|
"started_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Started At",
|
|
"description": "Timestamp when this run started execution"
|
|
},
|
|
"finished_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Finished At",
|
|
"description": "Timestamp when this run finished"
|
|
},
|
|
"app_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "App Url",
|
|
"description": "URL to the application UI where the run can be viewed",
|
|
"examples": [
|
|
"https://app.skyvern.com/tasks/tsk_123",
|
|
"https://app.skyvern.com/workflows/wpid_123/wr_123"
|
|
]
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id",
|
|
"description": "ID of the Skyvern persistent browser session used for this run",
|
|
"examples": [
|
|
"pbs_123"
|
|
]
|
|
},
|
|
"browser_profile_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Profile Id",
|
|
"description": "ID of the browser profile used for this run",
|
|
"examples": [
|
|
"bp_123"
|
|
]
|
|
},
|
|
"max_screenshot_scrolls": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Max Screenshot Scrolls",
|
|
"description": "The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot"
|
|
},
|
|
"script_run": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ScriptRunResponse"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "The script run result"
|
|
},
|
|
"errors": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Errors",
|
|
"description": "The errors for the run"
|
|
},
|
|
"step_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Step Count",
|
|
"description": "Total number of steps executed in this run"
|
|
},
|
|
"run_type": {
|
|
"type": "string",
|
|
"const": "workflow_run",
|
|
"title": "Run Type",
|
|
"description": "Type of run - always workflow_run for workflow runs"
|
|
},
|
|
"run_with": {
|
|
"type": "string",
|
|
"title": "Run With",
|
|
"description": "Whether the workflow run was executed with agent or code",
|
|
"default": "agent",
|
|
"examples": [
|
|
"agent",
|
|
"code"
|
|
]
|
|
},
|
|
"ai_fallback": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Ai Fallback",
|
|
"description": "Whether to fallback to AI if code run fails."
|
|
},
|
|
"script_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Script Id",
|
|
"description": "ID of the cached script used for this workflow run, if any."
|
|
},
|
|
"run_request": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowRunRequest-Output"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "The original request parameters used to start this workflow run"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"run_id",
|
|
"status",
|
|
"created_at",
|
|
"modified_at",
|
|
"run_type"
|
|
],
|
|
"title": "WorkflowRunResponse"
|
|
},
|
|
"WorkflowRunStatus": {
|
|
"type": "string",
|
|
"enum": [
|
|
"created",
|
|
"queued",
|
|
"running",
|
|
"failed",
|
|
"terminated",
|
|
"canceled",
|
|
"timed_out",
|
|
"completed",
|
|
"paused"
|
|
],
|
|
"title": "WorkflowRunStatus"
|
|
},
|
|
"WorkflowRunTimeline": {
|
|
"properties": {
|
|
"type": {
|
|
"$ref": "#/components/schemas/WorkflowRunTimelineType"
|
|
},
|
|
"block": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WorkflowRunBlock"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"thought": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Thought"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"children": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowRunTimeline"
|
|
},
|
|
"type": "array",
|
|
"title": "Children",
|
|
"default": []
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "WorkflowRunTimeline"
|
|
},
|
|
"WorkflowRunTimelineType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"thought",
|
|
"block"
|
|
],
|
|
"title": "WorkflowRunTimelineType"
|
|
},
|
|
"WorkflowRunTriggerType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"manual",
|
|
"api",
|
|
"scheduled",
|
|
"webhook"
|
|
],
|
|
"title": "WorkflowRunTriggerType",
|
|
"description": "How a workflow run was initiated.\n\n- manual: User clicked \"Run\" in the UI\n- api: Direct API call to the run endpoint\n- scheduled: Triggered by a cron schedule\n- webhook: Triggered by an external system via the webhook endpoint"
|
|
},
|
|
"WorkflowSchedule": {
|
|
"properties": {
|
|
"workflow_schedule_id": {
|
|
"type": "string",
|
|
"title": "Workflow Schedule Id"
|
|
},
|
|
"organization_id": {
|
|
"type": "string",
|
|
"title": "Organization Id"
|
|
},
|
|
"workflow_permanent_id": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"cron_expression": {
|
|
"type": "string",
|
|
"title": "Cron Expression"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"title": "Timezone"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"title": "Enabled"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameters"
|
|
},
|
|
"temporal_schedule_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Temporal Schedule Id"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Name"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Created At"
|
|
},
|
|
"modified_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Modified At"
|
|
},
|
|
"deleted_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Deleted At"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_schedule_id",
|
|
"organization_id",
|
|
"workflow_permanent_id",
|
|
"cron_expression",
|
|
"timezone",
|
|
"enabled",
|
|
"created_at",
|
|
"modified_at"
|
|
],
|
|
"title": "WorkflowSchedule"
|
|
},
|
|
"WorkflowScheduleListResponse": {
|
|
"properties": {
|
|
"schedules": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/WorkflowSchedule"
|
|
},
|
|
"type": "array",
|
|
"title": "Schedules"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"schedules"
|
|
],
|
|
"title": "WorkflowScheduleListResponse"
|
|
},
|
|
"WorkflowScheduleResponse": {
|
|
"properties": {
|
|
"schedule": {
|
|
"$ref": "#/components/schemas/WorkflowSchedule"
|
|
},
|
|
"next_runs": {
|
|
"items": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"type": "array",
|
|
"title": "Next Runs"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"schedule"
|
|
],
|
|
"title": "WorkflowScheduleResponse"
|
|
},
|
|
"WorkflowScheduleUpsertRequest": {
|
|
"properties": {
|
|
"cron_expression": {
|
|
"type": "string",
|
|
"title": "Cron Expression"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"title": "Timezone"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"title": "Enabled",
|
|
"default": true
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameters"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Name"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Description"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"cron_expression",
|
|
"timezone"
|
|
],
|
|
"title": "WorkflowScheduleUpsertRequest"
|
|
},
|
|
"WorkflowStatus": {
|
|
"type": "string",
|
|
"enum": [
|
|
"published",
|
|
"draft",
|
|
"auto_generated",
|
|
"importing",
|
|
"import_failed"
|
|
],
|
|
"title": "WorkflowStatus"
|
|
},
|
|
"WorkflowTagsBatchRequest": {
|
|
"properties": {
|
|
"workflow_permanent_ids": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Workflow Permanent Ids",
|
|
"description": "Workflow permanent IDs to fetch tags for."
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "WorkflowTagsBatchRequest",
|
|
"description": "Body for ``POST /v1/workflow-tags`` (used when the wpid list would\nexceed the URL length cap)."
|
|
},
|
|
"WorkflowTagsBatchResponse": {
|
|
"properties": {
|
|
"workflow_tags": {
|
|
"additionalProperties": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TagItem"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"type": "object",
|
|
"title": "Workflow Tags"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"workflow_tags"
|
|
],
|
|
"title": "WorkflowTagsBatchResponse",
|
|
"description": "Response for the batch endpoint.\n\nWorkflows with no tags are present with an empty list so the frontend can\ndistinguish \"fetched, none set\" from \"not fetched\" without a second call.\nWorkflows outside the caller's org are silently absent (no leakage)."
|
|
},
|
|
"WorkflowTriggerBlock": {
|
|
"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": "workflow_trigger",
|
|
"title": "Block Type",
|
|
"default": "workflow_trigger"
|
|
},
|
|
"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
|
|
},
|
|
"workflow_permanent_id": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"payload": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Payload"
|
|
},
|
|
"wait_for_completion": {
|
|
"type": "boolean",
|
|
"title": "Wait For Completion",
|
|
"default": true
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id"
|
|
},
|
|
"use_parent_browser_session": {
|
|
"type": "boolean",
|
|
"title": "Use Parent Browser Session",
|
|
"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",
|
|
"workflow_permanent_id"
|
|
],
|
|
"title": "WorkflowTriggerBlock"
|
|
},
|
|
"WorkflowTriggerBlockYAML": {
|
|
"properties": {
|
|
"block_type": {
|
|
"type": "string",
|
|
"const": "workflow_trigger",
|
|
"title": "Block Type",
|
|
"default": "workflow_trigger"
|
|
},
|
|
"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
|
|
},
|
|
"workflow_permanent_id": {
|
|
"type": "string",
|
|
"title": "Workflow Permanent Id"
|
|
},
|
|
"payload": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Payload"
|
|
},
|
|
"wait_for_completion": {
|
|
"type": "boolean",
|
|
"title": "Wait For Completion",
|
|
"default": true
|
|
},
|
|
"browser_session_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Browser Session Id"
|
|
},
|
|
"use_parent_browser_session": {
|
|
"type": "boolean",
|
|
"title": "Use Parent Browser Session",
|
|
"default": false
|
|
},
|
|
"parameter_keys": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"title": "Parameter Keys"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"label",
|
|
"workflow_permanent_id"
|
|
],
|
|
"title": "WorkflowTriggerBlockYAML"
|
|
},
|
|
"skyvern__forge__sdk__schemas__credentials__CredentialType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"password",
|
|
"credit_card",
|
|
"secret"
|
|
],
|
|
"title": "CredentialType",
|
|
"description": "Type of credential stored in the system."
|
|
},
|
|
"skyvern__schemas__credential_type__CredentialType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"skyvern",
|
|
"bitwarden",
|
|
"1password",
|
|
"azure_vault"
|
|
],
|
|
"title": "CredentialType"
|
|
}
|
|
}
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://api.skyvern.com",
|
|
"x-fern-server-name": "Cloud"
|
|
},
|
|
{
|
|
"url": "https://api-staging.skyvern.com",
|
|
"x-fern-server-name": "Staging"
|
|
},
|
|
{
|
|
"url": "http://localhost:8000",
|
|
"x-fern-server-name": "Local"
|
|
}
|
|
]
|
|
}
|