@skyvern/client 1.0.24 → 1.0.55

package/dist/cjs/api/types/TagDeleteInput.d.ts

@@ -0,0 +1,10 @@
+/**
+ * One tag to soft-delete: a grouped tag by its ``key``, or a standalone label
+ * by its ``value`` (omit the key).
+ */
+export interface TagDeleteInput {
+    /** Group (key) to delete. Use for grouped tags. */
+    key?: string;
+    /** Label (value) to delete. Use for standalone labels. */
+    value?: string;
+}

package/dist/cjs/api/types/TagDeleteInput.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagHistoryItem.d.ts

@@ -0,0 +1,13 @@
+/**
+ * One row from ``GET /v1/workflows/{wpid}/tags/history``.
+ */
+export interface TagHistoryItem {
+    tag_event_id: string;
+    key?: string;
+    value?: string;
+    event_type: string;
+    source: string;
+    set_at: string;
+    set_by: string;
+    superseded_at?: string;
+}

package/dist/cjs/api/types/TagHistoryItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagHistoryResponse.d.ts

@@ -0,0 +1,5 @@
+import type * as Skyvern from "../index.js";
+export interface TagHistoryResponse {
+    workflow_permanent_id: string;
+    events: Skyvern.TagHistoryItem[];
+}

package/dist/cjs/api/types/TagHistoryResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagInput.d.ts

@@ -0,0 +1,10 @@
+/**
+ * One tag to set. ``value`` is the required label; ``key`` is the optional
+ * group — null for a standalone label, set for a grouped label (e.g. env:prod).
+ */
+export interface TagInput {
+    /** Optional group (key). Omit for a standalone label. */
+    key?: string;
+    /** Label (value). Always required. */
+    value: string;
+}

package/dist/cjs/api/types/TagInput.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagItem.d.ts

@@ -0,0 +1,8 @@
+/**
+ * A single tag (key + label) without per-tag attribution. ``key`` is null
+ * for a standalone label.
+ */
+export interface TagItem {
+    key?: string;
+    value: string;
+}

package/dist/cjs/api/types/TagItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagKey.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Tag-key registry entry.
+ */
+export interface TagKey {
+    key: string;
+    description?: string;
+    workflow_count?: number;
+}

package/dist/cjs/api/types/TagKey.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagKeyDeleteResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Response for ``DELETE /v1/tag-keys/{key}``.
+ */
+export interface TagKeyDeleteResponse {
+    key: string;
+    removed_from_workflow_count: number;
+    removed_from_run_count?: number;
+    removed_count?: number;
+}

package/dist/cjs/api/types/TagKeyDeleteResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Current state of one tag (``GET /v1/workflows/{wpid}/tags`` row).
+ * ``key`` is null for a standalone label.
+ */
+export interface TagResponse {
+    key?: string;
+    value: string;
+    source: string;
+    set_at: string;
+    set_by: string;
+}

package/dist/cjs/api/types/TagResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagValue.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Tag-value color registry entry: the palette color assigned to a grouped
+ * (key, value) pair.
+ */
+export interface TagValue {
+    key: string;
+    value: string;
+    color: string;
+    /** Number of non-deleted workflows currently carrying this (key, value) label. */
+    workflow_count?: number;
+}

package/dist/cjs/api/types/TagValue.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagValueDeleteResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Response for ``DELETE /v1/tag-values/{key}``.
+ */
+export interface TagValueDeleteResponse {
+    key: string;
+    value: string;
+    removed_from_workflow_count: number;
+    removed_from_run_count?: number;
+    removed_count?: number;
+}

package/dist/cjs/api/types/TagValueDeleteResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagValueRenameResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Response for ``PATCH /v1/tag-values/{key}/rename``: the renamed label with its
+ * carried-over color and the number of workflows re-tagged.
+ */
+export interface TagValueRenameResponse {
+    key: string;
+    value: string;
+    color: string;
+    renamed_workflow_count: number;
+}

package/dist/cjs/api/types/TagValueRenameResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TagsResponse.d.ts

@@ -0,0 +1,9 @@
+import type * as Skyvern from "../index.js";
+/**
+ * Current tags for a workflow. A list (not a key-map) so standalone labels,
+ * which have no key, are representable.
+ */
+export interface TagsResponse {
+    workflow_permanent_id: string;
+    tags: Skyvern.TagResponse[];
+}

