Skip to content

Automate browser based workflows with AI

Update API specifications with fern api update (#7389)

Shuchang Zheng41d7feea8443
diff --git a/fern/openapi/skyvern_openapi.json b/fern/openapi/skyvern_openapi.json
index de8880c90..d8d540495 100644
--- a/fern/openapi/skyvern_openapi.json
+++ b/fern/openapi/skyvern_openapi.json
@@ -135,10 +135,8 @@
"type": "null"
}
],
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
"title": "X-Api-Key"
- },
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
+ }
},
{
"name": "x-max-steps-override",
@@ -1372,15 +1370,29 @@
"x-fern-sdk-method-name": "delete_folder"
}
},
- "/v1/tag-keys": {
- "get": {
+ "/v1/runs/{workflow_run_id}/tags": {
+ "post": {
"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",
+ "summary": "Apply run tags",
+ "description": "Atomically apply tag changes to a workflow run. Sets and deletes happen in one transaction; same-key collisions resolve set-wins.",
+ "operationId": "apply_run_tags_v1_runs__workflow_run_id__tags_post",
"parameters": [
+ {
+ "name": "workflow_run_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Workflow run ID",
+ "examples": [
+ "wr_123"
+ ],
+ "title": "Workflow Run Id"
+ },
+ "description": "Workflow run ID"
+ },
{
"name": "x-api-key",
"in": "header",
@@ -1400,54 +1412,57 @@
"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 retrieved tag keys",
+ "description": "Successfully applied tag changes",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TagKey"
- },
- "title": "Response List Tag Keys V1 Tag Keys Get"
+ "$ref": "#/components/schemas/RunTagsResponse"
}
}
}
},
+ "404": {
+ "description": "Workflow run not found"
+ },
"422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
+ "description": "Invalid tag key or value"
}
},
- "x-fern-sdk-method-name": "list_tag_keys"
- }
- },
- "/v1/tag-keys/{key}": {
- "patch": {
+ "x-fern-sdk-method-name": "apply_run_tags"
+ },
+ "get": {
"tags": [
"Tags"
],
- "summary": "Update tag key",
- "description": "Update the description for a tag key.",
- "operationId": "update_tag_key_v1_tag_keys__key__patch",
+ "summary": "Get run tags",
+ "description": "Get the current tag state for a workflow run.",
+ "operationId": "get_run_tags_v1_runs__workflow_run_id__tags_get",
"parameters": [
{
- "name": "key",
+ "name": "workflow_run_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Tag key to update",
- "title": "Key"
+ "description": "Workflow run ID",
+ "examples": [
+ "wr_123"
+ ],
+ "title": "Workflow Run Id"
},
- "description": "Tag key to update"
+ "description": "Workflow run ID"
},
{
"name": "x-api-key",
@@ -1468,44 +1483,57 @@
"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",
+ "description": "Successfully retrieved tags",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagKey"
+ "$ref": "#/components/schemas/RunTagsResponse"
}
}
}
},
"404": {
- "description": "Tag key not found"
+ "description": "Workflow run not found"
},
"422": {
- "description": "Description too long"
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
}
},
- "x-fern-sdk-method-name": "update_tag_key"
- },
+ "x-fern-sdk-method-name": "get_run_tags"
+ }
+ },
+ "/v1/runs/{workflow_run_id}/tags/{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",
+ "summary": "Delete run tag",
+ "description": "Soft-delete a single grouped tag from a workflow run. Writes a DELETE event row.",
+ "operationId": "delete_run_tag_v1_runs__workflow_run_id__tags__key__delete",
"parameters": [
+ {
+ "name": "workflow_run_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Workflow run ID",
+ "examples": [
+ "wr_123"
+ ],
+ "title": "Workflow Run Id"
+ },
+ "description": "Workflow run ID"
+ },
{
"name": "key",
"in": "path",
@@ -1519,21 +1547,39 @@
"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",
+ "description": "Successfully deleted tag (or no-op if absent)",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagKeyDeleteResponse"
+ "$ref": "#/components/schemas/RunTagsResponse"
}
}
}
},
"404": {
- "description": "Tag key not found"
+ "description": "Workflow run not found"
},
"422": {
"description": "Validation Error",
@@ -1546,38 +1592,82 @@
}
}
},
- "x-fern-sdk-method-name": "delete_tag_key"
+ "x-fern-sdk-method-name": "delete_run_tag"
}
},
- "/v1/workflow-tags": {
+ "/v1/runs/{workflow_run_id}/tags/history": {
"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",
+ "summary": "Get run tag history",
+ "description": "Chronological tag-event log for a workflow run (newest first). Includes SET and DELETE events.",
+ "operationId": "get_run_tag_history_v1_runs__workflow_run_id__tags_history_get",
"parameters": [
{
- "name": "workflow_permanent_ids",
+ "name": "workflow_run_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Workflow run ID",
+ "examples": [
+ "wr_123"
+ ],
+ "title": "Workflow Run Id"
+ },
+ "description": "Workflow run 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"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "description": "Comma-separated workflow permanent IDs",
- "examples": [
- "wpid_123,wpid_456"
+ "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"
+ }
],
- "title": "Workflow Permanent Ids"
+ "description": "Filter to events for a single tag key",
+ "title": "Key"
},
- "description": "Comma-separated workflow permanent IDs"
+ "description": "Filter to events for a single tag key"
},
{
"name": "x-api-key",
@@ -1600,17 +1690,17 @@
],
"responses": {
"200": {
- "description": "Successfully retrieved tags",
+ "description": "Successfully retrieved tag history",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowTagsBatchResponse"
+ "$ref": "#/components/schemas/RunTagHistoryResponse"
}
}
}
},
- "400": {
- "description": "Too many workflow IDs requested"
+ "404": {
+ "description": "Workflow run not found"
},
"422": {
"description": "Validation Error",
@@ -1623,16 +1713,17 @@
}
}
},
- "x-hidden": true,
- "x-fern-sdk-method-name": "batch_get_workflow_tags"
- },
- "post": {
+ "x-fern-sdk-method-name": "get_run_tag_history"
+ }
+ },
+ "/v1/tag-keys": {
+ "get": {
"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",
+ "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",
@@ -1653,30 +1744,21 @@
"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",
+ "description": "Successfully retrieved tag keys",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowTagsBatchResponse"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TagKey"
+ },
+ "title": "Response List Tag Keys V1 Tag Keys Get"
}
}
}
},
- "400": {
- "description": "Too many workflow IDs requested"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -1688,49 +1770,132 @@
}
}
},
- "x-hidden": true,
- "x-fern-sdk-method-name": "batch_get_workflow_tags_post"
+ "x-fern-sdk-method-name": "list_tag_keys"
}
},
- "/v1/artifacts/{artifact_id}/content": {
- "get": {
+ "/v1/tag-keys/{key}": {
+ "patch": {
"tags": [
- "Artifacts"
+ "Tags"
],
- "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",
+ "summary": "Update tag key",
+ "description": "Update the description for a tag key.",
+ "operationId": "update_tag_key_v1_tag_keys__key__patch",
"parameters": [
{
- "name": "artifact_id",
+ "name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Artifact Id"
- }
+ "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": "Raw artifact content",
+ "description": "Successfully updated tag key",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/TagKey"
+ }
}
}
},
- "206": {
- "description": "Partial artifact content (Range request)"
+ "404": {
+ "description": "Tag key not found"
},
- "403": {
- "description": "Invalid or expired artifact URL"
+ "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"
},
- "404": {
- "description": "Artifact not found or content unavailable"
+ {
+ "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"
+ }
+ }
+ }
},
- "416": {
- "description": "Range not satisfiable"
+ "404": {
+ "description": "Tag key not found"
},
"422": {
"description": "Validation Error",
@@ -1742,47 +1907,36 @@
}
}
}
- }
+ },
+ "x-fern-sdk-method-name": "delete_tag_key"
}
},
- "/v1/runs/{run_id}/artifacts": {
+ "/v1/tag-values": {
"get": {
"tags": [
- "Artifacts"
+ "Tags"
],
- "summary": "Get artifacts for a run",
- "description": "Get artifacts for a run",
- "operationId": "get_run_artifacts_v1_runs__run_id__artifacts_get",
+ "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": "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",
+ "name": "key",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ArtifactType"
- }
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Artifact Type"
- }
+ "description": "Filter to values for a single tag key",
+ "title": "Key"
+ },
+ "description": "Filter to values for a single tag key"
},
{
"name": "x-api-key",
@@ -1805,15 +1959,15 @@
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully retrieved tag values",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Artifact"
+ "$ref": "#/components/schemas/TagValue"
},
- "title": "Response Get Run Artifacts V1 Runs Run Id Artifacts Get"
+ "title": "Response List Tag Values V1 Tag Values Get"
}
}
}
@@ -1829,32 +1983,31 @@
}
}
},
- "x-fern-sdk-method-name": "get_run_artifacts"
+ "x-fern-sdk-method-name": "list_tag_values"
}
},
- "/v1/runs/{run_id}/retry_webhook": {
- "post": {
+ "/v1/tag-values/{key}": {
+ "patch": {
"tags": [
- "Runs"
+ "Tags"
],
- "summary": "Replay a run webhook",
- "description": "Retry sending the webhook for a run",
- "operationId": "retry_run_webhook_v1_runs__run_id__retry_webhook_post",
+ "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": "run_id",
+ "name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The id of the task run or the workflow run.",
+ "description": "Tag key (group)",
"examples": [
- "tsk_123",
- "wr_123"
+ "env"
],
- "title": "Run Id"
+ "title": "Key"
},
- "description": "The id of the task run or the workflow run."
+ "description": "Tag key (group)"
},
{
"name": "x-api-key",
@@ -1876,84 +2029,56 @@
}
],
"requestBody": {
+ "required": true,
"content": {
"application/json": {
"schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/RetryRunWebhookRequest"
- },
- {
- "type": "null"
- }
- ],
- "title": "Request"
+ "$ref": "#/components/schemas/TagValueUpdate"
}
}
}
},
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully recolored tag value",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RunWebhookReplayResponse"
+ "$ref": "#/components/schemas/TagValue"
}
}
}
},
+ "404": {
+ "description": "Tag value not found"
+ },
"422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
+ "description": "Invalid palette color"
}
},
- "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": {
+ "x-fern-sdk-method-name": "update_tag_value"
+ },
+ "delete": {
"tags": [
- "Runs"
+ "Tags"
],
- "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",
+ "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": "run_id",
+ "name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The id of the workflow run or task_v2 run.",
+ "description": "Tag key (group)",
"examples": [
- "wr_123",
- "tsk_v2_123"
+ "env"
],
- "title": "Run Id"
+ "title": "Key"
},
- "description": "The id of the workflow run or task_v2 run."
+ "description": "Tag key (group)"
},
{
"name": "x-api-key",
@@ -1974,26 +2099,29 @@
"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 retrieved run timeline",
+ "description": "Successfully deleted tag value",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/WorkflowRunTimeline"
- },
- "title": "Response Get Run Timeline V1 Runs Run Id Timeline Get"
+ "$ref": "#/components/schemas/TagValueDeleteResponse"
}
}
}
},
"404": {
- "description": "Run not found"
- },
- "400": {
- "description": "Timeline not available for this run type"
+ "description": "Tag value not found"
},
"422": {
"description": "Validation Error",
@@ -2006,123 +2134,114 @@
}
}
},
- "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"
- }
- ]
- }
- ]
+ "x-fern-sdk-method-name": "delete_tag_value"
}
},
- "/v1/version": {
- "get": {
+ "/v1/tag-values/{key}/rename": {
+ "patch": {
"tags": [
- "Server"
+ "Tags"
],
- "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",
+ "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": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "default": 1,
- "title": "Page"
- }
- },
- {
- "name": "page_size",
- "in": "query",
- "required": false,
+ "name": "key",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "default": 10,
- "title": "Page Size"
- }
+ "type": "string",
+ "description": "Tag key (group)",
+ "examples": [
+ "env"
+ ],
+ "title": "Key"
+ },
+ "description": "Tag key (group)"
},
{
- "name": "status",
- "in": "query",
+ "name": "x-api-key",
+ "in": "header",
"required": false,
"schema": {
"anyOf": [
{
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RunStatus"
- }
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Status"
+ "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": "search_key",
+ "name": "workflow_permanent_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "minLength": 3
+ "type": "string"
},
{
"type": "null"
}
],
- "description": "Case-insensitive substring search (min 3 chars for trigram index).",
+ "description": "Comma-separated workflow permanent IDs",
"examples": [
- "login_url",
- "wr_abc123"
+ "wpid_123,wpid_456"
],
- "title": "Search Key"
+ "title": "Workflow Permanent Ids"
},
- "description": "Case-insensitive substring search (min 3 chars for trigram index)."
+ "description": "Comma-separated workflow permanent IDs"
},
{
"name": "x-api-key",
@@ -2145,19 +2264,18 @@
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully retrieved tags",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TaskRunListItem"
- },
- "title": "Response Get Runs V2 V1 Runs Get"
+ "$ref": "#/components/schemas/WorkflowTagsBatchResponse"
}
}
}
},
+ "400": {
+ "description": "Too many workflow IDs requested"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -2170,16 +2288,15 @@
}
},
"x-hidden": true,
- "x-fern-sdk-method-name": "get_runs_v2"
- }
- },
- "/v1/upload_file": {
+ "x-fern-sdk-method-name": "batch_get_workflow_tags"
+ },
"post": {
"tags": [
- "Files"
+ "Tags"
],
- "summary": "Upload File",
- "operationId": "upload_file_v1_upload_file_post",
+ "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",
@@ -2203,24 +2320,27 @@
"requestBody": {
"required": true,
"content": {
- "multipart/form-data": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_upload_file_v1_upload_file_post"
+ "$ref": "#/components/schemas/WorkflowTagsBatchRequest"
}
}
}
},
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully retrieved tags",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UploadFileResponse"
+ "$ref": "#/components/schemas/WorkflowTagsBatchResponse"
}
}
}
},
+ "400": {
+ "description": "Too many workflow IDs requested"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -2232,17 +2352,94 @@
}
}
},
- "x-fern-sdk-method-name": "upload_file"
+ "x-hidden": true,
+ "x-fern-sdk-method-name": "batch_get_workflow_tags_post"
}
},
- "/v1/browser_profiles": {
+ "/v1/run-tags": {
+ "get": {
+ "tags": [
+ "Tags"
+ ],
+ "summary": "Batch get run tags",
+ "description": "Batch fetch current tags for many workflow runs. Avoids N+1 on run-list pages.",
+ "operationId": "batch_get_run_tags_v1_run_tags_get",
+ "parameters": [
+ {
+ "name": "workflow_run_ids",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Comma-separated workflow run IDs",
+ "examples": [
+ "wr_123,wr_456"
+ ],
+ "title": "Workflow Run Ids"
+ },
+ "description": "Comma-separated workflow run 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/RunTagsBatchResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Too many workflow run IDs requested"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "x-hidden": true,
+ "x-fern-sdk-method-name": "batch_get_run_tags"
+ },
"post": {
"tags": [
- "Browser Profiles"
+ "Tags"
],
- "summary": "Create a browser profile",
- "description": "Create a blank browser profile, or create one from a persistent browser session or workflow run.",
- "operationId": "create_browser_profile_v1_browser_profiles_post",
+ "summary": "Batch get run tags (POST)",
+ "description": "Batch fetch current tags for many workflow runs (POST variant for id lists exceeding URL length).",
+ "operationId": "batch_get_run_tags_post_v1_run_tags_post",
"parameters": [
{
"name": "x-api-key",
@@ -2268,27 +2465,24 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateBrowserProfileRequest"
+ "$ref": "#/components/schemas/RunTagsBatchRequest"
}
}
}
},
"responses": {
"200": {
- "description": "Successfully created browser profile",
+ "description": "Successfully retrieved tags",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BrowserProfile"
+ "$ref": "#/components/schemas/RunTagsBatchResponse"
}
}
}
},
"400": {
- "description": "Invalid request - source not found or source archive unavailable"
- },
- "409": {
- "description": "Browser profile name already exists"
+ "description": "Too many workflow run IDs requested"
},
"422": {
"description": "Validation Error",
@@ -2301,85 +2495,101 @@
}
}
},
- "x-fern-sdk-method-name": "create_browser_profile",
- "x-fern-examples": [
+ "x-hidden": true,
+ "x-fern-sdk-method-name": "batch_get_run_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": [
{
- "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"
+ "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": [
- "Browser Profiles"
+ "Artifacts"
],
- "summary": "List browser profiles",
- "description": "Get all browser profiles for the organization",
- "operationId": "list_browser_profiles_v1_browser_profiles_get",
+ "summary": "Get artifacts for a run",
+ "description": "Get artifacts for a run",
+ "operationId": "get_run_artifacts_v1_runs__run_id__artifacts_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,
+ "name": "run_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "boolean",
- "description": "Include deleted browser profiles",
- "default": false,
- "title": "Include Deleted"
+ "type": "string",
+ "description": "The id of the task run or the workflow run.",
+ "title": "Run Id"
},
- "description": "Include deleted browser profiles"
+ "description": "The id of the task run or the workflow run."
},
{
- "name": "search_key",
+ "name": "artifact_type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ArtifactType"
+ }
},
{
"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."
+ "title": "Artifact Type"
+ }
},
{
"name": "x-api-key",
@@ -2402,15 +2612,15 @@
],
"responses": {
"200": {
- "description": "Successfully retrieved browser profiles",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BrowserProfile"
+ "$ref": "#/components/schemas/Artifact"
},
- "title": "Response List Browser Profiles V1 Browser Profiles Get"
+ "title": "Response Get Run Artifacts V1 Runs Run Id Artifacts Get"
}
}
}
@@ -2426,45 +2636,32 @@
}
}
},
- "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"
- }
- ]
- }
- ]
+ "x-fern-sdk-method-name": "get_run_artifacts"
}
},
- "/v1/browser_profiles/{profile_id}": {
- "get": {
+ "/v1/runs/{run_id}/retry_webhook": {
+ "post": {
"tags": [
- "Browser Profiles"
+ "Runs"
],
- "summary": "Get browser profile",
- "description": "Get a specific browser profile by ID",
- "operationId": "get_browser_profile_v1_browser_profiles__profile_id__get",
+ "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": "profile_id",
+ "name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The ID of the browser profile. browser_profile_id starts with `bp_`",
+ "description": "The id of the task run or the workflow run.",
"examples": [
- "bp_123456"
+ "tsk_123",
+ "wr_123"
],
- "title": "Profile Id"
+ "title": "Run Id"
},
- "description": "The ID of the browser profile. browser_profile_id starts with `bp_`"
+ "description": "The id of the task run or the workflow run."
},
{
"name": "x-api-key",
@@ -2485,20 +2682,34 @@
"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": "Successfully retrieved browser profile",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BrowserProfile"
+ "$ref": "#/components/schemas/RunWebhookReplayResponse"
}
}
}
},
- "404": {
- "description": "Browser profile not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -2510,43 +2721,46 @@
}
}
},
- "x-fern-sdk-method-name": "get_browser_profile",
+ "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\")\nbrowser_profile = await skyvern.browser_profiles.get_browser_profile(\"bp_123\")\nprint(browser_profile)\n"
+ "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\" });\nconst browserProfile = await skyvern.browserProfiles.getBrowserProfile(\"bp_123\");\nconsole.log(browserProfile);\n"
+ "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.retryRunWebhook(\"tsk_v2_123\");\n"
}
]
}
]
- },
- "patch": {
+ }
+ },
+ "/v1/runs/{run_id}/timeline": {
+ "get": {
"tags": [
- "Browser Profiles"
+ "Runs"
],
- "summary": "Update browser profile",
- "description": "Update a browser profile's name and/or description",
- "operationId": "update_browser_profile_v1_browser_profiles__profile_id__patch",
+ "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": "profile_id",
+ "name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The ID of the browser profile to update. browser_profile_id starts with `bp_`",
+ "description": "The id of the workflow run or task_v2 run.",
"examples": [
- "bp_123456"
+ "wr_123",
+ "tsk_v2_123"
],
- "title": "Profile Id"
+ "title": "Run Id"
},
- "description": "The ID of the browser profile to update. browser_profile_id starts with `bp_`"
+ "description": "The id of the workflow run or task_v2 run."
},
{
"name": "x-api-key",
@@ -2567,32 +2781,26 @@
"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",
+ "description": "Successfully retrieved run timeline",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BrowserProfile"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WorkflowRunTimeline"
+ },
+ "title": "Response Get Run Timeline V1 Runs Run Id Timeline Get"
}
}
}
},
- "404": {
- "description": "Browser profile not found"
+ "400": {
+ "description": "Timeline not available for this run type"
},
- "409": {
- "description": "Browser profile name already exists"
+ "404": {
+ "description": "Run not found"
},
"422": {
"description": "Validation Error",
@@ -2605,43 +2813,142 @@
}
}
},
- "x-fern-sdk-method-name": "update_browser_profile",
+ "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\")\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"
+ "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\" });\nconst browserProfile = await skyvern.browserProfiles.updateBrowserProfile(\"bp_123\", {\n name: \"Renamed Profile\",\n description: \"Updated description\",\n});\nconsole.log(browserProfile);\n"
+ "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"
}
]
}
]
- },
- "delete": {
+ }
+ },
+ "/v1/version": {
+ "get": {
"tags": [
- "Browser Profiles"
+ "Server"
],
- "summary": "Delete browser profile",
- "description": "Delete a browser profile (soft delete)",
- "operationId": "delete_browser_profile_v1_browser_profiles__profile_id__delete",
+ "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": "profile_id",
- "in": "path",
- "required": true,
+ "name": "page",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "description": "The ID of the browser profile to delete. browser_profile_id starts with `bp_`",
+ "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": [
- "bp_123456"
+ "login_url",
+ "wr_abc123"
],
- "title": "Profile Id"
+ "title": "Search Key"
},
- "description": "The ID of the browser profile to delete. browser_profile_id starts with `bp_`"
+ "description": "Case-insensitive substring search (min 3 chars for trigram index)."
+ },
+ {
+ "name": "run_type",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RunType"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Run Type"
+ }
},
{
"name": "x-api-key",
@@ -2663,11 +2970,19 @@
}
],
"responses": {
- "204": {
- "description": "Successfully deleted browser profile"
- },
- "404": {
- "description": "Browser profile not found"
+ "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",
@@ -2680,31 +2995,17 @@
}
}
},
- "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"
- }
- ]
- }
- ]
+ "x-hidden": true,
+ "x-fern-sdk-method-name": "get_runs_v2"
}
},
- "/v1/browser_sessions": {
+ "/v1/upload_file": {
"post": {
"tags": [
- "Browser Sessions"
+ "Files"
],
- "summary": "Create a session",
- "description": "Create a browser session that persists across multiple runs",
- "operationId": "create_browser_session_v1_browser_sessions_post",
+ "summary": "Upload File",
+ "operationId": "upload_file_v1_upload_file_post",
"parameters": [
{
"name": "x-api-key",
@@ -2726,35 +3027,26 @@
}
],
"requestBody": {
+ "required": true,
"content": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
- "$ref": "#/components/schemas/CreateBrowserSessionRequest",
- "default": {
- "timeout": 60,
- "generate_browser_profile": false
- }
+ "$ref": "#/components/schemas/Body_upload_file_v1_upload_file_post"
}
}
}
},
"responses": {
"200": {
- "description": "Successfully created browser session",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BrowserSessionResponse"
+ "$ref": "#/components/schemas/UploadFileResponse"
}
}
}
},
- "403": {
- "description": "Unauthorized - Invalid or missing authentication"
- },
- "404": {
- "description": "Browser profile not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -2766,29 +3058,17 @@
}
}
},
- "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": {
+ "x-fern-sdk-method-name": "upload_file"
+ }
+ },
+ "/v1/browser_profiles": {
+ "post": {
"tags": [
- "Browser Sessions"
+ "Browser Profiles"
],
- "summary": "Get active browser sessions",
- "description": "Get all active browser sessions for the organization",
- "operationId": "get_browser_sessions_v1_browser_sessions_get",
+ "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",
@@ -2809,23 +3089,32 @@
"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 retrieved all active browser sessions",
+ "description": "Successfully created browser profile",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BrowserSessionResponse"
- },
- "title": "Response Get Browser Sessions V1 Browser Sessions Get"
+ "$ref": "#/components/schemas/BrowserProfile"
}
}
}
},
- "403": {
- "description": "Unauthorized - Invalid or missing authentication"
+ "400": {
+ "description": "Invalid request - source not found or source archive unavailable"
+ },
+ "409": {
+ "description": "Browser profile name already exists"
},
"422": {
"description": "Validation Error",
@@ -2838,45 +3127,103 @@
}
}
},
- "x-fern-sdk-method-name": "get_browser_sessions",
+ "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\")\nbrowser_sessions = await skyvern.get_browser_sessions()\nprint(browser_sessions)\n"
+ "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\n# Create a blank browser profile for future runs\nblank_profile = await skyvern.browser_profiles.create_browser_profile(\n name=\"Fresh Profile\",\n)\nprint(blank_profile)\n\n# Create a browser profile from a persistent browser session\nbrowser_profile = await skyvern.browser_profiles.create_browser_profile(\n name=\"My Profile\",\n browser_session_id=\"pbs_123\",\n)\nprint(browser_profile)\n\n# Or create from 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\" });\nconst browserSessions = await skyvern.getBrowserSessions();\nconsole.log(browserSessions);\n"
+ "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\n// Create a blank browser profile for future runs\nconst blankProfile = await skyvern.browserProfiles.createBrowserProfile({\n name: \"Fresh Profile\",\n});\nconsole.log(blankProfile);\n\n// Create a browser profile from a persistent browser session\nconst browserProfile = await skyvern.browserProfiles.createBrowserProfile({\n name: \"My Profile\",\n browser_session_id: \"pbs_123\",\n});\nconsole.log(browserProfile);\n\n// Or create from 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"
}
]
}
]
- }
- },
- "/v1/browser_sessions/{browser_session_id}/close": {
- "post": {
+ },
+ "get": {
"tags": [
- "Browser Sessions"
+ "Browser Profiles"
],
- "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",
+ "summary": "List browser profiles",
+ "description": "Get all browser profiles for the organization",
+ "operationId": "list_browser_profiles_v1_browser_profiles_get",
"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_`",
+ "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": [
- "pbs_123456"
+ "my_profile",
+ "production"
],
- "title": "Browser Session Id"
+ "title": "Search Key"
},
- "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_`"
+ "description": "Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches."
+ },
+ {
+ "name": "managed",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Omit to return all profiles; false returns only user-created profiles; true returns only auto-managed profiles.",
+ "title": "Managed"
+ },
+ "description": "Omit to return all profiles; false returns only user-created profiles; true returns only auto-managed profiles."
},
{
"name": "x-api-key",
@@ -2899,16 +3246,19 @@
],
"responses": {
"200": {
- "description": "Successfully closed browser session",
+ "description": "Successfully retrieved browser profiles",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/BrowserProfile"
+ },
+ "title": "Response List Browser Profiles V1 Browser Profiles Get"
+ }
}
}
},
- "403": {
- "description": "Unauthorized - Invalid or missing authentication"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -2920,45 +3270,45 @@
}
}
},
- "x-fern-sdk-method-name": "close_browser_session",
+ "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\")\nawait skyvern.close_browser_session(browser_session_id=\"pbs_123\")\n"
+ "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\" });\nawait skyvern.closeBrowserSession(\"pbs_123\");\n"
+ "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_sessions/{browser_session_id}": {
- "patch": {
+ "/v1/browser_profiles/{profile_id}": {
+ "get": {
"tags": [
- "Browser Sessions"
+ "Browser Profiles"
],
- "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",
+ "summary": "Get browser profile",
+ "description": "Get a specific browser profile by ID",
+ "operationId": "get_browser_profile_v1_browser_profiles__profile_id__get",
"parameters": [
{
- "name": "browser_session_id",
+ "name": "profile_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The ID of the browser session. browser_session_id starts with `pbs_`",
+ "description": "The ID of the browser profile. browser_profile_id starts with `bp_`",
"examples": [
- "pbs_123456"
+ "bp_123456"
],
- "title": "Browser Session Id"
+ "title": "Profile Id"
},
- "description": "The ID of the browser session. browser_session_id starts with `pbs_`"
+ "description": "The ID of the browser profile. browser_profile_id starts with `bp_`"
},
{
"name": "x-api-key",
@@ -2979,35 +3329,19 @@
"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",
+ "description": "Successfully retrieved browser profile",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BrowserSessionResponse"
+ "$ref": "#/components/schemas/BrowserProfile"
}
}
}
},
"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"
+ "description": "Browser profile not found"
},
"422": {
"description": "Validation Error",
@@ -3020,29 +3354,43 @@
}
}
},
- "x-fern-sdk-method-name": "update_browser_session"
+ "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"
+ }
+ ]
+ }
+ ]
},
- "get": {
+ "patch": {
"tags": [
- "Browser Sessions"
+ "Browser Profiles"
],
- "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",
+ "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": "browser_session_id",
+ "name": "profile_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The ID of the browser session. browser_session_id starts with `pbs_`",
+ "description": "The ID of the browser profile to update. browser_profile_id starts with `bp_`",
"examples": [
- "pbs_123456"
+ "bp_123456"
],
- "title": "Browser Session Id"
+ "title": "Profile Id"
},
- "description": "The ID of the browser session. browser_session_id starts with `pbs_`"
+ "description": "The ID of the browser profile to update. browser_profile_id starts with `bp_`"
},
{
"name": "x-api-key",
@@ -3063,22 +3411,32 @@
"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 retrieved browser session details",
+ "description": "Successfully updated browser profile",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BrowserSessionResponse"
+ "$ref": "#/components/schemas/BrowserProfile"
}
}
}
},
"404": {
- "description": "Browser session not found"
+ "description": "Browser profile not found"
},
- "403": {
- "description": "Unauthorized - Invalid or missing authentication"
+ "409": {
+ "description": "Browser profile name already exists"
},
"422": {
"description": "Validation Error",
@@ -3091,32 +3449,44 @@
}
}
},
- "x-fern-sdk-method-name": "get_browser_session",
+ "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_session = await skyvern.get_browser_session(browser_session_id=\"pbs_123\")\nprint(browser_session)\n"
+ "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 browserSession = await skyvern.getBrowserSession(\"pbs_123\");\nconsole.log(browserSession);\n"
+ "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"
}
]
}
]
- }
- },
- "/v1/credentials/totp": {
- "post": {
+ },
+ "delete": {
"tags": [
- "Credentials"
+ "Browser Profiles"
],
- "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",
+ "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",
@@ -3136,26 +3506,12 @@
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TOTPCodeCreate"
- }
- }
- }
- },
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TOTPCode"
- }
- }
- }
+ "204": {
+ "description": "Successfully deleted browser profile"
+ },
+ "404": {
+ "description": "Browser profile not found"
},
"422": {
"description": "Validation Error",
@@ -3168,31 +3524,31 @@
}
}
},
- "x-fern-sdk-method-name": "send_totp_code",
+ "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.send_totp_code(\n totp_identifier=\"[email protected]\",\n content=\"Hello, your verification code is 123456\"\n)\n"
+ "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.sendTotpCode({\n totp_identifier: \"[email protected]\",\n content: \"Hello, your verification code is 123456\"\n});\n"
+ "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.browserProfiles.deleteBrowserProfile(\"bp_123\");\n"
}
]
}
]
}
},
- "/v1/credentials": {
+ "/v1/browser_sessions": {
"post": {
"tags": [
- "Credentials"
+ "Browser Sessions"
],
- "summary": "Create credential",
- "description": "Creates a new credential for the current organization",
- "operationId": "create_credential_v1_credentials_post",
+ "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",
@@ -3214,41 +3570,35 @@
}
],
"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": "[email protected]",
- "password": "securepassword123",
- "totp": "JBSWY3DPEHPK3PXP"
- }
- }
- ],
- "openapi_extra": {
- "x-fern-sdk-parameter-name": "data"
+ "$ref": "#/components/schemas/CreateBrowserSessionRequest",
+ "default": {
+ "timeout": 60,
+ "generate_browser_profile": false
}
}
}
}
},
"responses": {
- "201": {
- "description": "Successful Response",
+ "200": {
+ "description": "Successfully created browser session",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CredentialResponse"
+ "$ref": "#/components/schemas/BrowserSessionResponse"
}
}
}
},
+ "403": {
+ "description": "Unauthorized - Invalid or missing authentication"
+ },
+ "404": {
+ "description": "Browser profile not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -3260,25 +3610,17 @@
}
}
},
- "x-fern-sdk-method-name": "create_credential",
+ "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\")\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 },\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"
+ "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\" });\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 }\n});\n"
+ "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"
}
]
}
@@ -3286,105 +3628,12 @@
},
"get": {
"tags": [
- "Credentials"
+ "Browser Sessions"
],
- "summary": "Get all credentials",
- "description": "Retrieves a paginated list of credentials for the current organization",
- "operationId": "get_credentials_v1_credentials_get",
+ "summary": "Get active browser sessions",
+ "description": "Get all active browser sessions for the organization",
+ "operationId": "get_browser_sessions_v1_browser_sessions_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. 'skyvern', 'custom', 'bitwarden', 'azure_vault')",
- "title": "Vault Type"
- },
- "description": "Filter credentials by vault type (e.g. 'skyvern', '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",
@@ -3406,19 +3655,22 @@
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully retrieved all active browser sessions",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CredentialResponse"
+ "$ref": "#/components/schemas/BrowserSessionResponse"
},
- "title": "Response Get Credentials V1 Credentials Get"
+ "title": "Response Get Browser Sessions V1 Browser Sessions Get"
}
}
}
},
+ "403": {
+ "description": "Unauthorized - Invalid or missing authentication"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -3430,48 +3682,45 @@
}
}
},
- "x-fern-sdk-method-name": "get_credentials",
+ "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\")\ncredentials = await skyvern.get_credentials()\nprint(credentials)\n"
+ "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 credentials = await skyvern.getCredentials();\nconsole.log(credentials);\n"
+ "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/credentials/{credential_id}/update": {
+ "/v1/browser_sessions/{browser_session_id}/close": {
"post": {
"tags": [
- "Credentials"
+ "Browser Sessions"
],
- "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",
+ "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": "credential_id",
+ "name": "browser_session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The unique identifier of the credential to update",
+ "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": [
- "cred_1234567890"
+ "pbs_123456"
],
- "openapi_extra": {
- "x-fern-sdk-parameter-name": "credential_id"
- },
- "title": "Credential Id"
+ "title": "Browser Session Id"
},
- "description": "The unique identifier of the credential to update"
+ "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",
@@ -3492,41 +3741,21 @@
"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": "[email protected]",
- "password": "newpassword123"
- }
- }
- ],
- "openapi_extra": {
- "x-fern-sdk-parameter-name": "data"
- }
- }
- }
- }
- },
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully closed browser session",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/CredentialResponse"
- }
+ "schema": {}
}
}
},
+ "403": {
+ "description": "Unauthorized - Invalid or missing authentication"
+ },
+ "404": {
+ "description": "Browser session not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -3538,48 +3767,45 @@
}
}
},
- "x-fern-sdk-method-name": "update_credential",
+ "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\")\nupdated = await skyvern.update_credential(\n credential_id=\"cred_123\",\n name=\"My Credential\",\n credential_type=\"password\",\n credential={\"username\": \"[email protected]\", \"password\": \"newpassword123\"},\n)\nprint(updated)\n"
+ "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\" });\nconst updated = await skyvern.updateCredential(\"cred_123\", {\n name: \"My Credential\",\n credential_type: \"password\",\n credential: { username: \"[email protected]\", password: \"newpassword123\" }\n});\nconsole.log(updated);\n"
+ "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.closeBrowserSession(\"pbs_123\");\n"
}
]
}
]
}
},
- "/v1/credentials/{credential_id}/delete": {
- "post": {
+ "/v1/browser_sessions/{browser_session_id}": {
+ "patch": {
"tags": [
- "Credentials"
+ "Browser Sessions"
],
- "summary": "Delete credential",
- "description": "Deletes a specific credential by its ID",
- "operationId": "delete_credential_v1_credentials__credential_id__delete_post",
+ "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": "credential_id",
+ "name": "browser_session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The unique identifier of the credential to delete",
+ "description": "The ID of the browser session. browser_session_id starts with `pbs_`",
"examples": [
- "cred_1234567890"
+ "pbs_123456"
],
- "openapi_extra": {
- "x-fern-sdk-parameter-name": "credential_id"
- },
- "title": "Credential Id"
+ "title": "Browser Session Id"
},
- "description": "The unique identifier of the credential to delete"
+ "description": "The ID of the browser session. browser_session_id starts with `pbs_`"
},
{
"name": "x-api-key",
@@ -3600,9 +3826,35 @@
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
}
],
- "responses": {
- "204": {
- "description": "Successful Response"
+ "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"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Unauthorized - Invalid or missing authentication"
+ },
+ "404": {
+ "description": "Browser session not found"
+ },
+ "409": {
+ "description": "Conflict - browser session has already ended and can no longer be updated"
},
"422": {
"description": "Validation Error",
@@ -3615,48 +3867,29 @@
}
}
},
- "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}": {
+ "x-fern-sdk-method-name": "update_browser_session"
+ },
"get": {
"tags": [
- "Credentials"
+ "Browser Sessions"
],
- "summary": "Get credential by ID",
- "description": "Retrieves a specific credential by its ID",
- "operationId": "get_credential_v1_credentials__credential_id__get",
+ "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": "credential_id",
+ "name": "browser_session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The unique identifier of the credential",
+ "description": "The ID of the browser session. browser_session_id starts with `pbs_`",
"examples": [
- "cred_1234567890"
+ "pbs_123456"
],
- "openapi_extra": {
- "x-fern-sdk-parameter-name": "credential_id"
- },
- "title": "Credential Id"
+ "title": "Browser Session Id"
},
- "description": "The unique identifier of the credential"
+ "description": "The ID of the browser session. browser_session_id starts with `pbs_`"
},
{
"name": "x-api-key",
@@ -3679,15 +3912,21 @@
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully retrieved browser session details",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CredentialResponse"
+ "$ref": "#/components/schemas/BrowserSessionResponse"
}
}
}
},
+ "403": {
+ "description": "Unauthorized - Invalid or missing authentication"
+ },
+ "404": {
+ "description": "Browser session not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -3699,31 +3938,31 @@
}
}
},
- "x-fern-sdk-method-name": "get_credential",
+ "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\")\ncredential = await skyvern.get_credential(credential_id=\"cred_123\")\nprint(credential)\n"
+ "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 credential = await skyvern.getCredential(\"cred_123\");\nconsole.log(credential);\n"
+ "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/run/tasks/login": {
+ "/v1/credentials/totp": {
"post": {
"tags": [
- "Agents"
+ "Credentials"
],
- "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",
+ "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",
@@ -3742,22 +3981,6 @@
"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": {
@@ -3765,7 +3988,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LoginRequest"
+ "$ref": "#/components/schemas/TOTPCodeCreate"
}
}
}
@@ -3776,7 +3999,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowRunResponse"
+ "$ref": "#/components/schemas/TOTPCode"
}
}
}
@@ -3792,49 +4015,31 @@
}
}
},
- "x-hidden": true,
- "x-excluded": true,
- "x-fern-sdk-method-name": "login",
+ "x-fern-sdk-method-name": "send_totp_code",
"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"
+ "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.send_totp_code(\n totp_identifier=\"[email protected]\",\n content=\"Hello, your verification code is 123456\"\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"
+ "code": "import { SkyvernClient } from \"@skyvern/client\";\n\nconst skyvern = new SkyvernClient({ apiKey: \"YOUR_API_KEY\" });\nawait skyvern.sendTotpCode({\n totp_identifier: \"[email protected]\",\n content: \"Hello, your verification code is 123456\"\n});\n"
}
]
}
]
}
},
- "/v1/run/tasks/download_files": {
+ "/v1/credentials": {
"post": {
"tags": [
- "Agents"
+ "Credentials"
],
- "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",
+ "summary": "Create credential",
+ "description": "Creates a new credential for the current organization",
+ "operationId": "create_credential_v1_credentials_post",
"parameters": [
{
"name": "x-api-key",
@@ -3853,22 +4058,6 @@
"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": {
@@ -3876,18 +4065,33 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadFilesRequest"
+ "$ref": "#/components/schemas/CreateCredentialRequest",
+ "description": "The credential data to create",
+ "examples": [
+ {
+ "name": "My Credential",
+ "credential_type": "PASSWORD",
+ "credential": {
+ "username": "[email protected]",
+ "password": "securepassword123",
+ "totp": "JBSWY3DPEHPK3PXP"
+ }
+ }
+ ],
+ "openapi_extra": {
+ "x-fern-sdk-parameter-name": "data"
+ }
}
}
}
},
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowRunResponse"
+ "$ref": "#/components/schemas/CredentialResponse"
}
}
}
@@ -3903,108 +4107,54 @@
}
}
},
- "x-hidden": true,
- "x-excluded": true,
- "x-fern-sdk-method-name": "download_files",
+ "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.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"
+ "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\": \"[email protected]\",\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.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"
+ "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: \"[email protected]\",\n metadata: { checkout_profile: \"default\" }\n }\n});\n"
}
]
}
]
- }
- },
- "/v1/scripts": {
- "post": {
+ },
+ "get": {
"tags": [
- "Scripts"
+ "Credentials"
],
- "summary": "Create script",
- "description": "Create a new script with optional files and metadata",
- "operationId": "create_script_v1_scripts_post",
+ "summary": "Get all credentials",
+ "description": "Retrieves a paginated list of credentials for the current organization",
+ "operationId": "get_credentials_v1_credentials_get",
"parameters": [
{
- "name": "x-api-key",
- "in": "header",
+ "name": "page",
+ "in": "query",
"required": false,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
+ "type": "integer",
+ "minimum": 1,
+ "description": "Page number for pagination",
+ "examples": [
+ 1
],
- "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"
+ "openapi_extra": {
+ "x-fern-sdk-parameter-name": "page"
+ },
+ "default": 1,
+ "title": "Page"
},
"description": "Page number for pagination"
},
@@ -4019,81 +4169,68 @@
"examples": [
10
],
+ "openapi_extra": {
+ "x-fern-sdk-parameter-name": "page_size"
+ },
"default": 10,
"title": "Page Size"
},
"description": "Number of items per page"
},
{
- "name": "x-api-key",
- "in": "header",
+ "name": "vault_type",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/CredentialVaultType"
},
{
"type": "null"
}
],
- "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
- "title": "X-Api-Key"
+ "description": "Filter credentials by vault type (e.g. 'skyvern', 'custom', 'bitwarden', 'azure_vault')",
+ "title": "Vault Type"
},
- "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"
- }
- }
- }
+ "description": "Filter credentials by vault type (e.g. 'skyvern', 'custom', 'bitwarden', 'azure_vault')"
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ {
+ "name": "credential_type",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/skyvern__forge__sdk__schemas__credentials__CredentialType"
+ },
+ {
+ "type": "null"
}
- }
- }
- }
- },
- "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": [
+ ],
+ "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": "script_id",
- "in": "path",
- "required": true,
+ "name": "search",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "description": "The unique identifier of the script",
- "examples": [
- "s_abc123"
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 200
+ },
+ {
+ "type": "null"
+ }
],
- "title": "Script Id"
+ "description": "Case-insensitive search across credential name, username, secret label, and card details",
+ "title": "Search"
},
- "description": "The unique identifier of the script"
+ "description": "Case-insensitive search across credential name, username, secret label, and card details"
},
{
"name": "x-api-key",
@@ -4120,7 +4257,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Script"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CredentialResponse"
+ },
+ "title": "Response Get Credentials V1 Credentials Get"
}
}
}
@@ -4136,31 +4277,48 @@
}
}
},
- "x-fern-sdk-method-name": "get_script"
+ "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/scripts/{script_id}/deploy": {
+ "/v1/credentials/{credential_id}/update": {
"post": {
"tags": [
- "Scripts"
+ "Credentials"
],
- "summary": "Deploy script",
- "description": "Deploy a script with updated files, creating a new version",
- "operationId": "deploy_script_v1_scripts__script_id__deploy_post",
+ "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": "script_id",
+ "name": "credential_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The unique identifier of the script",
+ "description": "The unique identifier of the credential to update",
"examples": [
- "s_abc123"
+ "cred_1234567890"
],
- "title": "Script Id"
+ "openapi_extra": {
+ "x-fern-sdk-parameter-name": "credential_id"
+ },
+ "title": "Credential Id"
},
- "description": "The unique identifier of the script"
+ "description": "The unique identifier of the credential to update"
},
{
"name": "x-api-key",
@@ -4186,7 +4344,21 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DeployScriptRequest"
+ "$ref": "#/components/schemas/CreateCredentialRequest",
+ "description": "The new credential data to store",
+ "examples": [
+ {
+ "name": "My Credential",
+ "credential_type": "PASSWORD",
+ "credential": {
+ "username": "[email protected]",
+ "password": "newpassword123"
+ }
+ }
+ ],
+ "openapi_extra": {
+ "x-fern-sdk-parameter-name": "data"
+ }
}
}
}
@@ -4197,7 +4369,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateScriptResponse"
+ "$ref": "#/components/schemas/CredentialResponse"
}
}
}
@@ -4213,31 +4385,48 @@
}
}
},
- "x-fern-sdk-method-name": "deploy_script"
+ "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\": \"[email protected]\", \"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: \"[email protected]\", password: \"newpassword123\" }\n});\nconsole.log(updated);\n"
+ }
+ ]
+ }
+ ]
}
},
- "/v1/scripts/{script_id}/run": {
+ "/v1/credentials/{credential_id}/delete": {
"post": {
"tags": [
- "Scripts"
+ "Credentials"
],
- "summary": "Run script",
- "description": "Run a script",
- "operationId": "run_script_v1_scripts__script_id__run_post",
+ "summary": "Delete credential",
+ "description": "Deletes a specific credential by its ID",
+ "operationId": "delete_credential_v1_credentials__credential_id__delete_post",
"parameters": [
{
- "name": "script_id",
+ "name": "credential_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The unique identifier of the script",
+ "description": "The unique identifier of the credential to delete",
"examples": [
- "s_abc123"
+ "cred_1234567890"
],
- "title": "Script Id"
+ "openapi_extra": {
+ "x-fern-sdk-parameter-name": "credential_id"
+ },
+ "title": "Credential Id"
},
- "description": "The unique identifier of the script"
+ "description": "The unique identifier of the credential to delete"
},
{
"name": "x-api-key",
@@ -4259,13 +4448,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -4277,18 +4461,50 @@
}
}
}
- }
- }
- },
- "/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",
+ },
+ "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",
@@ -4308,23 +4524,13 @@
"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"
+ "$ref": "#/components/schemas/CredentialResponse"
}
}
}
@@ -4340,81 +4546,32 @@
}
}
},
- "x-excluded": true,
- "x-fern-sdk-method-name": "run_sdk_action"
+ "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/schedules": {
+ "/v1/custom-llms": {
"get": {
"tags": [
- "Schedules"
+ "Custom LLMs"
],
- "summary": "List all schedules for the organization",
- "operationId": "schedules_list_all",
+ "summary": "List Custom LLMs",
+ "description": "List the custom LLM configurations available to the current organization.",
+ "operationId": "list_custom_llms_v1_custom_llms_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",
- "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",
@@ -4440,7 +4597,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/OrganizationScheduleListResponse"
+ "$ref": "#/components/schemas/CustomLLMListResponse"
}
}
}
@@ -4455,32 +4612,17 @@
}
}
}
- }
- }
- },
- "/v1/agents/{workflow_permanent_id}/folder": {
- "put": {
+ },
+ "x-fern-sdk-method-name": "list_custom_llms"
+ },
+ "post": {
"tags": [
- "Folders"
+ "Custom LLMs"
],
- "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",
+ "summary": "Create Custom LLM",
+ "description": "Create a custom LLM configuration for the current organization.",
+ "operationId": "create_custom_llm_v1_custom_llms_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",
@@ -4505,28 +4647,22 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateWorkflowFolderRequest"
+ "$ref": "#/components/schemas/CustomLLMCreateRequest"
}
}
}
},
"responses": {
"200": {
- "description": "Successfully updated workflow folder",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Workflow"
+ "$ref": "#/components/schemas/CustomLLMResponse"
}
}
}
},
- "404": {
- "description": "Workflow not found"
- },
- "400": {
- "description": "Folder not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -4538,31 +4674,46 @@
}
}
},
- "x-fern-sdk-method-name": "update_workflow_folder"
+ "x-fern-sdk-method-name": "create_custom_llm"
}
},
- "/v1/agents/{workflow_permanent_id}/tags": {
- "post": {
+ "/v1/custom-llms/{custom_llm_id}": {
+ "put": {
"tags": [
- "Tags"
+ "Custom LLMs"
],
- "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",
+ "summary": "Update Custom LLM",
+ "description": "Update a custom LLM configuration for the current organization.",
+ "operationId": "update_custom_llm_v1_custom_llms__custom_llm_id__put",
"parameters": [
{
- "name": "workflow_permanent_id",
+ "name": "custom_llm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Workflow permanent ID",
- "examples": [
- "wpid_123"
+ "description": "The custom LLM id.",
+ "title": "Custom Llm Id"
+ },
+ "description": "The custom LLM id."
+ },
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
],
- "title": "Workflow Permanent Id"
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
+ "title": "X-Api-Key"
},
- "description": "Workflow permanent ID"
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
}
],
"requestBody": {
@@ -4570,52 +4721,53 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagApplyRequest"
+ "$ref": "#/components/schemas/CustomLLMUpdateRequest"
}
}
}
},
"responses": {
"200": {
- "description": "Successfully applied tag changes",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagsResponse"
+ "$ref": "#/components/schemas/CustomLLMResponse"
}
}
}
},
- "404": {
- "description": "Workflow not found"
- },
"422": {
- "description": "Invalid tag key or value"
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
}
},
- "x-fern-sdk-method-name": "apply_workflow_tags"
+ "x-fern-sdk-method-name": "update_custom_llm"
},
- "get": {
+ "delete": {
"tags": [
- "Tags"
+ "Custom LLMs"
],
- "summary": "Get agent tags",
- "description": "Get the current tag state for a workflow.",
- "operationId": "get_workflow_tags_v1_workflows__workflow_permanent_id__tags_get",
+ "summary": "Delete Custom LLM",
+ "description": "Delete a custom LLM configuration for the current organization.",
+ "operationId": "delete_custom_llm_v1_custom_llms__custom_llm_id__delete",
"parameters": [
{
- "name": "workflow_permanent_id",
+ "name": "custom_llm_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "Workflow permanent ID",
- "examples": [
- "wpid_123"
- ],
- "title": "Workflow Permanent Id"
+ "description": "The custom LLM id.",
+ "title": "Custom Llm Id"
},
- "description": "Workflow permanent ID"
+ "description": "The custom LLM id."
},
{
"name": "x-api-key",
@@ -4638,18 +4790,15 @@
],
"responses": {
"200": {
- "description": "Successfully retrieved tags",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagsResponse"
+ "$ref": "#/components/schemas/ClearOrganizationAuthTokenResponse"
}
}
}
},
- "404": {
- "description": "Workflow not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -4661,134 +4810,21 @@
}
}
},
- "x-fern-sdk-method-name": "get_workflow_tags"
+ "x-fern-sdk-method-name": "delete_custom_llm"
}
},
- "/v1/agents/{workflow_permanent_id}/tags/{key}": {
- "delete": {
+ "/v1/run/tasks/login": {
+ "post": {
"tags": [
- "Tags"
+ "Agents"
],
- "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"
- }
- ],
- "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",
+ "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": "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",
+ "name": "x-api-key",
+ "in": "header",
"required": false,
"schema": {
"anyOf": [
@@ -4799,13 +4835,13 @@
"type": "null"
}
],
- "description": "Filter to events for a single tag key",
- "title": "Key"
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
+ "title": "X-Api-Key"
},
- "description": "Filter to events for a single tag key"
+ "description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
},
{
- "name": "x-api-key",
+ "name": "x-user-agent",
"in": "header",
"required": false,
"schema": {
@@ -4817,26 +4853,31 @@
"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."
+ "title": "X-User-Agent"
+ }
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LoginRequest"
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Successfully retrieved tag history",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagHistoryResponse"
+ "$ref": "#/components/schemas/WorkflowRunResponse"
}
}
}
},
- "404": {
- "description": "Workflow not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -4848,32 +4889,50 @@
}
}
},
- "x-fern-sdk-method-name": "get_workflow_tag_history"
+ "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/agents/runs/{workflow_run_id}/retry": {
+ "/v1/run/tasks/download_files": {
"post": {
"tags": [
- "Runs"
+ "Agents"
],
- "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",
+ "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": "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",
@@ -4892,22 +4951,6 @@
},
"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",
@@ -4925,9 +4968,19 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DownloadFilesRequest"
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Successfully retried workflow run",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
@@ -4936,12 +4989,6 @@
}
}
},
- "400": {
- "description": "Workflow run is not retryable"
- },
- "404": {
- "description": "Workflow run not found"
- },
"422": {
"description": "Validation Error",
"content": {
@@ -4953,113 +5000,34 @@
}
}
},
- "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."
- },
+ "x-hidden": true,
+ "x-excluded": true,
+ "x-fern-sdk-method-name": "download_files",
+ "x-fern-examples": [
{
- "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."
- },
+ "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",
@@ -5079,17 +5047,23 @@
"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": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/WorkflowRun"
- },
- "title": "Response Get Workflow Runs V1 Workflows Runs Get"
+ "$ref": "#/components/schemas/CreateScriptResponse"
}
}
}
@@ -5105,27 +5079,16 @@
}
}
},
- "x-fern-sdk-method-name": "get_workflow_runs"
- }
- },
- "/v1/agents/{workflow_id}/runs": {
+ "x-fern-sdk-method-name": "create_script"
+ },
"get": {
"tags": [
- "Runs"
+ "Scripts"
],
- "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",
+ "summary": "Get all scripts",
+ "description": "Retrieves a paginated list of scripts for the current organization",
+ "operationId": "get_scripts_v1_scripts_get",
"parameters": [
- {
- "name": "workflow_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Workflow Id"
- }
- },
{
"name": "page",
"in": "query",
@@ -5133,11 +5096,14 @@
"schema": {
"type": "integer",
"minimum": 1,
- "description": "Page number for pagination.",
+ "description": "Page number for pagination",
+ "examples": [
+ 1
+ ],
"default": 1,
"title": "Page"
},
- "description": "Page number for pagination."
+ "description": "Page number for pagination"
},
{
"name": "page_size",
@@ -5146,80 +5112,14 @@
"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.",
+ "description": "Number of items per page",
"examples": [
- "INVALID_CREDENTIALS",
- "LOGIN_FAILED",
- "CAPTCHA_DETECTED"
+ 10
],
- "title": "Error Code"
+ "default": 10,
+ "title": "Page Size"
},
- "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."
+ "description": "Number of items per page"
},
{
"name": "x-api-key",
@@ -5248,9 +5148,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/WorkflowRun"
+ "$ref": "#/components/schemas/Script"
},
- "title": "Response Get Workflow Runs By Id V1 Workflows Workflow Id Runs Get"
+ "title": "Response Get Scripts V1 Scripts Get"
}
}
}
@@ -5266,51 +5166,31 @@
}
}
},
- "x-fern-sdk-method-name": "get_workflow_runs_by_id"
+ "x-fern-sdk-method-name": "get_scripts"
}
},
- "/v1/agents/{workflow_permanent_id}": {
+ "/v1/scripts/{script_id}": {
"get": {
"tags": [
- "Agents"
+ "Scripts"
],
- "summary": "Get an agent by id",
- "operationId": "get_workflow_v1_workflows__workflow_permanent_id__get",
+ "summary": "Get script by ID",
+ "description": "Retrieves a specific script by its ID",
+ "operationId": "get_script_v1_scripts__script_id__get",
"parameters": [
{
- "name": "workflow_permanent_id",
+ "name": "script_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Workflow Permanent Id"
- }
- },
- {
- "name": "version",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
+ "description": "The unique identifier of the script",
+ "examples": [
+ "s_abc123"
],
- "title": "Version"
- }
- },
- {
- "name": "template",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Template"
- }
+ "title": "Script Id"
+ },
+ "description": "The unique identifier of the script"
},
{
"name": "x-api-key",
@@ -5337,7 +5217,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Workflow"
+ "$ref": "#/components/schemas/Script"
}
}
}
@@ -5353,36 +5233,31 @@
}
}
},
- "x-fern-sdk-method-name": "get_workflow"
+ "x-fern-sdk-method-name": "get_script"
}
},
- "/v1/agents/{workflow_permanent_id}/versions": {
- "get": {
+ "/v1/scripts/{script_id}/deploy": {
+ "post": {
"tags": [
- "Agents"
+ "Scripts"
],
- "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",
+ "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": "workflow_permanent_id",
+ "name": "script_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"
- }
+ "description": "The unique identifier of the script",
+ "examples": [
+ "s_abc123"
+ ],
+ "title": "Script Id"
+ },
+ "description": "The unique identifier of the script"
},
{
"name": "x-api-key",
@@ -5403,17 +5278,23 @@
"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": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Workflow"
- },
- "title": "Response Get Workflow Versions V1 Workflows Workflow Permanent Id Versions Get"
+ "$ref": "#/components/schemas/CreateScriptResponse"
}
}
}
@@ -5429,31 +5310,31 @@
}
}
},
- "x-fern-sdk-method-name": "get_workflow_versions"
+ "x-fern-sdk-method-name": "deploy_script"
}
},
- "/v1/agents/{workflow_permanent_id}/browser_session/reset_profile": {
+ "/v1/scripts/{script_id}/run": {
"post": {
"tags": [
- "Agents"
+ "Scripts"
],
- "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",
+ "summary": "Run script",
+ "description": "Run a script",
+ "operationId": "run_script_v1_scripts__script_id__run_post",
"parameters": [
{
- "name": "workflow_permanent_id",
+ "name": "script_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "description": "The permanent ID of the workflow. Starts with `wpid_`.",
+ "description": "The unique identifier of the script",
"examples": [
- "wpid_123"
+ "s_abc123"
],
- "title": "Workflow Permanent Id"
+ "title": "Script Id"
},
- "description": "The permanent ID of the workflow. Starts with `wpid_`."
+ "description": "The unique identifier of the script"
},
{
"name": "x-api-key",
@@ -5475,14 +5356,13 @@
}
],
"responses": {
- "204": {
- "description": "Successfully cleared persisted browser profile"
- },
- "404": {
- "description": "Workflow not found"
- },
- "500": {
- "description": "Storage deletion failed; retry"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -5494,27 +5374,18 @@
}
}
}
- },
- "x-hidden": true
+ }
}
},
- "/v1/agents/{workflow_permanent_id}/schedules": {
+ "/v1/sdk/run_action": {
"post": {
"tags": [
- "Schedules"
+ "SDK"
],
- "summary": "Create a schedule for an agent",
- "operationId": "schedules_create",
+ "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": "workflow_permanent_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Workflow Permanent Id"
- }
- },
{
"name": "x-api-key",
"in": "header",
@@ -5539,7 +5410,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowScheduleUpsertRequest"
+ "$ref": "#/components/schemas/RunSdkActionRequest"
}
}
}
@@ -5550,7 +5421,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowScheduleResponse"
+ "$ref": "#/components/schemas/RunSdkActionResponse"
}
}
}
@@ -5565,24 +5436,82 @@
}
}
}
- }
- },
+ },
+ "x-excluded": true,
+ "x-fern-sdk-method-name": "run_sdk_action"
+ }
+ },
+ "/v1/schedules": {
"get": {
"tags": [
"Schedules"
],
- "summary": "List schedules for an agent",
- "operationId": "schedules_list",
+ "summary": "List all schedules for the organization",
+ "operationId": "schedules_list_all",
"parameters": [
{
- "name": "workflow_permanent_id",
- "in": "path",
- "required": true,
+ "name": "page",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "title": "Workflow Permanent Id"
+ "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",
@@ -5608,7 +5537,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowScheduleListResponse"
+ "$ref": "#/components/schemas/OrganizationScheduleListResponse"
}
}
}
@@ -5626,13 +5555,14 @@
}
}
},
- "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}": {
- "get": {
+ "/v1/agents/{workflow_permanent_id}/folder": {
+ "put": {
"tags": [
- "Schedules"
+ "Folders"
],
- "summary": "Get an agent schedule by id",
- "operationId": "schedules_get",
+ "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",
@@ -5640,17 +5570,13 @@
"required": true,
"schema": {
"type": "string",
+ "description": "Workflow permanent ID",
+ "examples": [
+ "wpid_123"
+ ],
"title": "Workflow Permanent Id"
- }
- },
- {
- "name": "workflow_schedule_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Workflow Schedule Id"
- }
+ },
+ "description": "Workflow permanent ID"
},
{
"name": "x-api-key",
@@ -5671,17 +5597,33 @@
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
}
],
- "responses": {
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateWorkflowFolderRequest"
+ }
+ }
+ }
+ },
+ "responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully updated workflow folder",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowScheduleResponse"
+ "$ref": "#/components/schemas/Workflow"
}
}
}
},
+ "400": {
+ "description": "Folder not found"
+ },
+ "404": {
+ "description": "Workflow not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -5692,14 +5634,18 @@
}
}
}
- }
- },
- "put": {
+ },
+ "x-fern-sdk-method-name": "update_workflow_folder"
+ }
+ },
+ "/v1/agents/{workflow_permanent_id}/tags": {
+ "post": {
"tags": [
- "Schedules"
+ "Tags"
],
- "summary": "Update an agent schedule",
- "operationId": "schedules_update",
+ "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",
@@ -5707,17 +5653,13 @@
"required": true,
"schema": {
"type": "string",
+ "description": "Workflow permanent ID",
+ "examples": [
+ "wpid_123"
+ ],
"title": "Workflow Permanent Id"
- }
- },
- {
- "name": "workflow_schedule_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Workflow Schedule Id"
- }
+ },
+ "description": "Workflow permanent ID"
},
{
"name": "x-api-key",
@@ -5743,40 +5685,38 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowScheduleUpsertRequest"
+ "$ref": "#/components/schemas/TagApplyRequest"
}
}
}
},
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully applied tag changes",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowScheduleResponse"
+ "$ref": "#/components/schemas/TagsResponse"
}
}
}
},
+ "404": {
+ "description": "Workflow not found"
+ },
"422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
+ "description": "Invalid tag key or value"
}
- }
+ },
+ "x-fern-sdk-method-name": "apply_workflow_tags"
},
- "delete": {
+ "get": {
"tags": [
- "Schedules"
+ "Tags"
],
- "summary": "Delete an agent schedule",
- "operationId": "schedules_delete",
+ "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",
@@ -5784,17 +5724,13 @@
"required": true,
"schema": {
"type": "string",
+ "description": "Workflow permanent ID",
+ "examples": [
+ "wpid_123"
+ ],
"title": "Workflow Permanent Id"
- }
- },
- {
- "name": "workflow_schedule_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Workflow Schedule Id"
- }
+ },
+ "description": "Workflow permanent ID"
},
{
"name": "x-api-key",
@@ -5817,15 +5753,18 @@
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully retrieved tags",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DeleteScheduleResponse"
+ "$ref": "#/components/schemas/TagsResponse"
}
}
}
},
+ "404": {
+ "description": "Workflow not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -5836,16 +5775,18 @@
}
}
}
- }
+ },
+ "x-fern-sdk-method-name": "get_workflow_tags"
}
},
- "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/enable": {
- "post": {
+ "/v1/agents/{workflow_permanent_id}/tags/{key}": {
+ "delete": {
"tags": [
- "Schedules"
+ "Tags"
],
- "summary": "Enable an agent schedule",
- "operationId": "schedules_enable",
+ "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",
@@ -5853,17 +5794,27 @@
"required": true,
"schema": {
"type": "string",
+ "description": "Workflow permanent ID",
+ "examples": [
+ "wpid_123"
+ ],
"title": "Workflow Permanent Id"
- }
+ },
+ "description": "Workflow permanent ID"
},
{
- "name": "workflow_schedule_id",
+ "name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Workflow Schedule Id"
- }
+ "description": "Tag key to delete",
+ "examples": [
+ "env"
+ ],
+ "title": "Key"
+ },
+ "description": "Tag key to delete"
},
{
"name": "x-api-key",
@@ -5886,15 +5837,18 @@
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully deleted tag (or no-op if absent)",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowScheduleResponse"
+ "$ref": "#/components/schemas/TagsResponse"
}
}
}
},
+ "404": {
+ "description": "Workflow not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -5905,16 +5859,18 @@
}
}
}
- }
+ },
+ "x-fern-sdk-method-name": "delete_workflow_tag"
}
},
- "/v1/agents/{workflow_permanent_id}/schedules/{workflow_schedule_id}/disable": {
- "post": {
+ "/v1/agents/{workflow_permanent_id}/tags/history": {
+ "get": {
"tags": [
- "Schedules"
+ "Tags"
],
- "summary": "Disable an agent schedule",
- "operationId": "schedules_disable",
+ "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",
@@ -5922,17 +5878,64 @@
"required": true,
"schema": {
"type": "string",
+ "description": "Workflow permanent ID",
+ "examples": [
+ "wpid_123"
+ ],
"title": "Workflow Permanent Id"
- }
+ },
+ "description": "Workflow permanent ID"
},
{
- "name": "workflow_schedule_id",
- "in": "path",
- "required": true,
+ "name": "limit",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "title": "Workflow Schedule Id"
- }
+ "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",
@@ -5955,15 +5958,18 @@
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "Successfully retrieved tag history",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowScheduleResponse"
+ "$ref": "#/components/schemas/TagHistoryResponse"
}
}
}
},
+ "404": {
+ "description": "Workflow not found"
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -5974,280 +5980,1853 @@
}
}
}
- }
+ },
+ "x-fern-sdk-method-name": "get_workflow_tag_history"
}
- }
- },
- "components": {
- "schemas": {
- "AIFallbackMode": {
- "type": "string",
- "enum": [
- "fallback",
- "proactive"
+ },
+ "/v1/agents/runs/{workflow_run_id}/retry": {
+ "post": {
+ "tags": [
+ "Runs"
],
- "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": {
+ "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"
+ }
+ ],
+ "title": "X-Api-Key"
+ }
+ },
+ {
+ "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": "created_at_start",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Only include runs created at or after this UTC timestamp (ISO 8601).",
+ "title": "Created At Start"
+ },
+ "description": "Only include runs created at or after this UTC timestamp (ISO 8601)."
+ },
+ {
+ "name": "created_at_end",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Only include runs created strictly before this UTC timestamp (ISO 8601).",
+ "title": "Created At End"
+ },
+ "description": "Only include runs created strictly before this UTC timestamp (ISO 8601)."
+ },
+ {
+ "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"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Storage deletion failed; retry"
+ }
+ },
+ "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": {
+ "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": "string"
+ "type": "boolean"
},
{
"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"
+ "title": "Download"
},
- "deleted_at": {
+ "download_triggered": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "boolean"
},
{
"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"
+ "title": "Download Triggered"
},
- "description": {
+ "downloaded_files": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Description"
- },
- "aws_key": {
- "type": "string",
- "title": "Aws Key"
- }
- },
- "type": "object",
- "required": [
- "key",
- "aws_key"
- ],
- "title": "AWSSecretParameterYAML"
- },
- "ActAction": {
- "properties": {
- "type": {
- "type": "string",
- "const": "ai_act",
- "title": "Type",
- "default": "ai_act"
- },
- "intention": {
- "type": "string",
- "title": "Intention",
- "description": "Natural language prompt for the action",
- "default": ""
+ "title": "Downloaded Files"
},
- "data": {
+ "is_upload_file_tag": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
- "additionalProperties": true,
- "type": "object"
+ "type": "null"
+ }
+ ],
+ "title": "Is Upload File Tag"
+ },
+ "text": {
+ "anyOf": [
+ {
+ "type": "string"
},
{
"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"
+ "title": "Text"
},
- "status": {
- "$ref": "#/components/schemas/ActionStatus",
- "default": "pending"
+ "input_or_select_context": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/InputOrSelectContext"
+ },
+ {
+ "type": "null"
+ }
+ ]
},
- "action_id": {
+ "option": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/SelectOption"
},
{
"type": "null"
}
- ],
- "title": "Action Id"
+ ]
},
- "source_action_id": {
+ "is_checked": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Source Action Id"
+ "title": "Is Checked"
},
- "organization_id": {
+ "verified": {
+ "type": "boolean",
+ "title": "Verified",
+ "default": false
+ },
+ "click_context": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/ClickContext"
},
{
"type": "null"
}
- ],
- "title": "Organization Id"
+ ]
},
- "workflow_run_id": {
+ "totp_timing_info": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Workflow Run Id"
+ "title": "Totp Timing Info"
},
- "task_id": {
+ "has_mini_agent": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Task Id"
+ "title": "Has Mini Agent"
},
- "step_id": {
+ "skip_auto_complete_tab": {
+ "type": "boolean",
+ "title": "Skip Auto Complete Tab",
+ "default": false
+ },
+ "created_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Step Id"
+ "title": "Created At"
},
- "step_order": {
+ "modified_at": {
"anyOf": [
{
- "type": "integer"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Step Order"
+ "title": "Modified At"
},
- "action_order": {
+ "created_by": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Action Order"
+ "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."
},
- "confidence_float": {
+ "next_block_label": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Confidence Float"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "description": {
+ "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": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Description"
+ "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"
},
- "reasoning": {
+ "url": {
"anyOf": [
{
"type": "string"
@@ -6256,9 +7835,18 @@
"type": "null"
}
],
- "title": "Reasoning"
+ "title": "Url"
},
- "intention": {
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "default": ""
+ },
+ "engine": {
+ "$ref": "#/components/schemas/RunEngine",
+ "default": "skyvern-1.0"
+ },
+ "complete_criterion": {
"anyOf": [
{
"type": "string"
@@ -6267,9 +7855,9 @@
"type": "null"
}
],
- "title": "Intention"
+ "title": "Complete Criterion"
},
- "response": {
+ "terminate_criterion": {
"anyOf": [
{
"type": "string"
@@ -6278,9 +7866,9 @@
"type": "null"
}
],
- "title": "Response"
+ "title": "Terminate Criterion"
},
- "element_id": {
+ "navigation_goal": {
"anyOf": [
{
"type": "string"
@@ -6289,9 +7877,9 @@
"type": "null"
}
],
- "title": "Element Id"
+ "title": "Navigation Goal"
},
- "skyvern_element_hash": {
+ "data_extraction_goal": {
"anyOf": [
{
"type": "string"
@@ -6300,22 +7888,18 @@
"type": "null"
}
],
- "title": "Skyvern Element Hash"
+ "title": "Data Extraction Goal"
},
- "skyvern_element_data": {
+ "data_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
- "type": "null"
- }
- ],
- "title": "Skyvern Element Data"
- },
- "screenshot_artifact_id": {
- "anyOf": [
+ "items": {},
+ "type": "array"
+ },
{
"type": "string"
},
@@ -6323,50 +7907,102 @@
"type": "null"
}
],
- "title": "Screenshot Artifact Id"
+ "title": "Data Schema"
},
- "tool_call_id": {
+ "error_code_mapping": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Tool Call Id"
+ "title": "Error Code Mapping"
},
- "xpath": {
+ "max_retries": {
+ "type": "integer",
+ "title": "Max Retries",
+ "default": 0
+ },
+ "max_steps_per_run": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Xpath"
+ "title": "Max Steps Per Run"
},
- "errors": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/UserDefinedError"
+ "parameters": {
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowParameter"
},
- "type": "array"
- },
- {
- "type": "null"
+ {
+ "$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"
+ }
}
- ],
- "title": "Errors"
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
},
- "terminal_user_errors": {
+ "complete_on_download": {
"type": "boolean",
- "title": "Terminal User Errors",
+ "title": "Complete On Download",
"default": false
},
- "data_extraction_goal": {
+ "download_suffix": {
"anyOf": [
{
"type": "string"
@@ -6375,18 +8011,21 @@
"type": "null"
}
],
- "title": "Data Extraction Goal"
+ "title": "Download Suffix"
},
- "output": {
+ "totp_verification_url": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
- "items": {},
- "type": "array"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Totp Verification Url"
+ },
+ "totp_identifier": {
+ "anyOf": [
{
"type": "string"
},
@@ -6394,20 +8033,35 @@
"type": "null"
}
],
- "title": "Output"
+ "title": "Totp Identifier"
},
- "file_name": {
+ "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": "string"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "File Name"
+ "title": "Download Timeout"
},
- "file_url": {
+ "include_extracted_text": {
+ "type": "boolean",
+ "title": "Include Extracted Text",
+ "default": true
+ },
+ "selector": {
"anyOf": [
{
"type": "string"
@@ -6416,56 +8070,104 @@
"type": "null"
}
],
- "title": "File Url"
+ "title": "Selector"
},
- "download": {
+ "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": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Download"
+ "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]]."
},
- "download_triggered": {
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
{
- "type": "boolean"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Download Triggered"
+ "title": "Model"
},
- "downloaded_files": {
+ "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": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Downloaded Files"
+ "title": "Url"
},
- "is_upload_file_tag": {
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "default": ""
+ },
+ "engine": {
+ "$ref": "#/components/schemas/RunEngine",
+ "default": "skyvern-1.0"
+ },
+ "navigation_goal": {
"anyOf": [
{
- "type": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Is Upload File Tag"
+ "title": "Navigation Goal"
},
- "text": {
+ "selector": {
"anyOf": [
{
"type": "string"
@@ -6474,132 +8176,201 @@
"type": "null"
}
],
- "title": "Text"
+ "title": "Selector"
},
- "input_or_select_context": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/InputOrSelectContext"
- },
- {
- "type": "null"
- }
- ]
+ "ai_fallback": {
+ "$ref": "#/components/schemas/AIFallbackMode",
+ "default": "fallback"
},
- "option": {
+ "error_code_mapping": {
"anyOf": [
{
- "$ref": "#/components/schemas/SelectOption"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Error Code Mapping"
},
- "is_checked": {
+ "max_retries": {
+ "type": "integer",
+ "title": "Max Retries",
+ "default": 0
+ },
+ "parameter_keys": {
"anyOf": [
{
- "type": "boolean"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Is Checked"
+ "title": "Parameter Keys"
},
- "verified": {
+ "complete_on_download": {
"type": "boolean",
- "title": "Verified",
+ "title": "Complete On Download",
"default": false
},
- "click_context": {
+ "download_suffix": {
"anyOf": [
{
- "$ref": "#/components/schemas/ClickContext"
+ "type": "string"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Download Suffix"
},
- "totp_timing_info": {
+ "totp_verification_url": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Totp Timing Info"
+ "title": "Totp Verification Url"
},
- "has_mini_agent": {
+ "totp_identifier": {
"anyOf": [
{
- "type": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Has Mini Agent"
+ "title": "Totp Identifier"
},
- "skip_auto_complete_tab": {
+ "disable_cache": {
"type": "boolean",
- "title": "Skip Auto Complete Tab",
+ "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",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Created At"
+ "title": "Bundle Key"
},
- "modified_at": {
+ "checksum": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Modified At"
+ "title": "Checksum"
},
- "created_by": {
+ "file_size": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"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."
+ "title": "File Size"
},
- "next_block_label": {
+ "task_id": {
"anyOf": [
{
"type": "string"
@@ -6608,56 +8379,20 @@
"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
+ "title": "Task Id"
},
- "model": {
+ "step_id": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
- },
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
- },
- "task_type": {
- "type": "string",
- "title": "Task Type",
- "default": "general"
+ "title": "Step Id"
},
- "url": {
+ "workflow_run_id": {
"anyOf": [
{
"type": "string"
@@ -6666,18 +8401,9 @@
"type": "null"
}
],
- "title": "Url"
- },
- "title": {
- "type": "string",
- "title": "Title",
- "default": ""
- },
- "engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "title": "Workflow Run Id"
},
- "complete_criterion": {
+ "workflow_run_block_id": {
"anyOf": [
{
"type": "string"
@@ -6686,9 +8412,9 @@
"type": "null"
}
],
- "title": "Complete Criterion"
+ "title": "Workflow Run Block Id"
},
- "terminate_criterion": {
+ "run_id": {
"anyOf": [
{
"type": "string"
@@ -6697,9 +8423,9 @@
"type": "null"
}
],
- "title": "Terminate Criterion"
+ "title": "Run Id"
},
- "navigation_goal": {
+ "browser_session_id": {
"anyOf": [
{
"type": "string"
@@ -6708,9 +8434,9 @@
"type": "null"
}
],
- "title": "Navigation Goal"
+ "title": "Browser Session Id"
},
- "data_extraction_goal": {
+ "observer_cruise_id": {
"anyOf": [
{
"type": "string"
@@ -6719,18 +8445,10 @@
"type": "null"
}
],
- "title": "Data Extraction Goal"
+ "title": "Observer Cruise Id"
},
- "data_schema": {
+ "observer_thought_id": {
"anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "items": {},
- "type": "array"
- },
{
"type": "string"
},
@@ -6738,102 +8456,102 @@
"type": "null"
}
],
- "title": "Data Schema"
+ "title": "Observer Thought Id"
},
- "error_code_mapping": {
+ "ai_suggestion_id": {
"anyOf": [
{
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Error Code Mapping"
- },
- "max_retries": {
- "type": "integer",
- "title": "Max Retries",
- "default": 0
+ "title": "Ai Suggestion Id"
},
- "max_steps_per_run": {
+ "signed_url": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Max Steps Per Run"
- },
- "parameters": {
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/WorkflowParameter"
- },
- {
- "$ref": "#/components/schemas/ContextParameter"
- },
- {
- "$ref": "#/components/schemas/AWSSecretParameter"
- },
- {
- "$ref": "#/components/schemas/AzureSecretParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
- },
- {
- "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
- },
- {
- "$ref": "#/components/schemas/OnePasswordCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/AzureVaultCredentialParameter"
- },
- {
- "$ref": "#/components/schemas/OutputParameter"
- },
- {
- "$ref": "#/components/schemas/CredentialParameter"
- }
- ],
- "discriminator": {
- "propertyName": "parameter_type",
- "mapping": {
- "aws_secret": "#/components/schemas/AWSSecretParameter",
- "azure_secret": "#/components/schemas/AzureSecretParameter",
- "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
- "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
- "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
- "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
- "context": "#/components/schemas/ContextParameter",
- "credential": "#/components/schemas/CredentialParameter",
- "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
- "output": "#/components/schemas/OutputParameter",
- "workflow": "#/components/schemas/WorkflowParameter"
- }
- }
- },
- "type": "array",
- "title": "Parameters",
- "default": []
+ "title": "Signed Url"
},
- "complete_on_download": {
+ "archived": {
"type": "boolean",
- "title": "Complete On Download",
+ "title": "Archived",
"default": false
},
- "download_suffix": {
+ "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"
@@ -6842,20 +8560,67 @@
"type": "null"
}
],
- "title": "Download Suffix"
+ "title": "Description"
},
- "totp_verification_url": {
+ "azure_secret_parameter_id": {
+ "type": "string",
+ "title": "Azure Secret Parameter Id"
+ },
+ "workflow_id": {
+ "type": "string",
+ "title": "Workflow Id"
+ },
+ "azure_key": {
+ "type": "string",
+ "title": "Azure Key"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ },
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
+ },
+ "deleted_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Totp Verification Url"
+ "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"
},
- "totp_identifier": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -6864,71 +8629,88 @@
"type": "null"
}
],
- "title": "Totp Identifier"
+ "title": "Description"
},
- "complete_verification": {
- "type": "boolean",
- "title": "Complete Verification",
- "default": true
+ "azure_vault_credential_parameter_id": {
+ "type": "string",
+ "title": "Azure Vault Credential Parameter Id"
},
- "include_action_history_in_verification": {
- "type": "boolean",
- "title": "Include Action History In Verification",
- "default": false
+ "workflow_id": {
+ "type": "string",
+ "title": "Workflow Id"
},
- "download_timeout": {
+ "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": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Download Timeout"
+ "title": "Totp Secret Key"
},
- "include_extracted_text": {
- "type": "boolean",
- "title": "Include Extracted Text",
- "default": true
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
},
- "selector": {
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
+ },
+ "deleted_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Selector"
- },
- "ai_fallback": {
- "$ref": "#/components/schemas/AIFallbackMode",
- "default": "fallback"
+ "title": "Deleted At"
}
},
"type": "object",
"required": [
- "label",
- "output_parameter"
+ "key",
+ "azure_vault_credential_parameter_id",
+ "workflow_id",
+ "vault_name",
+ "username_key",
+ "password_key",
+ "created_at",
+ "modified_at"
],
- "title": "ActionBlock"
+ "title": "AzureVaultCredentialParameter"
},
- "ActionBlockYAML": {
+ "AzureVaultCredentialParameterYAML": {
"properties": {
- "block_type": {
+ "parameter_type": {
"type": "string",
- "const": "action",
- "title": "Block Type",
- "default": "action"
+ "const": "azure_vault_credential",
+ "title": "Parameter Type",
+ "default": "azure_vault_credential"
},
- "label": {
+ "key": {
"type": "string",
- "title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
+ "title": "Key"
},
- "next_block_label": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -6937,37 +8719,54 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
+ "title": "Description"
},
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "vault_name": {
+ "type": "string",
+ "title": "Vault Name"
},
- "model": {
+ "username_key": {
+ "type": "string",
+ "title": "Username Key"
+ },
+ "password_key": {
+ "type": "string",
+ "title": "Password Key"
+ },
+ "totp_secret_key": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "title": "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"
},
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
+ "key": {
+ "type": "string",
+ "title": "Key"
},
- "url": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -6976,29 +8775,87 @@
"type": "null"
}
],
- "title": "Url"
+ "title": "Description"
},
- "title": {
+ "bitwarden_credit_card_data_parameter_id": {
"type": "string",
- "title": "Title",
- "default": ""
+ "title": "Bitwarden Credit Card Data Parameter Id"
},
- "engine": {
- "$ref": "#/components/schemas/RunEngine",
- "default": "skyvern-1.0"
+ "workflow_id": {
+ "type": "string",
+ "title": "Workflow Id"
},
- "navigation_goal": {
+ "bitwarden_client_id_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Client Id Aws Secret Key"
+ },
+ "bitwarden_client_secret_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Client Secret Aws Secret Key"
+ },
+ "bitwarden_master_password_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Master Password Aws Secret Key"
+ },
+ "bitwarden_collection_id": {
+ "type": "string",
+ "title": "Bitwarden Collection Id"
+ },
+ "bitwarden_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"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Navigation Goal"
+ "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"
},
- "selector": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7007,51 +8864,84 @@
"type": "null"
}
],
- "title": "Selector"
+ "title": "Description"
},
- "ai_fallback": {
- "$ref": "#/components/schemas/AIFallbackMode",
- "default": "fallback"
+ "bitwarden_client_id_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Client Id Aws Secret Key"
},
- "error_code_mapping": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Error Code Mapping"
+ "bitwarden_client_secret_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Client Secret Aws Secret Key"
},
- "max_retries": {
- "type": "integer",
- "title": "Max Retries",
- "default": 0
+ "bitwarden_master_password_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Master Password Aws Secret Key"
},
- "parameter_keys": {
+ "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": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Parameter Keys"
+ "title": "Description"
},
- "complete_on_download": {
- "type": "boolean",
- "title": "Complete On Download",
- "default": false
+ "bitwarden_login_credential_parameter_id": {
+ "type": "string",
+ "title": "Bitwarden Login Credential Parameter Id"
},
- "download_suffix": {
+ "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"
@@ -7060,9 +8950,9 @@
"type": "null"
}
],
- "title": "Download Suffix"
+ "title": "Url Parameter Key"
},
- "totp_verification_url": {
+ "bitwarden_collection_id": {
"anyOf": [
{
"type": "string"
@@ -7071,9 +8961,9 @@
"type": "null"
}
],
- "title": "Totp Verification Url"
+ "title": "Bitwarden Collection Id"
},
- "totp_identifier": {
+ "bitwarden_item_id": {
"anyOf": [
{
"type": "string"
@@ -7082,104 +8972,57 @@
"type": "null"
}
],
- "title": "Totp Identifier"
+ "title": "Bitwarden Item Id"
},
- "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"
- ]
+ "format": "date-time",
+ "title": "Created At"
},
"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"
+ "format": "date-time",
+ "title": "Modified At"
},
- "bundle_key": {
+ "deleted_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Bundle Key"
+ "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"
},
- "checksum": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7188,20 +9031,32 @@
"type": "null"
}
],
- "title": "Checksum"
+ "title": "Description"
},
- "file_size": {
+ "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": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "File Size"
+ "title": "Url Parameter Key"
},
- "task_id": {
+ "bitwarden_collection_id": {
"anyOf": [
{
"type": "string"
@@ -7210,9 +9065,9 @@
"type": "null"
}
],
- "title": "Task Id"
+ "title": "Bitwarden Collection Id"
},
- "step_id": {
+ "bitwarden_item_id": {
"anyOf": [
{
"type": "string"
@@ -7221,9 +9076,31 @@
"type": "null"
}
],
- "title": "Step Id"
+ "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"
},
- "workflow_run_id": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7232,31 +9109,95 @@
"type": "null"
}
],
- "title": "Workflow Run Id"
+ "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"
},
- "workflow_run_block_id": {
+ "deleted_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Workflow Run Block Id"
+ "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"
},
- "run_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Run Id"
+ "key": {
+ "type": "string",
+ "title": "Key"
},
- "browser_session_id": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7265,31 +9206,130 @@
"type": "null"
}
],
- "title": "Browser Session Id"
+ "title": "Description"
},
- "observer_cruise_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Observer Cruise Id"
+ "bitwarden_client_id_aws_secret_key": {
+ "type": "string",
+ "title": "Bitwarden Client Id Aws Secret Key"
},
- "observer_thought_id": {
+ "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",
+ "split_pdf",
+ "email_inbox"
+ ],
+ "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": [
{
- "type": "string"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/JinjaBranchCriteria"
+ },
+ {
+ "$ref": "#/components/schemas/PromptBranchCriteria"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "criteria_type",
+ "mapping": {
+ "jinja2_template": "#/components/schemas/JinjaBranchCriteria",
+ "prompt": "#/components/schemas/PromptBranchCriteria"
+ }
+ }
},
{
"type": "null"
}
],
- "title": "Observer Thought Id"
+ "title": "Criteria"
},
- "ai_suggestion_id": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -7298,9 +9338,9 @@
"type": "null"
}
],
- "title": "Ai Suggestion Id"
+ "title": "Next Block Label"
},
- "signed_url": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7309,78 +9349,40 @@
"type": "null"
}
],
- "title": "Signed Url"
+ "title": "Description"
},
- "archived": {
+ "is_default": {
"type": "boolean",
- "title": "Archived",
+ "title": "Is Default",
"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"
+ "title": "BranchCondition",
+ "description": "Represents a single conditional branch edge within a ConditionalBlock."
},
- "AzureSecretParameter": {
+ "BranchConditionYAML": {
"properties": {
- "parameter_type": {
- "type": "string",
- "const": "azure_secret",
- "title": "Parameter Type",
- "default": "azure_secret"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "criteria": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/BranchCriteriaYAML"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "next_block_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Block Label"
},
"description": {
"anyOf": [
@@ -7393,63 +9395,61 @@
],
"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": {
+ "is_default": {
+ "type": "boolean",
+ "title": "Is Default",
+ "default": false
+ }
+ },
+ "type": "object",
+ "title": "BranchConditionYAML"
+ },
+ "BranchCriteriaYAML": {
+ "properties": {
+ "criteria_type": {
"type": "string",
- "format": "date-time",
- "title": "Created At"
+ "enum": [
+ "jinja2_template",
+ "prompt"
+ ],
+ "title": "Criteria Type",
+ "default": "jinja2_template"
},
- "modified_at": {
+ "expression": {
"type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "title": "Expression"
},
- "deleted_at": {
+ "description": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Deleted At"
+ "title": "Description"
}
},
"type": "object",
"required": [
- "key",
- "azure_secret_parameter_id",
- "workflow_id",
- "azure_key",
- "created_at",
- "modified_at"
+ "expression"
],
- "title": "AzureSecretParameter"
+ "title": "BranchCriteriaYAML"
},
- "AzureVaultCredentialParameter": {
+ "BrowserProfile": {
"properties": {
- "parameter_type": {
+ "browser_profile_id": {
"type": "string",
- "const": "azure_vault_credential",
- "title": "Parameter Type",
- "default": "azure_vault_credential"
+ "title": "Browser Profile Id"
},
- "key": {
+ "organization_id": {
"type": "string",
- "title": "Key"
+ "title": "Organization Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
},
"description": {
"anyOf": [
@@ -7462,27 +9462,63 @@
],
"title": "Description"
},
- "azure_vault_credential_parameter_id": {
- "type": "string",
- "title": "Azure Vault Credential Parameter Id"
+ "source_browser_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Source Browser Type"
},
- "workflow_id": {
- "type": "string",
- "title": "Workflow Id"
+ "proxy_location": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ProxyLocation"
+ },
+ {
+ "$ref": "#/components/schemas/GeoTarget"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Proxy Location"
},
- "vault_name": {
- "type": "string",
- "title": "Vault Name"
+ "proxy_session_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Proxy Session Id"
},
- "username_key": {
- "type": "string",
- "title": "Username Key"
+ "is_managed": {
+ "type": "boolean",
+ "title": "Is Managed",
+ "default": false
},
- "password_key": {
- "type": "string",
- "title": "Password Key"
+ "workflow_permanent_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Workflow Permanent Id"
},
- "totp_secret_key": {
+ "browser_profile_key_digest": {
"anyOf": [
{
"type": "string"
@@ -7491,7 +9527,7 @@
"type": "null"
}
],
- "title": "Totp Secret Key"
+ "title": "Browser Profile Key Digest"
},
"created_at": {
"type": "string",
@@ -7518,30 +9554,30 @@
},
"type": "object",
"required": [
- "key",
- "azure_vault_credential_parameter_id",
- "workflow_id",
- "vault_name",
- "username_key",
- "password_key",
+ "browser_profile_id",
+ "organization_id",
+ "name",
"created_at",
"modified_at"
],
- "title": "AzureVaultCredentialParameter"
+ "title": "BrowserProfile"
},
- "AzureVaultCredentialParameterYAML": {
+ "BrowserSessionResponse": {
"properties": {
- "parameter_type": {
+ "browser_session_id": {
"type": "string",
- "const": "azure_vault_credential",
- "title": "Parameter Type",
- "default": "azure_vault_credential"
+ "title": "Browser Session Id",
+ "description": "Unique identifier for the browser session. browser_session_id starts with `pbs_`.",
+ "examples": [
+ "pbs_123456"
+ ]
},
- "key": {
+ "organization_id": {
"type": "string",
- "title": "Key"
+ "title": "Organization Id",
+ "description": "ID of the organization that owns this session"
},
- "description": {
+ "status": {
"anyOf": [
{
"type": "string"
@@ -7550,21 +9586,81 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Status",
+ "description": "Current status of the browser session",
+ "examples": [
+ "created",
+ "running",
+ "completed",
+ "failed",
+ "timeout"
+ ]
},
- "vault_name": {
- "type": "string",
- "title": "Vault Name"
+ "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"
+ ]
},
- "username_key": {
- "type": "string",
- "title": "Username Key"
+ "runnable_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Runnable Id",
+ "description": "ID of the current runnable",
+ "examples": [
+ "tsk_123456",
+ "wr_123456"
+ ]
},
- "password_key": {
- "type": "string",
- "title": "Password Key"
+ "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"
+ ]
},
- "totp_secret_key": {
+ "app_url": {
"anyOf": [
{
"type": "string"
@@ -7573,120 +9669,39 @@
"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"
+ "title": "App Url",
+ "description": "Url for the browser session page",
+ "examples": [
+ "https://app.skyvern.com/browser-session/pbs_123456"
+ ]
},
- "description": {
+ "extensions": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "$ref": "#/components/schemas/Extensions"
+ },
+ "type": "array"
},
{
"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"
+ "title": "Extensions",
+ "description": "A list of extensions installed in the browser session."
},
- "deleted_at": {
+ "browser_type": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "$ref": "#/components/schemas/PersistentBrowserType"
},
{
"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": "The type of browser used for the session."
},
- "description": {
+ "browser_profile_id": {
"anyOf": [
{
"type": "string"
@@ -7695,53 +9710,22 @@
"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"
+ "title": "Browser Profile Id",
+ "description": "ID of the browser profile loaded into this session, if any. browser_profile_id starts with `bp_`."
},
- "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"
+ "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
},
- "key": {
- "type": "string",
- "title": "Key"
+ "vnc_streaming_supported": {
+ "type": "boolean",
+ "title": "Vnc Streaming Supported",
+ "description": "Whether the browser session supports VNC streaming",
+ "default": false
},
- "description": {
+ "download_path": {
"anyOf": [
{
"type": "string"
@@ -7750,70 +9734,76 @@
"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"
+ "title": "Download Path",
+ "description": "The path where the browser session downloads files"
},
- "bitwarden_master_password_aws_secret_key": {
- "type": "string",
- "title": "Bitwarden Master Password Aws Secret Key"
+ "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"
},
- "url_parameter_key": {
+ "recordings": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "$ref": "#/components/schemas/FileInfo"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Url Parameter Key"
+ "title": "Recordings",
+ "description": "The list of video recordings from the browser session"
},
- "bitwarden_collection_id": {
+ "started_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Bitwarden Collection Id"
+ "title": "Started At",
+ "description": "Timestamp when the session was started"
},
- "bitwarden_item_id": {
+ "completed_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Bitwarden Item Id"
+ "title": "Completed At",
+ "description": "Timestamp when the session was completed"
},
"created_at": {
"type": "string",
"format": "date-time",
- "title": "Created At"
+ "title": "Created At",
+ "description": "Timestamp when the session was created (the timestamp for the initial request)"
},
"modified_at": {
"type": "string",
"format": "date-time",
- "title": "Modified At"
+ "title": "Modified At",
+ "description": "Timestamp when the session was last modified"
},
"deleted_at": {
"anyOf": [
@@ -7825,35 +9815,88 @@
"type": "null"
}
],
- "title": "Deleted At"
+ "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": [
- "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"
+ "run_ids"
],
- "title": "BitwardenLoginCredentialParameter"
+ "title": "BulkCancelRunsRequest"
},
- "BitwardenLoginCredentialParameterYAML": {
+ "BulkCancelRunsResponse": {
"properties": {
- "parameter_type": {
- "type": "string",
- "const": "bitwarden_login_credential",
- "title": "Parameter Type",
- "default": "bitwarden_login_credential"
+ "cancelled": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Cancelled",
+ "description": "Run IDs that were successfully cancelled"
},
- "key": {
+ "failed": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Failed",
+ "description": "Run IDs that could not be cancelled"
+ }
+ },
+ "type": "object",
+ "required": [
+ "cancelled",
+ "failed"
+ ],
+ "title": "BulkCancelRunsResponse"
+ },
+ "ClearOrganizationAuthTokenResponse": {
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "Success",
+ "description": "Whether the token was cleared successfully"
+ }
+ },
+ "type": "object",
+ "required": [
+ "success"
+ ],
+ "title": "ClearOrganizationAuthTokenResponse",
+ "description": "Response model for clearing an organization auth token."
+ },
+ "ClickAction": {
+ "properties": {
+ "type": {
"type": "string",
- "title": "Key"
+ "const": "ai_click",
+ "title": "Type",
+ "default": "ai_click"
},
- "description": {
+ "selector": {
"anyOf": [
{
"type": "string"
@@ -7862,32 +9905,46 @@
"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"
+ "title": "Selector",
+ "description": "CSS selector for the element",
+ "default": ""
},
- "bitwarden_master_password_aws_secret_key": {
+ "intention": {
"type": "string",
- "title": "Bitwarden Master Password Aws Secret Key"
+ "title": "Intention",
+ "description": "The intention or goal of the click",
+ "default": ""
},
- "url_parameter_key": {
+ "data": {
"anyOf": [
{
"type": "string"
},
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
{
"type": "null"
}
],
- "title": "Url Parameter Key"
+ "title": "Data",
+ "description": "Additional context data"
},
- "bitwarden_collection_id": {
+ "timeout": {
+ "type": "number",
+ "title": "Timeout",
+ "description": "Timeout in milliseconds",
+ "default": 10000
+ }
+ },
+ "type": "object",
+ "title": "ClickAction",
+ "description": "Click action parameters."
+ },
+ "ClickContext": {
+ "properties": {
+ "thought": {
"anyOf": [
{
"type": "string"
@@ -7896,42 +9953,31 @@
"type": "null"
}
],
- "title": "Bitwarden Collection Id"
+ "title": "Thought"
},
- "bitwarden_item_id": {
+ "single_option_click": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Bitwarden Item Id"
+ "title": "Single Option Click"
}
},
"type": "object",
- "required": [
- "key",
- "bitwarden_client_id_aws_secret_key",
- "bitwarden_client_secret_aws_secret_key",
- "bitwarden_master_password_aws_secret_key"
- ],
- "title": "BitwardenLoginCredentialParameterYAML"
+ "title": "ClickContext"
},
- "BitwardenSensitiveInformationParameter": {
+ "CodeBlock": {
"properties": {
- "parameter_type": {
- "type": "string",
- "const": "bitwarden_sensitive_information",
- "title": "Parameter Type",
- "default": "bitwarden_sensitive_information"
- },
- "key": {
+ "label": {
"type": "string",
- "title": "Key"
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
},
- "description": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -7940,224 +9986,160 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "bitwarden_sensitive_information_parameter_id": {
+ "block_type": {
"type": "string",
- "title": "Bitwarden Sensitive Information Parameter Id"
+ "const": "code",
+ "title": "Block Type",
+ "default": "code"
},
- "workflow_id": {
- "type": "string",
- "title": "Workflow Id"
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
},
- "bitwarden_client_id_aws_secret_key": {
- "type": "string",
- "title": "Bitwarden Client Id Aws Secret Key"
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
},
- "bitwarden_client_secret_aws_secret_key": {
- "type": "string",
- "title": "Bitwarden Client Secret Aws Secret Key"
+ "model": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Model"
},
- "bitwarden_master_password_aws_secret_key": {
- "type": "string",
- "title": "Bitwarden Master Password Aws Secret Key"
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
},
- "bitwarden_collection_id": {
- "type": "string",
- "title": "Bitwarden Collection Id"
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
},
- "bitwarden_identity_key": {
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "code": {
"type": "string",
- "title": "Bitwarden Identity Key"
+ "title": "Code"
},
- "bitwarden_identity_fields": {
+ "parameters": {
"items": {
- "type": "string"
+ "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": "Bitwarden Identity Fields"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
- },
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "title": "Parameters",
+ "default": []
},
- "deleted_at": {
+ "prompt": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"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"
+ "title": "Prompt"
},
- "description": {
+ "steps": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "$ref": "#/components/schemas/CodeBlockStep"
+ },
+ "type": "array"
},
{
"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"
- ],
- "title": "BlockType"
- },
- "Body_upload_file_v1_upload_file_post": {
- "properties": {
- "file": {
- "type": "string",
- "contentMediaType": "application/octet-stream",
- "title": "File"
+ "title": "Steps"
}
},
"type": "object",
"required": [
- "file"
+ "label",
+ "output_parameter",
+ "code"
],
- "title": "Body_upload_file_v1_upload_file_post"
+ "title": "CodeBlock"
},
- "BranchCondition": {
+ "CodeBlockStep": {
"properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "criteria": {
+ "title": {
"anyOf": [
{
- "oneOf": [
- {
- "$ref": "#/components/schemas/JinjaBranchCriteria"
- },
- {
- "$ref": "#/components/schemas/PromptBranchCriteria"
- }
- ],
- "discriminator": {
- "propertyName": "criteria_type",
- "mapping": {
- "jinja2_template": "#/components/schemas/JinjaBranchCriteria",
- "prompt": "#/components/schemas/PromptBranchCriteria"
- }
- }
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Criteria"
+ "title": "Title"
},
- "next_block_label": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -8166,42 +10148,41 @@
"type": "null"
}
],
- "title": "Next Block Label"
+ "title": "Description"
},
- "description": {
+ "action_type": {
+ "$ref": "#/components/schemas/ActionType",
+ "default": "null_action"
+ },
+ "line_start": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Description"
+ "title": "Line Start"
},
- "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": {
+ "line_end": {
"anyOf": [
{
- "$ref": "#/components/schemas/BranchCriteriaYAML"
+ "type": "integer"
},
{
"type": "null"
}
- ]
- },
- "next_block_label": {
+ ],
+ "title": "Line End"
+ }
+ },
+ "type": "object",
+ "title": "CodeBlockStep"
+ },
+ "CodeBlockStepYAML": {
+ "properties": {
+ "title": {
"anyOf": [
{
"type": "string"
@@ -8210,7 +10191,7 @@
"type": "null"
}
],
- "title": "Next Block Label"
+ "title": "Title"
},
"description": {
"anyOf": [
@@ -8223,63 +10204,51 @@
],
"title": "Description"
},
- "is_default": {
- "type": "boolean",
- "title": "Is Default",
- "default": false
- }
- },
- "type": "object",
- "title": "BranchConditionYAML"
- },
- "BranchCriteriaYAML": {
- "properties": {
- "criteria_type": {
+ "action_type": {
"type": "string",
- "enum": [
- "jinja2_template",
- "prompt"
- ],
- "title": "Criteria Type",
- "default": "jinja2_template"
+ "title": "Action Type",
+ "default": "null_action"
},
- "expression": {
- "type": "string",
- "title": "Expression"
+ "line_start": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Line Start"
},
- "description": {
+ "line_end": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Description"
+ "title": "Line End"
}
},
"type": "object",
- "required": [
- "expression"
- ],
- "title": "BranchCriteriaYAML"
+ "title": "CodeBlockStepYAML"
},
- "BrowserProfile": {
+ "CodeBlockYAML": {
"properties": {
- "browser_profile_id": {
- "type": "string",
- "title": "Browser Profile Id"
- },
- "organization_id": {
+ "block_type": {
"type": "string",
- "title": "Organization Id"
+ "const": "code",
+ "title": "Block Type",
+ "default": "code"
},
- "name": {
+ "label": {
"type": "string",
- "title": "Name"
+ "title": "Label",
+ "description": "Author-facing identifier; must be unique per workflow."
},
- "description": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -8288,27 +10257,16 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
},
- "source_browser_type": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Source Browser Type"
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
},
- "proxy_location": {
+ "model": {
"anyOf": [
- {
- "$ref": "#/components/schemas/ProxyLocation"
- },
- {
- "$ref": "#/components/schemas/GeoTarget"
- },
{
"additionalProperties": true,
"type": "object"
@@ -8317,36 +10275,37 @@
"type": "null"
}
],
- "title": "Proxy Location"
+ "title": "Model"
},
- "proxy_session_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Proxy Session Id"
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
},
- "is_managed": {
+ "next_loop_on_failure": {
"type": "boolean",
- "title": "Is Managed",
+ "title": "Next Loop On Failure",
"default": false
},
- "workflow_permanent_id": {
+ "code": {
+ "type": "string",
+ "title": "Code"
+ },
+ "parameter_keys": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Workflow Permanent Id"
+ "title": "Parameter Keys"
},
- "browser_profile_key_digest": {
+ "prompt": {
"anyOf": [
{
"type": "string"
@@ -8355,57 +10314,38 @@
"type": "null"
}
],
- "title": "Browser Profile Key Digest"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
- },
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At"
+ "title": "Prompt"
},
- "deleted_at": {
+ "steps": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "items": {
+ "$ref": "#/components/schemas/CodeBlockStepYAML"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Deleted At"
+ "title": "Steps"
}
},
"type": "object",
"required": [
- "browser_profile_id",
- "organization_id",
- "name",
- "created_at",
- "modified_at"
+ "label",
+ "code"
],
- "title": "BrowserProfile"
+ "title": "CodeBlockYAML"
},
- "BrowserSessionResponse": {
+ "ConditionalBlock": {
"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": {
+ "label": {
"type": "string",
- "title": "Organization Id",
- "description": "ID of the organization that owns this session"
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
},
- "status": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -8414,33 +10354,80 @@
"type": "null"
}
],
- "title": "Status",
- "description": "Current status of the browser session",
- "examples": [
- "created",
- "running",
- "completed",
- "failed",
- "timeout"
- ]
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "runnable_type": {
+ "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": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Runnable Type",
- "description": "Type of the current runnable associated with this session (workflow, task etc)",
- "examples": [
- "task",
- "workflow_run"
- ]
+ "title": "Model"
},
- "runnable_id": {
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "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"
@@ -8449,30 +10436,63 @@
"type": "null"
}
],
- "title": "Runnable Id",
- "description": "ID of the current runnable",
- "examples": [
- "tsk_123456",
- "wr_123456"
- ]
+ "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]]."
},
- "timeout": {
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
{
- "type": "integer"
+ "additionalProperties": true,
+ "type": "object"
},
{
"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
- ]
+ "title": "Model"
},
- "browser_address": {
+ "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"
@@ -8481,79 +10501,95 @@
"type": "null"
}
],
- "title": "Browser Address",
- "description": "Url for connecting to the browser",
- "examples": [
- "http://localhost:9222",
- "https://3.12.10.11/browser/123456"
- ]
+ "title": "Description"
},
- "app_url": {
+ "source": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/WorkflowParameter"
},
{
- "type": "null"
- }
- ],
- "title": "App Url",
- "description": "Url for the browser session page",
- "examples": [
- "https://app.skyvern.com/browser-session/pbs_123456"
- ]
- },
- "extensions": {
- "anyOf": [
+ "$ref": "#/components/schemas/ContextParameter"
+ },
{
- "items": {
- "$ref": "#/components/schemas/Extensions"
- },
- "type": "array"
+ "$ref": "#/components/schemas/AWSSecretParameter"
},
{
- "type": "null"
- }
- ],
- "title": "Extensions",
- "description": "A list of extensions installed in the browser session."
- },
- "browser_type": {
- "anyOf": [
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
{
- "$ref": "#/components/schemas/PersistentBrowserType"
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
}
],
- "description": "The type of browser used for the session."
+ "title": "Source"
},
- "browser_profile_id": {
+ "value": {
"anyOf": [
{
"type": "string"
},
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
{
"type": "null"
}
],
- "title": "Browser Profile Id",
- "description": "ID of the browser profile loaded into this session, if any. browser_profile_id starts with `bp_`."
- },
- "generate_browser_profile": {
- "type": "boolean",
- "title": "Generate Browser Profile",
- "description": "Whether this session's browser profile will be saved when it ends so it can become a reusable browser profile.",
- "default": false
+ "title": "Value"
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "source"
+ ],
+ "title": "ContextParameter"
+ },
+ "ContextParameterYAML": {
+ "properties": {
+ "parameter_type": {
+ "type": "string",
+ "const": "context",
+ "title": "Parameter Type",
+ "default": "context"
},
- "vnc_streaming_supported": {
- "type": "boolean",
- "title": "Vnc Streaming Supported",
- "description": "Whether the browser session supports VNC streaming",
- "default": false
+ "key": {
+ "type": "string",
+ "title": "Key"
},
- "download_path": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -8562,176 +10598,128 @@
"type": "null"
}
],
- "title": "Download Path",
- "description": "The path where the browser session downloads files"
+ "title": "Description"
},
- "downloaded_files": {
+ "source_parameter_key": {
+ "type": "string",
+ "title": "Source Parameter Key"
+ }
+ },
+ "type": "object",
+ "required": [
+ "key",
+ "source_parameter_key"
+ ],
+ "title": "ContextParameterYAML"
+ },
+ "CreateBrowserProfileRequest": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "title": "Name",
+ "description": "Name for the browser profile"
+ },
+ "description": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/FileInfo"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Downloaded Files",
- "description": "The list of files downloaded by the browser session"
+ "title": "Description",
+ "description": "Optional profile description"
},
- "recordings": {
+ "browser_session_id": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/FileInfo"
- },
- "type": "array"
+ "type": "string",
+ "minLength": 1
},
{
"type": "null"
}
],
- "title": "Recordings",
- "description": "The list of video recordings from the browser session"
+ "title": "Browser Session Id",
+ "description": "Persistent browser session to convert into a profile. Omit for a blank profile."
},
- "started_at": {
+ "workflow_run_id": {
"anyOf": [
{
"type": "string",
- "format": "date-time"
+ "minLength": 1
},
{
"type": "null"
}
],
- "title": "Started At",
- "description": "Timestamp when the session was started"
+ "title": "Workflow Run Id",
+ "description": "Workflow run whose persisted session should be captured. Omit for a blank profile."
},
- "completed_at": {
+ "proxy_location": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "$ref": "#/components/schemas/ProxyLocation"
+ },
+ {
+ "$ref": "#/components/schemas/GeoTarget"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Completed At",
- "description": "Timestamp when the session was completed"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At",
- "description": "Timestamp when the session was created (the timestamp for the initial request)"
- },
- "modified_at": {
- "type": "string",
- "format": "date-time",
- "title": "Modified At",
- "description": "Timestamp when the session was last modified"
+ "title": "Proxy Location",
+ "description": "Optional proxy location for this profile's pinned proxy identity."
},
- "deleted_at": {
+ "proxy_session_id": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Deleted At",
- "description": "Timestamp when the session was deleted, if applicable"
- }
- },
- "type": "object",
- "required": [
- "browser_session_id",
- "organization_id",
- "created_at",
- "modified_at"
- ],
- "title": "BrowserSessionResponse",
- "description": "Response model for browser session information."
- },
- "BulkCancelRunsRequest": {
- "properties": {
- "run_ids": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "maxItems": 100,
- "title": "Run Ids",
- "description": "List of run IDs to cancel"
- }
- },
- "type": "object",
- "required": [
- "run_ids"
- ],
- "title": "BulkCancelRunsRequest"
- },
- "BulkCancelRunsResponse": {
- "properties": {
- "cancelled": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Cancelled",
- "description": "Run IDs that were successfully cancelled"
- },
- "failed": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Failed",
- "description": "Run IDs that could not be cancelled"
+ "title": "Proxy Session Id",
+ "description": "Explicit sticky-session id for this profile's pinned proxy identity."
}
},
"type": "object",
"required": [
- "cancelled",
- "failed"
+ "name"
],
- "title": "BulkCancelRunsResponse"
+ "title": "CreateBrowserProfileRequest"
},
- "ClickAction": {
+ "CreateBrowserSessionRequest": {
"properties": {
- "type": {
- "type": "string",
- "const": "ai_click",
- "title": "Type",
- "default": "ai_click"
- },
- "selector": {
+ "timeout": {
"anyOf": [
{
- "type": "string"
+ "type": "integer",
+ "maximum": 1440,
+ "minimum": 5
},
{
"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": ""
+ "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
},
- "data": {
+ "proxy_location": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/ProxyLocation"
+ },
+ {
+ "$ref": "#/components/schemas/GeoTarget"
},
{
"additionalProperties": true,
@@ -8741,23 +10729,10 @@
"type": "null"
}
],
- "title": "Data",
- "description": "Additional context data"
+ "title": "Proxy Location",
+ "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_KR: South Korea\n- RESIDENTIAL_SA: Saudi Arabia\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_BR: Brazil\n- RESIDENTIAL_TR: Turkey\n- RESIDENTIAL_CA: Canada\n- RESIDENTIAL_MX: Mexico\n- RESIDENTIAL_IT: Italy\n- RESIDENTIAL_NL: Netherlands\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n\nFor self-hosted deployments, you can pass a custom proxy URL as a dict: {\"url\": \"http://user:[email protected]:8080\"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool.\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}, or a custom proxy URL dict for self-hosted deployments: {\"url\": \"http://user:[email protected]:8080\"}"
},
- "timeout": {
- "type": "number",
- "title": "Timeout",
- "description": "Timeout in milliseconds",
- "default": 5000
- }
- },
- "type": "object",
- "title": "ClickAction",
- "description": "Click action parameters."
- },
- "ClickContext": {
- "properties": {
- "thought": {
+ "proxy_session_id": {
"anyOf": [
{
"type": "string"
@@ -8766,58 +10741,118 @@
"type": "null"
}
],
- "title": "Thought"
+ "title": "Proxy Session Id",
+ "description": "Opaque Skyvern-managed proxy sticky-session id for pinned Residential ISP sessions."
},
- "single_option_click": {
+ "extensions": {
"anyOf": [
{
- "type": "boolean"
+ "items": {
+ "$ref": "#/components/schemas/Extensions"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Single Option Click"
+ "title": "Extensions",
+ "description": "A list of extensions to install in the browser session."
+ },
+ "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": "ClickContext"
+ "title": "CreateBrowserSessionRequest"
},
- "CodeBlock": {
+ "CreateCredentialRequest": {
"properties": {
- "label": {
+ "name": {
"type": "string",
- "title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "title": "Name",
+ "description": "Name of the credential",
+ "examples": [
+ "Amazon Login"
+ ]
},
- "next_block_label": {
+ "credential_type": {
+ "$ref": "#/components/schemas/skyvern__forge__sdk__schemas__credentials__CredentialType",
+ "description": "Type of credential to create"
+ },
+ "credential": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/NonEmptyPasswordCredential"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/NonEmptyCreditCardCredential"
+ },
+ {
+ "$ref": "#/components/schemas/SecretCredential"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
- },
- "block_type": {
- "type": "string",
- "const": "code",
- "title": "Block Type",
- "default": "code"
- },
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
+ "title": "Credential",
+ "description": "The credential data to store",
+ "examples": [
+ {
+ "password": "securepassword123",
+ "username": "[email protected]"
+ }
+ ]
},
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "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": [
+ "skyvern",
+ "custom",
+ "azure_vault",
+ "bitwarden"
+ ]
},
- "model": {
+ "proxy_location": {
"anyOf": [
+ {
+ "$ref": "#/components/schemas/ProxyLocation"
+ },
+ {
+ "$ref": "#/components/schemas/GeoTarget"
+ },
{
"additionalProperties": true,
"type": "object"
@@ -8826,108 +10861,40 @@
"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"
+ "title": "Proxy Location",
+ "description": "Optional proxy location for this credential's pinned proxy identity."
},
- "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"
- }
+ "proxy_session_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- },
- "type": "array",
- "title": "Parameters",
- "default": []
+ ],
+ "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": [
- "label",
- "output_parameter",
- "code"
+ "name",
+ "credential_type",
+ "credential"
],
- "title": "CodeBlock"
+ "title": "CreateCredentialRequest",
+ "description": "Request model for creating a new credential."
},
- "CodeBlockYAML": {
+ "CreateScriptRequest": {
"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": {
+ "workflow_id": {
"anyOf": [
{
"type": "string"
@@ -8936,45 +10903,26 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "title": "Workflow Id",
+ "description": "Associated workflow ID"
},
- "model": {
+ "run_id": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
- },
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
- },
- "code": {
- "type": "string",
- "title": "Code"
+ "title": "Run Id",
+ "description": "Associated run ID"
},
- "parameter_keys": {
+ "files": {
"anyOf": [
{
"items": {
- "type": "string"
+ "$ref": "#/components/schemas/ScriptFileCreate"
},
"type": "array"
},
@@ -8982,24 +10930,46 @@
"type": "null"
}
],
- "title": "Parameter Keys"
+ "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",
- "required": [
- "label",
- "code"
- ],
- "title": "CodeBlockYAML"
+ "title": "CreateScriptRequest"
},
- "ConditionalBlock": {
+ "CreateScriptResponse": {
"properties": {
- "label": {
+ "script_id": {
"type": "string",
- "title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "title": "Script Id",
+ "description": "Unique script identifier",
+ "examples": [
+ "s_abc123"
+ ]
},
- "next_block_label": {
+ "version": {
+ "type": "integer",
+ "title": "Version",
+ "description": "Script version number",
+ "examples": [
+ 1
+ ]
+ },
+ "run_id": {
"anyOf": [
{
"type": "string"
@@ -9008,139 +10978,140 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
+ "title": "Run Id",
+ "description": "ID of the workflow run or task run that generated this script"
},
- "block_type": {
- "type": "string",
- "const": "conditional",
- "title": "Block Type",
- "default": "conditional"
+ "file_count": {
+ "type": "integer",
+ "title": "File Count",
+ "description": "Total number of files in the script"
},
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
+ "file_tree": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/FileNode"
+ },
+ "type": "object",
+ "title": "File Tree",
+ "description": "Hierarchical file tree structure"
},
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "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"
},
- "model": {
+ "key": {
+ "type": "string",
+ "title": "Key"
+ },
+ "description": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
- },
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "title": "Description"
},
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
+ "credential_parameter_id": {
+ "type": "string",
+ "title": "Credential Parameter Id"
},
- "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": {
+ "workflow_id": {
"type": "string",
- "const": "conditional",
- "title": "Block Type",
- "default": "conditional"
+ "title": "Workflow Id"
},
- "label": {
+ "credential_id": {
"type": "string",
- "title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
+ "title": "Credential Id"
},
- "next_block_label": {
+ "credential_ids": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "title": "Credential Ids"
},
- "model": {
+ "selection_strategy": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Model"
+ "title": "Selection Strategy"
},
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
},
- "next_loop_on_failure": {
- "type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Modified At"
},
- "branch_conditions": {
- "items": {
- "$ref": "#/components/schemas/BranchConditionYAML"
- },
- "type": "array",
- "title": "Branch Conditions"
+ "deleted_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Deleted At"
}
},
"type": "object",
"required": [
- "label"
+ "key",
+ "credential_parameter_id",
+ "workflow_id",
+ "credential_id",
+ "created_at",
+ "modified_at"
],
- "title": "ConditionalBlockYAML"
+ "title": "CredentialParameter"
},
- "ContextParameter": {
+ "CredentialParameterYAML": {
"properties": {
"parameter_type": {
"type": "string",
- "const": "context",
+ "const": "credential",
"title": "Parameter Type",
- "default": "context"
+ "default": "credential"
},
"key": {
"type": "string",
@@ -9157,93 +11128,92 @@
],
"title": "Description"
},
- "source": {
+ "credential_id": {
+ "type": "string",
+ "title": "Credential Id"
+ },
+ "credential_ids": {
"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"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
- "$ref": "#/components/schemas/CredentialParameter"
+ "type": "null"
}
],
- "title": "Source"
+ "title": "Credential Ids"
},
- "value": {
+ "selection_strategy": {
"anyOf": [
{
"type": "string"
},
- {
- "type": "integer"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- },
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "items": {},
- "type": "array"
- },
{
"type": "null"
}
],
- "title": "Value"
+ "title": "Selection Strategy"
}
},
"type": "object",
"required": [
"key",
- "source"
+ "credential_id"
],
- "title": "ContextParameter"
+ "title": "CredentialParameterYAML"
},
- "ContextParameterYAML": {
+ "CredentialResponse": {
"properties": {
- "parameter_type": {
+ "credential_id": {
"type": "string",
- "const": "context",
- "title": "Parameter Type",
- "default": "context"
+ "title": "Credential Id",
+ "description": "Unique identifier for the credential",
+ "examples": [
+ "cred_1234567890"
+ ]
},
- "key": {
+ "credential": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/PasswordCredentialResponse"
+ },
+ {
+ "$ref": "#/components/schemas/CreditCardCredentialResponse"
+ },
+ {
+ "$ref": "#/components/schemas/SecretCredentialResponse"
+ }
+ ],
+ "title": "Credential",
+ "description": "The credential data"
+ },
+ "credential_type": {
+ "$ref": "#/components/schemas/CredentialType-Output",
+ "description": "Type of the credential"
+ },
+ "name": {
"type": "string",
- "title": "Key"
+ "title": "Name",
+ "description": "Name of the credential",
+ "examples": [
+ "Amazon Login"
+ ]
},
- "description": {
+ "vault_type": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/CredentialVaultType"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Which vault stores this credential (e.g., 'skyvern', 'bitwarden', 'azure_vault', 'custom')"
+ },
+ "browser_profile_id": {
"anyOf": [
{
"type": "string"
@@ -9252,29 +11222,22 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Browser Profile Id",
+ "description": "Browser profile ID linked to this credential"
},
- "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"
+ "tested_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Tested Url",
+ "description": "Login page URL used during the credential test"
},
- "description": {
+ "user_context": {
"anyOf": [
{
"type": "string"
@@ -9283,34 +11246,35 @@
"type": "null"
}
],
- "title": "Description",
- "description": "Optional profile description"
+ "title": "User Context",
+ "description": "User-provided context describing the login sequence (e.g., 'click SSO button first')"
},
- "browser_session_id": {
+ "save_browser_session_intent": {
"anyOf": [
{
- "type": "string",
- "minLength": 1
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Browser Session Id",
- "description": "Persistent browser session to convert into a profile. Omit for a blank profile."
+ "title": "Save Browser Session Intent",
+ "description": "Whether the user intends to save a browser session, regardless of test outcome"
},
- "workflow_run_id": {
+ "folder_id": {
"anyOf": [
{
- "type": "string",
- "minLength": 1
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Workflow Run Id",
- "description": "Workflow run whose persisted session should be captured. Omit for a blank profile."
+ "title": "Folder Id",
+ "description": "ID of the credential folder this credential belongs to, if any",
+ "examples": [
+ "cfld_1234567890"
+ ]
},
"proxy_location": {
"anyOf": [
@@ -9329,7 +11293,7 @@
}
],
"title": "Proxy Location",
- "description": "Optional proxy location for this profile's pinned proxy identity."
+ "description": "Optional proxy location used for the credential's pinned proxy identity."
},
"proxy_session_id": {
"anyOf": [
@@ -9341,202 +11305,444 @@
}
],
"title": "Proxy Session Id",
- "description": "Explicit sticky-session id for this profile's pinned proxy identity."
+ "description": "Opaque Skyvern-managed proxy sticky-session id."
}
},
"type": "object",
"required": [
+ "credential_id",
+ "credential",
+ "credential_type",
"name"
],
- "title": "CreateBrowserProfileRequest"
+ "title": "CredentialResponse",
+ "description": "Response model for credential operations."
},
- "CreateBrowserSessionRequest": {
+ "CredentialType-Output": {
+ "type": "string",
+ "enum": [
+ "password",
+ "credit_card",
+ "secret"
+ ],
+ "title": "CredentialType",
+ "description": "Type of credential stored in the system."
+ },
+ "CredentialVaultType": {
+ "type": "string",
+ "enum": [
+ "skyvern",
+ "bitwarden",
+ "azure_vault",
+ "gcp",
+ "custom"
+ ],
+ "title": "CredentialVaultType"
+ },
+ "CreditCardBillingAddress": {
"properties": {
- "timeout": {
+ "line1": {
"anyOf": [
{
- "type": "integer",
- "maximum": 1440.0,
- "minimum": 5.0
+ "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": "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
+ "title": "City",
+ "description": "Billing city",
+ "examples": [
+ "San Francisco"
+ ]
},
- "proxy_location": {
+ "state": {
"anyOf": [
{
- "$ref": "#/components/schemas/ProxyLocation"
+ "type": "string"
},
{
- "$ref": "#/components/schemas/GeoTarget"
- },
+ "type": "null"
+ }
+ ],
+ "title": "State",
+ "description": "Billing state or region",
+ "examples": [
+ "California"
+ ]
+ },
+ "state_code": {
+ "anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Proxy Location",
- "description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_PH: Philippines\n- RESIDENTIAL_KR: South Korea\n- RESIDENTIAL_SA: Saudi Arabia\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_BR: Brazil\n- RESIDENTIAL_TR: Turkey\n- RESIDENTIAL_CA: Canada\n- RESIDENTIAL_MX: Mexico\n- RESIDENTIAL_IT: Italy\n- RESIDENTIAL_NL: Netherlands\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)\n- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)\n- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)\n- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)\n- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)\n- NONE: No proxy\n\nFor self-hosted deployments, you can pass a custom proxy URL as a dict: {\"url\": \"http://user:[email protected]:8080\"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool.\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}, or a custom proxy URL dict for self-hosted deployments: {\"url\": \"http://user:[email protected]:8080\"}"
+ "title": "State Code",
+ "description": "Billing state or region code",
+ "examples": [
+ "CA"
+ ]
},
- "extensions": {
+ "postal_code": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/Extensions"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Extensions",
- "description": "A list of extensions to install in the browser session."
+ "title": "Postal Code",
+ "description": "Billing postal code",
+ "examples": [
+ "94105"
+ ]
},
- "browser_type": {
+ "country": {
"anyOf": [
{
- "$ref": "#/components/schemas/PersistentBrowserType"
+ "type": "string"
},
{
"type": "null"
}
],
- "description": "The type of browser to use for the session."
+ "title": "Country",
+ "description": "Billing country",
+ "examples": [
+ "United States"
+ ]
},
- "browser_profile_id": {
+ "country_code": {
"anyOf": [
{
- "type": "string",
- "pattern": "^bp_"
+ "type": "string"
},
{
"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
+ "title": "Country Code",
+ "description": "ISO 3166-1 alpha-2 billing country code",
+ "examples": [
+ "US"
+ ]
}
},
"type": "object",
- "title": "CreateBrowserSessionRequest"
+ "title": "CreditCardBillingAddress",
+ "description": "Optional billing address fields associated with a credit card credential."
},
- "CreateCredentialRequest": {
+ "CreditCardCredentialResponse": {
"properties": {
- "name": {
+ "last_four": {
"type": "string",
- "title": "Name",
- "description": "Name of the credential",
+ "title": "Last Four",
+ "description": "Last four digits of the credit card number",
"examples": [
- "Amazon Login"
+ "1234"
]
},
- "credential_type": {
- "$ref": "#/components/schemas/skyvern__forge__sdk__schemas__credentials__CredentialType",
- "description": "Type of credential to create"
+ "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."
+ },
+ "CustomLLM": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "Id"
},
- "credential": {
+ "organization_id": {
+ "type": "string",
+ "title": "Organization Id"
+ },
+ "config": {
+ "$ref": "#/components/schemas/CustomLLMConfig"
+ },
+ "created_at": {
+ "type": "string",
+ "title": "Created At"
+ },
+ "modified_at": {
+ "type": "string",
+ "title": "Modified At"
+ },
+ "valid": {
+ "type": "boolean",
+ "title": "Valid"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "organization_id",
+ "config",
+ "created_at",
+ "modified_at",
+ "valid"
+ ],
+ "title": "CustomLLM"
+ },
+ "CustomLLMConfig": {
+ "properties": {
+ "display_name": {
+ "type": "string",
+ "maxLength": 120,
+ "minLength": 1,
+ "title": "Display Name"
+ },
+ "provider": {
+ "$ref": "#/components/schemas/CustomLLMProvider"
+ },
+ "model_name": {
+ "type": "string",
+ "maxLength": 250,
+ "minLength": 1,
+ "title": "Model Name"
+ },
+ "api_base": {
"anyOf": [
{
- "$ref": "#/components/schemas/NonEmptyPasswordCredential"
- },
- {
- "$ref": "#/components/schemas/NonEmptyCreditCardCredential"
+ "type": "string",
+ "maxLength": 500
},
{
- "$ref": "#/components/schemas/SecretCredential"
+ "type": "null"
}
],
- "title": "Credential",
- "description": "The credential data to store",
- "examples": [
+ "title": "Api Base"
+ },
+ "api_key": {
+ "anyOf": [
{
- "password": "securepassword123",
- "username": "[email protected]"
+ "type": "string",
+ "maxLength": 1000
+ },
+ {
+ "type": "null"
}
- ]
+ ],
+ "title": "Api Key"
},
- "vault_type": {
+ "api_version": {
"anyOf": [
{
- "$ref": "#/components/schemas/CredentialVaultType"
+ "type": "string",
+ "maxLength": 100
},
{
"type": "null"
}
],
- "description": "Which vault to store this credential in. If omitted, uses the instance default. Use this to mix Skyvern-hosted and custom credentials within the same organization.",
- "examples": [
- "skyvern",
- "custom",
- "azure_vault",
- "bitwarden"
- ]
+ "title": "Api Version"
},
- "proxy_location": {
+ "supports_vision": {
+ "type": "boolean",
+ "title": "Supports Vision",
+ "default": true
+ },
+ "add_assistant_prefix": {
+ "type": "boolean",
+ "title": "Add Assistant Prefix",
+ "default": false
+ },
+ "max_completion_tokens": {
"anyOf": [
{
- "$ref": "#/components/schemas/ProxyLocation"
+ "type": "integer",
+ "maximum": 1000000,
+ "minimum": 1
},
{
- "$ref": "#/components/schemas/GeoTarget"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Max Completion Tokens"
+ },
+ "temperature": {
+ "anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "number",
+ "maximum": 2,
+ "minimum": 0
},
{
"type": "null"
}
],
- "title": "Proxy Location",
- "description": "Optional proxy location for this credential's pinned proxy identity."
+ "title": "Temperature"
},
- "proxy_session_id": {
+ "reasoning_effort": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 50
},
{
"type": "null"
}
],
- "title": "Proxy Session Id",
- "description": "Optional advanced reuse key for this credential's pinned proxy identity."
- },
- "rotate_proxy_session_id": {
+ "title": "Reasoning Effort"
+ }
+ },
+ "type": "object",
+ "required": [
+ "display_name",
+ "provider",
+ "model_name"
+ ],
+ "title": "CustomLLMConfig"
+ },
+ "CustomLLMCreateRequest": {
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/CustomLLMConfig"
+ }
+ },
+ "type": "object",
+ "required": [
+ "config"
+ ],
+ "title": "CustomLLMCreateRequest"
+ },
+ "CustomLLMListResponse": {
+ "properties": {
+ "custom_llms": {
+ "items": {
+ "$ref": "#/components/schemas/CustomLLM"
+ },
+ "type": "array",
+ "title": "Custom Llms"
+ }
+ },
+ "type": "object",
+ "required": [
+ "custom_llms"
+ ],
+ "title": "CustomLLMListResponse"
+ },
+ "CustomLLMProvider": {
+ "type": "string",
+ "enum": [
+ "openai_compatible",
+ "ollama",
+ "openrouter"
+ ],
+ "title": "CustomLLMProvider"
+ },
+ "CustomLLMResponse": {
+ "properties": {
+ "custom_llm": {
+ "$ref": "#/components/schemas/CustomLLM"
+ }
+ },
+ "type": "object",
+ "required": [
+ "custom_llm"
+ ],
+ "title": "CustomLLMResponse"
+ },
+ "CustomLLMUpdateRequest": {
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/CustomLLMConfig"
+ }
+ },
+ "type": "object",
+ "required": [
+ "config"
+ ],
+ "title": "CustomLLMUpdateRequest"
+ },
+ "DeleteScheduleResponse": {
+ "properties": {
+ "ok": {
"type": "boolean",
- "title": "Rotate Proxy Session Id",
- "description": "Rotate the Skyvern-managed proxy sticky-session id when updating this credential.",
- "default": false
+ "title": "Ok"
}
},
"type": "object",
"required": [
- "name",
- "credential_type",
- "credential"
+ "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": "CreateCredentialRequest",
- "description": "Request model for creating a new credential."
+ "title": "DeployScriptRequest",
+ "description": "Request model for deploying a script with updated files."
},
- "CreateScriptRequest": {
+ "DownloadFilesRequest": {
"properties": {
- "workflow_id": {
+ "url": {
"anyOf": [
{
"type": "string"
@@ -9545,10 +11751,10 @@
"type": "null"
}
],
- "title": "Workflow Id",
- "description": "Associated workflow ID"
+ "title": "Url",
+ "description": "Website URL"
},
- "run_id": {
+ "webhook_url": {
"anyOf": [
{
"type": "string"
@@ -9557,61 +11763,21 @@
"type": "null"
}
],
- "title": "Run Id",
- "description": "Associated run ID"
+ "title": "Webhook Url",
+ "description": "Webhook URL to send status updates"
},
- "files": {
+ "proxy_location": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/ScriptFileCreate"
- },
- "type": "array"
+ "$ref": "#/components/schemas/ProxyLocation"
},
{
"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
- ]
+ "description": "Proxy location to use"
},
- "run_id": {
+ "totp_identifier": {
"anyOf": [
{
"type": "string"
@@ -9620,52 +11786,10 @@
"type": "null"
}
],
- "title": "Run Id",
- "description": "ID of the workflow run or task run that generated this script"
- },
- "file_count": {
- "type": "integer",
- "title": "File Count",
- "description": "Total number of files in the script"
- },
- "file_tree": {
- "additionalProperties": {
- "$ref": "#/components/schemas/FileNode"
- },
- "type": "object",
- "title": "File Tree",
- "description": "Hierarchical file tree structure"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At",
- "description": "Timestamp when the script was created"
- }
- },
- "type": "object",
- "required": [
- "script_id",
- "version",
- "file_count",
- "file_tree",
- "created_at"
- ],
- "title": "CreateScriptResponse"
- },
- "CredentialParameter": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "credential",
- "title": "Parameter Type",
- "default": "credential"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "title": "Totp Identifier",
+ "description": "Identifier for TOTP (Time-based One-Time Password) if required"
},
- "description": {
+ "totp_url": {
"anyOf": [
{
"type": "string"
@@ -9674,67 +11798,25 @@
"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"
+ "title": "Totp Url",
+ "description": "TOTP URL to fetch one-time passwords"
},
- "deleted_at": {
+ "browser_session_id": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Deleted At"
- }
- },
- "type": "object",
- "required": [
- "key",
- "credential_parameter_id",
- "workflow_id",
- "credential_id",
- "created_at",
- "modified_at"
- ],
- "title": "CredentialParameter"
- },
- "CredentialParameterYAML": {
- "properties": {
- "parameter_type": {
- "type": "string",
- "const": "credential",
- "title": "Parameter Type",
- "default": "credential"
- },
- "key": {
- "type": "string",
- "title": "Key"
+ "title": "Browser Session Id",
+ "description": "ID of the browser session to use, which is prefixed by `pbs_` e.g. `pbs_123456`",
+ "examples": [
+ "pbs_123456"
+ ]
},
- "description": {
+ "browser_profile_id": {
"anyOf": [
{
"type": "string"
@@ -9743,93 +11825,73 @@
"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"
- ]
+ "title": "Browser Profile Id",
+ "description": "ID of a browser profile to reuse for this run"
},
- "credential": {
+ "browser_address": {
"anyOf": [
{
- "$ref": "#/components/schemas/PasswordCredentialResponse"
- },
- {
- "$ref": "#/components/schemas/CreditCardCredentialResponse"
+ "type": "string"
},
{
- "$ref": "#/components/schemas/SecretCredentialResponse"
+ "type": "null"
}
],
- "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",
+ "title": "Browser Address",
+ "description": "The CDP address for the task.",
"examples": [
- "Amazon Login"
+ "http://127.0.0.1:9222",
+ "ws://127.0.0.1:9222/devtools/browser/1234567890"
]
},
- "vault_type": {
+ "extra_http_headers": {
"anyOf": [
{
- "$ref": "#/components/schemas/CredentialVaultType"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
{
"type": "null"
}
],
- "description": "Which vault stores this credential (e.g., 'skyvern', 'bitwarden', 'azure_vault', 'custom')"
+ "title": "Extra Http Headers",
+ "description": "Additional HTTP headers to include in requests"
},
- "browser_profile_id": {
+ "cdp_connect_headers": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Browser Profile Id",
- "description": "Browser profile ID linked to this credential"
+ "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."
},
- "tested_url": {
+ "max_screenshot_scrolling_times": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
- ],
- "title": "Tested Url",
- "description": "Login page URL used during the credential test"
+ ],
+ "title": "Max Screenshot Scrolling Times",
+ "description": "Maximum number of times to scroll for screenshots"
},
- "user_context": {
+ "navigation_goal": {
+ "type": "string",
+ "title": "Navigation Goal",
+ "description": "Instructions for navigating to and downloading the file"
+ },
+ "download_suffix": {
"anyOf": [
{
"type": "string"
@@ -9838,137 +11900,48 @@
"type": "null"
}
],
- "title": "User Context",
- "description": "User-provided context describing the login sequence (e.g., 'click SSO button first')"
+ "title": "Download Suffix",
+ "description": "Suffix or complete filename for the downloaded file"
},
- "save_browser_session_intent": {
+ "download_timeout": {
"anyOf": [
{
- "type": "boolean"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Save Browser Session Intent",
- "description": "Whether the user intends to save a browser session, regardless of test outcome"
+ "title": "Download Timeout",
+ "description": "Timeout in seconds for the download operation"
},
- "folder_id": {
+ "max_steps_per_run": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Folder Id",
- "description": "ID of the credential folder this credential belongs to, if any",
- "examples": [
- "cfld_1234567890"
- ]
+ "title": "Max Steps Per Run",
+ "description": "Maximum number of steps to execute"
}
},
"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": [
- "skyvern",
- "bitwarden",
- "azure_vault",
- "gcp",
- "custom"
+ "navigation_goal"
],
- "title": "CredentialVaultType"
+ "title": "DownloadFilesRequest"
},
- "CreditCardCredentialResponse": {
+ "DownloadToS3Block": {
"properties": {
- "last_four": {
+ "label": {
"type": "string",
- "title": "Last Four",
- "description": "Last four digits of the credit card number",
- "examples": [
- "1234"
- ]
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
},
- "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, or card holder name."
- },
- "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": {
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -9977,33 +11950,77 @@
"type": "null"
}
],
- "title": "Url",
- "description": "Website URL"
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "webhook_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Webhook Url",
- "description": "Webhook URL to send status updates"
+ "block_type": {
+ "type": "string",
+ "const": "download_to_s3",
+ "title": "Block Type",
+ "default": "download_to_s3"
},
- "proxy_location": {
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
{
- "$ref": "#/components/schemas/ProxyLocation"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "description": "Proxy location to use"
+ "title": "Model"
},
- "totp_identifier": {
+ "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"
@@ -10012,22 +12029,56 @@
"type": "null"
}
],
- "title": "Totp Identifier",
- "description": "Identifier for TOTP (Time-based One-Time Password) if required"
+ "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]]."
},
- "totp_url": {
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Totp Url",
- "description": "TOTP URL to fetch one-time passwords"
+ "title": "Model"
},
- "browser_session_id": {
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "url": {
+ "type": "string",
+ "title": "Url"
+ }
+ },
+ "type": "object",
+ "required": [
+ "label",
+ "url"
+ ],
+ "title": "DownloadToS3BlockYAML"
+ },
+ "EmailInboxBlock": {
+ "properties": {
+ "label": {
+ "type": "string",
+ "title": "Label",
+ "description": "Author-facing identifier for a block; unique within a workflow."
+ },
+ "next_block_label": {
"anyOf": [
{
"type": "string"
@@ -10036,88 +12087,92 @@
"type": "null"
}
],
- "title": "Browser Session Id",
- "description": "ID of the browser session to use, which is prefixed by `pbs_` e.g. `pbs_123456`",
- "examples": [
- "pbs_123456"
- ]
+ "title": "Next Block Label",
+ "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
},
- "browser_profile_id": {
+ "block_type": {
+ "type": "string",
+ "const": "email_inbox",
+ "title": "Block Type",
+ "default": "email_inbox"
+ },
+ "output_parameter": {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ "continue_on_failure": {
+ "type": "boolean",
+ "title": "Continue On Failure",
+ "default": false
+ },
+ "model": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Browser Profile Id",
- "description": "ID of a browser profile to reuse for this run"
+ "title": "Model"
},
- "browser_address": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
+ "disable_cache": {
+ "type": "boolean",
+ "title": "Disable Cache",
+ "default": false
+ },
+ "ignore_workflow_system_prompt": {
+ "type": "boolean",
+ "title": "Ignore Workflow System Prompt",
+ "default": false
+ },
+ "next_loop_on_failure": {
+ "type": "boolean",
+ "title": "Next Loop On Failure",
+ "default": false
+ },
+ "email_client": {
+ "type": "string",
+ "enum": [
+ "gmail",
+ "outlook"
],
- "title": "Browser Address",
- "description": "The CDP address for the task.",
- "examples": [
- "http://127.0.0.1:9222",
- "ws://127.0.0.1:9222/devtools/browser/1234567890"
- ]
+ "title": "Email Client"
},
- "extra_http_headers": {
+ "credential_id": {
"anyOf": [
{
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Extra Http Headers",
- "description": "Additional HTTP headers to include in requests"
+ "title": "Credential Id"
},
- "cdp_connect_headers": {
+ "folder": {
"anyOf": [
{
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Cdp Connect Headers",
- "description": "HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites."
+ "title": "Folder"
},
- "max_screenshot_scrolling_times": {
+ "prompt": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Max Screenshot Scrolling Times",
- "description": "Maximum number of times to scroll for screenshots"
- },
- "navigation_goal": {
- "type": "string",
- "title": "Navigation Goal",
- "description": "Instructions for navigating to and downloading the file"
+ "title": "Prompt"
},
- "download_suffix": {
+ "sender": {
"anyOf": [
{
"type": "string"
@@ -10126,22 +12181,20 @@
"type": "null"
}
],
- "title": "Download Suffix",
- "description": "Suffix or complete filename for the downloaded file"
+ "title": "Sender"
},
- "download_timeout": {
+ "subject": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Download Timeout",
- "description": "Timeout in seconds for the download operation"
+ "title": "Subject"
},
- "max_steps_per_run": {
+ "newer_than_days": {
"anyOf": [
{
"type": "integer"
@@ -10150,22 +12203,97 @@
"type": "null"
}
],
- "title": "Max Steps Per Run",
- "description": "Maximum number of steps to execute"
+ "title": "Newer Than Days"
+ },
+ "max_results": {
+ "type": "integer",
+ "title": "Max Results",
+ "default": 25
+ },
+ "include_body": {
+ "type": "boolean",
+ "title": "Include Body",
+ "default": true
+ },
+ "parameters": {
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowParameter"
+ },
+ {
+ "$ref": "#/components/schemas/ContextParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AWSSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSecretParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenLoginCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenSensitiveInformationParameter"
+ },
+ {
+ "$ref": "#/components/schemas/BitwardenCreditCardDataParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OnePasswordCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/AzureVaultCredentialParameter"
+ },
+ {
+ "$ref": "#/components/schemas/OutputParameter"
+ },
+ {
+ "$ref": "#/components/schemas/CredentialParameter"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "parameter_type",
+ "mapping": {
+ "aws_secret": "#/components/schemas/AWSSecretParameter",
+ "azure_secret": "#/components/schemas/AzureSecretParameter",
+ "azure_vault_credential": "#/components/schemas/AzureVaultCredentialParameter",
+ "bitwarden_credit_card_data": "#/components/schemas/BitwardenCreditCardDataParameter",
+ "bitwarden_login_credential": "#/components/schemas/BitwardenLoginCredentialParameter",
+ "bitwarden_sensitive_information": "#/components/schemas/BitwardenSensitiveInformationParameter",
+ "context": "#/components/schemas/ContextParameter",
+ "credential": "#/components/schemas/CredentialParameter",
+ "onepassword": "#/components/schemas/OnePasswordCredentialParameter",
+ "output": "#/components/schemas/OutputParameter",
+ "workflow": "#/components/schemas/WorkflowParameter"
+ }
+ }
+ },
+ "type": "array",
+ "title": "Parameters",
+ "default": []
}
},
"type": "object",
"required": [
- "navigation_goal"
+ "label",
+ "output_parameter",
+ "email_client"
],
- "title": "DownloadFilesRequest"
+ "title": "EmailInboxBlock"
},
- "DownloadToS3Block": {
+ "EmailInboxBlockYAML": {
"properties": {
+ "block_type": {
+ "type": "string",
+ "const": "email_inbox",
+ "title": "Block Type",
+ "default": "email_inbox"
+ },
"label": {
"type": "string",
"title": "Label",
- "description": "Author-facing identifier for a block; unique within a workflow."
+ "description": "Author-facing identifier; must be unique per workflow."
},
"next_block_label": {
"anyOf": [
@@ -10177,16 +12305,7 @@
}
],
"title": "Next Block Label",
- "description": "Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted."
- },
- "block_type": {
- "type": "string",
- "const": "download_to_s3",
- "title": "Block Type",
- "default": "download_to_s3"
- },
- "output_parameter": {
- "$ref": "#/components/schemas/OutputParameter"
+ "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
},
"continue_on_failure": {
"type": "boolean",
@@ -10205,11 +12324,6 @@
],
"title": "Model"
},
- "disable_cache": {
- "type": "boolean",
- "title": "Disable Cache",
- "default": false
- },
"ignore_workflow_system_prompt": {
"type": "boolean",
"title": "Ignore Workflow System Prompt",
@@ -10220,33 +12334,59 @@
"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": {
+ "email_client": {
"type": "string",
- "const": "download_to_s3",
- "title": "Block Type",
- "default": "download_to_s3"
+ "enum": [
+ "gmail",
+ "outlook"
+ ],
+ "title": "Email Client"
},
- "label": {
- "type": "string",
- "title": "Label",
- "description": "Author-facing identifier; must be unique per workflow."
+ "credential_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Credential Id"
+ },
+ "folder": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Folder"
+ },
+ "prompt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Prompt"
+ },
+ "sender": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sender"
},
- "next_block_label": {
+ "subject": {
"anyOf": [
{
"type": "string"
@@ -10255,47 +12395,50 @@
"type": "null"
}
],
- "title": "Next Block Label",
- "description": "Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]."
- },
- "continue_on_failure": {
- "type": "boolean",
- "title": "Continue On Failure",
- "default": false
+ "title": "Subject"
},
- "model": {
+ "newer_than_days": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Model"
+ "title": "Newer Than Days"
},
- "ignore_workflow_system_prompt": {
- "type": "boolean",
- "title": "Ignore Workflow System Prompt",
- "default": false
+ "max_results": {
+ "type": "integer",
+ "title": "Max Results",
+ "default": 25
},
- "next_loop_on_failure": {
+ "include_body": {
"type": "boolean",
- "title": "Next Loop On Failure",
- "default": false
+ "title": "Include Body",
+ "default": true
},
- "url": {
- "type": "string",
- "title": "Url"
+ "parameter_keys": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Parameter Keys"
}
},
"type": "object",
"required": [
"label",
- "url"
+ "email_client"
],
- "title": "DownloadToS3BlockYAML"
+ "title": "EmailInboxBlockYAML"
},
"Extensions": {
"type": "string",
@@ -11644,7 +13787,8 @@
"enum": [
"s3",
"azure",
- "google_drive"
+ "google_drive",
+ "sftp"
],
"title": "FileStorageType"
},
@@ -11656,7 +13800,8 @@
"excel",
"pdf",
"image",
- "docx"
+ "docx",
+ "zip"
],
"title": "FileType"
},
@@ -11823,6 +13968,106 @@
],
"title": "Google Drive Folder Id"
},
+ "sftp_host": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Host"
+ },
+ "sftp_port": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Port"
+ },
+ "sftp_username": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Username"
+ },
+ "sftp_password": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Password"
+ },
+ "sftp_private_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Private Key"
+ },
+ "sftp_private_key_passphrase": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Private Key Passphrase"
+ },
+ "sftp_remote_path": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Remote Path"
+ },
+ "sftp_host_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Host Key"
+ },
+ "prompt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Prompt",
+ "description": "Optional natural-language control over which downloaded files are uploaded; empty means upload all."
+ },
"path": {
"anyOf": [
{
@@ -11833,6 +14078,12 @@
}
],
"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",
@@ -12008,6 +14259,106 @@
],
"title": "Google Drive Folder Id"
},
+ "sftp_host": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Host"
+ },
+ "sftp_port": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Port"
+ },
+ "sftp_username": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Username"
+ },
+ "sftp_password": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Password"
+ },
+ "sftp_private_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Private Key"
+ },
+ "sftp_private_key_passphrase": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Private Key Passphrase"
+ },
+ "sftp_remote_path": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Remote Path"
+ },
+ "sftp_host_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sftp Host Key"
+ },
+ "prompt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Prompt",
+ "description": "Optional natural-language control over which downloaded files are uploaded; empty means upload all."
+ },
"path": {
"anyOf": [
{
@@ -12286,8 +14637,17 @@
{
"$ref": "#/components/schemas/GoogleSheetsReadBlock"
},
+ {
+ "$ref": "#/components/schemas/EmailInboxBlock"
+ },
{
"$ref": "#/components/schemas/GoogleSheetsWriteBlock"
+ },
+ {
+ "$ref": "#/components/schemas/PdfFillBlock"
+ },
+ {
+ "$ref": "#/components/schemas/SplitPdfBlock"
}
],
"discriminator": {
@@ -12297,6 +14657,7 @@
"code": "#/components/schemas/CodeBlock",
"conditional": "#/components/schemas/ConditionalBlock",
"download_to_s3": "#/components/schemas/DownloadToS3Block",
+ "email_inbox": "#/components/schemas/EmailInboxBlock",
"extraction": "#/components/schemas/ExtractionBlock",
"file_download": "#/components/schemas/FileDownloadBlock",
"file_upload": "#/components/schemas/FileUploadBlock",
@@ -12309,9 +14670,11 @@
"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",
+ "split_pdf": "#/components/schemas/SplitPdfBlock",
"task": "#/components/schemas/TaskBlock",
"task_v2": "#/components/schemas/TaskV2Block",
"text_prompt": "#/components/schemas/TextPromptBlock",
@@ -12554,12 +14917,21 @@
{
"$ref": "#/components/schemas/PrintPageBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/PdfFillBlockYAML"
+ },
+ {
+ "$ref": "#/components/schemas/SplitPdfBlockYAML"
+ },
{
"$ref": "#/components/schemas/WorkflowTriggerBlockYAML"
},
{
"$ref": "#/components/schemas/GoogleSheetsReadBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/EmailInboxBlockYAML"
+ },
{
"$ref": "#/components/schemas/GoogleSheetsWriteBlockYAML"
}
@@ -13454,6 +15826,20 @@
"title": "Save Response As File",
"default": false
},
+ "secret_response_paths": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Secret Response Paths"
+ },
"parameters": {
"items": {
"oneOf": [
@@ -13641,18 +16027,32 @@
"download_filename": {
"anyOf": [
{
- "type": "string"
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Download Filename"
+ },
+ "save_response_as_file": {
+ "type": "boolean",
+ "title": "Save Response As File",
+ "default": false
+ },
+ "secret_response_paths": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Download Filename"
- },
- "save_response_as_file": {
- "type": "boolean",
- "title": "Save Response As File",
- "default": false
+ "title": "Secret Response Paths"
},
"parameter_keys": {
"anyOf": [
@@ -14307,7 +16707,7 @@
"type": "number",
"title": "Timeout",
"description": "Timeout in milliseconds",
- "default": 5000
+ "default": 10000
}
},
"type": "object",
@@ -15710,6 +18110,56 @@
"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",
@@ -16137,21 +18587,225 @@
},
"type": "object",
"required": [
- "key"
- ],
- "title": "OutputParameterYAML"
- },
- "PDFFormat": {
- "type": "string",
- "enum": [
- "A4",
- "Letter",
- "Legal",
- "Tabloid"
+ "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": [
+ ]
+ },
+ "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": [
+ "+14155550123"
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "username"
],
- "title": "PDFFormat"
+ "title": "PasswordCredentialResponse",
+ "description": "Response model for password credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include password or TOTP secret."
},
- "PDFParserBlock": {
+ "PdfFillBlock": {
"properties": {
"label": {
"type": "string",
@@ -16172,9 +18826,9 @@
},
"block_type": {
"type": "string",
- "const": "pdf_parser",
+ "const": "pdf_fill",
"title": "Block Type",
- "default": "pdf_parser"
+ "default": "pdf_fill"
},
"output_parameter": {
"$ref": "#/components/schemas/OutputParameter"
@@ -16215,35 +18869,115 @@
"type": "string",
"title": "File Url"
},
- "json_schema": {
+ "prompt": {
+ "type": "string",
+ "title": "Prompt"
+ },
+ "payload": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
{
"type": "null"
}
],
- "title": "Json Schema"
+ "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"
+ "file_url",
+ "prompt"
],
- "title": "PDFParserBlock",
- "description": "DEPRECATED: Use FileParserBlock with file_type=FileType.PDF instead.\nThis block will be removed in a future version."
+ "title": "PdfFillBlock"
},
- "PDFParserBlockYAML": {
+ "PdfFillBlockYAML": {
"properties": {
"block_type": {
"type": "string",
- "const": "pdf_parser",
+ "const": "pdf_fill",
"title": "Block Type",
- "default": "pdf_parser"
+ "default": "pdf_fill"
},
"label": {
"type": "string",
@@ -16293,45 +19027,30 @@
"type": "string",
"title": "File Url"
},
- "json_schema": {
+ "prompt": {
+ "type": "string",
+ "title": "Prompt"
+ },
+ "payload": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
{
"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": [
- ]
- },
- "totp_type": {
- "$ref": "#/components/schemas/TotpType",
- "description": "Type of 2FA method used for this credential",
- "default": "none",
- "examples": [
- "authenticator"
- ]
+ "title": "Payload"
},
- "totp_identifier": {
+ "llm_key": {
"anyOf": [
{
"type": "string"
@@ -16340,20 +19059,30 @@
"type": "null"
}
],
- "title": "Totp Identifier",
- "description": "Identifier (email or phone number) used to fetch TOTP codes",
- "examples": [
- "+14155550123"
- ]
+ "title": "Llm Key"
+ },
+ "parameter_keys": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Parameter Keys"
}
},
"type": "object",
"required": [
- "username"
+ "label",
+ "file_url",
+ "prompt"
],
- "title": "PasswordCredentialResponse",
- "description": "Response model for password credentials — non-sensitive fields only.\n\nSECURITY: Must NEVER include password or TOTP secret."
+ "title": "PdfFillBlockYAML"
},
"PersistentBrowserType": {
"type": "string",
@@ -16885,24 +19614,115 @@
},
"type": "object",
"required": [
- "workflow_run_id"
+ "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"
+ },
+ "RunTagHistoryResponse": {
+ "properties": {
+ "workflow_run_id": {
+ "type": "string",
+ "title": "Workflow Run Id"
+ },
+ "events": {
+ "items": {
+ "$ref": "#/components/schemas/TagHistoryItem"
+ },
+ "type": "array",
+ "title": "Events"
+ }
+ },
+ "type": "object",
+ "required": [
+ "workflow_run_id",
+ "events"
+ ],
+ "title": "RunTagHistoryResponse"
+ },
+ "RunTagsBatchRequest": {
+ "properties": {
+ "workflow_run_ids": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Workflow Run Ids",
+ "description": "Workflow run IDs to fetch tags for."
+ }
+ },
+ "type": "object",
+ "title": "RunTagsBatchRequest",
+ "description": "Body for ``POST /v1/run-tags`` (used when the run-id list would exceed\nthe URL length cap)."
+ },
+ "RunTagsBatchResponse": {
+ "properties": {
+ "run_tags": {
+ "additionalProperties": {
+ "items": {
+ "$ref": "#/components/schemas/TagItem"
+ },
+ "type": "array"
+ },
+ "type": "object",
+ "title": "Run Tags"
+ }
+ },
+ "type": "object",
+ "required": [
+ "run_tags"
+ ],
+ "title": "RunTagsBatchResponse",
+ "description": "Response for the run-tags batch endpoint.\n\nRuns with no tags are present with an empty list so the frontend can\ndistinguish \"fetched, none set\" from \"not fetched\" without a second call.\nRuns outside the caller's org are silently absent (no leakage)."
+ },
+ "RunTagsResponse": {
+ "properties": {
+ "workflow_run_id": {
+ "type": "string",
+ "title": "Workflow Run Id"
+ },
+ "tags": {
+ "items": {
+ "$ref": "#/components/schemas/TagResponse"
+ },
+ "type": "array",
+ "title": "Tags"
+ }
+ },
+ "type": "object",
+ "required": [
+ "workflow_run_id",
+ "tags"
],
- "title": "RunSdkActionResponse",
- "description": "Response from running an SDK action."
+ "title": "RunTagsResponse",
+ "description": "Current tags for a workflow run."
},
- "RunStatus": {
+ "RunType": {
"type": "string",
"enum": [
- "created",
- "queued",
- "running",
- "timed_out",
- "failed",
- "terminated",
- "completed",
- "canceled"
+ "task_v1",
+ "task_v2",
+ "workflow_run",
+ "openai_cua",
+ "anthropic_cua",
+ "ui_tars",
+ "yutori_navigator"
],
- "title": "RunStatus"
+ "title": "RunType"
},
"RunWebhookReplayResponse": {
"properties": {
@@ -17305,7 +20125,7 @@
"type": "number",
"title": "Timeout",
"description": "Timeout in milliseconds",
- "default": 5000
+ "default": 10000
}
},
"type": "object",
@@ -17514,7 +20334,254 @@
"type": "string",
"title": "Body"
},
- "file_attachments": {
+ "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"
+ },
+ "SplitPdfBlock": {
+ "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": "split_pdf",
+ "title": "Block Type",
+ "default": "split_pdf"
+ },
+ "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"
+ },
+ "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": "SplitPdfBlock"
+ },
+ "SplitPdfBlockYAML": {
+ "properties": {
+ "block_type": {
+ "type": "string",
+ "const": "split_pdf",
+ "title": "Block Type",
+ "default": "split_pdf"
+ },
+ "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"
+ },
+ "llm_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Llm Key"
+ },
+ "parameter_keys": {
"anyOf": [
{
"items": {
@@ -17526,22 +20593,16 @@
"type": "null"
}
],
- "title": "File Attachments"
+ "title": "Parameter Keys"
}
},
"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"
+ "file_url",
+ "prompt"
],
- "title": "SendEmailBlockYAML"
+ "title": "SplitPdfBlockYAML"
},
"TOTPCode": {
"properties": {
@@ -17845,6 +20906,21 @@
"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",
@@ -18065,6 +21141,16 @@
"removed_from_workflow_count": {
"type": "integer",
"title": "Removed From Workflow Count"
+ },
+ "removed_from_run_count": {
+ "type": "integer",
+ "title": "Removed From Run Count",
+ "default": 0
+ },
+ "removed_count": {
+ "type": "integer",
+ "title": "Removed Count",
+ "default": 0
}
},
"type": "object",
@@ -18135,6 +21221,156 @@
"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"
+ },
+ "removed_from_run_count": {
+ "type": "integer",
+ "title": "Removed From Run Count",
+ "default": 0
+ },
+ "removed_count": {
+ "type": "integer",
+ "title": "Removed Count",
+ "default": 0
+ }
+ },
+ "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": {
@@ -20610,7 +23846,7 @@
"type": "number",
"title": "Timeout",
"description": "Timeout in milliseconds",
- "default": 5000
+ "default": 10000
}
},
"type": "object",
@@ -21164,8 +24400,8 @@
},
"confidence_float": {
"type": "number",
- "maximum": 1.0,
- "minimum": 0.0,
+ "maximum": 1,
+ "minimum": 0,
"title": "Confidence Float"
},
"error_type": {
@@ -21516,6 +24752,11 @@
"type": "boolean",
"title": "Include Extracted Text",
"default": true
+ },
+ "without_page_information": {
+ "type": "boolean",
+ "title": "Without Page Information",
+ "default": false
}
},
"type": "object",
@@ -21631,6 +24872,11 @@
"type": "boolean",
"title": "Disable Cache",
"default": false
+ },
+ "without_page_information": {
+ "type": "boolean",
+ "title": "Without Page Information",
+ "default": false
}
},
"type": "object",
@@ -22015,8 +25261,17 @@
{
"$ref": "#/components/schemas/GoogleSheetsReadBlock"
},
+ {
+ "$ref": "#/components/schemas/EmailInboxBlock"
+ },
{
"$ref": "#/components/schemas/GoogleSheetsWriteBlock"
+ },
+ {
+ "$ref": "#/components/schemas/PdfFillBlock"
+ },
+ {
+ "$ref": "#/components/schemas/SplitPdfBlock"
}
],
"discriminator": {
@@ -22026,6 +25281,7 @@
"code": "#/components/schemas/CodeBlock",
"conditional": "#/components/schemas/ConditionalBlock",
"download_to_s3": "#/components/schemas/DownloadToS3Block",
+ "email_inbox": "#/components/schemas/EmailInboxBlock",
"extraction": "#/components/schemas/ExtractionBlock",
"file_download": "#/components/schemas/FileDownloadBlock",
"file_upload": "#/components/schemas/FileUploadBlock",
@@ -22038,9 +25294,11 @@
"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",
+ "split_pdf": "#/components/schemas/SplitPdfBlock",
"task": "#/components/schemas/TaskBlock",
"task_v2": "#/components/schemas/TaskV2Block",
"text_prompt": "#/components/schemas/TextPromptBlock",
@@ -22211,12 +25469,21 @@
{
"$ref": "#/components/schemas/PrintPageBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/PdfFillBlockYAML"
+ },
+ {
+ "$ref": "#/components/schemas/SplitPdfBlockYAML"
+ },
{
"$ref": "#/components/schemas/WorkflowTriggerBlockYAML"
},
{
"$ref": "#/components/schemas/GoogleSheetsReadBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/EmailInboxBlockYAML"
+ },
{
"$ref": "#/components/schemas/GoogleSheetsWriteBlockYAML"
}
@@ -22338,6 +25605,11 @@
"title": "Persist Browser Session",
"default": false
},
+ "pin_saved_session_ip": {
+ "type": "boolean",
+ "title": "Pin Saved Session Ip",
+ "default": false
+ },
"browser_profile_id": {
"anyOf": [
{
@@ -22349,6 +25621,17 @@
],
"title": "Browser Profile Id"
},
+ "browser_profile_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Profile Key"
+ },
"model": {
"anyOf": [
{
@@ -22441,6 +25724,11 @@
"title": "Adaptive Caching",
"default": false
},
+ "enable_self_healing": {
+ "type": "boolean",
+ "title": "Enable Self Healing",
+ "default": false
+ },
"code_version": {
"anyOf": [
{
@@ -22523,6 +25811,11 @@
],
"title": "Edited By"
},
+ "copilot_authored": {
+ "type": "boolean",
+ "title": "Copilot Authored",
+ "default": false
+ },
"created_at": {
"type": "string",
"format": "date-time",
@@ -22640,6 +25933,11 @@
"title": "Persist Browser Session",
"default": false
},
+ "pin_saved_session_ip": {
+ "type": "boolean",
+ "title": "Pin Saved Session Ip",
+ "default": false
+ },
"browser_profile_id": {
"anyOf": [
{
@@ -22651,6 +25949,17 @@
],
"title": "Browser Profile Id"
},
+ "browser_profile_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Browser Profile Key"
+ },
"model": {
"anyOf": [
{
@@ -22686,8 +25995,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 480.0,
- "minimum": 1.0
+ "maximum": 480,
+ "minimum": 1
},
{
"type": "null"
@@ -22754,12 +26063,23 @@
"title": "Adaptive Caching",
"default": false
},
+ "enable_self_healing": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Enable Self Healing"
+ },
"code_version": {
"anyOf": [
{
"type": "integer",
- "maximum": 2.0,
- "minimum": 1.0
+ "maximum": 2,
+ "minimum": 1
},
{
"type": "null"
@@ -22952,8 +26272,17 @@
{
"$ref": "#/components/schemas/GoogleSheetsReadBlock"
},
+ {
+ "$ref": "#/components/schemas/EmailInboxBlock"
+ },
{
"$ref": "#/components/schemas/GoogleSheetsWriteBlock"
+ },
+ {
+ "$ref": "#/components/schemas/PdfFillBlock"
+ },
+ {
+ "$ref": "#/components/schemas/SplitPdfBlock"
}
],
"discriminator": {
@@ -22963,6 +26292,7 @@
"code": "#/components/schemas/CodeBlock",
"conditional": "#/components/schemas/ConditionalBlock",
"download_to_s3": "#/components/schemas/DownloadToS3Block",
+ "email_inbox": "#/components/schemas/EmailInboxBlock",
"extraction": "#/components/schemas/ExtractionBlock",
"file_download": "#/components/schemas/FileDownloadBlock",
"file_upload": "#/components/schemas/FileUploadBlock",
@@ -22975,9 +26305,11 @@
"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",
+ "split_pdf": "#/components/schemas/SplitPdfBlock",
"task": "#/components/schemas/TaskBlock",
"task_v2": "#/components/schemas/TaskV2Block",
"text_prompt": "#/components/schemas/TextPromptBlock",
@@ -23039,9 +26371,15 @@
"WorkflowDefinitionYAML": {
"properties": {
"version": {
- "type": "integer",
- "title": "Version",
- "default": 1
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Version"
},
"parameters": {
"items": {
@@ -23171,12 +26509,21 @@
{
"$ref": "#/components/schemas/PrintPageBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/PdfFillBlockYAML"
+ },
+ {
+ "$ref": "#/components/schemas/SplitPdfBlockYAML"
+ },
{
"$ref": "#/components/schemas/WorkflowTriggerBlockYAML"
},
{
"$ref": "#/components/schemas/GoogleSheetsReadBlockYAML"
},
+ {
+ "$ref": "#/components/schemas/EmailInboxBlockYAML"
+ },
{
"$ref": "#/components/schemas/GoogleSheetsWriteBlockYAML"
}
@@ -23188,6 +26535,7 @@
"code": "#/components/schemas/CodeBlockYAML",
"conditional": "#/components/schemas/ConditionalBlockYAML",
"download_to_s3": "#/components/schemas/DownloadToS3BlockYAML",
+ "email_inbox": "#/components/schemas/EmailInboxBlockYAML",
"extraction": "#/components/schemas/ExtractionBlockYAML",
"file_download": "#/components/schemas/FileDownloadBlockYAML",
"file_upload": "#/components/schemas/FileUploadBlockYAML",
@@ -23200,9 +26548,11 @@
"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",
+ "split_pdf": "#/components/schemas/SplitPdfBlockYAML",
"task": "#/components/schemas/TaskBlockYAML",
"task_v2": "#/components/schemas/TaskV2BlockYAML",
"text_prompt": "#/components/schemas/TextPromptBlockYAML",
@@ -24227,6 +27577,17 @@
],
"title": "Body"
},
+ "prompt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Prompt"
+ },
"instructions": {
"anyOf": [
{
@@ -24313,6 +27674,17 @@
"type": "null"
}
]
+ },
+ "downloaded_file_count": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Downloaded File Count"
}
},
"type": "object",
@@ -24465,8 +27837,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 480.0,
- "minimum": 1.0
+ "maximum": 480,
+ "minimum": 1
},
{
"type": "null"
@@ -24710,8 +28082,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 480.0,
- "minimum": 1.0
+ "maximum": 480,
+ "minimum": 1
},
{
"type": "null"
@@ -25379,7 +28751,14 @@
"title": "Timezone"
},
"enabled": {
- "type": "boolean",
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Enabled",
"default": true
},
@@ -25782,4 +29161,4 @@
"x-fern-server-name": "Local"
}
]
-}
+}
\ No newline at end of file