package/dist/cjs/api/types/TagsResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskBlock.d.ts

@@ -8,6 +8,7 @@ export interface TaskBlock {
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
     disable_cache?: boolean;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     task_type?: string;
     url?: string;
@@ -29,6 +30,7 @@ export interface TaskBlock {
     complete_verification?: boolean;
     include_action_history_in_verification?: boolean;
     download_timeout?: number;
+    include_extracted_text?: boolean;
 }
 export declare namespace TaskBlock {
     type DataSchema = Record<string, unknown> | unknown[] | string;

package/dist/cjs/api/types/TaskBlockYaml.d.ts

@@ -6,6 +6,7 @@ export interface TaskBlockYaml {
     next_block_label?: string;
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     url?: string;
     title?: string;

package/dist/cjs/api/types/TaskRunListItem.d.ts

@@ -0,0 +1,18 @@
+import type * as Skyvern from "../index.js";
+/**
+ * Lightweight run-history item backed by the task_runs table.
+ */
+export interface TaskRunListItem {
+    task_run_id: string;
+    run_id: string;
+    task_run_type: string;
+    status: string;
+    title?: string;
+    started_at?: string;
+    finished_at?: string;
+    created_at: string;
+    workflow_permanent_id?: string;
+    workflow_deleted?: boolean;
+    script_run?: boolean;
+    trigger_type?: Skyvern.WorkflowRunTriggerType;
+}

package/dist/cjs/api/types/TaskRunListItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/{TaskRunRequest.d.ts → TaskRunRequestOutput.d.ts}

@@ -1,5 +1,5 @@
 import type * as Skyvern from "../index.js";
-export interface TaskRunRequest {
+export interface TaskRunRequestOutput {
     /**
      * The goal or task description for Skyvern to accomplish
      */
@@ -9,7 +9,7 @@ export interface TaskRunRequest {
      */
     url?: string;
     /**
-     * The engine that powers the agent task. The default value is `skyvern-2.0`, the latest Skyvern agent that performs pretty well with complex and multi-step tasks. `skyvern-1.0` is good for simple tasks like filling a form, or searching for information on Google. The `openai-cua` engine uses OpenAI's CUA model. The `anthropic-cua` uses Anthropic's Claude Sonnet 3.7 model with the computer use tool.
+     * The engine that powers the agent task. The default value is `skyvern-1.0`, which is good for simple tasks like filling a form, or searching for information on Google. `skyvern-2.0` remains available for existing V2 workflows and explicitly requested V2 task runs. The `openai-cua` engine uses OpenAI's CUA model. The `anthropic-cua` uses Anthropic's Claude Sonnet 3.7 model with the computer use tool.
      */
     engine?: Skyvern.RunEngine;
     /** The title for the task */
@@ -29,6 +29,7 @@ export interface TaskRunRequest {
      * - RESIDENTIAL_NZ: New Zealand
      * - RESIDENTIAL_PH: Philippines
      * - RESIDENTIAL_KR: South Korea
+     * - RESIDENTIAL_SA: Saudi Arabia
      * - RESIDENTIAL_ZA: South Africa
      * - RESIDENTIAL_AR: Argentina
      * - RESIDENTIAL_AU: Australia
@@ -45,13 +46,15 @@ export interface TaskRunRequest {
      * - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
      * - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
      * - NONE: No proxy
+     *
+     * For self-hosted deployments, you can pass a custom proxy URL as a dict: {"url": "http://user:password@proxy.example.com:8080"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool.
      *  Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
      */
-    proxy_location?: TaskRunRequest.ProxyLocation;
+    proxy_location?: TaskRunRequestOutput.ProxyLocation;
     /**
      * The schema for data to be extracted from the webpage. If you're looking for consistent data schema being returned by the agent, it's highly recommended to use https://json-schema.org/.
      */
-    data_extraction_schema?: TaskRunRequest.DataExtractionSchema;
+    data_extraction_schema?: TaskRunRequestOutput.DataExtractionSchema;
     /**
      * Custom mapping of error codes to error messages if Skyvern encounters an error.
      */
@@ -82,7 +85,9 @@ export interface TaskRunRequest {
     model?: Record<string, unknown>;
     /** The extra HTTP headers for the requests in browser. */
     extra_http_headers?: Record<string, string | undefined>;
-    /** Whether to publish this task as a reusable workflow. Only available for skyvern-2.0. */
+    /** HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites. */
+    cdp_connect_headers?: Record<string, string | undefined>;
+    /** Deprecated. Whether to publish a `skyvern-2.0` task as a reusable workflow. For backwards compatibility, this routes the request through the legacy `skyvern-2.0` publish path. Prefer creating reusable workflows through the workflow APIs. */
     publish_workflow?: boolean;
     /** Whether to include action history when verifying that the task is complete */
     include_action_history_in_verification?: boolean;
@@ -90,10 +95,10 @@ export interface TaskRunRequest {
     max_screenshot_scrolls?: number;
     /** The CDP address for the task. */
     browser_address?: string;
-    /** Whether to run the task with agent or code. */
+    /** Whether to run the task with agent or code. Null means use the default. */
     run_with?: string;
 }
-export declare namespace TaskRunRequest {
+export declare namespace TaskRunRequestOutput {
     /**
      *
      * Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -110,6 +115,7 @@ export declare namespace TaskRunRequest {
      * - RESIDENTIAL_NZ: New Zealand
      * - RESIDENTIAL_PH: Philippines
      * - RESIDENTIAL_KR: South Korea
+     * - RESIDENTIAL_SA: Saudi Arabia
      * - RESIDENTIAL_ZA: South Africa
      * - RESIDENTIAL_AR: Argentina
      * - RESIDENTIAL_AU: Australia
@@ -126,6 +132,8 @@ export declare namespace TaskRunRequest {
      * - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
      * - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
      * - NONE: No proxy
+     *
+     * For self-hosted deployments, you can pass a custom proxy URL as a dict: {"url": "http://user:password@proxy.example.com:8080"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool.
      *  Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
      */
     type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;

package/dist/cjs/api/types/TaskRunRequestOutput.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskRunResponse.d.ts

@@ -10,6 +10,8 @@ export interface TaskRunResponse {
     downloaded_files?: Skyvern.FileInfo[];
     /** URL to the recording of the run */
     recording_url?: string;
+    /** True when the recording exists but has been archived to cold storage and is not currently accessible. */
+    recording_archived?: boolean;
     /** List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot. */
     screenshot_urls?: string[];
     /** Reason for failure if the run failed or terminated */
@@ -39,7 +41,7 @@ export interface TaskRunResponse {
     /** Total number of steps executed in this run */
     step_count?: number;
     /** The original request parameters used to start this task run */
-    run_request?: Skyvern.TaskRunRequest;
+    run_request?: Skyvern.TaskRunRequestOutput;
 }
 export declare namespace TaskRunResponse {
     /**

package/dist/cjs/api/types/TaskV2Block.d.ts

@@ -8,6 +8,7 @@ export interface TaskV2Block {
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
     disable_cache?: boolean;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     prompt: string;
     url?: string;

package/dist/cjs/api/types/TaskV2BlockYaml.d.ts

@@ -5,6 +5,7 @@ export interface TaskV2BlockYaml {
     next_block_label?: string;
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     prompt: string;
     url?: string;

package/dist/cjs/api/types/TextPromptBlock.d.ts

@@ -8,6 +8,7 @@ export interface TextPromptBlock {
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
     disable_cache?: boolean;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     llm_key?: string;
     prompt: string;

package/dist/cjs/api/types/TextPromptBlockYaml.d.ts

@@ -5,6 +5,7 @@ export interface TextPromptBlockYaml {
     next_block_label?: string;
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     llm_key?: string;
     prompt: string;

package/dist/cjs/api/types/Thought.d.ts

@@ -19,6 +19,7 @@ export interface Thought {
     reasoning_token_count?: number;
     cached_token_count?: number;
     thought_cost?: number;
+    last_llm_model?: string;
     created_at: string;
     modified_at: string;
 }

package/dist/cjs/api/types/UploadToS3Block.d.ts

@@ -8,6 +8,7 @@ export interface UploadToS3Block {
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
     disable_cache?: boolean;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     path?: string;
 }

package/dist/cjs/api/types/UploadToS3BlockYaml.d.ts

@@ -5,6 +5,7 @@ export interface UploadToS3BlockYaml {
     next_block_label?: string;
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     path?: string;
 }

package/dist/cjs/api/types/UrlBlock.d.ts

@@ -8,6 +8,7 @@ export interface UrlBlock {
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
     disable_cache?: boolean;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     task_type?: string;
     url: string;
@@ -29,6 +30,7 @@ export interface UrlBlock {
     complete_verification?: boolean;
     include_action_history_in_verification?: boolean;
     download_timeout?: number;
+    include_extracted_text?: boolean;
 }
 export declare namespace UrlBlock {
     type DataSchema = Record<string, unknown> | unknown[] | string;

package/dist/cjs/api/types/UrlBlockYaml.d.ts

@@ -5,6 +5,7 @@ export interface UrlBlockYaml {
     next_block_label?: string;
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     url: string;
 }

package/dist/cjs/api/types/UserDefinedError.d.ts

@@ -2,4 +2,5 @@ export interface UserDefinedError {
     error_code: string;
     reasoning: string;
     confidence_float: number;
+    error_type?: "USER_DEFINED_ERROR";
 }

package/dist/cjs/api/types/ValidationBlock.d.ts

@@ -8,6 +8,7 @@ export interface ValidationBlock {
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
     disable_cache?: boolean;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     task_type?: string;
     url?: string;
@@ -29,6 +30,8 @@ export interface ValidationBlock {
     complete_verification?: boolean;
     include_action_history_in_verification?: boolean;
     download_timeout?: number;
+    include_extracted_text?: boolean;
+    without_page_information?: boolean;
 }
 export declare namespace ValidationBlock {
     type DataSchema = Record<string, unknown> | unknown[] | string;

package/dist/cjs/api/types/ValidationBlockYaml.d.ts

@@ -5,10 +5,12 @@ export interface ValidationBlockYaml {
     next_block_label?: string;
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     complete_criterion?: string;
     terminate_criterion?: string;
     error_code_mapping?: Record<string, string | undefined>;
     parameter_keys?: string[];
     disable_cache?: boolean;
+    without_page_information?: boolean;
 }

package/dist/cjs/api/types/WaitBlock.d.ts

@@ -8,6 +8,7 @@ export interface WaitBlock {
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
     disable_cache?: boolean;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     wait_sec: number;
     parameters?: Skyvern.WaitBlockParametersItem[];

package/dist/cjs/api/types/WaitBlockYaml.d.ts

@@ -5,6 +5,7 @@ export interface WaitBlockYaml {
     next_block_label?: string;
     continue_on_failure?: boolean;
     model?: Record<string, unknown>;
+    ignore_workflow_system_prompt?: boolean;
     next_loop_on_failure?: boolean;
     wait_sec?: number;
 }

package/dist/cjs/api/types/WhileLoopBlock.d.ts

@@ -0,0 +1,25 @@
+import type * as Skyvern from "../index.js";
+/**
+ * Loop block driven by a runtime condition. Iterates while ``condition`` evaluates truthy.
+ *
+ * Top-of-loop semantics: the condition is evaluated *before* each iteration (including the
+ * first). If the condition is false on the first check, the body never runs and the block
+ * returns success with an empty output list.
+ *
+ * Safety: the loop is capped at ``DEFAULT_MAX_LOOP_ITERATIONS`` (500). Reaching the cap is
+ * treated as a failure so that a misbehaving condition can never spin forever.
+ */
+export interface WhileLoopBlock {
+    /** Author-facing identifier for a block; unique within a workflow. */
+    label: string;
+    /** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
+    next_block_label?: string;
+    output_parameter: Skyvern.OutputParameter;
+    continue_on_failure?: boolean;
+    model?: Record<string, unknown>;
+    disable_cache?: boolean;
+    ignore_workflow_system_prompt?: boolean;
+    next_loop_on_failure?: boolean;
+    loop_blocks: Skyvern.WhileLoopBlockLoopBlocksItem[];
+    condition: Skyvern.WhileLoopBlockCondition;
+}

package/dist/cjs/api/types/WhileLoopBlock.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/WhileLoopBlockCondition.d.ts

@@ -0,0 +1,10 @@
+import type * as Skyvern from "../index.js";
+export type WhileLoopBlockCondition = Skyvern.WhileLoopBlockCondition.Jinja2Template | Skyvern.WhileLoopBlockCondition.Prompt;
+export declare namespace WhileLoopBlockCondition {
+    interface Jinja2Template extends Skyvern.JinjaBranchCriteria {
+        criteria_type: "jinja2_template";
+    }
+    interface Prompt extends Skyvern.PromptBranchCriteria {
+        criteria_type: "prompt";
+    }
+}

package/dist/cjs/api/types/WhileLoopBlockCondition.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });