Skip to content

Automate browser based workflows with AI

SKY-10574: follow the live frontier in copilot chat during a run (#6283)

Andrew Neilsonba003033a129
diff --git a/pyproject.toml b/pyproject.toml
index 08bd9230f..0e30c6a15 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[project]
name = "skyvern"
-version = "1.0.36"
+version = "1.0.37"
description = ""
authors = [{ name = "Skyvern AI", email = "[email protected]" }]
requires-python = ">=3.11,<3.14"
diff --git a/skyvern-frontend/src/components/SidebarTreeNav.tsx b/skyvern-frontend/src/components/SidebarTreeNav.tsx
index 17a700726..6e7aa2868 100644
--- a/skyvern-frontend/src/components/SidebarTreeNav.tsx
+++ b/skyvern-frontend/src/components/SidebarTreeNav.tsx
@@ -40,6 +40,7 @@ type SidebarNavItem = {
type Props = {
items: Array<SidebarNavItem>;
+ collapsed?: boolean;
};
const OPEN_GROUPS_STORAGE_KEY = "skyvern-sidebar-open-groups";
@@ -277,8 +278,9 @@ function CollapsedNavItem({
);
}
-function SidebarTreeNav({ items }: Props) {
- const collapsed = useSidebarStore((state) => state.collapsed);
+function SidebarTreeNav({ items, collapsed: collapsedOverride }: Props) {
+ const collapsedFromStore = useSidebarStore((state) => state.collapsed);
+ const collapsed = collapsedOverride ?? collapsedFromStore;
const isActive = useIsActive();
const openGroupsDidMountRef = useRef(false);
const expandedChildrenDidMountRef = useRef(false);
diff --git a/skyvern-frontend/src/routes/root/SideNav.test.tsx b/skyvern-frontend/src/routes/root/SideNav.test.tsx
index 15a3bdaae..187753a45 100644
--- a/skyvern-frontend/src/routes/root/SideNav.test.tsx
+++ b/skyvern-frontend/src/routes/root/SideNav.test.tsx
@@ -151,6 +151,20 @@ describe("SideNav", () => {
).toEqual(storedState);
});
+ it("renders expanded navigation when collapsed override is false despite store", () => {
+ useSidebarStore.setState({ collapsed: true });
+ setViewportHeight(1024);
+
+ render(
+ <MemoryRouter>
+ <SideNav collapsed={false} />
+ </MemoryRouter>,
+ );
+
+ expect(screen.getByRole("button", { name: /Agents/i })).toBeTruthy();
+ expect(screen.queryByTitle("Agents")).toBeNull();
+ });
+
it("shows clickable parent headers in collapsed popout menus", async () => {
useSidebarStore.setState({ collapsed: true });
diff --git a/skyvern-frontend/src/routes/root/SideNav.tsx b/skyvern-frontend/src/routes/root/SideNav.tsx
index 7ced2702e..84bcda84d 100644
--- a/skyvern-frontend/src/routes/root/SideNav.tsx
+++ b/skyvern-frontend/src/routes/root/SideNav.tsx
@@ -36,7 +36,11 @@ import { defaultWorkflowRequest } from "@/routes/workflows/defaultWorkflowReques
import { useCreateWorkflowMutation } from "@/routes/workflows/hooks/useCreateWorkflowMutation";
import { shouldDefaultRecipesOpen } from "./sidebarDefaults";
-function SideNav() {
+type Props = {
+ collapsed?: boolean;
+};
+
+function SideNav({ collapsed }: Props = {}) {
const createWorkflowMutation = useCreateWorkflowMutation();
const navItems: Array<SidebarNavItem> = [
{
@@ -228,7 +232,7 @@ function SideNav() {
},
];
- return <SidebarTreeNav items={navItems} />;
+ return <SidebarTreeNav items={navItems} collapsed={collapsed} />;
}
export { SideNav };
diff --git a/skyvern-frontend/src/routes/root/SidebarContent.tsx b/skyvern-frontend/src/routes/root/SidebarContent.tsx
index 7c147a043..0926d119d 100644
--- a/skyvern-frontend/src/routes/root/SidebarContent.tsx
+++ b/skyvern-frontend/src/routes/root/SidebarContent.tsx
@@ -41,7 +41,7 @@ function SidebarContent({ useCollapsedState }: Props) {
"px-3": !collapsed,
})}
>
- <SideNav />
+ <SideNav collapsed={collapsed} />
</div>
{!sidebarHidden ? <SidebarResourceLinks collapsed={collapsed} /> : null}
<div
@@ -54,20 +54,22 @@ function SidebarContent({ useCollapsedState }: Props) {
)}
>
{!collapsed ? <ThemeToggle /> : null}
- <Button
- size="icon"
- variant="ghost"
- className="size-8 text-neutral-500 hover:bg-neutral-200/70 hover:text-neutral-950 dark:hover:bg-white/[0.04] dark:hover:text-neutral-200"
- onClick={() => {
- setCollapsed(!collapsed);
- }}
- >
- {collapsed ? (
- <ChevronRightIcon className="h-6 w-6" />
- ) : (
- <ChevronLeftIcon className="hidden h-6 w-6 lg:block" />
- )}
- </Button>
+ {useCollapsedState ? (
+ <Button
+ size="icon"
+ variant="ghost"
+ className="size-8 text-neutral-500 hover:bg-neutral-200/70 hover:text-neutral-950 dark:hover:bg-white/[0.04] dark:hover:text-neutral-200"
+ onClick={() => {
+ setCollapsed(!collapsed);
+ }}
+ >
+ {collapsed ? (
+ <ChevronRightIcon className="h-6 w-6" />
+ ) : (
+ <ChevronLeftIcon className="h-6 w-6" />
+ )}
+ </Button>
+ ) : null}
</div>
</div>
);
diff --git a/skyvern-frontend/src/routes/workflows/copilot/NarrativeView.collapse.test.tsx b/skyvern-frontend/src/routes/workflows/copilot/NarrativeView.collapse.test.tsx
new file mode 100644
index 000000000..d627407f3
--- /dev/null
+++ b/skyvern-frontend/src/routes/workflows/copilot/NarrativeView.collapse.test.tsx
@@ -0,0 +1,108 @@
+// @vitest-environment jsdom
+
+import { cleanup, fireEvent, render, screen } from "@testing-library/react";
+import { afterEach, describe, expect, it } from "vitest";
+
+import { NarrativeView } from "./NarrativeView";
+import {
+ BlockState,
+ EMPTY_NARRATIVE,
+ TurnNarrativeState,
+} from "./narrativeState";
+
+const completedBlock = (label: string): BlockState => ({
+ workflowRunBlockId: `wrb_${label}`,
+ label,
+ blockType: "navigation",
+ state: "completed",
+ lastSeenIteration: 1,
+ activity: [],
+ startedAt: "2026-05-30T00:00:00Z",
+ endedAt: "2026-05-30T00:00:10Z",
+});
+
+const terminalBuildTurn = (): TurnNarrativeState => ({
+ ...EMPTY_NARRATIVE,
+ turnId: "turn-1",
+ turnIndex: 0,
+ mode: "build",
+ designStarted: true,
+ designEnded: true,
+ draft: { blockCount: 1, blockLabels: ["block_1"], summary: null },
+ blocks: [completedBlock("block_1")],
+ terminal: "response",
+ narrativeSummary: "Built it.",
+ startedAt: "2026-05-30T00:00:00Z",
+ endedAt: "2026-05-30T00:00:12Z",
+});
+
+const inFlightTurn = (): TurnNarrativeState => ({
+ ...EMPTY_NARRATIVE,
+ turnId: "turn-2",
+ turnIndex: 1,
+ mode: "build",
+ terminal: null,
+});
+
+const HEADLINE = "Built and tested the workflow";
+
+afterEach(() => {
+ cleanup();
+});
+
+describe("NarrativeView collapse default", () => {
+ it("rolls up a terminal turn to the summary card by default", () => {
+ render(<NarrativeView turn={terminalBuildTurn()} />);
+
+ expect(screen.getByText(HEADLINE)).toBeTruthy();
+ expect(
+ screen
+ .getByRole("button", { name: new RegExp(HEADLINE) })
+ .getAttribute("aria-expanded"),
+ ).toBe("false");
+ });
+
+ it("keeps the in-flight turn expanded in the detail view", () => {
+ render(<NarrativeView turn={inFlightTurn()} />);
+
+ expect(screen.queryByText(HEADLINE)).toBeNull();
+ expect(
+ screen.getByText("Waiting for the first block to start…"),
+ ).toBeTruthy();
+ });
+
+ it("expands on click and re-collapses via the same header control", () => {
+ render(<NarrativeView turn={terminalBuildTurn()} />);
+ const head = () =>
+ screen.getByRole("button", { name: new RegExp(HEADLINE) });
+
+ expect(head().getAttribute("aria-expanded")).toBe("false");
+
+ fireEvent.click(head());
+ expect(head().getAttribute("aria-expanded")).toBe("true");
+
+ fireEvent.click(head());
+ expect(head().getAttribute("aria-expanded")).toBe("false");
+ });
+
+ it("collapses on the in-flight to terminal transition", () => {
+ const { rerender } = render(<NarrativeView turn={inFlightTurn()} />);
+ expect(screen.queryByText(HEADLINE)).toBeNull();
+
+ rerender(<NarrativeView turn={terminalBuildTurn()} />);
+ expect(screen.getByText(HEADLINE)).toBeTruthy();
+ });
+
+ it("preserves a user's expand override across re-renders", () => {
+ const turn = terminalBuildTurn();
+ const { rerender } = render(<NarrativeView turn={turn} />);
+ const head = () =>
+ screen.getByRole("button", { name: new RegExp(HEADLINE) });
+
+ fireEvent.click(head());
+ expect(head().getAttribute("aria-expanded")).toBe("true");
+
+ rerender(<NarrativeView turn={turn} />);
+ expect(head().getAttribute("aria-expanded")).toBe("true");
+ });
+});
diff --git a/skyvern-frontend/src/routes/workflows/copilot/NarrativeView.tsx b/skyvern-frontend/src/routes/workflows/copilot/NarrativeView.tsx
index 86cd9c3d2..d37bfc3a9 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/NarrativeView.tsx
+++ b/skyvern-frontend/src/routes/workflows/copilot/NarrativeView.tsx
@@ -701,26 +701,14 @@ function DetailView({
interface NarrativeViewProps {
turn: TurnNarrativeState;
onBlockSelect?: (blockLabel: string) => void;
- // Past turns render rolled-up by default; the latest / in-flight turn
- // renders in detail. Parent decides via this flag.
- defaultExpanded?: boolean;
}
-export function NarrativeView({
- turn,
- onBlockSelect,
- defaultExpanded = true,
-}: NarrativeViewProps) {
+export function NarrativeView({ turn, onBlockSelect }: NarrativeViewProps) {
const summary = useMemo(() => computeTurnSummary(turn), [turn]);
const isInFlight = turn.terminal === null;
const isComplete = !isInFlight;
- const defaultRolled = isComplete && !defaultExpanded;
const [userRolled, setUserRolled] = useState<boolean | null>(null);
- const rolled = userRolled === null ? defaultRolled : userRolled;
-
- useEffect(() => {
- setUserRolled(null);
- }, [defaultExpanded]);
+ const rolled = userRolled === null ? isComplete : userRolled;
if (rolled && isComplete) {
return (
diff --git a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.queue.test.tsx b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.queue.test.tsx
index cfa94d7f2..88c22ec2c 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.queue.test.tsx
+++ b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.queue.test.tsx
@@ -157,6 +157,7 @@ async function completeOldestStream(message: string) {
beforeEach(() => {
// jsdom has no layout engine.
HTMLElement.prototype.scrollIntoView = vi.fn();
+ HTMLElement.prototype.scrollTo = vi.fn();
streamCalls.length = 0;
postStreaming.mockClear();
cancelPost.mockClear();
diff --git a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.scroll.test.tsx b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.scroll.test.tsx
new file mode 100644
index 000000000..c9bf44d06
--- /dev/null
+++ b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.scroll.test.tsx
@@ -0,0 +1,97 @@
+import {
+ cleanup,
+ fireEvent,
+ render,
+ screen,
+ waitFor,
+} from "@testing-library/react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+const jumpToLatest = vi.fn();
+const { hookState } = vi.hoisted(() => ({ hookState: { isPinned: true } }));
+
+vi.mock("./useStickToBottom", () => ({
+ useStickToBottom: () => ({
+ scrollRef: { current: null },
+ isPinned: hookState.isPinned,
+ jumpToLatest,
+ repin: vi.fn(),
+ }),
+ computeFollowSignature: () => "sig",
+}));
+
+vi.mock("@/api/sse", () => ({
+ getSseClient: vi.fn().mockResolvedValue({ postStreaming: vi.fn() }),
+}));
+
+vi.mock("@/api/AxiosClient", () => ({
+ getClient: vi.fn().mockResolvedValue({
+ get: vi.fn().mockResolvedValue({
+ data: {
+ workflow_copilot_chat_id: null,
+ chat_history: [],
+ proposed_workflow: null,
+ auto_accept: false,
+ },
+ }),
+ post: vi.fn().mockResolvedValue({}),
+ }),
+}));
+
+vi.mock("@/hooks/useCredentialGetter", () => ({
+ useCredentialGetter: () => null,
+}));
+
+vi.mock("@/components/ui/use-toast", () => ({ toast: vi.fn() }));
+
+vi.mock("react-router-dom", async (importOriginal) => {
+ const actual = await importOriginal<typeof import("react-router-dom")>();
+ return {
+ ...actual,
+ useParams: () => ({
+ workflowPermanentId: "wpid_1",
+ workflowRunId: undefined,
+ }),
+ };
+});
+
+vi.mock("@/store/WorkflowHasChangesStore", () => ({
+ useWorkflowHasChangesStore: () => ({ getSaveData: () => ({}) }),
+}));
+
+import { WorkflowCopilotChat } from "./WorkflowCopilotChat";
+
+async function renderChat() {
+ render(<WorkflowCopilotChat />);
+ await waitFor(() =>
+ expect(screen.getByPlaceholderText(/Type your message/)).toBeTruthy(),
+ );
+}
+
+beforeEach(() => {
+ HTMLElement.prototype.scrollIntoView = vi.fn();
+ HTMLElement.prototype.scrollTo = vi.fn();
+ jumpToLatest.mockClear();
+ hookState.isPinned = true;
+});
+
+afterEach(() => {
+ cleanup();
+});
+
+describe("WorkflowCopilotChat — Jump to latest pill", () => {
+ it("hides the pill while pinned", async () => {
+ hookState.isPinned = true;
+ await renderChat();
+ expect(screen.queryByText(/Jump to latest/)).toBeNull();
+ });
+
+ it("shows the pill while disengaged and wires the click to jumpToLatest", async () => {
+ hookState.isPinned = false;
+ await renderChat();
+ const pill = screen.getByText(/Jump to latest/);
+ expect(pill).toBeTruthy();
+ fireEvent.click(pill);
+ expect(jumpToLatest).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.tsx b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.tsx
index cd5e30721..7fda69d3c 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.tsx
+++ b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.tsx
@@ -2,6 +2,7 @@ import {
useState,
useEffect,
useLayoutEffect,
+ useMemo,
useRef,
useCallback,
memo,
@@ -9,7 +10,7 @@ import {
import { getClient } from "@/api/AxiosClient";
import { useCredentialGetter } from "@/hooks/useCredentialGetter";
import { useParams } from "react-router-dom";
-import { ReloadIcon, Cross2Icon } from "@radix-ui/react-icons";
+import { ReloadIcon, Cross2Icon, ChevronDownIcon } from "@radix-ui/react-icons";
import { stringify as convertToYAML } from "yaml";
import { useWorkflowHasChangesStore } from "@/store/WorkflowHasChangesStore";
import { WorkflowCreateYAMLRequest } from "@/routes/workflows/types/workflowYamlTypes";
@@ -51,6 +52,7 @@ import {
hydrateNarrativeFromPayload,
parseUtcIsoMs,
} from "./narrativeState";
+import { computeFollowSignature, useStickToBottom } from "./useStickToBottom";
// Cap on retained per-turn snap-back snapshots. A typical session has a
// handful of turns; this ceiling guards a runaway long-running chat.
@@ -371,11 +373,9 @@ export function WorkflowCopilotChat({
});
const credentialGetter = useCredentialGetter();
const { workflowRunId, workflowPermanentId } = useParams();
- const messagesEndRef = useRef<HTMLDivElement>(null);
const textareaRef = useRef<HTMLTextAreaElement>(null);
const { getSaveData } = useWorkflowHasChangesStore();
const hasInitializedPosition = useRef(false);
- const hasScrolledOnLoad = useRef(false);
const hasAutoSentRef = useRef(false);
const isWaitingForLiveBrowser = shouldWaitForLiveBrowser({
requiresLiveBrowser,
@@ -395,9 +395,27 @@ export function WorkflowCopilotChat({
// messages, and so auto-send has a synchronous "history loaded" gate.
const historyLoadedForRef = useRef<string | null>(null);
- const scrollToBottom = (behavior: ScrollBehavior) => {
- messagesEndRef.current?.scrollIntoView({ behavior });
- };
+ const followSignature = useMemo(
+ () =>
+ computeFollowSignature(
+ messages,
+ narrative,
+ isLoading,
+ isLoadingHistory,
+ queuedPrompt,
+ Boolean(proposedWorkflow),
+ ),
+ [
+ messages,
+ narrative,
+ isLoading,
+ isLoadingHistory,
+ queuedPrompt,
+ proposedWorkflow,
+ ],
+ );
+ const { scrollRef, isPinned, jumpToLatest, repin } =
+ useStickToBottom<HTMLDivElement>(followSignature, { enabled: isOpen });
const adjustTextareaHeight = useCallback(() => {
const textarea = textareaRef.current;
@@ -426,7 +444,7 @@ export function WorkflowCopilotChat({
turnSnapshots.current.clear();
pendingSubmitSnapshot.current = null;
latestTurnId.current = null;
- hasScrolledOnLoad.current = false;
+ repin();
};
const applyWorkflowUpdate = useCallback(
@@ -623,22 +641,6 @@ export function WorkflowCopilotChat({
}
}, [messages.length, onMessageCountChange]);
- useEffect(() => {
- if (!isOpen) {
- hasScrolledOnLoad.current = false;
- return;
- }
- if (isLoadingHistory) {
- return;
- }
- if (!hasScrolledOnLoad.current) {
- scrollToBottom("auto");
- hasScrolledOnLoad.current = true;
- return;
- }
- scrollToBottom("smooth");
- }, [messages, isLoading, isLoadingHistory, isOpen]);
-
useEffect(() => {
if (!workflowPermanentId) {
setMessages([]);
@@ -659,7 +661,7 @@ export function WorkflowCopilotChat({
const fetchHistory = async () => {
setIsLoadingHistory(true);
- hasScrolledOnLoad.current = false;
+ repin();
try {
const client = await getClient(credentialGetter, "sans-api-v1");
const response = await client.get<WorkflowCopilotChatHistoryResponse>(
@@ -715,7 +717,7 @@ export function WorkflowCopilotChat({
return () => {
isMounted = false;
};
- }, [credentialGetter, updateQueuedPrompt, workflowPermanentId]);
+ }, [credentialGetter, repin, updateQueuedPrompt, workflowPermanentId]);
const cancelSend = useCallback(async () => {
// Capture upfront so the 15s timer below can't latch onto a next turn's controller.
@@ -1533,156 +1535,166 @@ export function WorkflowCopilotChat({
</div>
{/* Messages */}
- <div className="flex-1 overflow-y-auto p-4">
- <div className="space-y-3">
- {!isLoadingHistory && messages.length === 0 && !isLoading ? (
- <div className="rounded-lg border border-neutral-200 bg-neutral-50 p-4 text-sm text-neutral-700 dark:border-neutral-800 dark:bg-neutral-900/60 dark:text-neutral-300">
- <p className="font-semibold text-neutral-900 dark:text-neutral-100">
- Start a new chat
- </p>
- <p className="mt-2 text-neutral-500 dark:text-neutral-400">
- Ask the copilot to draft or edit your agent. Provide a goal, the
- target site, and any credentials it should use.
- </p>
- <p className="mt-2 text-neutral-500 dark:text-neutral-400">
- Example: "Build an agent to find the top post on hackernews
- today"
- </p>
- </div>
- ) : null}
- <ConvoAggregatePill
- messages={messages}
- isInFlight={
- isLoading ||
- (narrative.turnId !== null && narrative.terminal === null)
- }
- />
- {messages.map((message, index) => {
- const isLastMessage = index === messages.length - 1;
- const showQueuedFooter =
- isQueuedPromptWaiting && message.id === queuedPrompt?.id;
- // Per-message frozen narrative. When an AI message carries a
- // frozen narrative, render the narrative card stack in place
- // of the legacy text bubble so the per-block cards survive
- // subsequent turns. The Accept/Reject controls render only on
- // the latest message AND while the proposal is pending review.
- if (message.sender === "ai" && message.narrative) {
- const showProposalActions =
- isLastMessage && Boolean(proposedWorkflow);
+ <div className="relative min-h-0 flex-1">
+ <div ref={scrollRef} className="h-full overflow-y-auto p-4">
+ <div className="space-y-3">
+ {!isLoadingHistory && messages.length === 0 && !isLoading ? (
+ <div className="rounded-lg border border-neutral-200 bg-neutral-50 p-4 text-sm text-neutral-700 dark:border-neutral-800 dark:bg-neutral-900/60 dark:text-neutral-300">
+ <p className="font-semibold text-neutral-900 dark:text-neutral-100">
+ Start a new chat
+ </p>
+ <p className="mt-2 text-neutral-500 dark:text-neutral-400">
+ Ask the copilot to draft or edit your agent. Provide a goal,
+ the target site, and any credentials it should use.
+ </p>
+ <p className="mt-2 text-neutral-500 dark:text-neutral-400">
+ Example: "Build an agent to find the top post on hackernews
+ today"
+ </p>
+ </div>
+ ) : null}
+ <ConvoAggregatePill
+ messages={messages}
+ isInFlight={
+ isLoading ||
+ (narrative.turnId !== null && narrative.terminal === null)
+ }
+ />
+ {messages.map((message, index) => {
+ const isLastMessage = index === messages.length - 1;
+ const showQueuedFooter =
+ isQueuedPromptWaiting && message.id === queuedPrompt?.id;
+ // Per-message frozen narrative. When an AI message carries a
+ // frozen narrative, render the narrative card stack in place
+ // of the legacy text bubble so the per-block cards survive
+ // subsequent turns. The Accept/Reject controls render only on
+ // the latest message AND while the proposal is pending review.
+ if (message.sender === "ai" && message.narrative) {
+ const showProposalActions =
+ isLastMessage && Boolean(proposedWorkflow);
+ return (
+ <div
+ key={message.id}
+ className="flex flex-col gap-2"
+ role="status"
+ aria-live="polite"
+ >
+ <NarrativeView
+ turn={message.narrative}
+ onBlockSelect={onBlockSelect}
+ />
+ {showProposalActions && proposedWorkflow ? (
+ <div className="flex flex-wrap gap-2 pl-1">
+ <button
+ type="button"
+ onClick={() => handleReviewWorkflow(proposedWorkflow)}
+ className="rounded border border-brand/60 bg-brand/10 px-3 py-1 text-xs text-foreground hover:bg-brand/20"
+ >
+ Review
+ </button>
+ <button
+ type="button"
+ onClick={() => handleAcceptWorkflow(proposedWorkflow)}
+ className="rounded bg-success px-3 py-1 text-xs text-success-foreground hover:bg-success/90"
+ >
+ Accept
+ </button>
+ <button
+ type="button"
+ onClick={() =>
+ handleAcceptWorkflow(proposedWorkflow, true)
+ }
+ className="rounded bg-success px-3 py-1 text-xs text-success-foreground hover:bg-success/80"
+ >
+ Always accept
+ </button>
+ <button
+ type="button"
+ onClick={handleRejectWorkflow}
+ className="rounded bg-destructive px-3 py-1 text-xs text-destructive-foreground hover:bg-destructive/90"
+ >
+ Reject
+ </button>
+ </div>
+ ) : null}
+ </div>
+ );
+ }
+ const showProposedPanel = isLastMessage && proposedWorkflow;
return (
- <div
+ <MessageItem
key={message.id}
- className="flex flex-col gap-2"
- role="status"
- aria-live="polite"
- >
- <NarrativeView
- turn={message.narrative}
- onBlockSelect={onBlockSelect}
- defaultExpanded={isLastMessage}
- />
- {showProposalActions && proposedWorkflow ? (
- <div className="flex flex-wrap gap-2 pl-1">
- <button
- type="button"
- onClick={() => handleReviewWorkflow(proposedWorkflow)}
- className="rounded border border-brand/60 bg-brand/10 px-3 py-1 text-xs text-foreground hover:bg-brand/20"
- >
- Review
- </button>
- <button
- type="button"
- onClick={() => handleAcceptWorkflow(proposedWorkflow)}
- className="rounded bg-success px-3 py-1 text-xs text-success-foreground hover:bg-success/90"
- >
- Accept
- </button>
- <button
- type="button"
- onClick={() =>
- handleAcceptWorkflow(proposedWorkflow, true)
- }
- className="rounded bg-success px-3 py-1 text-xs text-success-foreground hover:bg-success/80"
- >
- Always accept
- </button>
- <button
- type="button"
- onClick={handleRejectWorkflow}
- className="rounded bg-destructive px-3 py-1 text-xs text-destructive-foreground hover:bg-destructive/90"
- >
- Reject
- </button>
- </div>
- ) : null}
- </div>
+ message={message}
+ footer={
+ showQueuedFooter ? (
+ <div className="flex items-center gap-2 text-xs text-neutral-500 dark:text-neutral-400">
+ <ReloadIcon className="h-3 w-3 animate-spin" />
+ <span>{queuedPromptWaitingStatus}</span>
+ </div>
+ ) : showProposedPanel ? (
+ <>
+ <button
+ type="button"
+ onClick={() => handleReviewWorkflow(proposedWorkflow)}
+ className="rounded border border-neutral-300 bg-white px-3 py-1 text-xs text-neutral-900 hover:bg-neutral-50 dark:border-neutral-700 dark:bg-neutral-950 dark:text-neutral-100 dark:hover:bg-neutral-900"
+ >
+ Review
+ </button>
+ <button
+ type="button"
+ onClick={() => handleAcceptWorkflow(proposedWorkflow)}
+ className="rounded bg-green-600 px-3 py-1 text-xs text-white hover:bg-green-700"
+ >
+ Accept
+ </button>
+ <button
+ type="button"
+ onClick={() =>
+ handleAcceptWorkflow(proposedWorkflow, true)
+ }
+ className="rounded bg-emerald-600 px-3 py-1 text-xs text-white hover:bg-emerald-700"
+ >
+ Always accept
+ </button>
+ <button
+ type="button"
+ onClick={handleRejectWorkflow}
+ className="rounded bg-red-600 px-3 py-1 text-xs text-white hover:bg-red-700"
+ >
+ Reject
+ </button>
+ </>
+ ) : null
+ }
+ />
);
- }
- const showProposedPanel = isLastMessage && proposedWorkflow;
- return (
- <MessageItem
- key={message.id}
- message={message}
- footer={
- showQueuedFooter ? (
- <div className="flex items-center gap-2 text-xs text-neutral-500 dark:text-neutral-400">
- <ReloadIcon className="h-3 w-3 animate-spin" />
- <span>{queuedPromptWaitingStatus}</span>
- </div>
- ) : showProposedPanel ? (
- <>
- <button
- type="button"
- onClick={() => handleReviewWorkflow(proposedWorkflow)}
- className="rounded border border-neutral-300 bg-white px-3 py-1 text-xs text-neutral-900 hover:bg-neutral-50 dark:border-neutral-700 dark:bg-neutral-950 dark:text-neutral-100 dark:hover:bg-neutral-900"
- >
- Review
- </button>
- <button
- type="button"
- onClick={() => handleAcceptWorkflow(proposedWorkflow)}
- className="rounded bg-green-600 px-3 py-1 text-xs text-white hover:bg-green-700"
- >
- Accept
- </button>
- <button
- type="button"
- onClick={() =>
- handleAcceptWorkflow(proposedWorkflow, true)
- }
- className="rounded bg-emerald-600 px-3 py-1 text-xs text-white hover:bg-emerald-700"
- >
- Always accept
- </button>
- <button
- type="button"
- onClick={handleRejectWorkflow}
- className="rounded bg-red-600 px-3 py-1 text-xs text-white hover:bg-red-700"
- >
- Reject
- </button>
- </>
- ) : null
- }
- />
- );
- })}
- {/*
+ })}
+ {/*
Bottom in-flight narrative bubble. Suppressed once the terminal
RESPONSE has frozen the narrative into the latest AI message —
otherwise the same turn would render twice.
*/}
- {narrative.turnId !== null && narrative.terminal === null && (
- <div
- className="flex flex-col gap-2"
- role="status"
- aria-live="polite"
- >
- <NarrativeView turn={narrative} onBlockSelect={onBlockSelect} />
- </div>
- )}
- <div ref={messagesEndRef} />
+ {narrative.turnId !== null && narrative.terminal === null && (
+ <div
+ className="flex flex-col gap-2"
+ role="status"
+ aria-live="polite"
+ >
+ <NarrativeView turn={narrative} onBlockSelect={onBlockSelect} />
+ </div>
+ )}
+ </div>
</div>
+ {!isPinned ? (
+ <button
+ type="button"
+ onClick={jumpToLatest}
+ className="absolute bottom-4 left-1/2 flex -translate-x-1/2 items-center gap-1 rounded-full border border-neutral-300 bg-white px-3 py-1 text-xs text-neutral-700 shadow-md hover:bg-neutral-50 dark:border-neutral-700 dark:bg-neutral-900 dark:text-neutral-200 dark:hover:bg-neutral-800"
+ >
+ <ChevronDownIcon className="h-3 w-3" />
+ Jump to latest
+ </button>
+ ) : null}
</div>
{/* Input */}
diff --git a/skyvern-frontend/src/routes/workflows/copilot/useStickToBottom.test.tsx b/skyvern-frontend/src/routes/workflows/copilot/useStickToBottom.test.tsx
new file mode 100644
index 000000000..2596b498e
--- /dev/null
+++ b/skyvern-frontend/src/routes/workflows/copilot/useStickToBottom.test.tsx
@@ -0,0 +1,335 @@
+import { act, cleanup, fireEvent, renderHook } from "@testing-library/react";
+import { afterEach, describe, expect, it, vi } from "vitest";
+
+import { computeFollowSignature, useStickToBottom } from "./useStickToBottom";
+import {
+ EMPTY_NARRATIVE,
+ TurnNarrativeState,
+ applyNarrativeEvent,
+} from "./narrativeState";
+import {
+ WorkflowCopilotBlockProgressUpdate,
+ WorkflowCopilotNarrationUpdate,
+ WorkflowCopilotTurnStartUpdate,
+ WorkflowCopilotWorkflowDraftUpdate,
+} from "./workflowCopilotTypes";
+
+const turnStart = (): WorkflowCopilotTurnStartUpdate => ({
+ type: "turn_start",
+ turn_id: "turn-1",
+ turn_index: 0,
+ mode: "build",
+ timestamp: "2026-05-25T00:00:00Z",
+});
+
+const workflowDraft = (
+ overrides: Partial<WorkflowCopilotWorkflowDraftUpdate> = {},
+): WorkflowCopilotWorkflowDraftUpdate => ({
+ type: "workflow_draft",
+ block_count: 2,
+ block_labels: ["block_one", "block_two"],
+ summary: "two block workflow",
+ timestamp: "2026-05-25T00:00:03Z",
+ ...overrides,
+});
+
+const blockProgress = (
+ overrides: Partial<WorkflowCopilotBlockProgressUpdate> &
+ Pick<WorkflowCopilotBlockProgressUpdate, "block_label" | "status">,
+): WorkflowCopilotBlockProgressUpdate => ({
+ type: "block_progress",
+ workflow_run_block_id: `wrb_${overrides.block_label}`,
+ block_type: "task",
+ iteration: 0,
+ timestamp: "2026-05-25T00:00:04Z",
+ ...overrides,
+});
+
+const narration = (text: string): WorkflowCopilotNarrationUpdate => ({
+ type: "narration",
+ narration: text,
+ iteration: 0,
+ timestamp: "2026-05-25T00:00:04Z",
+});
+
+const sig = (narrative: TurnNarrativeState) =>
+ computeFollowSignature([], narrative, false, false, null, false);
+
+describe("computeFollowSignature", () => {
+ it("changes when a block is appended", () => {
+ const a = applyNarrativeEvent(EMPTY_NARRATIVE, turnStart());
+ const b = applyNarrativeEvent(
+ a,
+ blockProgress({ block_label: "one", status: "running" }),
+ );
+ expect(sig(a)).not.toBe(sig(b));
+ });
+
+ it("changes when activity grows on a running block", () => {
+ let s = applyNarrativeEvent(EMPTY_NARRATIVE, turnStart());
+ s = applyNarrativeEvent(
+ s,
+ blockProgress({ block_label: "one", status: "running" }),
+ );
+ const before = sig(s);
+ s = applyNarrativeEvent(s, narration("looking at the page"));
+ expect(sig(s)).not.toBe(before);
+ });
+
+ it("keeps changing after the activity cap is reached (rotated tail)", () => {
+ let s = applyNarrativeEvent(EMPTY_NARRATIVE, turnStart());
+ s = applyNarrativeEvent(
+ s,
+ blockProgress({ block_label: "one", status: "running" }),
+ );
+ // Fill well past MAX_ACTIVITY_ENTRIES so length is pinned at the cap.
+ for (let i = 0; i < 40; i++) {
+ s = applyNarrativeEvent(s, narration(`step ${i}`));
+ }
+ const atCap = sig(s);
+ const cappedBlock = s.blocks[0];
+ expect(cappedBlock).toBeDefined();
+ const cappedLength = cappedBlock!.activity.length;
+ s = applyNarrativeEvent(s, narration("one more step"));
+ // Length is unchanged at the cap, but the signature still moves.
+ expect(s.blocks[0]!.activity.length).toBe(cappedLength);
+ expect(sig(s)).not.toBe(atCap);
+ });
+
+ it("changes when a draft replaces labels at the same block count", () => {
+ let s = applyNarrativeEvent(EMPTY_NARRATIVE, turnStart());
+ s = applyNarrativeEvent(s, workflowDraft());
+ const before = sig(s);
+ s = applyNarrativeEvent(
+ s,
+ workflowDraft({ block_labels: ["renamed_a", "renamed_b"] }),
+ );
+ expect(sig(s)).not.toBe(before);
+ });
+
+ it("changes when the turn reaches a terminal response", () => {
+ let s = applyNarrativeEvent(EMPTY_NARRATIVE, turnStart());
+ const before = sig(s);
+ s = applyNarrativeEvent(s, {
+ type: "response",
+ workflow_copilot_chat_id: "chat-1",
+ message: "Done.",
+ response_time: "2026-05-25T00:00:05Z",
+ proposal_disposition: "no_proposal",
+ });
+ expect(sig(s)).not.toBe(before);
+ });
+
+ it("changes on a new message, loading, queued-prompt, and proposal state", () => {
+ const base = computeFollowSignature(
+ [],
+ EMPTY_NARRATIVE,
+ false,
+ false,
+ null,
+ false,
+ );
+ expect(
+ computeFollowSignature(
+ [{ id: "m1", content: "hi" }],
+ EMPTY_NARRATIVE,
+ false,
+ false,
+ null,
+ false,
+ ),
+ ).not.toBe(base);
+ expect(
+ computeFollowSignature([], EMPTY_NARRATIVE, true, false, null, false),
+ ).not.toBe(base);
+ expect(
+ computeFollowSignature(
+ [],
+ EMPTY_NARRATIVE,
+ false,
+ false,
+ { id: "q1", reason: "working" },
+ false,
+ ),
+ ).not.toBe(base);
+ expect(
+ computeFollowSignature([], EMPTY_NARRATIVE, false, false, null, true),
+ ).not.toBe(base);
+ });
+
+ it("is stable when nothing visible changed", () => {
+ const s = applyNarrativeEvent(EMPTY_NARRATIVE, turnStart());
+ expect(sig(s)).toBe(sig(s));
+ });
+});
+
+// renderHook doesn't mount the ref onto a real node, so attach the test
+// element to scrollRef.current by hand (RefObject.current is read-only).
+function setRefCurrent<T>(ref: { current: T | null }, value: T) {
+ ref.current = value;
+}
+
+function makeScrollEl(opts: {
+ scrollHeight: number;
+ clientHeight: number;
+ scrollTop: number;
+}) {
+ const el = document.createElement("div");
+ Object.defineProperty(el, "scrollHeight", {
+ configurable: true,
+ value: opts.scrollHeight,
+ });
+ Object.defineProperty(el, "clientHeight", {
+ configurable: true,
+ value: opts.clientHeight,
+ });
+ let top = opts.scrollTop;
+ Object.defineProperty(el, "scrollTop", {
+ configurable: true,
+ get: () => top,
+ set: (v: number) => {
+ top = v;
+ },
+ });
+ el.scrollTo = vi.fn((arg: { top: number }) => {
+ top = arg.top;
+ }) as unknown as typeof el.scrollTo;
+ document.body.appendChild(el);
+ return el;
+}
+
+afterEach(() => {
+ cleanup();
+ document.body.innerHTML = "";
+});
+
+describe("useStickToBottom", () => {
+ it("starts pinned and follows on content change", () => {
+ const el = makeScrollEl({
+ scrollHeight: 1000,
+ clientHeight: 300,
+ scrollTop: 700,
+ });
+ const { result, rerender } = renderHook(
+ ({ signature }) => {
+ const hook = useStickToBottom<HTMLDivElement>(signature, {
+ enabled: true,
+ });
+ setRefCurrent(hook.scrollRef, el);
+ return hook;
+ },
+ { initialProps: { signature: "a" } },
+ );
+ expect(result.current.isPinned).toBe(true);
+ (el.scrollTo as ReturnType<typeof vi.fn>).mockClear();
+ rerender({ signature: "b" });
+ expect(el.scrollTo).toHaveBeenCalled();
+ });
+
+ it("disengages when the user scrolls up past the threshold", () => {
+ const el = makeScrollEl({
+ scrollHeight: 1000,
+ clientHeight: 300,
+ scrollTop: 700,
+ });
+ const { result } = renderHook(() => {
+ const hook = useStickToBottom<HTMLDivElement>("a", { enabled: true });
+ setRefCurrent(hook.scrollRef, el);
+ return hook;
+ });
+ el.scrollTop = 500; // distance = 1000 - 500 - 300 = 200 > 48
+ fireEvent.scroll(el);
+ expect(result.current.isPinned).toBe(false);
+ });
+
+ it("does not follow new content while disengaged", () => {
+ const el = makeScrollEl({
+ scrollHeight: 1000,
+ clientHeight: 300,
+ scrollTop: 700,
+ });
+ const { result, rerender } = renderHook(
+ ({ signature }) => {
+ const hook = useStickToBottom<HTMLDivElement>(signature, {
+ enabled: true,
+ });
+ setRefCurrent(hook.scrollRef, el);
+ return hook;
+ },
+ { initialProps: { signature: "a" } },
+ );
+ el.scrollTop = 500;
+ fireEvent.scroll(el);
+ expect(result.current.isPinned).toBe(false);
+ (el.scrollTo as ReturnType<typeof vi.fn>).mockClear();
+ rerender({ signature: "b" });
+ expect(el.scrollTo).not.toHaveBeenCalled();
+ });
+
+ it("re-engages when the user scrolls back to the bottom", () => {
+ const el = makeScrollEl({
+ scrollHeight: 1000,
+ clientHeight: 300,
+ scrollTop: 700,
+ });
+ const { result } = renderHook(() => {
+ const hook = useStickToBottom<HTMLDivElement>("a", { enabled: true });
+ setRefCurrent(hook.scrollRef, el);
+ return hook;
+ });
+ el.scrollTop = 500;
+ fireEvent.scroll(el);
+ expect(result.current.isPinned).toBe(false);
+ el.scrollTop = 700; // distance = 0 <= 48
+ fireEvent.scroll(el);
+ expect(result.current.isPinned).toBe(true);
+ });
+
+ it("jumpToLatest re-pins and scrolls to the bottom", () => {
+ const el = makeScrollEl({
+ scrollHeight: 1000,
+ clientHeight: 300,
+ scrollTop: 700,
+ });
+ const { result } = renderHook(() => {
+ const hook = useStickToBottom<HTMLDivElement>("a", { enabled: true });
+ setRefCurrent(hook.scrollRef, el);
+ return hook;
+ });
+ el.scrollTop = 500;
+ fireEvent.scroll(el);
+ expect(result.current.isPinned).toBe(false);
+ (el.scrollTo as ReturnType<typeof vi.fn>).mockClear();
+ act(() => {
+ result.current.jumpToLatest();
+ });
+ expect(result.current.isPinned).toBe(true);
+ expect(el.scrollTo).toHaveBeenCalled();
+ });
+
+ it("re-pins and scrolls to the bottom after a close/reopen following a scroll-up", () => {
+ const el = makeScrollEl({
+ scrollHeight: 1000,
+ clientHeight: 300,
+ scrollTop: 700,
+ });
+ const { result, rerender } = renderHook(
+ ({ enabled }) => {
+ const hook = useStickToBottom<HTMLDivElement>("a", { enabled });
+ setRefCurrent(hook.scrollRef, el);
+ return hook;
+ },
+ { initialProps: { enabled: true } },
+ );
+ el.scrollTop = 500;
+ fireEvent.scroll(el);
+ expect(result.current.isPinned).toBe(false);
+ rerender({ enabled: false });
+ (el.scrollTo as ReturnType<typeof vi.fn>).mockClear();
+ rerender({ enabled: true });
+ expect(result.current.isPinned).toBe(true);
+ // Must actually scroll, not just flip the flag: the container remounts at
+ // the top on reopen, so a flag-only re-pin would leave the user stuck up.
+ expect(el.scrollTo).toHaveBeenCalled();
+ });
+});
diff --git a/skyvern-frontend/src/routes/workflows/copilot/useStickToBottom.ts b/skyvern-frontend/src/routes/workflows/copilot/useStickToBottom.ts
new file mode 100644
index 000000000..9750ab77b
--- /dev/null
+++ b/skyvern-frontend/src/routes/workflows/copilot/useStickToBottom.ts
@@ -0,0 +1,104 @@
+import {
+ RefObject,
+ useCallback,
+ useEffect,
+ useLayoutEffect,
+ useRef,
+ useState,
+} from "react";
+
+const DEFAULT_THRESHOLD_PX = 48;
+
+interface UseStickToBottomOptions {
+ enabled?: boolean;
+ thresholdPx?: number;
+}
+
+interface UseStickToBottomResult<T extends HTMLElement> {
+ scrollRef: RefObject<T>;
+ isPinned: boolean;
+ jumpToLatest: () => void;
+ repin: () => void;
+}
+
+// Follow-the-frontier scroll for a streaming chat pane: re-scrolls to the
+// bottom whenever `signature` changes while pinned, disengaging when the user
+// scrolls up past `thresholdPx` and re-engaging at the bottom / on jumpToLatest.
+export function useStickToBottom<T extends HTMLElement>(
+ signature: number | string,
+ options: UseStickToBottomOptions = {},
+): UseStickToBottomResult<T> {
+ const { enabled = true, thresholdPx = DEFAULT_THRESHOLD_PX } = options;
+ const scrollRef = useRef<T>(null);
+ const pinnedRef = useRef(true);
+ const [isPinned, setIsPinned] = useState(true);
+
+ const setPinned = useCallback((next: boolean) => {
+ pinnedRef.current = next;
+ setIsPinned((prev) => (prev === next ? prev : next));
+ }, []);
+
+ // Instant, not smooth: a smooth animation emits intermediate scroll events
+ // that the listener below would misread as a user scroll-up (self-unpinning).
+ const scrollToBottom = useCallback(() => {
+ const el = scrollRef.current;
+ if (!el) return;
+ el.scrollTo({ top: el.scrollHeight });
+ }, []);
+
+ const repin = useCallback(() => {
+ setPinned(true);
+ }, [setPinned]);
+
+ const jumpToLatest = useCallback(() => {
+ setPinned(true);
+ scrollToBottom();
+ }, [scrollToBottom, setPinned]);
+
+ // `enabled` is in the deps so reopen rebinds the listener to the fresh node —
+ // the consumer unmounts the scroll container while the panel is closed.
+ useEffect(() => {
+ if (!enabled) return;
+ const el = scrollRef.current;
+ if (!el) return;
+ const handleScroll = () => {
+ const distance = el.scrollHeight - el.scrollTop - el.clientHeight;
+ setPinned(distance <= thresholdPx);
+ };
+ el.addEventListener("scroll", handleScroll, { passive: true });
+ return () => el.removeEventListener("scroll", handleScroll);
+ }, [enabled, setPinned, thresholdPx]);
+
+ // Reopen must re-pin AND scroll: the fresh node starts at the top, and a user
+ // who scrolled up before closing left pinnedRef false, so the follow effect
+ // below would otherwise skip and reopen stuck at the top.
+ useLayoutEffect(() => {
+ if (!enabled) return;
+ setPinned(true);
+ scrollToBottom();
+ }, [enabled, scrollToBottom, setPinned]);
+
+ useLayoutEffect(() => {
+ if (!enabled || !pinnedRef.current) return;
+ scrollToBottom();
+ }, [signature, enabled, scrollToBottom]);
+
+ return { scrollRef, isPinned, jumpToLatest, repin };
+}
+
+// Visible-content fingerprint that changes on any rendered growth/move. The
+// narrative is serialized rather than counted because `appendCapped` rotates
+// tail content at the cap, so its length stops changing mid-run.
+export function computeFollowSignature(
+ messages: ReadonlyArray<{ id: string; content: string }>,
+ narrative: unknown,
+ isLoading: boolean,
+ isLoadingHistory: boolean,
+ queuedPrompt: { id: string; reason: string } | null,
+ hasProposal: boolean,
+): string {
+ const last = messages[messages.length - 1];
+ const messagePart = `${messages.length}:${last?.id ?? ""}:${last?.content.length ?? 0}`;
+ const footerPart = `${isLoading ? 1 : 0}:${isLoadingHistory ? 1 : 0}:${queuedPrompt?.id ?? ""}:${queuedPrompt?.reason ?? ""}:${hasProposal ? 1 : 0}`;
+ return `${messagePart}|${footerPart}|${JSON.stringify(narrative)}`;
+}
diff --git a/skyvern/client/__init__.py b/skyvern/client/__init__.py
index 5211c3a5d..8d8ce2300 100644
--- a/skyvern/client/__init__.py
+++ b/skyvern/client/__init__.py
@@ -25,6 +25,7 @@ if typing.TYPE_CHECKING:
ActionBlockParametersItem_Output,
ActionBlockParametersItem_Workflow,
ActionBlockYaml,
+ ActionOutput,
ActionStatus,
ActionType,
Artifact,
@@ -50,6 +51,7 @@ if typing.TYPE_CHECKING:
BranchCriteriaYamlCriteriaType,
BrowserProfile,
BrowserSessionResponse,
+ BulkCancelRunsResponse,
ClickAction,
ClickActionData,
ClickContext,
@@ -84,6 +86,7 @@ if typing.TYPE_CHECKING:
ContextParameterSource_Workflow,
ContextParameterValue,
ContextParameterYaml,
+ CreateBrowserSessionRequestProxyLocation,
CreateCredentialRequest,
CreateCredentialRequestCredential,
CreateScriptResponse,
@@ -154,6 +157,8 @@ if typing.TYPE_CHECKING:
ForLoopBlockLoopBlocksItem_FileUpload,
ForLoopBlockLoopBlocksItem_FileUrlParser,
ForLoopBlockLoopBlocksItem_ForLoop,
+ ForLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ ForLoopBlockLoopBlocksItem_GoogleSheetsWrite,
ForLoopBlockLoopBlocksItem_GotoUrl,
ForLoopBlockLoopBlocksItem_HttpRequest,
ForLoopBlockLoopBlocksItem_HumanInteraction,
@@ -168,6 +173,7 @@ if typing.TYPE_CHECKING:
ForLoopBlockLoopBlocksItem_UploadToS3,
ForLoopBlockLoopBlocksItem_Validation,
ForLoopBlockLoopBlocksItem_Wait,
+ ForLoopBlockLoopBlocksItem_WhileLoop,
ForLoopBlockLoopBlocksItem_WorkflowTrigger,
ForLoopBlockLoopOver,
ForLoopBlockLoopOver_AwsSecret,
@@ -193,6 +199,8 @@ if typing.TYPE_CHECKING:
ForLoopBlockYamlLoopBlocksItem_FileUpload,
ForLoopBlockYamlLoopBlocksItem_FileUrlParser,
ForLoopBlockYamlLoopBlocksItem_ForLoop,
+ ForLoopBlockYamlLoopBlocksItem_GoogleSheetsRead,
+ ForLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite,
ForLoopBlockYamlLoopBlocksItem_GotoUrl,
ForLoopBlockYamlLoopBlocksItem_HttpRequest,
ForLoopBlockYamlLoopBlocksItem_HumanInteraction,
@@ -207,6 +215,7 @@ if typing.TYPE_CHECKING:
ForLoopBlockYamlLoopBlocksItem_UploadToS3,
ForLoopBlockYamlLoopBlocksItem_Validation,
ForLoopBlockYamlLoopBlocksItem_Wait,
+ ForLoopBlockYamlLoopBlocksItem_WhileLoop,
ForLoopBlockYamlLoopBlocksItem_WorkflowTrigger,
GeoTarget,
GetRunResponse,
@@ -216,6 +225,37 @@ if typing.TYPE_CHECKING:
GetRunResponse_TaskV2,
GetRunResponse_UiTars,
GetRunResponse_WorkflowRun,
+ GetRunResponse_YutoriNavigator,
+ GoogleSheetsReadBlock,
+ GoogleSheetsReadBlockParametersItem,
+ GoogleSheetsReadBlockParametersItem_AwsSecret,
+ GoogleSheetsReadBlockParametersItem_AzureSecret,
+ GoogleSheetsReadBlockParametersItem_AzureVaultCredential,
+ GoogleSheetsReadBlockParametersItem_BitwardenCreditCardData,
+ GoogleSheetsReadBlockParametersItem_BitwardenLoginCredential,
+ GoogleSheetsReadBlockParametersItem_BitwardenSensitiveInformation,
+ GoogleSheetsReadBlockParametersItem_Context,
+ GoogleSheetsReadBlockParametersItem_Credential,
+ GoogleSheetsReadBlockParametersItem_Onepassword,
+ GoogleSheetsReadBlockParametersItem_Output,
+ GoogleSheetsReadBlockParametersItem_Workflow,
+ GoogleSheetsReadBlockYaml,
+ GoogleSheetsWriteBlock,
+ GoogleSheetsWriteBlockParametersItem,
+ GoogleSheetsWriteBlockParametersItem_AwsSecret,
+ GoogleSheetsWriteBlockParametersItem_AzureSecret,
+ GoogleSheetsWriteBlockParametersItem_AzureVaultCredential,
+ GoogleSheetsWriteBlockParametersItem_BitwardenCreditCardData,
+ GoogleSheetsWriteBlockParametersItem_BitwardenLoginCredential,
+ GoogleSheetsWriteBlockParametersItem_BitwardenSensitiveInformation,
+ GoogleSheetsWriteBlockParametersItem_Context,
+ GoogleSheetsWriteBlockParametersItem_Credential,
+ GoogleSheetsWriteBlockParametersItem_Onepassword,
+ GoogleSheetsWriteBlockParametersItem_Output,
+ GoogleSheetsWriteBlockParametersItem_Workflow,
+ GoogleSheetsWriteBlockWriteMode,
+ GoogleSheetsWriteBlockYaml,
+ GoogleSheetsWriteBlockYamlWriteMode,
HttpRequestBlock,
HttpRequestBlockParametersItem,
HttpRequestBlockParametersItem_AwsSecret,
@@ -326,6 +366,7 @@ if typing.TYPE_CHECKING:
RunSdkActionRequestAction_Validate,
RunSdkActionResponse,
RunStatus,
+ RunWebhookReplayResponse,
Script,
ScriptFileCreate,
ScriptRunResponse,
@@ -337,7 +378,7 @@ if typing.TYPE_CHECKING:
SendEmailBlock,
SendEmailBlockYaml,
SkyvernForgeSdkSchemasCredentialsCredentialType,
- SkyvernSchemasRunBlocksCredentialType,
+ SkyvernSchemasCredentialTypeCredentialType,
TaskBlock,
TaskBlockDataSchema,
TaskBlockParametersItem,
@@ -355,9 +396,11 @@ if typing.TYPE_CHECKING:
TaskBlockYaml,
TaskBlockYamlDataSchema,
TaskRunListItem,
- TaskRunRequest,
- TaskRunRequestDataExtractionSchema,
- TaskRunRequestProxyLocation,
+ TaskRunRequestInputDataExtractionSchema,
+ TaskRunRequestInputProxyLocation,
+ TaskRunRequestOutput,
+ TaskRunRequestOutputDataExtractionSchema,
+ TaskRunRequestOutputProxyLocation,
TaskRunResponse,
TaskRunResponseOutput,
TaskV2Block,
@@ -434,6 +477,67 @@ if typing.TYPE_CHECKING:
WaitBlockParametersItem_Output,
WaitBlockParametersItem_Workflow,
WaitBlockYaml,
+ WhileLoopBlock,
+ WhileLoopBlockCondition,
+ WhileLoopBlockCondition_Jinja2Template,
+ WhileLoopBlockCondition_Prompt,
+ WhileLoopBlockLoopBlocksItem,
+ WhileLoopBlockLoopBlocksItem_Action,
+ WhileLoopBlockLoopBlocksItem_Code,
+ WhileLoopBlockLoopBlocksItem_Conditional,
+ WhileLoopBlockLoopBlocksItem_DownloadToS3,
+ WhileLoopBlockLoopBlocksItem_Extraction,
+ WhileLoopBlockLoopBlocksItem_FileDownload,
+ WhileLoopBlockLoopBlocksItem_FileUpload,
+ WhileLoopBlockLoopBlocksItem_FileUrlParser,
+ WhileLoopBlockLoopBlocksItem_ForLoop,
+ WhileLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite,
+ WhileLoopBlockLoopBlocksItem_GotoUrl,
+ WhileLoopBlockLoopBlocksItem_HttpRequest,
+ WhileLoopBlockLoopBlocksItem_HumanInteraction,
+ WhileLoopBlockLoopBlocksItem_Login,
+ WhileLoopBlockLoopBlocksItem_Navigation,
+ WhileLoopBlockLoopBlocksItem_PdfParser,
+ WhileLoopBlockLoopBlocksItem_PrintPage,
+ WhileLoopBlockLoopBlocksItem_SendEmail,
+ WhileLoopBlockLoopBlocksItem_Task,
+ WhileLoopBlockLoopBlocksItem_TaskV2,
+ WhileLoopBlockLoopBlocksItem_TextPrompt,
+ WhileLoopBlockLoopBlocksItem_UploadToS3,
+ WhileLoopBlockLoopBlocksItem_Validation,
+ WhileLoopBlockLoopBlocksItem_Wait,
+ WhileLoopBlockLoopBlocksItem_WhileLoop,
+ WhileLoopBlockLoopBlocksItem_WorkflowTrigger,
+ WhileLoopBlockYaml,
+ WhileLoopBlockYamlLoopBlocksItem,
+ WhileLoopBlockYamlLoopBlocksItem_Action,
+ WhileLoopBlockYamlLoopBlocksItem_Code,
+ WhileLoopBlockYamlLoopBlocksItem_Conditional,
+ WhileLoopBlockYamlLoopBlocksItem_DownloadToS3,
+ WhileLoopBlockYamlLoopBlocksItem_Extraction,
+ WhileLoopBlockYamlLoopBlocksItem_FileDownload,
+ WhileLoopBlockYamlLoopBlocksItem_FileUpload,
+ WhileLoopBlockYamlLoopBlocksItem_FileUrlParser,
+ WhileLoopBlockYamlLoopBlocksItem_ForLoop,
+ WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsRead,
+ WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite,
+ WhileLoopBlockYamlLoopBlocksItem_GotoUrl,
+ WhileLoopBlockYamlLoopBlocksItem_HttpRequest,
+ WhileLoopBlockYamlLoopBlocksItem_HumanInteraction,
+ WhileLoopBlockYamlLoopBlocksItem_Login,
+ WhileLoopBlockYamlLoopBlocksItem_Navigation,
+ WhileLoopBlockYamlLoopBlocksItem_PdfParser,
+ WhileLoopBlockYamlLoopBlocksItem_PrintPage,
+ WhileLoopBlockYamlLoopBlocksItem_SendEmail,
+ WhileLoopBlockYamlLoopBlocksItem_Task,
+ WhileLoopBlockYamlLoopBlocksItem_TaskV2,
+ WhileLoopBlockYamlLoopBlocksItem_TextPrompt,
+ WhileLoopBlockYamlLoopBlocksItem_UploadToS3,
+ WhileLoopBlockYamlLoopBlocksItem_Validation,
+ WhileLoopBlockYamlLoopBlocksItem_Wait,
+ WhileLoopBlockYamlLoopBlocksItem_WhileLoop,
+ WhileLoopBlockYamlLoopBlocksItem_WorkflowTrigger,
Workflow,
WorkflowCreateYamlRequest,
WorkflowCreateYamlRequestProxyLocation,
@@ -448,6 +552,8 @@ if typing.TYPE_CHECKING:
WorkflowDefinitionBlocksItem_FileUpload,
WorkflowDefinitionBlocksItem_FileUrlParser,
WorkflowDefinitionBlocksItem_ForLoop,
+ WorkflowDefinitionBlocksItem_GoogleSheetsRead,
+ WorkflowDefinitionBlocksItem_GoogleSheetsWrite,
WorkflowDefinitionBlocksItem_GotoUrl,
WorkflowDefinitionBlocksItem_HttpRequest,
WorkflowDefinitionBlocksItem_HumanInteraction,
@@ -462,6 +568,7 @@ if typing.TYPE_CHECKING:
WorkflowDefinitionBlocksItem_UploadToS3,
WorkflowDefinitionBlocksItem_Validation,
WorkflowDefinitionBlocksItem_Wait,
+ WorkflowDefinitionBlocksItem_WhileLoop,
WorkflowDefinitionBlocksItem_WorkflowTrigger,
WorkflowDefinitionParametersItem,
WorkflowDefinitionParametersItem_AwsSecret,
@@ -486,6 +593,8 @@ if typing.TYPE_CHECKING:
WorkflowDefinitionYamlBlocksItem_FileUpload,
WorkflowDefinitionYamlBlocksItem_FileUrlParser,
WorkflowDefinitionYamlBlocksItem_ForLoop,
+ WorkflowDefinitionYamlBlocksItem_GoogleSheetsRead,
+ WorkflowDefinitionYamlBlocksItem_GoogleSheetsWrite,
WorkflowDefinitionYamlBlocksItem_GotoUrl,
WorkflowDefinitionYamlBlocksItem_HttpRequest,
WorkflowDefinitionYamlBlocksItem_HumanInteraction,
@@ -500,6 +609,7 @@ if typing.TYPE_CHECKING:
WorkflowDefinitionYamlBlocksItem_UploadToS3,
WorkflowDefinitionYamlBlocksItem_Validation,
WorkflowDefinitionYamlBlocksItem_Wait,
+ WorkflowDefinitionYamlBlocksItem_WhileLoop,
WorkflowDefinitionYamlBlocksItem_WorkflowTrigger,
WorkflowDefinitionYamlParametersItem,
WorkflowDefinitionYamlParametersItem_AwsSecret,
@@ -525,8 +635,9 @@ if typing.TYPE_CHECKING:
WorkflowRunBlockNavigationPayload,
WorkflowRunBlockOutput,
WorkflowRunProxyLocation,
- WorkflowRunRequest,
- WorkflowRunRequestProxyLocation,
+ WorkflowRunRequestInputProxyLocation,
+ WorkflowRunRequestOutput,
+ WorkflowRunRequestOutputProxyLocation,
WorkflowRunResponse,
WorkflowRunResponseOutput,
WorkflowRunStatus,
@@ -553,8 +664,16 @@ if typing.TYPE_CHECKING:
WorkflowTriggerBlockParametersItem_Workflow,
WorkflowTriggerBlockYaml,
)
- from .errors import BadRequestError, ConflictError, ForbiddenError, NotFoundError, UnprocessableEntityError
- from . import artifacts, schedules, scripts
+ from .errors import (
+ BadRequestError,
+ ConflictError,
+ ForbiddenError,
+ InternalServerError,
+ NotFoundError,
+ RangeNotSatisfiableError,
+ UnprocessableEntityError,
+ )
+ from . import artifacts, schedules, scripts, server, workflows
from .client import AsyncSkyvern, Skyvern
from .environment import SkyvernEnvironment
from .schedules import SchedulesListAllRequestStatus
@@ -578,6 +697,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ActionBlockParametersItem_Output": ".types",
"ActionBlockParametersItem_Workflow": ".types",
"ActionBlockYaml": ".types",
+ "ActionOutput": ".types",
"ActionStatus": ".types",
"ActionType": ".types",
"Artifact": ".types",
@@ -605,6 +725,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"BranchCriteriaYamlCriteriaType": ".types",
"BrowserProfile": ".types",
"BrowserSessionResponse": ".types",
+ "BulkCancelRunsResponse": ".types",
"ClickAction": ".types",
"ClickActionData": ".types",
"ClickContext": ".types",
@@ -640,6 +761,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ContextParameterSource_Workflow": ".types",
"ContextParameterValue": ".types",
"ContextParameterYaml": ".types",
+ "CreateBrowserSessionRequestProxyLocation": ".types",
"CreateCredentialRequest": ".types",
"CreateCredentialRequestCredential": ".types",
"CreateScriptResponse": ".types",
@@ -710,6 +832,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"ForLoopBlockLoopBlocksItem_FileUpload": ".types",
"ForLoopBlockLoopBlocksItem_FileUrlParser": ".types",
"ForLoopBlockLoopBlocksItem_ForLoop": ".types",
+ "ForLoopBlockLoopBlocksItem_GoogleSheetsRead": ".types",
+ "ForLoopBlockLoopBlocksItem_GoogleSheetsWrite": ".types",
"ForLoopBlockLoopBlocksItem_GotoUrl": ".types",
"ForLoopBlockLoopBlocksItem_HttpRequest": ".types",
"ForLoopBlockLoopBlocksItem_HumanInteraction": ".types",
@@ -724,6 +848,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ForLoopBlockLoopBlocksItem_UploadToS3": ".types",
"ForLoopBlockLoopBlocksItem_Validation": ".types",
"ForLoopBlockLoopBlocksItem_Wait": ".types",
+ "ForLoopBlockLoopBlocksItem_WhileLoop": ".types",
"ForLoopBlockLoopBlocksItem_WorkflowTrigger": ".types",
"ForLoopBlockLoopOver": ".types",
"ForLoopBlockLoopOver_AwsSecret": ".types",
@@ -749,6 +874,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"ForLoopBlockYamlLoopBlocksItem_FileUpload": ".types",
"ForLoopBlockYamlLoopBlocksItem_FileUrlParser": ".types",
"ForLoopBlockYamlLoopBlocksItem_ForLoop": ".types",
+ "ForLoopBlockYamlLoopBlocksItem_GoogleSheetsRead": ".types",
+ "ForLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite": ".types",
"ForLoopBlockYamlLoopBlocksItem_GotoUrl": ".types",
"ForLoopBlockYamlLoopBlocksItem_HttpRequest": ".types",
"ForLoopBlockYamlLoopBlocksItem_HumanInteraction": ".types",
@@ -763,6 +890,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ForLoopBlockYamlLoopBlocksItem_UploadToS3": ".types",
"ForLoopBlockYamlLoopBlocksItem_Validation": ".types",
"ForLoopBlockYamlLoopBlocksItem_Wait": ".types",
+ "ForLoopBlockYamlLoopBlocksItem_WhileLoop": ".types",
"ForLoopBlockYamlLoopBlocksItem_WorkflowTrigger": ".types",
"ForbiddenError": ".errors",
"GeoTarget": ".types",
@@ -773,6 +901,37 @@ _dynamic_imports: typing.Dict[str, str] = {
"GetRunResponse_TaskV2": ".types",
"GetRunResponse_UiTars": ".types",
"GetRunResponse_WorkflowRun": ".types",
+ "GetRunResponse_YutoriNavigator": ".types",
+ "GoogleSheetsReadBlock": ".types",
+ "GoogleSheetsReadBlockParametersItem": ".types",
+ "GoogleSheetsReadBlockParametersItem_AwsSecret": ".types",
+ "GoogleSheetsReadBlockParametersItem_AzureSecret": ".types",
+ "GoogleSheetsReadBlockParametersItem_AzureVaultCredential": ".types",
+ "GoogleSheetsReadBlockParametersItem_BitwardenCreditCardData": ".types",
+ "GoogleSheetsReadBlockParametersItem_BitwardenLoginCredential": ".types",
+ "GoogleSheetsReadBlockParametersItem_BitwardenSensitiveInformation": ".types",
+ "GoogleSheetsReadBlockParametersItem_Context": ".types",
+ "GoogleSheetsReadBlockParametersItem_Credential": ".types",
+ "GoogleSheetsReadBlockParametersItem_Onepassword": ".types",
+ "GoogleSheetsReadBlockParametersItem_Output": ".types",
+ "GoogleSheetsReadBlockParametersItem_Workflow": ".types",
+ "GoogleSheetsReadBlockYaml": ".types",
+ "GoogleSheetsWriteBlock": ".types",
+ "GoogleSheetsWriteBlockParametersItem": ".types",
+ "GoogleSheetsWriteBlockParametersItem_AwsSecret": ".types",
+ "GoogleSheetsWriteBlockParametersItem_AzureSecret": ".types",
+ "GoogleSheetsWriteBlockParametersItem_AzureVaultCredential": ".types",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenCreditCardData": ".types",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenLoginCredential": ".types",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenSensitiveInformation": ".types",
+ "GoogleSheetsWriteBlockParametersItem_Context": ".types",
+ "GoogleSheetsWriteBlockParametersItem_Credential": ".types",
+ "GoogleSheetsWriteBlockParametersItem_Onepassword": ".types",
+ "GoogleSheetsWriteBlockParametersItem_Output": ".types",
+ "GoogleSheetsWriteBlockParametersItem_Workflow": ".types",
+ "GoogleSheetsWriteBlockWriteMode": ".types",
+ "GoogleSheetsWriteBlockYaml": ".types",
+ "GoogleSheetsWriteBlockYamlWriteMode": ".types",
"HttpRequestBlock": ".types",
"HttpRequestBlockParametersItem": ".types",
"HttpRequestBlockParametersItem_AwsSecret": ".types",
@@ -806,6 +965,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"InputOrSelectContext": ".types",
"InputTextAction": ".types",
"InputTextActionData": ".types",
+ "InternalServerError": ".errors",
"JinjaBranchCriteria": ".types",
"LocateElementAction": ".types",
"LoginBlock": ".types",
@@ -870,6 +1030,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"PromptAction": ".types",
"PromptBranchCriteria": ".types",
"ProxyLocation": ".types",
+ "RangeNotSatisfiableError": ".errors",
"RetryRunWebhookRequest": ".types",
"RunEngine": ".types",
"RunSdkActionRequestAction": ".types",
@@ -884,6 +1045,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"RunSdkActionRequestAction_Validate": ".types",
"RunSdkActionResponse": ".types",
"RunStatus": ".types",
+ "RunWebhookReplayResponse": ".types",
"SchedulesListAllRequestStatus": ".schedules",
"Script": ".types",
"ScriptFileCreate": ".types",
@@ -898,7 +1060,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"Skyvern": ".client",
"SkyvernEnvironment": ".environment",
"SkyvernForgeSdkSchemasCredentialsCredentialType": ".types",
- "SkyvernSchemasRunBlocksCredentialType": ".types",
+ "SkyvernSchemasCredentialTypeCredentialType": ".types",
"TaskBlock": ".types",
"TaskBlockDataSchema": ".types",
"TaskBlockParametersItem": ".types",
@@ -916,9 +1078,11 @@ _dynamic_imports: typing.Dict[str, str] = {
"TaskBlockYaml": ".types",
"TaskBlockYamlDataSchema": ".types",
"TaskRunListItem": ".types",
- "TaskRunRequest": ".types",
- "TaskRunRequestDataExtractionSchema": ".types",
- "TaskRunRequestProxyLocation": ".types",
+ "TaskRunRequestInputDataExtractionSchema": ".types",
+ "TaskRunRequestInputProxyLocation": ".types",
+ "TaskRunRequestOutput": ".types",
+ "TaskRunRequestOutputDataExtractionSchema": ".types",
+ "TaskRunRequestOutputProxyLocation": ".types",
"TaskRunResponse": ".types",
"TaskRunResponseOutput": ".types",
"TaskV2Block": ".types",
@@ -996,6 +1160,67 @@ _dynamic_imports: typing.Dict[str, str] = {
"WaitBlockParametersItem_Output": ".types",
"WaitBlockParametersItem_Workflow": ".types",
"WaitBlockYaml": ".types",
+ "WhileLoopBlock": ".types",
+ "WhileLoopBlockCondition": ".types",
+ "WhileLoopBlockCondition_Jinja2Template": ".types",
+ "WhileLoopBlockCondition_Prompt": ".types",
+ "WhileLoopBlockLoopBlocksItem": ".types",
+ "WhileLoopBlockLoopBlocksItem_Action": ".types",
+ "WhileLoopBlockLoopBlocksItem_Code": ".types",
+ "WhileLoopBlockLoopBlocksItem_Conditional": ".types",
+ "WhileLoopBlockLoopBlocksItem_DownloadToS3": ".types",
+ "WhileLoopBlockLoopBlocksItem_Extraction": ".types",
+ "WhileLoopBlockLoopBlocksItem_FileDownload": ".types",
+ "WhileLoopBlockLoopBlocksItem_FileUpload": ".types",
+ "WhileLoopBlockLoopBlocksItem_FileUrlParser": ".types",
+ "WhileLoopBlockLoopBlocksItem_ForLoop": ".types",
+ "WhileLoopBlockLoopBlocksItem_GoogleSheetsRead": ".types",
+ "WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite": ".types",
+ "WhileLoopBlockLoopBlocksItem_GotoUrl": ".types",
+ "WhileLoopBlockLoopBlocksItem_HttpRequest": ".types",
+ "WhileLoopBlockLoopBlocksItem_HumanInteraction": ".types",
+ "WhileLoopBlockLoopBlocksItem_Login": ".types",
+ "WhileLoopBlockLoopBlocksItem_Navigation": ".types",
+ "WhileLoopBlockLoopBlocksItem_PdfParser": ".types",
+ "WhileLoopBlockLoopBlocksItem_PrintPage": ".types",
+ "WhileLoopBlockLoopBlocksItem_SendEmail": ".types",
+ "WhileLoopBlockLoopBlocksItem_Task": ".types",
+ "WhileLoopBlockLoopBlocksItem_TaskV2": ".types",
+ "WhileLoopBlockLoopBlocksItem_TextPrompt": ".types",
+ "WhileLoopBlockLoopBlocksItem_UploadToS3": ".types",
+ "WhileLoopBlockLoopBlocksItem_Validation": ".types",
+ "WhileLoopBlockLoopBlocksItem_Wait": ".types",
+ "WhileLoopBlockLoopBlocksItem_WhileLoop": ".types",
+ "WhileLoopBlockLoopBlocksItem_WorkflowTrigger": ".types",
+ "WhileLoopBlockYaml": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Action": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Code": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Conditional": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_DownloadToS3": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Extraction": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_FileDownload": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_FileUpload": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_FileUrlParser": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_ForLoop": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsRead": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_GotoUrl": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_HttpRequest": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_HumanInteraction": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Login": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Navigation": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_PdfParser": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_PrintPage": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_SendEmail": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Task": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_TaskV2": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_TextPrompt": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_UploadToS3": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Validation": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_Wait": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_WhileLoop": ".types",
+ "WhileLoopBlockYamlLoopBlocksItem_WorkflowTrigger": ".types",
"Workflow": ".types",
"WorkflowCreateYamlRequest": ".types",
"WorkflowCreateYamlRequestProxyLocation": ".types",
@@ -1010,6 +1235,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"WorkflowDefinitionBlocksItem_FileUpload": ".types",
"WorkflowDefinitionBlocksItem_FileUrlParser": ".types",
"WorkflowDefinitionBlocksItem_ForLoop": ".types",
+ "WorkflowDefinitionBlocksItem_GoogleSheetsRead": ".types",
+ "WorkflowDefinitionBlocksItem_GoogleSheetsWrite": ".types",
"WorkflowDefinitionBlocksItem_GotoUrl": ".types",
"WorkflowDefinitionBlocksItem_HttpRequest": ".types",
"WorkflowDefinitionBlocksItem_HumanInteraction": ".types",
@@ -1024,6 +1251,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"WorkflowDefinitionBlocksItem_UploadToS3": ".types",
"WorkflowDefinitionBlocksItem_Validation": ".types",
"WorkflowDefinitionBlocksItem_Wait": ".types",
+ "WorkflowDefinitionBlocksItem_WhileLoop": ".types",
"WorkflowDefinitionBlocksItem_WorkflowTrigger": ".types",
"WorkflowDefinitionParametersItem": ".types",
"WorkflowDefinitionParametersItem_AwsSecret": ".types",
@@ -1048,6 +1276,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"WorkflowDefinitionYamlBlocksItem_FileUpload": ".types",
"WorkflowDefinitionYamlBlocksItem_FileUrlParser": ".types",
"WorkflowDefinitionYamlBlocksItem_ForLoop": ".types",
+ "WorkflowDefinitionYamlBlocksItem_GoogleSheetsRead": ".types",
+ "WorkflowDefinitionYamlBlocksItem_GoogleSheetsWrite": ".types",
"WorkflowDefinitionYamlBlocksItem_GotoUrl": ".types",
"WorkflowDefinitionYamlBlocksItem_HttpRequest": ".types",
"WorkflowDefinitionYamlBlocksItem_HumanInteraction": ".types",
@@ -1062,6 +1292,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"WorkflowDefinitionYamlBlocksItem_UploadToS3": ".types",
"WorkflowDefinitionYamlBlocksItem_Validation": ".types",
"WorkflowDefinitionYamlBlocksItem_Wait": ".types",
+ "WorkflowDefinitionYamlBlocksItem_WhileLoop": ".types",
"WorkflowDefinitionYamlBlocksItem_WorkflowTrigger": ".types",
"WorkflowDefinitionYamlParametersItem": ".types",
"WorkflowDefinitionYamlParametersItem_AwsSecret": ".types",
@@ -1087,8 +1318,9 @@ _dynamic_imports: typing.Dict[str, str] = {
"WorkflowRunBlockNavigationPayload": ".types",
"WorkflowRunBlockOutput": ".types",
"WorkflowRunProxyLocation": ".types",
- "WorkflowRunRequest": ".types",
- "WorkflowRunRequestProxyLocation": ".types",
+ "WorkflowRunRequestInputProxyLocation": ".types",
+ "WorkflowRunRequestOutput": ".types",
+ "WorkflowRunRequestOutputProxyLocation": ".types",
"WorkflowRunResponse": ".types",
"WorkflowRunResponseOutput": ".types",
"WorkflowRunStatus": ".types",
@@ -1118,6 +1350,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"artifacts": ".artifacts",
"schedules": ".schedules",
"scripts": ".scripts",
+ "server": ".server",
+ "workflows": ".workflows",
}
@@ -1161,6 +1395,7 @@ __all__ = [
"ActionBlockParametersItem_Output",
"ActionBlockParametersItem_Workflow",
"ActionBlockYaml",
+ "ActionOutput",
"ActionStatus",
"ActionType",
"Artifact",
@@ -1188,6 +1423,7 @@ __all__ = [
"BranchCriteriaYamlCriteriaType",
"BrowserProfile",
"BrowserSessionResponse",
+ "BulkCancelRunsResponse",
"ClickAction",
"ClickActionData",
"ClickContext",
@@ -1223,6 +1459,7 @@ __all__ = [
"ContextParameterSource_Workflow",
"ContextParameterValue",
"ContextParameterYaml",
+ "CreateBrowserSessionRequestProxyLocation",
"CreateCredentialRequest",
"CreateCredentialRequestCredential",
"CreateScriptResponse",
@@ -1293,6 +1530,8 @@ __all__ = [
"ForLoopBlockLoopBlocksItem_FileUpload",
"ForLoopBlockLoopBlocksItem_FileUrlParser",
"ForLoopBlockLoopBlocksItem_ForLoop",
+ "ForLoopBlockLoopBlocksItem_GoogleSheetsRead",
+ "ForLoopBlockLoopBlocksItem_GoogleSheetsWrite",
"ForLoopBlockLoopBlocksItem_GotoUrl",
"ForLoopBlockLoopBlocksItem_HttpRequest",
"ForLoopBlockLoopBlocksItem_HumanInteraction",
@@ -1307,6 +1546,7 @@ __all__ = [
"ForLoopBlockLoopBlocksItem_UploadToS3",
"ForLoopBlockLoopBlocksItem_Validation",
"ForLoopBlockLoopBlocksItem_Wait",
+ "ForLoopBlockLoopBlocksItem_WhileLoop",
"ForLoopBlockLoopBlocksItem_WorkflowTrigger",
"ForLoopBlockLoopOver",
"ForLoopBlockLoopOver_AwsSecret",
@@ -1332,6 +1572,8 @@ __all__ = [
"ForLoopBlockYamlLoopBlocksItem_FileUpload",
"ForLoopBlockYamlLoopBlocksItem_FileUrlParser",
"ForLoopBlockYamlLoopBlocksItem_ForLoop",
+ "ForLoopBlockYamlLoopBlocksItem_GoogleSheetsRead",
+ "ForLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite",
"ForLoopBlockYamlLoopBlocksItem_GotoUrl",
"ForLoopBlockYamlLoopBlocksItem_HttpRequest",
"ForLoopBlockYamlLoopBlocksItem_HumanInteraction",
@@ -1346,6 +1588,7 @@ __all__ = [
"ForLoopBlockYamlLoopBlocksItem_UploadToS3",
"ForLoopBlockYamlLoopBlocksItem_Validation",
"ForLoopBlockYamlLoopBlocksItem_Wait",
+ "ForLoopBlockYamlLoopBlocksItem_WhileLoop",
"ForLoopBlockYamlLoopBlocksItem_WorkflowTrigger",
"ForbiddenError",
"GeoTarget",
@@ -1356,6 +1599,37 @@ __all__ = [
"GetRunResponse_TaskV2",
"GetRunResponse_UiTars",
"GetRunResponse_WorkflowRun",
+ "GetRunResponse_YutoriNavigator",
+ "GoogleSheetsReadBlock",
+ "GoogleSheetsReadBlockParametersItem",
+ "GoogleSheetsReadBlockParametersItem_AwsSecret",
+ "GoogleSheetsReadBlockParametersItem_AzureSecret",
+ "GoogleSheetsReadBlockParametersItem_AzureVaultCredential",
+ "GoogleSheetsReadBlockParametersItem_BitwardenCreditCardData",
+ "GoogleSheetsReadBlockParametersItem_BitwardenLoginCredential",
+ "GoogleSheetsReadBlockParametersItem_BitwardenSensitiveInformation",
+ "GoogleSheetsReadBlockParametersItem_Context",
+ "GoogleSheetsReadBlockParametersItem_Credential",
+ "GoogleSheetsReadBlockParametersItem_Onepassword",
+ "GoogleSheetsReadBlockParametersItem_Output",
+ "GoogleSheetsReadBlockParametersItem_Workflow",
+ "GoogleSheetsReadBlockYaml",
+ "GoogleSheetsWriteBlock",
+ "GoogleSheetsWriteBlockParametersItem",
+ "GoogleSheetsWriteBlockParametersItem_AwsSecret",
+ "GoogleSheetsWriteBlockParametersItem_AzureSecret",
+ "GoogleSheetsWriteBlockParametersItem_AzureVaultCredential",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenCreditCardData",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenLoginCredential",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenSensitiveInformation",
+ "GoogleSheetsWriteBlockParametersItem_Context",
+ "GoogleSheetsWriteBlockParametersItem_Credential",
+ "GoogleSheetsWriteBlockParametersItem_Onepassword",
+ "GoogleSheetsWriteBlockParametersItem_Output",
+ "GoogleSheetsWriteBlockParametersItem_Workflow",
+ "GoogleSheetsWriteBlockWriteMode",
+ "GoogleSheetsWriteBlockYaml",
+ "GoogleSheetsWriteBlockYamlWriteMode",
"HttpRequestBlock",
"HttpRequestBlockParametersItem",
"HttpRequestBlockParametersItem_AwsSecret",
@@ -1389,6 +1663,7 @@ __all__ = [
"InputOrSelectContext",
"InputTextAction",
"InputTextActionData",
+ "InternalServerError",
"JinjaBranchCriteria",
"LocateElementAction",
"LoginBlock",
@@ -1453,6 +1728,7 @@ __all__ = [
"PromptAction",
"PromptBranchCriteria",
"ProxyLocation",
+ "RangeNotSatisfiableError",
"RetryRunWebhookRequest",
"RunEngine",
"RunSdkActionRequestAction",
@@ -1467,6 +1743,7 @@ __all__ = [
"RunSdkActionRequestAction_Validate",
"RunSdkActionResponse",
"RunStatus",
+ "RunWebhookReplayResponse",
"SchedulesListAllRequestStatus",
"Script",
"ScriptFileCreate",
@@ -1481,7 +1758,7 @@ __all__ = [
"Skyvern",
"SkyvernEnvironment",
"SkyvernForgeSdkSchemasCredentialsCredentialType",
- "SkyvernSchemasRunBlocksCredentialType",
+ "SkyvernSchemasCredentialTypeCredentialType",
"TaskBlock",
"TaskBlockDataSchema",
"TaskBlockParametersItem",
@@ -1499,9 +1776,11 @@ __all__ = [
"TaskBlockYaml",
"TaskBlockYamlDataSchema",
"TaskRunListItem",
- "TaskRunRequest",
- "TaskRunRequestDataExtractionSchema",
- "TaskRunRequestProxyLocation",
+ "TaskRunRequestInputDataExtractionSchema",
+ "TaskRunRequestInputProxyLocation",
+ "TaskRunRequestOutput",
+ "TaskRunRequestOutputDataExtractionSchema",
+ "TaskRunRequestOutputProxyLocation",
"TaskRunResponse",
"TaskRunResponseOutput",
"TaskV2Block",
@@ -1579,6 +1858,67 @@ __all__ = [
"WaitBlockParametersItem_Output",
"WaitBlockParametersItem_Workflow",
"WaitBlockYaml",
+ "WhileLoopBlock",
+ "WhileLoopBlockCondition",
+ "WhileLoopBlockCondition_Jinja2Template",
+ "WhileLoopBlockCondition_Prompt",
+ "WhileLoopBlockLoopBlocksItem",
+ "WhileLoopBlockLoopBlocksItem_Action",
+ "WhileLoopBlockLoopBlocksItem_Code",
+ "WhileLoopBlockLoopBlocksItem_Conditional",
+ "WhileLoopBlockLoopBlocksItem_DownloadToS3",
+ "WhileLoopBlockLoopBlocksItem_Extraction",
+ "WhileLoopBlockLoopBlocksItem_FileDownload",
+ "WhileLoopBlockLoopBlocksItem_FileUpload",
+ "WhileLoopBlockLoopBlocksItem_FileUrlParser",
+ "WhileLoopBlockLoopBlocksItem_ForLoop",
+ "WhileLoopBlockLoopBlocksItem_GoogleSheetsRead",
+ "WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite",
+ "WhileLoopBlockLoopBlocksItem_GotoUrl",
+ "WhileLoopBlockLoopBlocksItem_HttpRequest",
+ "WhileLoopBlockLoopBlocksItem_HumanInteraction",
+ "WhileLoopBlockLoopBlocksItem_Login",
+ "WhileLoopBlockLoopBlocksItem_Navigation",
+ "WhileLoopBlockLoopBlocksItem_PdfParser",
+ "WhileLoopBlockLoopBlocksItem_PrintPage",
+ "WhileLoopBlockLoopBlocksItem_SendEmail",
+ "WhileLoopBlockLoopBlocksItem_Task",
+ "WhileLoopBlockLoopBlocksItem_TaskV2",
+ "WhileLoopBlockLoopBlocksItem_TextPrompt",
+ "WhileLoopBlockLoopBlocksItem_UploadToS3",
+ "WhileLoopBlockLoopBlocksItem_Validation",
+ "WhileLoopBlockLoopBlocksItem_Wait",
+ "WhileLoopBlockLoopBlocksItem_WhileLoop",
+ "WhileLoopBlockLoopBlocksItem_WorkflowTrigger",
+ "WhileLoopBlockYaml",
+ "WhileLoopBlockYamlLoopBlocksItem",
+ "WhileLoopBlockYamlLoopBlocksItem_Action",
+ "WhileLoopBlockYamlLoopBlocksItem_Code",
+ "WhileLoopBlockYamlLoopBlocksItem_Conditional",
+ "WhileLoopBlockYamlLoopBlocksItem_DownloadToS3",
+ "WhileLoopBlockYamlLoopBlocksItem_Extraction",
+ "WhileLoopBlockYamlLoopBlocksItem_FileDownload",
+ "WhileLoopBlockYamlLoopBlocksItem_FileUpload",
+ "WhileLoopBlockYamlLoopBlocksItem_FileUrlParser",
+ "WhileLoopBlockYamlLoopBlocksItem_ForLoop",
+ "WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsRead",
+ "WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite",
+ "WhileLoopBlockYamlLoopBlocksItem_GotoUrl",
+ "WhileLoopBlockYamlLoopBlocksItem_HttpRequest",
+ "WhileLoopBlockYamlLoopBlocksItem_HumanInteraction",
+ "WhileLoopBlockYamlLoopBlocksItem_Login",
+ "WhileLoopBlockYamlLoopBlocksItem_Navigation",
+ "WhileLoopBlockYamlLoopBlocksItem_PdfParser",
+ "WhileLoopBlockYamlLoopBlocksItem_PrintPage",
+ "WhileLoopBlockYamlLoopBlocksItem_SendEmail",
+ "WhileLoopBlockYamlLoopBlocksItem_Task",
+ "WhileLoopBlockYamlLoopBlocksItem_TaskV2",
+ "WhileLoopBlockYamlLoopBlocksItem_TextPrompt",
+ "WhileLoopBlockYamlLoopBlocksItem_UploadToS3",
+ "WhileLoopBlockYamlLoopBlocksItem_Validation",
+ "WhileLoopBlockYamlLoopBlocksItem_Wait",
+ "WhileLoopBlockYamlLoopBlocksItem_WhileLoop",
+ "WhileLoopBlockYamlLoopBlocksItem_WorkflowTrigger",
"Workflow",
"WorkflowCreateYamlRequest",
"WorkflowCreateYamlRequestProxyLocation",
@@ -1593,6 +1933,8 @@ __all__ = [
"WorkflowDefinitionBlocksItem_FileUpload",
"WorkflowDefinitionBlocksItem_FileUrlParser",
"WorkflowDefinitionBlocksItem_ForLoop",
+ "WorkflowDefinitionBlocksItem_GoogleSheetsRead",
+ "WorkflowDefinitionBlocksItem_GoogleSheetsWrite",
"WorkflowDefinitionBlocksItem_GotoUrl",
"WorkflowDefinitionBlocksItem_HttpRequest",
"WorkflowDefinitionBlocksItem_HumanInteraction",
@@ -1607,6 +1949,7 @@ __all__ = [
"WorkflowDefinitionBlocksItem_UploadToS3",
"WorkflowDefinitionBlocksItem_Validation",
"WorkflowDefinitionBlocksItem_Wait",
+ "WorkflowDefinitionBlocksItem_WhileLoop",
"WorkflowDefinitionBlocksItem_WorkflowTrigger",
"WorkflowDefinitionParametersItem",
"WorkflowDefinitionParametersItem_AwsSecret",
@@ -1631,6 +1974,8 @@ __all__ = [
"WorkflowDefinitionYamlBlocksItem_FileUpload",
"WorkflowDefinitionYamlBlocksItem_FileUrlParser",
"WorkflowDefinitionYamlBlocksItem_ForLoop",
+ "WorkflowDefinitionYamlBlocksItem_GoogleSheetsRead",
+ "WorkflowDefinitionYamlBlocksItem_GoogleSheetsWrite",
"WorkflowDefinitionYamlBlocksItem_GotoUrl",
"WorkflowDefinitionYamlBlocksItem_HttpRequest",
"WorkflowDefinitionYamlBlocksItem_HumanInteraction",
@@ -1645,6 +1990,7 @@ __all__ = [
"WorkflowDefinitionYamlBlocksItem_UploadToS3",
"WorkflowDefinitionYamlBlocksItem_Validation",
"WorkflowDefinitionYamlBlocksItem_Wait",
+ "WorkflowDefinitionYamlBlocksItem_WhileLoop",
"WorkflowDefinitionYamlBlocksItem_WorkflowTrigger",
"WorkflowDefinitionYamlParametersItem",
"WorkflowDefinitionYamlParametersItem_AwsSecret",
@@ -1670,8 +2016,9 @@ __all__ = [
"WorkflowRunBlockNavigationPayload",
"WorkflowRunBlockOutput",
"WorkflowRunProxyLocation",
- "WorkflowRunRequest",
- "WorkflowRunRequestProxyLocation",
+ "WorkflowRunRequestInputProxyLocation",
+ "WorkflowRunRequestOutput",
+ "WorkflowRunRequestOutputProxyLocation",
"WorkflowRunResponse",
"WorkflowRunResponseOutput",
"WorkflowRunStatus",
@@ -1701,4 +2048,6 @@ __all__ = [
"artifacts",
"schedules",
"scripts",
+ "server",
+ "workflows",
]
diff --git a/skyvern/client/client.py b/skyvern/client/client.py
index e61082be9..74cadd89a 100644
--- a/skyvern/client/client.py
+++ b/skyvern/client/client.py
@@ -14,6 +14,8 @@ from .types.artifact import Artifact
from .types.artifact_type import ArtifactType
from .types.browser_profile import BrowserProfile
from .types.browser_session_response import BrowserSessionResponse
+from .types.bulk_cancel_runs_response import BulkCancelRunsResponse
+from .types.create_browser_session_request_proxy_location import CreateBrowserSessionRequestProxyLocation
from .types.create_credential_request_credential import CreateCredentialRequestCredential
from .types.create_script_response import CreateScriptResponse
from .types.credential_response import CredentialResponse
@@ -29,20 +31,21 @@ from .types.run_engine import RunEngine
from .types.run_sdk_action_request_action import RunSdkActionRequestAction
from .types.run_sdk_action_response import RunSdkActionResponse
from .types.run_status import RunStatus
+from .types.run_webhook_replay_response import RunWebhookReplayResponse
from .types.script import Script
from .types.script_file_create import ScriptFileCreate
from .types.skyvern_forge_sdk_schemas_credentials_credential_type import SkyvernForgeSdkSchemasCredentialsCredentialType
-from .types.skyvern_schemas_run_blocks_credential_type import SkyvernSchemasRunBlocksCredentialType
+from .types.skyvern_schemas_credential_type_credential_type import SkyvernSchemasCredentialTypeCredentialType
from .types.task_run_list_item import TaskRunListItem
-from .types.task_run_request_data_extraction_schema import TaskRunRequestDataExtractionSchema
-from .types.task_run_request_proxy_location import TaskRunRequestProxyLocation
+from .types.task_run_request_input_data_extraction_schema import TaskRunRequestInputDataExtractionSchema
+from .types.task_run_request_input_proxy_location import TaskRunRequestInputProxyLocation
from .types.task_run_response import TaskRunResponse
from .types.totp_code import TotpCode
from .types.upload_file_response import UploadFileResponse
from .types.workflow import Workflow
from .types.workflow_create_yaml_request import WorkflowCreateYamlRequest
from .types.workflow_run import WorkflowRun
-from .types.workflow_run_request_proxy_location import WorkflowRunRequestProxyLocation
+from .types.workflow_run_request_input_proxy_location import WorkflowRunRequestInputProxyLocation
from .types.workflow_run_response import WorkflowRunResponse
from .types.workflow_run_status import WorkflowRunStatus
from .types.workflow_run_timeline import WorkflowRunTimeline
@@ -52,6 +55,8 @@ if typing.TYPE_CHECKING:
from .artifacts.client import ArtifactsClient, AsyncArtifactsClient
from .schedules.client import AsyncSchedulesClient, SchedulesClient
from .scripts.client import AsyncScriptsClient, ScriptsClient
+ from .server.client import AsyncServerClient, ServerClient
+ from .workflows.client import AsyncWorkflowsClient, WorkflowsClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
@@ -123,6 +128,8 @@ class Skyvern:
)
self._raw_client = RawSkyvern(client_wrapper=self._client_wrapper)
self._artifacts: typing.Optional[ArtifactsClient] = None
+ self._server: typing.Optional[ServerClient] = None
+ self._workflows: typing.Optional[WorkflowsClient] = None
self._scripts: typing.Optional[ScriptsClient] = None
self._schedules: typing.Optional[SchedulesClient] = None
@@ -145,8 +152,8 @@ class Skyvern:
url: typing.Optional[str] = OMIT,
engine: typing.Optional[RunEngine] = OMIT,
title: typing.Optional[str] = OMIT,
- proxy_location: typing.Optional[TaskRunRequestProxyLocation] = OMIT,
- data_extraction_schema: typing.Optional[TaskRunRequestDataExtractionSchema] = OMIT,
+ proxy_location: typing.Optional[TaskRunRequestInputProxyLocation] = OMIT,
+ data_extraction_schema: typing.Optional[TaskRunRequestInputDataExtractionSchema] = OMIT,
error_code_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_steps: typing.Optional[int] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
@@ -155,6 +162,7 @@ class Skyvern:
browser_session_id: typing.Optional[str] = OMIT,
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
publish_workflow: typing.Optional[bool] = OMIT,
include_action_history_in_verification: typing.Optional[bool] = OMIT,
max_screenshot_scrolls: typing.Optional[int] = OMIT,
@@ -184,7 +192,7 @@ class Skyvern:
title : typing.Optional[str]
The title for the task
- proxy_location : typing.Optional[TaskRunRequestProxyLocation]
+ proxy_location : typing.Optional[TaskRunRequestInputProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -200,6 +208,7 @@ class Skyvern:
- 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
@@ -216,9 +225,11 @@ class Skyvern:
- 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:[email protected]: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"}
- data_extraction_schema : typing.Optional[TaskRunRequestDataExtractionSchema]
+ data_extraction_schema : typing.Optional[TaskRunRequestInputDataExtractionSchema]
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/.
@@ -253,6 +264,9 @@ class Skyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
The extra HTTP headers for the requests in browser.
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+
publish_workflow : typing.Optional[bool]
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.
@@ -304,6 +318,7 @@ class Skyvern:
browser_session_id=browser_session_id,
model=model,
extra_http_headers=extra_http_headers,
+ cdp_connect_headers=cdp_connect_headers,
publish_workflow=publish_workflow,
include_action_history_in_verification=include_action_history_in_verification,
max_screenshot_scrolls=max_screenshot_scrolls,
@@ -322,7 +337,7 @@ class Skyvern:
user_agent: typing.Optional[str] = None,
parameters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
title: typing.Optional[str] = OMIT,
- proxy_location: typing.Optional[WorkflowRunRequestProxyLocation] = OMIT,
+ proxy_location: typing.Optional[WorkflowRunRequestInputProxyLocation] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
totp_url: typing.Optional[str] = OMIT,
totp_identifier: typing.Optional[str] = OMIT,
@@ -331,10 +346,11 @@ class Skyvern:
max_screenshot_scrolls: typing.Optional[int] = OMIT,
max_elapsed_time_minutes: typing.Optional[int] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
browser_address: typing.Optional[str] = OMIT,
ai_fallback: typing.Optional[bool] = OMIT,
run_with: typing.Optional[str] = OMIT,
- run_metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
+ run_metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> WorkflowRunResponse:
"""
@@ -357,7 +373,7 @@ class Skyvern:
title : typing.Optional[str]
The title for this workflow run
- proxy_location : typing.Optional[WorkflowRunRequestProxyLocation]
+ proxy_location : typing.Optional[WorkflowRunRequestInputProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -373,6 +389,7 @@ class Skyvern:
- 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
@@ -389,6 +406,8 @@ class Skyvern:
- 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:[email protected]: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"}
webhook_url : typing.Optional[str]
@@ -417,6 +436,9 @@ class Skyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
The extra HTTP headers for the requests in browser.
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+
browser_address : typing.Optional[str]
The CDP address for the workflow run.
@@ -426,7 +448,7 @@ class Skyvern:
run_with : typing.Optional[str]
Whether to run the workflow with agent or code. Null inherits from the workflow setting.
- run_metadata : typing.Optional[typing.Dict[str, str]]
+ run_metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
String key/value metadata to attach to this workflow run for analytics tag filtering.
request_options : typing.Optional[RequestOptions]
@@ -467,6 +489,7 @@ class Skyvern:
max_screenshot_scrolls=max_screenshot_scrolls,
max_elapsed_time_minutes=max_elapsed_time_minutes,
extra_http_headers=extra_http_headers,
+ cdp_connect_headers=cdp_connect_headers,
browser_address=browser_address,
ai_fallback=ai_fallback,
run_with=run_with,
@@ -475,33 +498,22 @@ class Skyvern:
)
return _response.data
- def retry_workflow_run(
- self,
- workflow_run_id: str,
- *,
- max_steps_override: typing.Optional[int] = None,
- user_agent: typing.Optional[str] = None,
- request_options: typing.Optional[RequestOptions] = None,
- ) -> WorkflowRunResponse:
+ def get_run(self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetRunResponse:
"""
- Retry a workflow run using the original run parameters.
+ Get run information (task run, workflow run)
Parameters
----------
- workflow_run_id : str
- The id of the workflow run to retry.
-
- max_steps_override : typing.Optional[int]
-
- user_agent : typing.Optional[str]
+ run_id : str
+ The id of the task run or the workflow run.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- WorkflowRunResponse
- Successfully retried workflow run
+ GetRunResponse
+ Successfully got run
Examples
--------
@@ -510,34 +522,31 @@ class Skyvern:
client = Skyvern(
api_key="YOUR_API_KEY",
)
- client.retry_workflow_run(
- workflow_run_id="wr_123",
+ client.get_run(
+ run_id="tsk_123",
)
"""
- _response = self._raw_client.retry_workflow_run(
- workflow_run_id,
- max_steps_override=max_steps_override,
- user_agent=user_agent,
- request_options=request_options,
- )
+ _response = self._raw_client.get_run(run_id, request_options=request_options)
return _response.data
- def get_run(self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetRunResponse:
+ def cancel_run(
+ self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> typing.Optional[typing.Any]:
"""
- Get run information (task run, workflow run)
+ Cancel a run (task or workflow)
Parameters
----------
run_id : str
- The id of the task run or the workflow run.
+ The id of the task run or the workflow run to cancel.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- GetRunResponse
- Successfully got run
+ typing.Optional[typing.Any]
+ Successful Response
Examples
--------
@@ -546,30 +555,30 @@ class Skyvern:
client = Skyvern(
api_key="YOUR_API_KEY",
)
- client.get_run(
- run_id="tsk_123",
+ client.cancel_run(
+ run_id="run_id",
)
"""
- _response = self._raw_client.get_run(run_id, request_options=request_options)
+ _response = self._raw_client.cancel_run(run_id, request_options=request_options)
return _response.data
- def cancel_run(
- self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
- ) -> typing.Optional[typing.Any]:
+ def bulk_cancel_runs(
+ self, *, run_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
+ ) -> BulkCancelRunsResponse:
"""
- Cancel a run (task or workflow)
+ Cancel multiple runs (tasks or workflows) in a single request
Parameters
----------
- run_id : str
- The id of the task run or the workflow run to cancel.
+ run_ids : typing.Sequence[str]
+ List of run IDs to cancel
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- typing.Optional[typing.Any]
+ BulkCancelRunsResponse
Successful Response
Examples
@@ -579,11 +588,11 @@ class Skyvern:
client = Skyvern(
api_key="YOUR_API_KEY",
)
- client.cancel_run(
- run_id="run_id",
+ client.bulk_cancel_runs(
+ run_ids=["run_ids"],
)
"""
- _response = self._raw_client.cancel_run(run_id, request_options=request_options)
+ _response = self._raw_client.bulk_cancel_runs(run_ids=run_ids, request_options=request_options)
return _response.data
def get_workflows(
@@ -1108,7 +1117,7 @@ class Skyvern:
*,
request: typing.Optional[RetryRunWebhookRequest] = None,
request_options: typing.Optional[RequestOptions] = None,
- ) -> typing.Optional[typing.Any]:
+ ) -> RunWebhookReplayResponse:
"""
Retry sending the webhook for a run
@@ -1124,7 +1133,7 @@ class Skyvern:
Returns
-------
- typing.Optional[typing.Any]
+ RunWebhookReplayResponse
Successful Response
Examples
@@ -1175,6 +1184,55 @@ class Skyvern:
_response = self._raw_client.get_run_timeline(run_id, request_options=request_options)
return _response.data
+ def retry_workflow_run(
+ self,
+ workflow_run_id: str,
+ *,
+ max_steps_override: typing.Optional[int] = None,
+ user_agent: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> WorkflowRunResponse:
+ """
+ Retry a workflow run using the original run parameters.
+
+ Parameters
+ ----------
+ workflow_run_id : str
+ The id of the workflow run to retry.
+
+ max_steps_override : typing.Optional[int]
+
+ user_agent : typing.Optional[str]
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ WorkflowRunResponse
+ Successfully retried workflow run
+
+ Examples
+ --------
+ from skyvern import Skyvern
+
+ client = Skyvern(
+ api_key="YOUR_API_KEY",
+ )
+ client.retry_workflow_run(
+ workflow_run_id="wr_123",
+ max_steps_override=1,
+ user_agent="x-user-agent",
+ )
+ """
+ _response = self._raw_client.retry_workflow_run(
+ workflow_run_id,
+ max_steps_override=max_steps_override,
+ user_agent=user_agent,
+ request_options=request_options,
+ )
+ return _response.data
+
def get_runs_v2(
self,
*,
@@ -1325,10 +1383,19 @@ class Skyvern:
"""
List runs for a specific workflow.
+ Supports filtering by **status**, **search_key**, and **error_code**. All filters are combined with **AND** logic.
+
+ ### search_key
+
+ Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. Soft-deleted parameter definitions are excluded.
+
+ ### error_code
+
+ 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`.
+
Parameters
----------
workflow_id : str
- Workflow permanent ID. Workflow ID starts with `wpid_`.
page : typing.Optional[int]
Page number for pagination.
@@ -1340,10 +1407,10 @@ class Skyvern:
Filter by one or more run statuses.
search_key : typing.Optional[str]
- Case-insensitive substring search across workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers.
+ 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.
error_code : typing.Optional[str]
- Exact-match filter on the error_code field inside each task's errors JSON array.
+ 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.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1352,6 +1419,21 @@ class Skyvern:
-------
typing.List[WorkflowRun]
Successful Response
+
+ Examples
+ --------
+ from skyvern import Skyvern
+
+ client = Skyvern(
+ api_key="YOUR_API_KEY",
+ )
+ client.get_workflow_runs_by_id(
+ workflow_id="workflow_id",
+ page=1,
+ page_size=1,
+ search_key="search_key",
+ error_code="error_code",
+ )
"""
_response = self._raw_client.get_workflow_runs_by_id(
workflow_id,
@@ -1477,16 +1559,29 @@ class Skyvern:
return _response.data
def list_browser_profiles(
- self, *, include_deleted: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None
+ self,
+ *,
+ page: typing.Optional[int] = None,
+ page_size: typing.Optional[int] = None,
+ include_deleted: typing.Optional[bool] = None,
+ search_key: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[BrowserProfile]:
"""
Get all browser profiles for the organization
Parameters
----------
+ page : typing.Optional[int]
+
+ page_size : typing.Optional[int]
+
include_deleted : typing.Optional[bool]
Include deleted browser profiles
+ search_key : typing.Optional[str]
+ Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1503,11 +1598,18 @@ class Skyvern:
api_key="YOUR_API_KEY",
)
client.list_browser_profiles(
+ page=1,
+ page_size=1,
include_deleted=True,
+ search_key="search_key",
)
"""
_response = self._raw_client.list_browser_profiles(
- include_deleted=include_deleted, request_options=request_options
+ page=page,
+ page_size=page_size,
+ include_deleted=include_deleted,
+ search_key=search_key,
+ request_options=request_options,
)
return _response.data
@@ -1630,6 +1732,52 @@ class Skyvern:
_response = self._raw_client.delete_browser_profile(profile_id, request_options=request_options)
return _response.data
+ def update_browser_profile(
+ self,
+ profile_id: str,
+ *,
+ name: typing.Optional[str] = OMIT,
+ description: typing.Optional[str] = OMIT,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> BrowserProfile:
+ """
+ Update a browser profile's name and/or description
+
+ Parameters
+ ----------
+ profile_id : str
+ The ID of the browser profile to update. browser_profile_id starts with `bp_`
+
+ name : typing.Optional[str]
+ New name for the browser profile
+
+ description : typing.Optional[str]
+ New description for the browser profile
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ BrowserProfile
+ Successfully updated browser profile
+
+ Examples
+ --------
+ from skyvern import Skyvern
+
+ client = Skyvern(
+ api_key="YOUR_API_KEY",
+ )
+ client.update_browser_profile(
+ profile_id="bp_123456",
+ )
+ """
+ _response = self._raw_client.update_browser_profile(
+ profile_id, name=name, description=description, request_options=request_options
+ )
+ return _response.data
+
def get_browser_sessions(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.List[BrowserSessionResponse]:
@@ -1662,7 +1810,7 @@ class Skyvern:
self,
*,
timeout: typing.Optional[int] = OMIT,
- proxy_location: typing.Optional[ProxyLocation] = OMIT,
+ proxy_location: typing.Optional[CreateBrowserSessionRequestProxyLocation] = OMIT,
extensions: typing.Optional[typing.Sequence[Extensions]] = OMIT,
browser_type: typing.Optional[PersistentBrowserType] = OMIT,
browser_profile_id: typing.Optional[str] = OMIT,
@@ -1676,7 +1824,7 @@ class Skyvern:
timeout : typing.Optional[int]
Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 1440. Defaults to 60.
- proxy_location : typing.Optional[ProxyLocation]
+ proxy_location : typing.Optional[CreateBrowserSessionRequestProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -1692,6 +1840,7 @@ class Skyvern:
- 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
@@ -1709,6 +1858,9 @@ class Skyvern:
- 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:[email protected]: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"}, or a custom proxy URL dict for self-hosted deployments: {"url": "http://user:[email protected]:8080"}
+
extensions : typing.Optional[typing.Sequence[Extensions]]
A list of extensions to install in the browser session.
@@ -2124,7 +2276,8 @@ class Skyvern:
def login(
self,
*,
- credential_type: SkyvernSchemasRunBlocksCredentialType,
+ credential_type: SkyvernSchemasCredentialTypeCredentialType,
+ user_agent: typing.Optional[str] = None,
url: typing.Optional[str] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
@@ -2134,6 +2287,7 @@ class Skyvern:
browser_profile_id: typing.Optional[str] = OMIT,
browser_address: typing.Optional[str] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_screenshot_scrolling_times: typing.Optional[int] = OMIT,
prompt: typing.Optional[str] = OMIT,
credential_id: typing.Optional[str] = OMIT,
@@ -2152,9 +2306,11 @@ class Skyvern:
Parameters
----------
- credential_type : SkyvernSchemasRunBlocksCredentialType
+ credential_type : SkyvernSchemasCredentialTypeCredentialType
Where to get the credential from
+ user_agent : typing.Optional[str]
+
url : typing.Optional[str]
Website URL
@@ -2182,6 +2338,9 @@ class Skyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
Additional HTTP headers to include in requests
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.
+
max_screenshot_scrolling_times : typing.Optional[int]
Maximum number of times to scroll for screenshots
@@ -2231,11 +2390,13 @@ class Skyvern:
api_key="YOUR_API_KEY",
)
client.login(
+ user_agent="x-user-agent",
credential_type="skyvern",
)
"""
_response = self._raw_client.login(
credential_type=credential_type,
+ user_agent=user_agent,
url=url,
webhook_url=webhook_url,
proxy_location=proxy_location,
@@ -2245,6 +2406,7 @@ class Skyvern:
browser_profile_id=browser_profile_id,
browser_address=browser_address,
extra_http_headers=extra_http_headers,
+ cdp_connect_headers=cdp_connect_headers,
max_screenshot_scrolling_times=max_screenshot_scrolling_times,
prompt=prompt,
credential_id=credential_id,
@@ -2264,6 +2426,7 @@ class Skyvern:
self,
*,
navigation_goal: str,
+ user_agent: typing.Optional[str] = None,
url: typing.Optional[str] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
@@ -2273,6 +2436,7 @@ class Skyvern:
browser_profile_id: typing.Optional[str] = OMIT,
browser_address: typing.Optional[str] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_screenshot_scrolling_times: typing.Optional[int] = OMIT,
download_suffix: typing.Optional[str] = OMIT,
download_timeout: typing.Optional[float] = OMIT,
@@ -2287,6 +2451,8 @@ class Skyvern:
navigation_goal : str
Instructions for navigating to and downloading the file
+ user_agent : typing.Optional[str]
+
url : typing.Optional[str]
Website URL
@@ -2314,6 +2480,9 @@ class Skyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
Additional HTTP headers to include in requests
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.
+
max_screenshot_scrolling_times : typing.Optional[int]
Maximum number of times to scroll for screenshots
@@ -2342,11 +2511,13 @@ class Skyvern:
api_key="YOUR_API_KEY",
)
client.download_files(
+ user_agent="x-user-agent",
navigation_goal="navigation_goal",
)
"""
_response = self._raw_client.download_files(
navigation_goal=navigation_goal,
+ user_agent=user_agent,
url=url,
webhook_url=webhook_url,
proxy_location=proxy_location,
@@ -2356,6 +2527,7 @@ class Skyvern:
browser_profile_id=browser_profile_id,
browser_address=browser_address,
extra_http_headers=extra_http_headers,
+ cdp_connect_headers=cdp_connect_headers,
max_screenshot_scrolling_times=max_screenshot_scrolling_times,
download_suffix=download_suffix,
download_timeout=download_timeout,
@@ -2594,6 +2766,22 @@ class Skyvern:
self._artifacts = ArtifactsClient(client_wrapper=self._client_wrapper)
return self._artifacts
+ @property
+ def server(self):
+ if self._server is None:
+ from .server.client import ServerClient # noqa: E402
+
+ self._server = ServerClient(client_wrapper=self._client_wrapper)
+ return self._server
+
+ @property
+ def workflows(self):
+ if self._workflows is None:
+ from .workflows.client import WorkflowsClient # noqa: E402
+
+ self._workflows = WorkflowsClient(client_wrapper=self._client_wrapper)
+ return self._workflows
+
@property
def scripts(self):
if self._scripts is None:
@@ -2678,6 +2866,8 @@ class AsyncSkyvern:
)
self._raw_client = AsyncRawSkyvern(client_wrapper=self._client_wrapper)
self._artifacts: typing.Optional[AsyncArtifactsClient] = None
+ self._server: typing.Optional[AsyncServerClient] = None
+ self._workflows: typing.Optional[AsyncWorkflowsClient] = None
self._scripts: typing.Optional[AsyncScriptsClient] = None
self._schedules: typing.Optional[AsyncSchedulesClient] = None
@@ -2700,8 +2890,8 @@ class AsyncSkyvern:
url: typing.Optional[str] = OMIT,
engine: typing.Optional[RunEngine] = OMIT,
title: typing.Optional[str] = OMIT,
- proxy_location: typing.Optional[TaskRunRequestProxyLocation] = OMIT,
- data_extraction_schema: typing.Optional[TaskRunRequestDataExtractionSchema] = OMIT,
+ proxy_location: typing.Optional[TaskRunRequestInputProxyLocation] = OMIT,
+ data_extraction_schema: typing.Optional[TaskRunRequestInputDataExtractionSchema] = OMIT,
error_code_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_steps: typing.Optional[int] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
@@ -2710,6 +2900,7 @@ class AsyncSkyvern:
browser_session_id: typing.Optional[str] = OMIT,
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
publish_workflow: typing.Optional[bool] = OMIT,
include_action_history_in_verification: typing.Optional[bool] = OMIT,
max_screenshot_scrolls: typing.Optional[int] = OMIT,
@@ -2739,7 +2930,7 @@ class AsyncSkyvern:
title : typing.Optional[str]
The title for the task
- proxy_location : typing.Optional[TaskRunRequestProxyLocation]
+ proxy_location : typing.Optional[TaskRunRequestInputProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -2755,6 +2946,7 @@ class AsyncSkyvern:
- 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
@@ -2771,9 +2963,11 @@ class AsyncSkyvern:
- 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:[email protected]: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"}
- data_extraction_schema : typing.Optional[TaskRunRequestDataExtractionSchema]
+ data_extraction_schema : typing.Optional[TaskRunRequestInputDataExtractionSchema]
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/.
@@ -2808,6 +3002,9 @@ class AsyncSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
The extra HTTP headers for the requests in browser.
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+
publish_workflow : typing.Optional[bool]
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.
@@ -2867,6 +3064,7 @@ class AsyncSkyvern:
browser_session_id=browser_session_id,
model=model,
extra_http_headers=extra_http_headers,
+ cdp_connect_headers=cdp_connect_headers,
publish_workflow=publish_workflow,
include_action_history_in_verification=include_action_history_in_verification,
max_screenshot_scrolls=max_screenshot_scrolls,
@@ -2885,7 +3083,7 @@ class AsyncSkyvern:
user_agent: typing.Optional[str] = None,
parameters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
title: typing.Optional[str] = OMIT,
- proxy_location: typing.Optional[WorkflowRunRequestProxyLocation] = OMIT,
+ proxy_location: typing.Optional[WorkflowRunRequestInputProxyLocation] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
totp_url: typing.Optional[str] = OMIT,
totp_identifier: typing.Optional[str] = OMIT,
@@ -2894,10 +3092,11 @@ class AsyncSkyvern:
max_screenshot_scrolls: typing.Optional[int] = OMIT,
max_elapsed_time_minutes: typing.Optional[int] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
browser_address: typing.Optional[str] = OMIT,
ai_fallback: typing.Optional[bool] = OMIT,
run_with: typing.Optional[str] = OMIT,
- run_metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
+ run_metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> WorkflowRunResponse:
"""
@@ -2920,7 +3119,7 @@ class AsyncSkyvern:
title : typing.Optional[str]
The title for this workflow run
- proxy_location : typing.Optional[WorkflowRunRequestProxyLocation]
+ proxy_location : typing.Optional[WorkflowRunRequestInputProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -2936,6 +3135,7 @@ class AsyncSkyvern:
- 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
@@ -2952,6 +3152,8 @@ class AsyncSkyvern:
- 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:[email protected]: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"}
webhook_url : typing.Optional[str]
@@ -2980,6 +3182,9 @@ class AsyncSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
The extra HTTP headers for the requests in browser.
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+
browser_address : typing.Optional[str]
The CDP address for the workflow run.
@@ -2989,7 +3194,7 @@ class AsyncSkyvern:
run_with : typing.Optional[str]
Whether to run the workflow with agent or code. Null inherits from the workflow setting.
- run_metadata : typing.Optional[typing.Dict[str, str]]
+ run_metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
String key/value metadata to attach to this workflow run for analytics tag filtering.
request_options : typing.Optional[RequestOptions]
@@ -3038,6 +3243,7 @@ class AsyncSkyvern:
max_screenshot_scrolls=max_screenshot_scrolls,
max_elapsed_time_minutes=max_elapsed_time_minutes,
extra_http_headers=extra_http_headers,
+ cdp_connect_headers=cdp_connect_headers,
browser_address=browser_address,
ai_fallback=ai_fallback,
run_with=run_with,
@@ -3046,33 +3252,22 @@ class AsyncSkyvern:
)
return _response.data
- async def retry_workflow_run(
- self,
- workflow_run_id: str,
- *,
- max_steps_override: typing.Optional[int] = None,
- user_agent: typing.Optional[str] = None,
- request_options: typing.Optional[RequestOptions] = None,
- ) -> WorkflowRunResponse:
+ async def get_run(self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetRunResponse:
"""
- Retry a workflow run using the original run parameters.
+ Get run information (task run, workflow run)
Parameters
----------
- workflow_run_id : str
- The id of the workflow run to retry.
-
- max_steps_override : typing.Optional[int]
-
- user_agent : typing.Optional[str]
+ run_id : str
+ The id of the task run or the workflow run.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- WorkflowRunResponse
- Successfully retried workflow run
+ GetRunResponse
+ Successfully got run
Examples
--------
@@ -3086,37 +3281,34 @@ class AsyncSkyvern:
async def main() -> None:
- await client.retry_workflow_run(
- workflow_run_id="wr_123",
+ await client.get_run(
+ run_id="tsk_123",
)
asyncio.run(main())
"""
- _response = await self._raw_client.retry_workflow_run(
- workflow_run_id,
- max_steps_override=max_steps_override,
- user_agent=user_agent,
- request_options=request_options,
- )
+ _response = await self._raw_client.get_run(run_id, request_options=request_options)
return _response.data
- async def get_run(self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetRunResponse:
+ async def cancel_run(
+ self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> typing.Optional[typing.Any]:
"""
- Get run information (task run, workflow run)
+ Cancel a run (task or workflow)
Parameters
----------
run_id : str
- The id of the task run or the workflow run.
+ The id of the task run or the workflow run to cancel.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- GetRunResponse
- Successfully got run
+ typing.Optional[typing.Any]
+ Successful Response
Examples
--------
@@ -3130,33 +3322,33 @@ class AsyncSkyvern:
async def main() -> None:
- await client.get_run(
- run_id="tsk_123",
+ await client.cancel_run(
+ run_id="run_id",
)
asyncio.run(main())
"""
- _response = await self._raw_client.get_run(run_id, request_options=request_options)
+ _response = await self._raw_client.cancel_run(run_id, request_options=request_options)
return _response.data
- async def cancel_run(
- self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
- ) -> typing.Optional[typing.Any]:
+ async def bulk_cancel_runs(
+ self, *, run_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
+ ) -> BulkCancelRunsResponse:
"""
- Cancel a run (task or workflow)
+ Cancel multiple runs (tasks or workflows) in a single request
Parameters
----------
- run_id : str
- The id of the task run or the workflow run to cancel.
+ run_ids : typing.Sequence[str]
+ List of run IDs to cancel
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- typing.Optional[typing.Any]
+ BulkCancelRunsResponse
Successful Response
Examples
@@ -3171,14 +3363,14 @@ class AsyncSkyvern:
async def main() -> None:
- await client.cancel_run(
- run_id="run_id",
+ await client.bulk_cancel_runs(
+ run_ids=["run_ids"],
)
asyncio.run(main())
"""
- _response = await self._raw_client.cancel_run(run_id, request_options=request_options)
+ _response = await self._raw_client.bulk_cancel_runs(run_ids=run_ids, request_options=request_options)
return _response.data
async def get_workflows(
@@ -3791,7 +3983,7 @@ class AsyncSkyvern:
*,
request: typing.Optional[RetryRunWebhookRequest] = None,
request_options: typing.Optional[RequestOptions] = None,
- ) -> typing.Optional[typing.Any]:
+ ) -> RunWebhookReplayResponse:
"""
Retry sending the webhook for a run
@@ -3807,7 +3999,7 @@ class AsyncSkyvern:
Returns
-------
- typing.Optional[typing.Any]
+ RunWebhookReplayResponse
Successful Response
Examples
@@ -3874,6 +4066,63 @@ class AsyncSkyvern:
_response = await self._raw_client.get_run_timeline(run_id, request_options=request_options)
return _response.data
+ async def retry_workflow_run(
+ self,
+ workflow_run_id: str,
+ *,
+ max_steps_override: typing.Optional[int] = None,
+ user_agent: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> WorkflowRunResponse:
+ """
+ Retry a workflow run using the original run parameters.
+
+ Parameters
+ ----------
+ workflow_run_id : str
+ The id of the workflow run to retry.
+
+ max_steps_override : typing.Optional[int]
+
+ user_agent : typing.Optional[str]
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ WorkflowRunResponse
+ Successfully retried workflow run
+
+ Examples
+ --------
+ import asyncio
+
+ from skyvern import AsyncSkyvern
+
+ client = AsyncSkyvern(
+ api_key="YOUR_API_KEY",
+ )
+
+
+ async def main() -> None:
+ await client.retry_workflow_run(
+ workflow_run_id="wr_123",
+ max_steps_override=1,
+ user_agent="x-user-agent",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.retry_workflow_run(
+ workflow_run_id,
+ max_steps_override=max_steps_override,
+ user_agent=user_agent,
+ request_options=request_options,
+ )
+ return _response.data
+
async def get_runs_v2(
self,
*,
@@ -4040,10 +4289,19 @@ class AsyncSkyvern:
"""
List runs for a specific workflow.
+ Supports filtering by **status**, **search_key**, and **error_code**. All filters are combined with **AND** logic.
+
+ ### search_key
+
+ Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. Soft-deleted parameter definitions are excluded.
+
+ ### error_code
+
+ 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`.
+
Parameters
----------
workflow_id : str
- Workflow permanent ID. Workflow ID starts with `wpid_`.
page : typing.Optional[int]
Page number for pagination.
@@ -4055,10 +4313,10 @@ class AsyncSkyvern:
Filter by one or more run statuses.
search_key : typing.Optional[str]
- Case-insensitive substring search across workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers.
+ 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.
error_code : typing.Optional[str]
- Exact-match filter on the error_code field inside each task's errors JSON array.
+ 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.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -4067,6 +4325,29 @@ class AsyncSkyvern:
-------
typing.List[WorkflowRun]
Successful Response
+
+ Examples
+ --------
+ import asyncio
+
+ from skyvern import AsyncSkyvern
+
+ client = AsyncSkyvern(
+ api_key="YOUR_API_KEY",
+ )
+
+
+ async def main() -> None:
+ await client.get_workflow_runs_by_id(
+ workflow_id="workflow_id",
+ page=1,
+ page_size=1,
+ search_key="search_key",
+ error_code="error_code",
+ )
+
+
+ asyncio.run(main())
"""
_response = await self._raw_client.get_workflow_runs_by_id(
workflow_id,
@@ -4218,16 +4499,29 @@ class AsyncSkyvern:
return _response.data
async def list_browser_profiles(
- self, *, include_deleted: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None
+ self,
+ *,
+ page: typing.Optional[int] = None,
+ page_size: typing.Optional[int] = None,
+ include_deleted: typing.Optional[bool] = None,
+ search_key: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[BrowserProfile]:
"""
Get all browser profiles for the organization
Parameters
----------
+ page : typing.Optional[int]
+
+ page_size : typing.Optional[int]
+
include_deleted : typing.Optional[bool]
Include deleted browser profiles
+ search_key : typing.Optional[str]
+ Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -4249,14 +4543,21 @@ class AsyncSkyvern:
async def main() -> None:
await client.list_browser_profiles(
+ page=1,
+ page_size=1,
include_deleted=True,
+ search_key="search_key",
)
asyncio.run(main())
"""
_response = await self._raw_client.list_browser_profiles(
- include_deleted=include_deleted, request_options=request_options
+ page=page,
+ page_size=page_size,
+ include_deleted=include_deleted,
+ search_key=search_key,
+ request_options=request_options,
)
return _response.data
@@ -4403,6 +4704,60 @@ class AsyncSkyvern:
_response = await self._raw_client.delete_browser_profile(profile_id, request_options=request_options)
return _response.data
+ async def update_browser_profile(
+ self,
+ profile_id: str,
+ *,
+ name: typing.Optional[str] = OMIT,
+ description: typing.Optional[str] = OMIT,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> BrowserProfile:
+ """
+ Update a browser profile's name and/or description
+
+ Parameters
+ ----------
+ profile_id : str
+ The ID of the browser profile to update. browser_profile_id starts with `bp_`
+
+ name : typing.Optional[str]
+ New name for the browser profile
+
+ description : typing.Optional[str]
+ New description for the browser profile
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ BrowserProfile
+ Successfully updated browser profile
+
+ Examples
+ --------
+ import asyncio
+
+ from skyvern import AsyncSkyvern
+
+ client = AsyncSkyvern(
+ api_key="YOUR_API_KEY",
+ )
+
+
+ async def main() -> None:
+ await client.update_browser_profile(
+ profile_id="bp_123456",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.update_browser_profile(
+ profile_id, name=name, description=description, request_options=request_options
+ )
+ return _response.data
+
async def get_browser_sessions(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.List[BrowserSessionResponse]:
@@ -4443,7 +4798,7 @@ class AsyncSkyvern:
self,
*,
timeout: typing.Optional[int] = OMIT,
- proxy_location: typing.Optional[ProxyLocation] = OMIT,
+ proxy_location: typing.Optional[CreateBrowserSessionRequestProxyLocation] = OMIT,
extensions: typing.Optional[typing.Sequence[Extensions]] = OMIT,
browser_type: typing.Optional[PersistentBrowserType] = OMIT,
browser_profile_id: typing.Optional[str] = OMIT,
@@ -4457,7 +4812,7 @@ class AsyncSkyvern:
timeout : typing.Optional[int]
Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 1440. Defaults to 60.
- proxy_location : typing.Optional[ProxyLocation]
+ proxy_location : typing.Optional[CreateBrowserSessionRequestProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -4473,6 +4828,7 @@ class AsyncSkyvern:
- 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
@@ -4490,6 +4846,9 @@ class AsyncSkyvern:
- 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:[email protected]: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"}, or a custom proxy URL dict for self-hosted deployments: {"url": "http://user:[email protected]:8080"}
+
extensions : typing.Optional[typing.Sequence[Extensions]]
A list of extensions to install in the browser session.
@@ -4979,7 +5338,8 @@ class AsyncSkyvern:
async def login(
self,
*,
- credential_type: SkyvernSchemasRunBlocksCredentialType,
+ credential_type: SkyvernSchemasCredentialTypeCredentialType,
+ user_agent: typing.Optional[str] = None,
url: typing.Optional[str] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
@@ -4989,6 +5349,7 @@ class AsyncSkyvern:
browser_profile_id: typing.Optional[str] = OMIT,
browser_address: typing.Optional[str] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_screenshot_scrolling_times: typing.Optional[int] = OMIT,
prompt: typing.Optional[str] = OMIT,
credential_id: typing.Optional[str] = OMIT,
@@ -5007,9 +5368,11 @@ class AsyncSkyvern:
Parameters
----------
- credential_type : SkyvernSchemasRunBlocksCredentialType
+ credential_type : SkyvernSchemasCredentialTypeCredentialType
Where to get the credential from
+ user_agent : typing.Optional[str]
+
url : typing.Optional[str]
Website URL
@@ -5037,6 +5400,9 @@ class AsyncSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
Additional HTTP headers to include in requests
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.
+
max_screenshot_scrolling_times : typing.Optional[int]
Maximum number of times to scroll for screenshots
@@ -5091,6 +5457,7 @@ class AsyncSkyvern:
async def main() -> None:
await client.login(
+ user_agent="x-user-agent",
credential_type="skyvern",
)
@@ -5099,6 +5466,7 @@ class AsyncSkyvern:
"""
_response = await self._raw_client.login(
credential_type=credential_type,
+ user_agent=user_agent,
url=url,
webhook_url=webhook_url,
proxy_location=proxy_location,
@@ -5108,6 +5476,7 @@ class AsyncSkyvern:
browser_profile_id=browser_profile_id,
browser_address=browser_address,
extra_http_headers=extra_http_headers,
+ cdp_connect_headers=cdp_connect_headers,
max_screenshot_scrolling_times=max_screenshot_scrolling_times,
prompt=prompt,
credential_id=credential_id,
@@ -5127,6 +5496,7 @@ class AsyncSkyvern:
self,
*,
navigation_goal: str,
+ user_agent: typing.Optional[str] = None,
url: typing.Optional[str] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
@@ -5136,6 +5506,7 @@ class AsyncSkyvern:
browser_profile_id: typing.Optional[str] = OMIT,
browser_address: typing.Optional[str] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_screenshot_scrolling_times: typing.Optional[int] = OMIT,
download_suffix: typing.Optional[str] = OMIT,
download_timeout: typing.Optional[float] = OMIT,
@@ -5150,6 +5521,8 @@ class AsyncSkyvern:
navigation_goal : str
Instructions for navigating to and downloading the file
+ user_agent : typing.Optional[str]
+
url : typing.Optional[str]
Website URL
@@ -5177,6 +5550,9 @@ class AsyncSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
Additional HTTP headers to include in requests
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.
+
max_screenshot_scrolling_times : typing.Optional[int]
Maximum number of times to scroll for screenshots
@@ -5210,6 +5586,7 @@ class AsyncSkyvern:
async def main() -> None:
await client.download_files(
+ user_agent="x-user-agent",
navigation_goal="navigation_goal",
)
@@ -5218,6 +5595,7 @@ class AsyncSkyvern:
"""
_response = await self._raw_client.download_files(
navigation_goal=navigation_goal,
+ user_agent=user_agent,
url=url,
webhook_url=webhook_url,
proxy_location=proxy_location,
@@ -5227,6 +5605,7 @@ class AsyncSkyvern:
browser_profile_id=browser_profile_id,
browser_address=browser_address,
extra_http_headers=extra_http_headers,
+ cdp_connect_headers=cdp_connect_headers,
max_screenshot_scrolling_times=max_screenshot_scrolling_times,
download_suffix=download_suffix,
download_timeout=download_timeout,
@@ -5505,6 +5884,22 @@ class AsyncSkyvern:
self._artifacts = AsyncArtifactsClient(client_wrapper=self._client_wrapper)
return self._artifacts
+ @property
+ def server(self):
+ if self._server is None:
+ from .server.client import AsyncServerClient # noqa: E402
+
+ self._server = AsyncServerClient(client_wrapper=self._client_wrapper)
+ return self._server
+
+ @property
+ def workflows(self):
+ if self._workflows is None:
+ from .workflows.client import AsyncWorkflowsClient # noqa: E402
+
+ self._workflows = AsyncWorkflowsClient(client_wrapper=self._client_wrapper)
+ return self._workflows
+
@property
def scripts(self):
if self._scripts is None:
diff --git a/skyvern/client/core/client_wrapper.py b/skyvern/client/core/client_wrapper.py
index 37f2cdbcd..bd630dbf0 100644
--- a/skyvern/client/core/client_wrapper.py
+++ b/skyvern/client/core/client_wrapper.py
@@ -22,10 +22,10 @@ class BaseClientWrapper:
def get_headers(self) -> typing.Dict[str, str]:
headers: typing.Dict[str, str] = {
- "User-Agent": "skyvern/1.0.34",
+ "User-Agent": "skyvern/1.0.37",
"X-Fern-Language": "Python",
"X-Fern-SDK-Name": "skyvern",
- "X-Fern-SDK-Version": "1.0.34",
+ "X-Fern-SDK-Version": "1.0.37",
**(self.get_custom_headers() or {}),
}
if self._api_key is not None:
diff --git a/skyvern/client/errors/__init__.py b/skyvern/client/errors/__init__.py
index 40b205910..4415e0d6b 100644
--- a/skyvern/client/errors/__init__.py
+++ b/skyvern/client/errors/__init__.py
@@ -9,13 +9,17 @@ if typing.TYPE_CHECKING:
from .bad_request_error import BadRequestError
from .conflict_error import ConflictError
from .forbidden_error import ForbiddenError
+ from .internal_server_error import InternalServerError
from .not_found_error import NotFoundError
+ from .range_not_satisfiable_error import RangeNotSatisfiableError
from .unprocessable_entity_error import UnprocessableEntityError
_dynamic_imports: typing.Dict[str, str] = {
"BadRequestError": ".bad_request_error",
"ConflictError": ".conflict_error",
"ForbiddenError": ".forbidden_error",
+ "InternalServerError": ".internal_server_error",
"NotFoundError": ".not_found_error",
+ "RangeNotSatisfiableError": ".range_not_satisfiable_error",
"UnprocessableEntityError": ".unprocessable_entity_error",
}
@@ -41,4 +45,12 @@ def __dir__():
return sorted(lazy_attrs)
-__all__ = ["BadRequestError", "ConflictError", "ForbiddenError", "NotFoundError", "UnprocessableEntityError"]
+__all__ = [
+ "BadRequestError",
+ "ConflictError",
+ "ForbiddenError",
+ "InternalServerError",
+ "NotFoundError",
+ "RangeNotSatisfiableError",
+ "UnprocessableEntityError",
+]
diff --git a/skyvern/client/errors/internal_server_error.py b/skyvern/client/errors/internal_server_error.py
new file mode 100644
index 000000000..14313ab41
--- /dev/null
+++ b/skyvern/client/errors/internal_server_error.py
@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class InternalServerError(ApiError):
+ def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+ super().__init__(status_code=500, headers=headers, body=body)
diff --git a/skyvern/client/errors/range_not_satisfiable_error.py b/skyvern/client/errors/range_not_satisfiable_error.py
new file mode 100644
index 000000000..079822df7
--- /dev/null
+++ b/skyvern/client/errors/range_not_satisfiable_error.py
@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class RangeNotSatisfiableError(ApiError):
+ def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+ super().__init__(status_code=416, headers=headers, body=body)
diff --git a/skyvern/client/raw_client.py b/skyvern/client/raw_client.py
index 4b8668351..0757d005b 100644
--- a/skyvern/client/raw_client.py
+++ b/skyvern/client/raw_client.py
@@ -20,6 +20,8 @@ from .types.artifact import Artifact
from .types.artifact_type import ArtifactType
from .types.browser_profile import BrowserProfile
from .types.browser_session_response import BrowserSessionResponse
+from .types.bulk_cancel_runs_response import BulkCancelRunsResponse
+from .types.create_browser_session_request_proxy_location import CreateBrowserSessionRequestProxyLocation
from .types.create_credential_request_credential import CreateCredentialRequestCredential
from .types.create_script_response import CreateScriptResponse
from .types.credential_response import CredentialResponse
@@ -35,20 +37,21 @@ from .types.run_engine import RunEngine
from .types.run_sdk_action_request_action import RunSdkActionRequestAction
from .types.run_sdk_action_response import RunSdkActionResponse
from .types.run_status import RunStatus
+from .types.run_webhook_replay_response import RunWebhookReplayResponse
from .types.script import Script
from .types.script_file_create import ScriptFileCreate
from .types.skyvern_forge_sdk_schemas_credentials_credential_type import SkyvernForgeSdkSchemasCredentialsCredentialType
-from .types.skyvern_schemas_run_blocks_credential_type import SkyvernSchemasRunBlocksCredentialType
+from .types.skyvern_schemas_credential_type_credential_type import SkyvernSchemasCredentialTypeCredentialType
from .types.task_run_list_item import TaskRunListItem
-from .types.task_run_request_data_extraction_schema import TaskRunRequestDataExtractionSchema
-from .types.task_run_request_proxy_location import TaskRunRequestProxyLocation
+from .types.task_run_request_input_data_extraction_schema import TaskRunRequestInputDataExtractionSchema
+from .types.task_run_request_input_proxy_location import TaskRunRequestInputProxyLocation
from .types.task_run_response import TaskRunResponse
from .types.totp_code import TotpCode
from .types.upload_file_response import UploadFileResponse
from .types.workflow import Workflow
from .types.workflow_create_yaml_request import WorkflowCreateYamlRequest
from .types.workflow_run import WorkflowRun
-from .types.workflow_run_request_proxy_location import WorkflowRunRequestProxyLocation
+from .types.workflow_run_request_input_proxy_location import WorkflowRunRequestInputProxyLocation
from .types.workflow_run_response import WorkflowRunResponse
from .types.workflow_run_status import WorkflowRunStatus
from .types.workflow_run_timeline import WorkflowRunTimeline
@@ -70,8 +73,8 @@ class RawSkyvern:
url: typing.Optional[str] = OMIT,
engine: typing.Optional[RunEngine] = OMIT,
title: typing.Optional[str] = OMIT,
- proxy_location: typing.Optional[TaskRunRequestProxyLocation] = OMIT,
- data_extraction_schema: typing.Optional[TaskRunRequestDataExtractionSchema] = OMIT,
+ proxy_location: typing.Optional[TaskRunRequestInputProxyLocation] = OMIT,
+ data_extraction_schema: typing.Optional[TaskRunRequestInputDataExtractionSchema] = OMIT,
error_code_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_steps: typing.Optional[int] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
@@ -80,6 +83,7 @@ class RawSkyvern:
browser_session_id: typing.Optional[str] = OMIT,
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
publish_workflow: typing.Optional[bool] = OMIT,
include_action_history_in_verification: typing.Optional[bool] = OMIT,
max_screenshot_scrolls: typing.Optional[int] = OMIT,
@@ -109,7 +113,7 @@ class RawSkyvern:
title : typing.Optional[str]
The title for the task
- proxy_location : typing.Optional[TaskRunRequestProxyLocation]
+ proxy_location : typing.Optional[TaskRunRequestInputProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -125,6 +129,7 @@ class RawSkyvern:
- 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
@@ -141,9 +146,11 @@ class RawSkyvern:
- 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:[email protected]: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"}
- data_extraction_schema : typing.Optional[TaskRunRequestDataExtractionSchema]
+ data_extraction_schema : typing.Optional[TaskRunRequestInputDataExtractionSchema]
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/.
@@ -178,6 +185,9 @@ class RawSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
The extra HTTP headers for the requests in browser.
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+
publish_workflow : typing.Optional[bool]
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.
@@ -210,10 +220,12 @@ class RawSkyvern:
"engine": engine,
"title": title,
"proxy_location": convert_and_respect_annotation_metadata(
- object_=proxy_location, annotation=TaskRunRequestProxyLocation, direction="write"
+ object_=proxy_location, annotation=TaskRunRequestInputProxyLocation, direction="write"
),
"data_extraction_schema": convert_and_respect_annotation_metadata(
- object_=data_extraction_schema, annotation=TaskRunRequestDataExtractionSchema, direction="write"
+ object_=data_extraction_schema,
+ annotation=TaskRunRequestInputDataExtractionSchema,
+ direction="write",
),
"error_code_mapping": error_code_mapping,
"max_steps": max_steps,
@@ -223,6 +235,7 @@ class RawSkyvern:
"browser_session_id": browser_session_id,
"model": model,
"extra_http_headers": extra_http_headers,
+ "cdp_connect_headers": cdp_connect_headers,
"publish_workflow": publish_workflow,
"include_action_history_in_verification": include_action_history_in_verification,
"max_screenshot_scrolls": max_screenshot_scrolls,
@@ -282,7 +295,7 @@ class RawSkyvern:
user_agent: typing.Optional[str] = None,
parameters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
title: typing.Optional[str] = OMIT,
- proxy_location: typing.Optional[WorkflowRunRequestProxyLocation] = OMIT,
+ proxy_location: typing.Optional[WorkflowRunRequestInputProxyLocation] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
totp_url: typing.Optional[str] = OMIT,
totp_identifier: typing.Optional[str] = OMIT,
@@ -291,10 +304,11 @@ class RawSkyvern:
max_screenshot_scrolls: typing.Optional[int] = OMIT,
max_elapsed_time_minutes: typing.Optional[int] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
browser_address: typing.Optional[str] = OMIT,
ai_fallback: typing.Optional[bool] = OMIT,
run_with: typing.Optional[str] = OMIT,
- run_metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
+ run_metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[WorkflowRunResponse]:
"""
@@ -317,7 +331,7 @@ class RawSkyvern:
title : typing.Optional[str]
The title for this workflow run
- proxy_location : typing.Optional[WorkflowRunRequestProxyLocation]
+ proxy_location : typing.Optional[WorkflowRunRequestInputProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -333,6 +347,7 @@ class RawSkyvern:
- 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
@@ -349,6 +364,8 @@ class RawSkyvern:
- 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:[email protected]: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"}
webhook_url : typing.Optional[str]
@@ -377,6 +394,9 @@ class RawSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
The extra HTTP headers for the requests in browser.
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+
browser_address : typing.Optional[str]
The CDP address for the workflow run.
@@ -386,7 +406,7 @@ class RawSkyvern:
run_with : typing.Optional[str]
Whether to run the workflow with agent or code. Null inherits from the workflow setting.
- run_metadata : typing.Optional[typing.Dict[str, str]]
+ run_metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
String key/value metadata to attach to this workflow run for analytics tag filtering.
request_options : typing.Optional[RequestOptions]
@@ -408,7 +428,7 @@ class RawSkyvern:
"parameters": parameters,
"title": title,
"proxy_location": convert_and_respect_annotation_metadata(
- object_=proxy_location, annotation=WorkflowRunRequestProxyLocation, direction="write"
+ object_=proxy_location, annotation=WorkflowRunRequestInputProxyLocation, direction="write"
),
"webhook_url": webhook_url,
"totp_url": totp_url,
@@ -418,6 +438,7 @@ class RawSkyvern:
"max_screenshot_scrolls": max_screenshot_scrolls,
"max_elapsed_time_minutes": max_elapsed_time_minutes,
"extra_http_headers": extra_http_headers,
+ "cdp_connect_headers": cdp_connect_headers,
"browser_address": browser_address,
"ai_fallback": ai_fallback,
"run_with": run_with,
@@ -468,65 +489,40 @@ class RawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
- def retry_workflow_run(
- self,
- workflow_run_id: str,
- *,
- max_steps_override: typing.Optional[int] = None,
- user_agent: typing.Optional[str] = None,
- request_options: typing.Optional[RequestOptions] = None,
- ) -> HttpResponse[WorkflowRunResponse]:
+ def get_run(
+ self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[GetRunResponse]:
"""
- Retry a workflow run using the original run parameters.
+ Get run information (task run, workflow run)
Parameters
----------
- workflow_run_id : str
- The id of the workflow run to retry.
-
- max_steps_override : typing.Optional[int]
-
- user_agent : typing.Optional[str]
+ run_id : str
+ The id of the task run or the workflow run.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- HttpResponse[WorkflowRunResponse]
- Successfully retried workflow run
+ HttpResponse[GetRunResponse]
+ Successfully got run
"""
_response = self._client_wrapper.httpx_client.request(
- f"v1/workflows/runs/{jsonable_encoder(workflow_run_id)}/retry",
- method="POST",
- headers={
- "x-max-steps-override": str(max_steps_override) if max_steps_override is not None else None,
- "x-user-agent": str(user_agent) if user_agent is not None else None,
- },
+ f"v1/runs/{jsonable_encoder(run_id)}",
+ method="GET",
request_options=request_options,
- omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
- WorkflowRunResponse,
+ GetRunResponse,
parse_obj_as(
- type_=WorkflowRunResponse, # type: ignore
+ type_=GetRunResponse, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
- if _response.status_code == 400:
- raise BadRequestError(
- headers=dict(_response.headers),
- body=typing.cast(
- typing.Optional[typing.Any],
- parse_obj_as(
- type_=typing.Optional[typing.Any], # type: ignore
- object_=_response.json(),
- ),
- ),
- )
if _response.status_code == 404:
raise NotFoundError(
headers=dict(_response.headers),
@@ -554,51 +550,42 @@ class RawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
- def get_run(
+ def cancel_run(
self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
- ) -> HttpResponse[GetRunResponse]:
+ ) -> HttpResponse[typing.Optional[typing.Any]]:
"""
- Get run information (task run, workflow run)
+ Cancel a run (task or workflow)
Parameters
----------
run_id : str
- The id of the task run or the workflow run.
+ The id of the task run or the workflow run to cancel.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- HttpResponse[GetRunResponse]
- Successfully got run
+ HttpResponse[typing.Optional[typing.Any]]
+ Successful Response
"""
_response = self._client_wrapper.httpx_client.request(
- f"v1/runs/{jsonable_encoder(run_id)}",
- method="GET",
+ f"v1/runs/{jsonable_encoder(run_id)}/cancel",
+ method="POST",
request_options=request_options,
)
try:
+ if _response is None or not _response.text.strip():
+ return HttpResponse(response=_response, data=None)
if 200 <= _response.status_code < 300:
_data = typing.cast(
- GetRunResponse,
+ typing.Optional[typing.Any],
parse_obj_as(
- type_=GetRunResponse, # type: ignore
+ type_=typing.Optional[typing.Any], # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
- if _response.status_code == 404:
- raise NotFoundError(
- headers=dict(_response.headers),
- body=typing.cast(
- typing.Optional[typing.Any],
- parse_obj_as(
- type_=typing.Optional[typing.Any], # type: ignore
- object_=_response.json(),
- ),
- ),
- )
if _response.status_code == 422:
raise UnprocessableEntityError(
headers=dict(_response.headers),
@@ -615,38 +602,43 @@ class RawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
- def cancel_run(
- self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
- ) -> HttpResponse[typing.Optional[typing.Any]]:
+ def bulk_cancel_runs(
+ self, *, run_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[BulkCancelRunsResponse]:
"""
- Cancel a run (task or workflow)
+ Cancel multiple runs (tasks or workflows) in a single request
Parameters
----------
- run_id : str
- The id of the task run or the workflow run to cancel.
+ run_ids : typing.Sequence[str]
+ List of run IDs to cancel
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- HttpResponse[typing.Optional[typing.Any]]
+ HttpResponse[BulkCancelRunsResponse]
Successful Response
"""
_response = self._client_wrapper.httpx_client.request(
- f"v1/runs/{jsonable_encoder(run_id)}/cancel",
+ "v1/runs/cancel",
method="POST",
+ json={
+ "run_ids": run_ids,
+ },
+ headers={
+ "content-type": "application/json",
+ },
request_options=request_options,
+ omit=OMIT,
)
try:
- if _response is None or not _response.text.strip():
- return HttpResponse(response=_response, data=None)
if 200 <= _response.status_code < 300:
_data = typing.cast(
- typing.Optional[typing.Any],
+ BulkCancelRunsResponse,
parse_obj_as(
- type_=typing.Optional[typing.Any], # type: ignore
+ type_=BulkCancelRunsResponse, # type: ignore
object_=_response.json(),
),
)
@@ -1470,7 +1462,7 @@ class RawSkyvern:
*,
request: typing.Optional[RetryRunWebhookRequest] = None,
request_options: typing.Optional[RequestOptions] = None,
- ) -> HttpResponse[typing.Optional[typing.Any]]:
+ ) -> HttpResponse[RunWebhookReplayResponse]:
"""
Retry sending the webhook for a run
@@ -1486,7 +1478,7 @@ class RawSkyvern:
Returns
-------
- HttpResponse[typing.Optional[typing.Any]]
+ HttpResponse[RunWebhookReplayResponse]
Successful Response
"""
_response = self._client_wrapper.httpx_client.request(
@@ -1502,13 +1494,11 @@ class RawSkyvern:
omit=OMIT,
)
try:
- if _response is None or not _response.text.strip():
- return HttpResponse(response=_response, data=None)
if 200 <= _response.status_code < 300:
_data = typing.cast(
- typing.Optional[typing.Any],
+ RunWebhookReplayResponse,
parse_obj_as(
- type_=typing.Optional[typing.Any], # type: ignore
+ type_=RunWebhookReplayResponse, # type: ignore
object_=_response.json(),
),
)
@@ -1601,6 +1591,91 @@ class RawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+ def retry_workflow_run(
+ self,
+ workflow_run_id: str,
+ *,
+ max_steps_override: typing.Optional[int] = None,
+ user_agent: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[WorkflowRunResponse]:
+ """
+ Retry a workflow run using the original run parameters.
+
+ Parameters
+ ----------
+ workflow_run_id : str
+ The id of the workflow run to retry.
+
+ max_steps_override : typing.Optional[int]
+
+ user_agent : typing.Optional[str]
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[WorkflowRunResponse]
+ Successfully retried workflow run
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"v1/workflows/runs/{jsonable_encoder(workflow_run_id)}/retry",
+ method="POST",
+ headers={
+ "x-max-steps-override": str(max_steps_override) if max_steps_override is not None else None,
+ "x-user-agent": str(user_agent) if user_agent is not None else None,
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ WorkflowRunResponse,
+ parse_obj_as(
+ type_=WorkflowRunResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 422:
+ raise UnprocessableEntityError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
def get_runs_v2(
self,
*,
@@ -1784,10 +1859,19 @@ class RawSkyvern:
"""
List runs for a specific workflow.
+ Supports filtering by **status**, **search_key**, and **error_code**. All filters are combined with **AND** logic.
+
+ ### search_key
+
+ Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. Soft-deleted parameter definitions are excluded.
+
+ ### error_code
+
+ 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`.
+
Parameters
----------
workflow_id : str
- Workflow permanent ID. Workflow ID starts with `wpid_`.
page : typing.Optional[int]
Page number for pagination.
@@ -1799,10 +1883,10 @@ class RawSkyvern:
Filter by one or more run statuses.
search_key : typing.Optional[str]
- Case-insensitive substring search across workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers.
+ 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.
error_code : typing.Optional[str]
- Exact-match filter on the error_code field inside each task's errors JSON array.
+ 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.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -2022,16 +2106,29 @@ class RawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def list_browser_profiles(
- self, *, include_deleted: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None
+ self,
+ *,
+ page: typing.Optional[int] = None,
+ page_size: typing.Optional[int] = None,
+ include_deleted: typing.Optional[bool] = None,
+ search_key: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[BrowserProfile]]:
"""
Get all browser profiles for the organization
Parameters
----------
+ page : typing.Optional[int]
+
+ page_size : typing.Optional[int]
+
include_deleted : typing.Optional[bool]
Include deleted browser profiles
+ search_key : typing.Optional[str]
+ Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -2044,7 +2141,10 @@ class RawSkyvern:
"v1/browser_profiles",
method="GET",
params={
+ "page": page,
+ "page_size": page_size,
"include_deleted": include_deleted,
+ "search_key": search_key,
},
request_options=request_options,
)
@@ -2285,6 +2385,97 @@ class RawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+ def update_browser_profile(
+ self,
+ profile_id: str,
+ *,
+ name: typing.Optional[str] = OMIT,
+ description: typing.Optional[str] = OMIT,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[BrowserProfile]:
+ """
+ Update a browser profile's name and/or description
+
+ Parameters
+ ----------
+ profile_id : str
+ The ID of the browser profile to update. browser_profile_id starts with `bp_`
+
+ name : typing.Optional[str]
+ New name for the browser profile
+
+ description : typing.Optional[str]
+ New description for the browser profile
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[BrowserProfile]
+ Successfully updated browser profile
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"v1/browser_profiles/{jsonable_encoder(profile_id)}",
+ method="PATCH",
+ json={
+ "name": name,
+ "description": description,
+ },
+ headers={
+ "content-type": "application/json",
+ },
+ request_options=request_options,
+ omit=OMIT,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ BrowserProfile,
+ parse_obj_as(
+ type_=BrowserProfile, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 409:
+ raise ConflictError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 422:
+ raise UnprocessableEntityError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
def get_browser_sessions(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[typing.List[BrowserSessionResponse]]:
@@ -2347,7 +2538,7 @@ class RawSkyvern:
self,
*,
timeout: typing.Optional[int] = OMIT,
- proxy_location: typing.Optional[ProxyLocation] = OMIT,
+ proxy_location: typing.Optional[CreateBrowserSessionRequestProxyLocation] = OMIT,
extensions: typing.Optional[typing.Sequence[Extensions]] = OMIT,
browser_type: typing.Optional[PersistentBrowserType] = OMIT,
browser_profile_id: typing.Optional[str] = OMIT,
@@ -2361,7 +2552,7 @@ class RawSkyvern:
timeout : typing.Optional[int]
Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 1440. Defaults to 60.
- proxy_location : typing.Optional[ProxyLocation]
+ proxy_location : typing.Optional[CreateBrowserSessionRequestProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -2377,6 +2568,7 @@ class RawSkyvern:
- 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
@@ -2394,6 +2586,9 @@ class RawSkyvern:
- 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:[email protected]: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"}, or a custom proxy URL dict for self-hosted deployments: {"url": "http://user:[email protected]:8080"}
+
extensions : typing.Optional[typing.Sequence[Extensions]]
A list of extensions to install in the browser session.
@@ -2416,7 +2611,9 @@ class RawSkyvern:
method="POST",
json={
"timeout": timeout,
- "proxy_location": proxy_location,
+ "proxy_location": convert_and_respect_annotation_metadata(
+ object_=proxy_location, annotation=CreateBrowserSessionRequestProxyLocation, direction="write"
+ ),
"extensions": extensions,
"browser_type": browser_type,
"browser_profile_id": browser_profile_id,
@@ -3024,7 +3221,8 @@ class RawSkyvern:
def login(
self,
*,
- credential_type: SkyvernSchemasRunBlocksCredentialType,
+ credential_type: SkyvernSchemasCredentialTypeCredentialType,
+ user_agent: typing.Optional[str] = None,
url: typing.Optional[str] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
@@ -3034,6 +3232,7 @@ class RawSkyvern:
browser_profile_id: typing.Optional[str] = OMIT,
browser_address: typing.Optional[str] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_screenshot_scrolling_times: typing.Optional[int] = OMIT,
prompt: typing.Optional[str] = OMIT,
credential_id: typing.Optional[str] = OMIT,
@@ -3052,9 +3251,11 @@ class RawSkyvern:
Parameters
----------
- credential_type : SkyvernSchemasRunBlocksCredentialType
+ credential_type : SkyvernSchemasCredentialTypeCredentialType
Where to get the credential from
+ user_agent : typing.Optional[str]
+
url : typing.Optional[str]
Website URL
@@ -3082,6 +3283,9 @@ class RawSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
Additional HTTP headers to include in requests
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.
+
max_screenshot_scrolling_times : typing.Optional[int]
Maximum number of times to scroll for screenshots
@@ -3136,6 +3340,7 @@ class RawSkyvern:
"browser_profile_id": browser_profile_id,
"browser_address": browser_address,
"extra_http_headers": extra_http_headers,
+ "cdp_connect_headers": cdp_connect_headers,
"max_screenshot_scrolling_times": max_screenshot_scrolling_times,
"credential_type": credential_type,
"prompt": prompt,
@@ -3151,6 +3356,7 @@ class RawSkyvern:
},
headers={
"content-type": "application/json",
+ "x-user-agent": str(user_agent) if user_agent is not None else None,
},
request_options=request_options,
omit=OMIT,
@@ -3185,6 +3391,7 @@ class RawSkyvern:
self,
*,
navigation_goal: str,
+ user_agent: typing.Optional[str] = None,
url: typing.Optional[str] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
@@ -3194,6 +3401,7 @@ class RawSkyvern:
browser_profile_id: typing.Optional[str] = OMIT,
browser_address: typing.Optional[str] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_screenshot_scrolling_times: typing.Optional[int] = OMIT,
download_suffix: typing.Optional[str] = OMIT,
download_timeout: typing.Optional[float] = OMIT,
@@ -3208,6 +3416,8 @@ class RawSkyvern:
navigation_goal : str
Instructions for navigating to and downloading the file
+ user_agent : typing.Optional[str]
+
url : typing.Optional[str]
Website URL
@@ -3235,6 +3445,9 @@ class RawSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
Additional HTTP headers to include in requests
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.
+
max_screenshot_scrolling_times : typing.Optional[int]
Maximum number of times to scroll for screenshots
@@ -3268,6 +3481,7 @@ class RawSkyvern:
"browser_profile_id": browser_profile_id,
"browser_address": browser_address,
"extra_http_headers": extra_http_headers,
+ "cdp_connect_headers": cdp_connect_headers,
"max_screenshot_scrolling_times": max_screenshot_scrolling_times,
"navigation_goal": navigation_goal,
"download_suffix": download_suffix,
@@ -3276,6 +3490,7 @@ class RawSkyvern:
},
headers={
"content-type": "application/json",
+ "x-user-agent": str(user_agent) if user_agent is not None else None,
},
request_options=request_options,
omit=OMIT,
@@ -3650,8 +3865,8 @@ class AsyncRawSkyvern:
url: typing.Optional[str] = OMIT,
engine: typing.Optional[RunEngine] = OMIT,
title: typing.Optional[str] = OMIT,
- proxy_location: typing.Optional[TaskRunRequestProxyLocation] = OMIT,
- data_extraction_schema: typing.Optional[TaskRunRequestDataExtractionSchema] = OMIT,
+ proxy_location: typing.Optional[TaskRunRequestInputProxyLocation] = OMIT,
+ data_extraction_schema: typing.Optional[TaskRunRequestInputDataExtractionSchema] = OMIT,
error_code_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_steps: typing.Optional[int] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
@@ -3660,6 +3875,7 @@ class AsyncRawSkyvern:
browser_session_id: typing.Optional[str] = OMIT,
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
publish_workflow: typing.Optional[bool] = OMIT,
include_action_history_in_verification: typing.Optional[bool] = OMIT,
max_screenshot_scrolls: typing.Optional[int] = OMIT,
@@ -3689,7 +3905,7 @@ class AsyncRawSkyvern:
title : typing.Optional[str]
The title for the task
- proxy_location : typing.Optional[TaskRunRequestProxyLocation]
+ proxy_location : typing.Optional[TaskRunRequestInputProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -3705,6 +3921,7 @@ class AsyncRawSkyvern:
- 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
@@ -3721,9 +3938,11 @@ class AsyncRawSkyvern:
- 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:[email protected]: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"}
- data_extraction_schema : typing.Optional[TaskRunRequestDataExtractionSchema]
+ data_extraction_schema : typing.Optional[TaskRunRequestInputDataExtractionSchema]
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/.
@@ -3758,6 +3977,9 @@ class AsyncRawSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
The extra HTTP headers for the requests in browser.
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+
publish_workflow : typing.Optional[bool]
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.
@@ -3790,10 +4012,12 @@ class AsyncRawSkyvern:
"engine": engine,
"title": title,
"proxy_location": convert_and_respect_annotation_metadata(
- object_=proxy_location, annotation=TaskRunRequestProxyLocation, direction="write"
+ object_=proxy_location, annotation=TaskRunRequestInputProxyLocation, direction="write"
),
"data_extraction_schema": convert_and_respect_annotation_metadata(
- object_=data_extraction_schema, annotation=TaskRunRequestDataExtractionSchema, direction="write"
+ object_=data_extraction_schema,
+ annotation=TaskRunRequestInputDataExtractionSchema,
+ direction="write",
),
"error_code_mapping": error_code_mapping,
"max_steps": max_steps,
@@ -3803,6 +4027,7 @@ class AsyncRawSkyvern:
"browser_session_id": browser_session_id,
"model": model,
"extra_http_headers": extra_http_headers,
+ "cdp_connect_headers": cdp_connect_headers,
"publish_workflow": publish_workflow,
"include_action_history_in_verification": include_action_history_in_verification,
"max_screenshot_scrolls": max_screenshot_scrolls,
@@ -3862,7 +4087,7 @@ class AsyncRawSkyvern:
user_agent: typing.Optional[str] = None,
parameters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
title: typing.Optional[str] = OMIT,
- proxy_location: typing.Optional[WorkflowRunRequestProxyLocation] = OMIT,
+ proxy_location: typing.Optional[WorkflowRunRequestInputProxyLocation] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
totp_url: typing.Optional[str] = OMIT,
totp_identifier: typing.Optional[str] = OMIT,
@@ -3871,10 +4096,11 @@ class AsyncRawSkyvern:
max_screenshot_scrolls: typing.Optional[int] = OMIT,
max_elapsed_time_minutes: typing.Optional[int] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
browser_address: typing.Optional[str] = OMIT,
ai_fallback: typing.Optional[bool] = OMIT,
run_with: typing.Optional[str] = OMIT,
- run_metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
+ run_metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[WorkflowRunResponse]:
"""
@@ -3897,7 +4123,7 @@ class AsyncRawSkyvern:
title : typing.Optional[str]
The title for this workflow run
- proxy_location : typing.Optional[WorkflowRunRequestProxyLocation]
+ proxy_location : typing.Optional[WorkflowRunRequestInputProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -3913,6 +4139,7 @@ class AsyncRawSkyvern:
- 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
@@ -3929,6 +4156,8 @@ class AsyncRawSkyvern:
- 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:[email protected]: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"}
webhook_url : typing.Optional[str]
@@ -3957,6 +4186,9 @@ class AsyncRawSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
The extra HTTP headers for the requests in browser.
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+
browser_address : typing.Optional[str]
The CDP address for the workflow run.
@@ -3966,7 +4198,7 @@ class AsyncRawSkyvern:
run_with : typing.Optional[str]
Whether to run the workflow with agent or code. Null inherits from the workflow setting.
- run_metadata : typing.Optional[typing.Dict[str, str]]
+ run_metadata : typing.Optional[typing.Dict[str, typing.Optional[str]]]
String key/value metadata to attach to this workflow run for analytics tag filtering.
request_options : typing.Optional[RequestOptions]
@@ -3988,7 +4220,7 @@ class AsyncRawSkyvern:
"parameters": parameters,
"title": title,
"proxy_location": convert_and_respect_annotation_metadata(
- object_=proxy_location, annotation=WorkflowRunRequestProxyLocation, direction="write"
+ object_=proxy_location, annotation=WorkflowRunRequestInputProxyLocation, direction="write"
),
"webhook_url": webhook_url,
"totp_url": totp_url,
@@ -3998,6 +4230,7 @@ class AsyncRawSkyvern:
"max_screenshot_scrolls": max_screenshot_scrolls,
"max_elapsed_time_minutes": max_elapsed_time_minutes,
"extra_http_headers": extra_http_headers,
+ "cdp_connect_headers": cdp_connect_headers,
"browser_address": browser_address,
"ai_fallback": ai_fallback,
"run_with": run_with,
@@ -4048,65 +4281,40 @@ class AsyncRawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
- async def retry_workflow_run(
- self,
- workflow_run_id: str,
- *,
- max_steps_override: typing.Optional[int] = None,
- user_agent: typing.Optional[str] = None,
- request_options: typing.Optional[RequestOptions] = None,
- ) -> AsyncHttpResponse[WorkflowRunResponse]:
+ async def get_run(
+ self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[GetRunResponse]:
"""
- Retry a workflow run using the original run parameters.
+ Get run information (task run, workflow run)
Parameters
----------
- workflow_run_id : str
- The id of the workflow run to retry.
-
- max_steps_override : typing.Optional[int]
-
- user_agent : typing.Optional[str]
+ run_id : str
+ The id of the task run or the workflow run.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- AsyncHttpResponse[WorkflowRunResponse]
- Successfully retried workflow run
+ AsyncHttpResponse[GetRunResponse]
+ Successfully got run
"""
_response = await self._client_wrapper.httpx_client.request(
- f"v1/workflows/runs/{jsonable_encoder(workflow_run_id)}/retry",
- method="POST",
- headers={
- "x-max-steps-override": str(max_steps_override) if max_steps_override is not None else None,
- "x-user-agent": str(user_agent) if user_agent is not None else None,
- },
+ f"v1/runs/{jsonable_encoder(run_id)}",
+ method="GET",
request_options=request_options,
- omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
- WorkflowRunResponse,
+ GetRunResponse,
parse_obj_as(
- type_=WorkflowRunResponse, # type: ignore
+ type_=GetRunResponse, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
- if _response.status_code == 400:
- raise BadRequestError(
- headers=dict(_response.headers),
- body=typing.cast(
- typing.Optional[typing.Any],
- parse_obj_as(
- type_=typing.Optional[typing.Any], # type: ignore
- object_=_response.json(),
- ),
- ),
- )
if _response.status_code == 404:
raise NotFoundError(
headers=dict(_response.headers),
@@ -4134,51 +4342,42 @@ class AsyncRawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
- async def get_run(
+ async def cancel_run(
self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
- ) -> AsyncHttpResponse[GetRunResponse]:
+ ) -> AsyncHttpResponse[typing.Optional[typing.Any]]:
"""
- Get run information (task run, workflow run)
+ Cancel a run (task or workflow)
Parameters
----------
run_id : str
- The id of the task run or the workflow run.
+ The id of the task run or the workflow run to cancel.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- AsyncHttpResponse[GetRunResponse]
- Successfully got run
+ AsyncHttpResponse[typing.Optional[typing.Any]]
+ Successful Response
"""
_response = await self._client_wrapper.httpx_client.request(
- f"v1/runs/{jsonable_encoder(run_id)}",
- method="GET",
+ f"v1/runs/{jsonable_encoder(run_id)}/cancel",
+ method="POST",
request_options=request_options,
)
try:
+ if _response is None or not _response.text.strip():
+ return AsyncHttpResponse(response=_response, data=None)
if 200 <= _response.status_code < 300:
_data = typing.cast(
- GetRunResponse,
+ typing.Optional[typing.Any],
parse_obj_as(
- type_=GetRunResponse, # type: ignore
+ type_=typing.Optional[typing.Any], # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
- if _response.status_code == 404:
- raise NotFoundError(
- headers=dict(_response.headers),
- body=typing.cast(
- typing.Optional[typing.Any],
- parse_obj_as(
- type_=typing.Optional[typing.Any], # type: ignore
- object_=_response.json(),
- ),
- ),
- )
if _response.status_code == 422:
raise UnprocessableEntityError(
headers=dict(_response.headers),
@@ -4195,38 +4394,43 @@ class AsyncRawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
- async def cancel_run(
- self, run_id: str, *, request_options: typing.Optional[RequestOptions] = None
- ) -> AsyncHttpResponse[typing.Optional[typing.Any]]:
+ async def bulk_cancel_runs(
+ self, *, run_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[BulkCancelRunsResponse]:
"""
- Cancel a run (task or workflow)
+ Cancel multiple runs (tasks or workflows) in a single request
Parameters
----------
- run_id : str
- The id of the task run or the workflow run to cancel.
+ run_ids : typing.Sequence[str]
+ List of run IDs to cancel
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
- AsyncHttpResponse[typing.Optional[typing.Any]]
+ AsyncHttpResponse[BulkCancelRunsResponse]
Successful Response
"""
_response = await self._client_wrapper.httpx_client.request(
- f"v1/runs/{jsonable_encoder(run_id)}/cancel",
+ "v1/runs/cancel",
method="POST",
+ json={
+ "run_ids": run_ids,
+ },
+ headers={
+ "content-type": "application/json",
+ },
request_options=request_options,
+ omit=OMIT,
)
try:
- if _response is None or not _response.text.strip():
- return AsyncHttpResponse(response=_response, data=None)
if 200 <= _response.status_code < 300:
_data = typing.cast(
- typing.Optional[typing.Any],
+ BulkCancelRunsResponse,
parse_obj_as(
- type_=typing.Optional[typing.Any], # type: ignore
+ type_=BulkCancelRunsResponse, # type: ignore
object_=_response.json(),
),
)
@@ -5050,7 +5254,7 @@ class AsyncRawSkyvern:
*,
request: typing.Optional[RetryRunWebhookRequest] = None,
request_options: typing.Optional[RequestOptions] = None,
- ) -> AsyncHttpResponse[typing.Optional[typing.Any]]:
+ ) -> AsyncHttpResponse[RunWebhookReplayResponse]:
"""
Retry sending the webhook for a run
@@ -5066,7 +5270,7 @@ class AsyncRawSkyvern:
Returns
-------
- AsyncHttpResponse[typing.Optional[typing.Any]]
+ AsyncHttpResponse[RunWebhookReplayResponse]
Successful Response
"""
_response = await self._client_wrapper.httpx_client.request(
@@ -5082,13 +5286,11 @@ class AsyncRawSkyvern:
omit=OMIT,
)
try:
- if _response is None or not _response.text.strip():
- return AsyncHttpResponse(response=_response, data=None)
if 200 <= _response.status_code < 300:
_data = typing.cast(
- typing.Optional[typing.Any],
+ RunWebhookReplayResponse,
parse_obj_as(
- type_=typing.Optional[typing.Any], # type: ignore
+ type_=RunWebhookReplayResponse, # type: ignore
object_=_response.json(),
),
)
@@ -5181,6 +5383,91 @@ class AsyncRawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+ async def retry_workflow_run(
+ self,
+ workflow_run_id: str,
+ *,
+ max_steps_override: typing.Optional[int] = None,
+ user_agent: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[WorkflowRunResponse]:
+ """
+ Retry a workflow run using the original run parameters.
+
+ Parameters
+ ----------
+ workflow_run_id : str
+ The id of the workflow run to retry.
+
+ max_steps_override : typing.Optional[int]
+
+ user_agent : typing.Optional[str]
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[WorkflowRunResponse]
+ Successfully retried workflow run
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"v1/workflows/runs/{jsonable_encoder(workflow_run_id)}/retry",
+ method="POST",
+ headers={
+ "x-max-steps-override": str(max_steps_override) if max_steps_override is not None else None,
+ "x-user-agent": str(user_agent) if user_agent is not None else None,
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ WorkflowRunResponse,
+ parse_obj_as(
+ type_=WorkflowRunResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 422:
+ raise UnprocessableEntityError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
async def get_runs_v2(
self,
*,
@@ -5364,10 +5651,19 @@ class AsyncRawSkyvern:
"""
List runs for a specific workflow.
+ Supports filtering by **status**, **search_key**, and **error_code**. All filters are combined with **AND** logic.
+
+ ### search_key
+
+ Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. Soft-deleted parameter definitions are excluded.
+
+ ### error_code
+
+ 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`.
+
Parameters
----------
workflow_id : str
- Workflow permanent ID. Workflow ID starts with `wpid_`.
page : typing.Optional[int]
Page number for pagination.
@@ -5379,10 +5675,10 @@ class AsyncRawSkyvern:
Filter by one or more run statuses.
search_key : typing.Optional[str]
- Case-insensitive substring search across workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers.
+ 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.
error_code : typing.Optional[str]
- Exact-match filter on the error_code field inside each task's errors JSON array.
+ 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.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -5602,16 +5898,29 @@ class AsyncRawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def list_browser_profiles(
- self, *, include_deleted: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None
+ self,
+ *,
+ page: typing.Optional[int] = None,
+ page_size: typing.Optional[int] = None,
+ include_deleted: typing.Optional[bool] = None,
+ search_key: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[BrowserProfile]]:
"""
Get all browser profiles for the organization
Parameters
----------
+ page : typing.Optional[int]
+
+ page_size : typing.Optional[int]
+
include_deleted : typing.Optional[bool]
Include deleted browser profiles
+ search_key : typing.Optional[str]
+ Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -5624,7 +5933,10 @@ class AsyncRawSkyvern:
"v1/browser_profiles",
method="GET",
params={
+ "page": page,
+ "page_size": page_size,
"include_deleted": include_deleted,
+ "search_key": search_key,
},
request_options=request_options,
)
@@ -5865,6 +6177,97 @@ class AsyncRawSkyvern:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+ async def update_browser_profile(
+ self,
+ profile_id: str,
+ *,
+ name: typing.Optional[str] = OMIT,
+ description: typing.Optional[str] = OMIT,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[BrowserProfile]:
+ """
+ Update a browser profile's name and/or description
+
+ Parameters
+ ----------
+ profile_id : str
+ The ID of the browser profile to update. browser_profile_id starts with `bp_`
+
+ name : typing.Optional[str]
+ New name for the browser profile
+
+ description : typing.Optional[str]
+ New description for the browser profile
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[BrowserProfile]
+ Successfully updated browser profile
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"v1/browser_profiles/{jsonable_encoder(profile_id)}",
+ method="PATCH",
+ json={
+ "name": name,
+ "description": description,
+ },
+ headers={
+ "content-type": "application/json",
+ },
+ request_options=request_options,
+ omit=OMIT,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ BrowserProfile,
+ parse_obj_as(
+ type_=BrowserProfile, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 409:
+ raise ConflictError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 422:
+ raise UnprocessableEntityError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
async def get_browser_sessions(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[typing.List[BrowserSessionResponse]]:
@@ -5927,7 +6330,7 @@ class AsyncRawSkyvern:
self,
*,
timeout: typing.Optional[int] = OMIT,
- proxy_location: typing.Optional[ProxyLocation] = OMIT,
+ proxy_location: typing.Optional[CreateBrowserSessionRequestProxyLocation] = OMIT,
extensions: typing.Optional[typing.Sequence[Extensions]] = OMIT,
browser_type: typing.Optional[PersistentBrowserType] = OMIT,
browser_profile_id: typing.Optional[str] = OMIT,
@@ -5941,7 +6344,7 @@ class AsyncRawSkyvern:
timeout : typing.Optional[int]
Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 1440. Defaults to 60.
- proxy_location : typing.Optional[ProxyLocation]
+ proxy_location : typing.Optional[CreateBrowserSessionRequestProxyLocation]
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -5957,6 +6360,7 @@ class AsyncRawSkyvern:
- 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
@@ -5974,6 +6378,9 @@ class AsyncRawSkyvern:
- 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:[email protected]: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"}, or a custom proxy URL dict for self-hosted deployments: {"url": "http://user:[email protected]:8080"}
+
extensions : typing.Optional[typing.Sequence[Extensions]]
A list of extensions to install in the browser session.
@@ -5996,7 +6403,9 @@ class AsyncRawSkyvern:
method="POST",
json={
"timeout": timeout,
- "proxy_location": proxy_location,
+ "proxy_location": convert_and_respect_annotation_metadata(
+ object_=proxy_location, annotation=CreateBrowserSessionRequestProxyLocation, direction="write"
+ ),
"extensions": extensions,
"browser_type": browser_type,
"browser_profile_id": browser_profile_id,
@@ -6604,7 +7013,8 @@ class AsyncRawSkyvern:
async def login(
self,
*,
- credential_type: SkyvernSchemasRunBlocksCredentialType,
+ credential_type: SkyvernSchemasCredentialTypeCredentialType,
+ user_agent: typing.Optional[str] = None,
url: typing.Optional[str] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
@@ -6614,6 +7024,7 @@ class AsyncRawSkyvern:
browser_profile_id: typing.Optional[str] = OMIT,
browser_address: typing.Optional[str] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_screenshot_scrolling_times: typing.Optional[int] = OMIT,
prompt: typing.Optional[str] = OMIT,
credential_id: typing.Optional[str] = OMIT,
@@ -6632,9 +7043,11 @@ class AsyncRawSkyvern:
Parameters
----------
- credential_type : SkyvernSchemasRunBlocksCredentialType
+ credential_type : SkyvernSchemasCredentialTypeCredentialType
Where to get the credential from
+ user_agent : typing.Optional[str]
+
url : typing.Optional[str]
Website URL
@@ -6662,6 +7075,9 @@ class AsyncRawSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
Additional HTTP headers to include in requests
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.
+
max_screenshot_scrolling_times : typing.Optional[int]
Maximum number of times to scroll for screenshots
@@ -6716,6 +7132,7 @@ class AsyncRawSkyvern:
"browser_profile_id": browser_profile_id,
"browser_address": browser_address,
"extra_http_headers": extra_http_headers,
+ "cdp_connect_headers": cdp_connect_headers,
"max_screenshot_scrolling_times": max_screenshot_scrolling_times,
"credential_type": credential_type,
"prompt": prompt,
@@ -6731,6 +7148,7 @@ class AsyncRawSkyvern:
},
headers={
"content-type": "application/json",
+ "x-user-agent": str(user_agent) if user_agent is not None else None,
},
request_options=request_options,
omit=OMIT,
@@ -6765,6 +7183,7 @@ class AsyncRawSkyvern:
self,
*,
navigation_goal: str,
+ user_agent: typing.Optional[str] = None,
url: typing.Optional[str] = OMIT,
webhook_url: typing.Optional[str] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
@@ -6774,6 +7193,7 @@ class AsyncRawSkyvern:
browser_profile_id: typing.Optional[str] = OMIT,
browser_address: typing.Optional[str] = OMIT,
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
max_screenshot_scrolling_times: typing.Optional[int] = OMIT,
download_suffix: typing.Optional[str] = OMIT,
download_timeout: typing.Optional[float] = OMIT,
@@ -6788,6 +7208,8 @@ class AsyncRawSkyvern:
navigation_goal : str
Instructions for navigating to and downloading the file
+ user_agent : typing.Optional[str]
+
url : typing.Optional[str]
Website URL
@@ -6815,6 +7237,9 @@ class AsyncRawSkyvern:
extra_http_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
Additional HTTP headers to include in requests
+ cdp_connect_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites.
+
max_screenshot_scrolling_times : typing.Optional[int]
Maximum number of times to scroll for screenshots
@@ -6848,6 +7273,7 @@ class AsyncRawSkyvern:
"browser_profile_id": browser_profile_id,
"browser_address": browser_address,
"extra_http_headers": extra_http_headers,
+ "cdp_connect_headers": cdp_connect_headers,
"max_screenshot_scrolling_times": max_screenshot_scrolling_times,
"navigation_goal": navigation_goal,
"download_suffix": download_suffix,
@@ -6856,6 +7282,7 @@ class AsyncRawSkyvern:
},
headers={
"content-type": "application/json",
+ "x-user-agent": str(user_agent) if user_agent is not None else None,
},
request_options=request_options,
omit=OMIT,
diff --git a/skyvern/client/server/__init__.py b/skyvern/client/server/__init__.py
new file mode 100644
index 000000000..5cde0202d
--- /dev/null
+++ b/skyvern/client/server/__init__.py
@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
diff --git a/skyvern/client/server/client.py b/skyvern/client/server/client.py
new file mode 100644
index 000000000..35ccce241
--- /dev/null
+++ b/skyvern/client/server/client.py
@@ -0,0 +1,99 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawServerClient, RawServerClient
+
+
+class ServerClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawServerClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawServerClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawServerClient
+ """
+ return self._raw_client
+
+ def get_version(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Dict[str, str]:
+ """
+ Returns the current Skyvern server version (git SHA for official builds).
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ typing.Dict[str, str]
+ Current server version
+
+ Examples
+ --------
+ from skyvern import Skyvern
+
+ client = Skyvern(
+ api_key="YOUR_API_KEY",
+ )
+ client.server.get_version()
+ """
+ _response = self._raw_client.get_version(request_options=request_options)
+ return _response.data
+
+
+class AsyncServerClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawServerClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawServerClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawServerClient
+ """
+ return self._raw_client
+
+ async def get_version(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Dict[str, str]:
+ """
+ Returns the current Skyvern server version (git SHA for official builds).
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ typing.Dict[str, str]
+ Current server version
+
+ Examples
+ --------
+ import asyncio
+
+ from skyvern import AsyncSkyvern
+
+ client = AsyncSkyvern(
+ api_key="YOUR_API_KEY",
+ )
+
+
+ async def main() -> None:
+ await client.server.get_version()
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.get_version(request_options=request_options)
+ return _response.data
diff --git a/skyvern/client/server/raw_client.py b/skyvern/client/server/raw_client.py
new file mode 100644
index 000000000..333e6a5ca
--- /dev/null
+++ b/skyvern/client/server/raw_client.py
@@ -0,0 +1,92 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+
+
+class RawServerClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def get_version(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[typing.Dict[str, str]]:
+ """
+ Returns the current Skyvern server version (git SHA for official builds).
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[typing.Dict[str, str]]
+ Current server version
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ "v1/version",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ typing.Dict[str, str],
+ parse_obj_as(
+ type_=typing.Dict[str, str], # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawServerClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def get_version(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[typing.Dict[str, str]]:
+ """
+ Returns the current Skyvern server version (git SHA for official builds).
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[typing.Dict[str, str]]
+ Current server version
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ "v1/version",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ typing.Dict[str, str],
+ parse_obj_as(
+ type_=typing.Dict[str, str], # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/skyvern/client/types/__init__.py b/skyvern/client/types/__init__.py
index 38799a4df..2a7111109 100644
--- a/skyvern/client/types/__init__.py
+++ b/skyvern/client/types/__init__.py
@@ -26,6 +26,7 @@ if typing.TYPE_CHECKING:
ActionBlockParametersItem_Workflow,
)
from .action_block_yaml import ActionBlockYaml
+ from .action_output import ActionOutput
from .action_status import ActionStatus
from .action_type import ActionType
from .artifact import Artifact
@@ -53,6 +54,7 @@ if typing.TYPE_CHECKING:
from .branch_criteria_yaml_criteria_type import BranchCriteriaYamlCriteriaType
from .browser_profile import BrowserProfile
from .browser_session_response import BrowserSessionResponse
+ from .bulk_cancel_runs_response import BulkCancelRunsResponse
from .click_action import ClickAction
from .click_action_data import ClickActionData
from .click_context import ClickContext
@@ -91,6 +93,7 @@ if typing.TYPE_CHECKING:
)
from .context_parameter_value import ContextParameterValue
from .context_parameter_yaml import ContextParameterYaml
+ from .create_browser_session_request_proxy_location import CreateBrowserSessionRequestProxyLocation
from .create_credential_request import CreateCredentialRequest
from .create_credential_request_credential import CreateCredentialRequestCredential
from .create_script_response import CreateScriptResponse
@@ -166,6 +169,8 @@ if typing.TYPE_CHECKING:
ForLoopBlockLoopBlocksItem_FileUpload,
ForLoopBlockLoopBlocksItem_FileUrlParser,
ForLoopBlockLoopBlocksItem_ForLoop,
+ ForLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ ForLoopBlockLoopBlocksItem_GoogleSheetsWrite,
ForLoopBlockLoopBlocksItem_GotoUrl,
ForLoopBlockLoopBlocksItem_HttpRequest,
ForLoopBlockLoopBlocksItem_HumanInteraction,
@@ -210,6 +215,8 @@ if typing.TYPE_CHECKING:
ForLoopBlockYamlLoopBlocksItem_FileUpload,
ForLoopBlockYamlLoopBlocksItem_FileUrlParser,
ForLoopBlockYamlLoopBlocksItem_ForLoop,
+ ForLoopBlockYamlLoopBlocksItem_GoogleSheetsRead,
+ ForLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite,
ForLoopBlockYamlLoopBlocksItem_GotoUrl,
ForLoopBlockYamlLoopBlocksItem_HttpRequest,
ForLoopBlockYamlLoopBlocksItem_HumanInteraction,
@@ -236,7 +243,42 @@ if typing.TYPE_CHECKING:
GetRunResponse_TaskV2,
GetRunResponse_UiTars,
GetRunResponse_WorkflowRun,
+ GetRunResponse_YutoriNavigator,
)
+ from .google_sheets_read_block import GoogleSheetsReadBlock
+ from .google_sheets_read_block_parameters_item import (
+ GoogleSheetsReadBlockParametersItem,
+ GoogleSheetsReadBlockParametersItem_AwsSecret,
+ GoogleSheetsReadBlockParametersItem_AzureSecret,
+ GoogleSheetsReadBlockParametersItem_AzureVaultCredential,
+ GoogleSheetsReadBlockParametersItem_BitwardenCreditCardData,
+ GoogleSheetsReadBlockParametersItem_BitwardenLoginCredential,
+ GoogleSheetsReadBlockParametersItem_BitwardenSensitiveInformation,
+ GoogleSheetsReadBlockParametersItem_Context,
+ GoogleSheetsReadBlockParametersItem_Credential,
+ GoogleSheetsReadBlockParametersItem_Onepassword,
+ GoogleSheetsReadBlockParametersItem_Output,
+ GoogleSheetsReadBlockParametersItem_Workflow,
+ )
+ from .google_sheets_read_block_yaml import GoogleSheetsReadBlockYaml
+ from .google_sheets_write_block import GoogleSheetsWriteBlock
+ from .google_sheets_write_block_parameters_item import (
+ GoogleSheetsWriteBlockParametersItem,
+ GoogleSheetsWriteBlockParametersItem_AwsSecret,
+ GoogleSheetsWriteBlockParametersItem_AzureSecret,
+ GoogleSheetsWriteBlockParametersItem_AzureVaultCredential,
+ GoogleSheetsWriteBlockParametersItem_BitwardenCreditCardData,
+ GoogleSheetsWriteBlockParametersItem_BitwardenLoginCredential,
+ GoogleSheetsWriteBlockParametersItem_BitwardenSensitiveInformation,
+ GoogleSheetsWriteBlockParametersItem_Context,
+ GoogleSheetsWriteBlockParametersItem_Credential,
+ GoogleSheetsWriteBlockParametersItem_Onepassword,
+ GoogleSheetsWriteBlockParametersItem_Output,
+ GoogleSheetsWriteBlockParametersItem_Workflow,
+ )
+ from .google_sheets_write_block_write_mode import GoogleSheetsWriteBlockWriteMode
+ from .google_sheets_write_block_yaml import GoogleSheetsWriteBlockYaml
+ from .google_sheets_write_block_yaml_write_mode import GoogleSheetsWriteBlockYamlWriteMode
from .http_request_block import HttpRequestBlock
from .http_request_block_parameters_item import (
HttpRequestBlockParametersItem,
@@ -359,6 +401,7 @@ if typing.TYPE_CHECKING:
)
from .run_sdk_action_response import RunSdkActionResponse
from .run_status import RunStatus
+ from .run_webhook_replay_response import RunWebhookReplayResponse
from .script import Script
from .script_file_create import ScriptFileCreate
from .script_run_response import ScriptRunResponse
@@ -370,7 +413,7 @@ if typing.TYPE_CHECKING:
from .send_email_block import SendEmailBlock
from .send_email_block_yaml import SendEmailBlockYaml
from .skyvern_forge_sdk_schemas_credentials_credential_type import SkyvernForgeSdkSchemasCredentialsCredentialType
- from .skyvern_schemas_run_blocks_credential_type import SkyvernSchemasRunBlocksCredentialType
+ from .skyvern_schemas_credential_type_credential_type import SkyvernSchemasCredentialTypeCredentialType
from .task_block import TaskBlock
from .task_block_data_schema import TaskBlockDataSchema
from .task_block_parameters_item import (
@@ -390,9 +433,11 @@ if typing.TYPE_CHECKING:
from .task_block_yaml import TaskBlockYaml
from .task_block_yaml_data_schema import TaskBlockYamlDataSchema
from .task_run_list_item import TaskRunListItem
- from .task_run_request import TaskRunRequest
- from .task_run_request_data_extraction_schema import TaskRunRequestDataExtractionSchema
- from .task_run_request_proxy_location import TaskRunRequestProxyLocation
+ from .task_run_request_input_data_extraction_schema import TaskRunRequestInputDataExtractionSchema
+ from .task_run_request_input_proxy_location import TaskRunRequestInputProxyLocation
+ from .task_run_request_output import TaskRunRequestOutput
+ from .task_run_request_output_data_extraction_schema import TaskRunRequestOutputDataExtractionSchema
+ from .task_run_request_output_proxy_location import TaskRunRequestOutputProxyLocation
from .task_run_response import TaskRunResponse
from .task_run_response_output import TaskRunResponseOutput
from .task_v2block import TaskV2Block
@@ -494,6 +539,8 @@ if typing.TYPE_CHECKING:
WhileLoopBlockLoopBlocksItem_FileUpload,
WhileLoopBlockLoopBlocksItem_FileUrlParser,
WhileLoopBlockLoopBlocksItem_ForLoop,
+ WhileLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite,
WhileLoopBlockLoopBlocksItem_GotoUrl,
WhileLoopBlockLoopBlocksItem_HttpRequest,
WhileLoopBlockLoopBlocksItem_HumanInteraction,
@@ -523,6 +570,8 @@ if typing.TYPE_CHECKING:
WhileLoopBlockYamlLoopBlocksItem_FileUpload,
WhileLoopBlockYamlLoopBlocksItem_FileUrlParser,
WhileLoopBlockYamlLoopBlocksItem_ForLoop,
+ WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsRead,
+ WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite,
WhileLoopBlockYamlLoopBlocksItem_GotoUrl,
WhileLoopBlockYamlLoopBlocksItem_HttpRequest,
WhileLoopBlockYamlLoopBlocksItem_HumanInteraction,
@@ -555,6 +604,8 @@ if typing.TYPE_CHECKING:
WorkflowDefinitionBlocksItem_FileUpload,
WorkflowDefinitionBlocksItem_FileUrlParser,
WorkflowDefinitionBlocksItem_ForLoop,
+ WorkflowDefinitionBlocksItem_GoogleSheetsRead,
+ WorkflowDefinitionBlocksItem_GoogleSheetsWrite,
WorkflowDefinitionBlocksItem_GotoUrl,
WorkflowDefinitionBlocksItem_HttpRequest,
WorkflowDefinitionBlocksItem_HumanInteraction,
@@ -598,6 +649,8 @@ if typing.TYPE_CHECKING:
WorkflowDefinitionYamlBlocksItem_FileUpload,
WorkflowDefinitionYamlBlocksItem_FileUrlParser,
WorkflowDefinitionYamlBlocksItem_ForLoop,
+ WorkflowDefinitionYamlBlocksItem_GoogleSheetsRead,
+ WorkflowDefinitionYamlBlocksItem_GoogleSheetsWrite,
WorkflowDefinitionYamlBlocksItem_GotoUrl,
WorkflowDefinitionYamlBlocksItem_HttpRequest,
WorkflowDefinitionYamlBlocksItem_HumanInteraction,
@@ -641,8 +694,9 @@ if typing.TYPE_CHECKING:
from .workflow_run_block_navigation_payload import WorkflowRunBlockNavigationPayload
from .workflow_run_block_output import WorkflowRunBlockOutput
from .workflow_run_proxy_location import WorkflowRunProxyLocation
- from .workflow_run_request import WorkflowRunRequest
- from .workflow_run_request_proxy_location import WorkflowRunRequestProxyLocation
+ from .workflow_run_request_input_proxy_location import WorkflowRunRequestInputProxyLocation
+ from .workflow_run_request_output import WorkflowRunRequestOutput
+ from .workflow_run_request_output_proxy_location import WorkflowRunRequestOutputProxyLocation
from .workflow_run_response import WorkflowRunResponse
from .workflow_run_response_output import WorkflowRunResponseOutput
from .workflow_run_status import WorkflowRunStatus
@@ -689,6 +743,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ActionBlockParametersItem_Output": ".action_block_parameters_item",
"ActionBlockParametersItem_Workflow": ".action_block_parameters_item",
"ActionBlockYaml": ".action_block_yaml",
+ "ActionOutput": ".action_output",
"ActionStatus": ".action_status",
"ActionType": ".action_type",
"Artifact": ".artifact",
@@ -714,6 +769,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"BranchCriteriaYamlCriteriaType": ".branch_criteria_yaml_criteria_type",
"BrowserProfile": ".browser_profile",
"BrowserSessionResponse": ".browser_session_response",
+ "BulkCancelRunsResponse": ".bulk_cancel_runs_response",
"ClickAction": ".click_action",
"ClickActionData": ".click_action_data",
"ClickContext": ".click_context",
@@ -748,6 +804,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ContextParameterSource_Workflow": ".context_parameter_source",
"ContextParameterValue": ".context_parameter_value",
"ContextParameterYaml": ".context_parameter_yaml",
+ "CreateBrowserSessionRequestProxyLocation": ".create_browser_session_request_proxy_location",
"CreateCredentialRequest": ".create_credential_request",
"CreateCredentialRequestCredential": ".create_credential_request_credential",
"CreateScriptResponse": ".create_script_response",
@@ -818,6 +875,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"ForLoopBlockLoopBlocksItem_FileUpload": ".for_loop_block_loop_blocks_item",
"ForLoopBlockLoopBlocksItem_FileUrlParser": ".for_loop_block_loop_blocks_item",
"ForLoopBlockLoopBlocksItem_ForLoop": ".for_loop_block_loop_blocks_item",
+ "ForLoopBlockLoopBlocksItem_GoogleSheetsRead": ".for_loop_block_loop_blocks_item",
+ "ForLoopBlockLoopBlocksItem_GoogleSheetsWrite": ".for_loop_block_loop_blocks_item",
"ForLoopBlockLoopBlocksItem_GotoUrl": ".for_loop_block_loop_blocks_item",
"ForLoopBlockLoopBlocksItem_HttpRequest": ".for_loop_block_loop_blocks_item",
"ForLoopBlockLoopBlocksItem_HumanInteraction": ".for_loop_block_loop_blocks_item",
@@ -858,6 +917,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"ForLoopBlockYamlLoopBlocksItem_FileUpload": ".for_loop_block_yaml_loop_blocks_item",
"ForLoopBlockYamlLoopBlocksItem_FileUrlParser": ".for_loop_block_yaml_loop_blocks_item",
"ForLoopBlockYamlLoopBlocksItem_ForLoop": ".for_loop_block_yaml_loop_blocks_item",
+ "ForLoopBlockYamlLoopBlocksItem_GoogleSheetsRead": ".for_loop_block_yaml_loop_blocks_item",
+ "ForLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite": ".for_loop_block_yaml_loop_blocks_item",
"ForLoopBlockYamlLoopBlocksItem_GotoUrl": ".for_loop_block_yaml_loop_blocks_item",
"ForLoopBlockYamlLoopBlocksItem_HttpRequest": ".for_loop_block_yaml_loop_blocks_item",
"ForLoopBlockYamlLoopBlocksItem_HumanInteraction": ".for_loop_block_yaml_loop_blocks_item",
@@ -882,6 +943,37 @@ _dynamic_imports: typing.Dict[str, str] = {
"GetRunResponse_TaskV2": ".get_run_response",
"GetRunResponse_UiTars": ".get_run_response",
"GetRunResponse_WorkflowRun": ".get_run_response",
+ "GetRunResponse_YutoriNavigator": ".get_run_response",
+ "GoogleSheetsReadBlock": ".google_sheets_read_block",
+ "GoogleSheetsReadBlockParametersItem": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_AwsSecret": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_AzureSecret": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_AzureVaultCredential": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_BitwardenCreditCardData": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_BitwardenLoginCredential": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_BitwardenSensitiveInformation": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_Context": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_Credential": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_Onepassword": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_Output": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockParametersItem_Workflow": ".google_sheets_read_block_parameters_item",
+ "GoogleSheetsReadBlockYaml": ".google_sheets_read_block_yaml",
+ "GoogleSheetsWriteBlock": ".google_sheets_write_block",
+ "GoogleSheetsWriteBlockParametersItem": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_AwsSecret": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_AzureSecret": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_AzureVaultCredential": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenCreditCardData": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenLoginCredential": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenSensitiveInformation": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_Context": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_Credential": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_Onepassword": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_Output": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockParametersItem_Workflow": ".google_sheets_write_block_parameters_item",
+ "GoogleSheetsWriteBlockWriteMode": ".google_sheets_write_block_write_mode",
+ "GoogleSheetsWriteBlockYaml": ".google_sheets_write_block_yaml",
+ "GoogleSheetsWriteBlockYamlWriteMode": ".google_sheets_write_block_yaml_write_mode",
"HttpRequestBlock": ".http_request_block",
"HttpRequestBlockParametersItem": ".http_request_block_parameters_item",
"HttpRequestBlockParametersItem_AwsSecret": ".http_request_block_parameters_item",
@@ -992,6 +1084,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"RunSdkActionRequestAction_Validate": ".run_sdk_action_request_action",
"RunSdkActionResponse": ".run_sdk_action_response",
"RunStatus": ".run_status",
+ "RunWebhookReplayResponse": ".run_webhook_replay_response",
"Script": ".script",
"ScriptFileCreate": ".script_file_create",
"ScriptRunResponse": ".script_run_response",
@@ -1003,7 +1096,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"SendEmailBlock": ".send_email_block",
"SendEmailBlockYaml": ".send_email_block_yaml",
"SkyvernForgeSdkSchemasCredentialsCredentialType": ".skyvern_forge_sdk_schemas_credentials_credential_type",
- "SkyvernSchemasRunBlocksCredentialType": ".skyvern_schemas_run_blocks_credential_type",
+ "SkyvernSchemasCredentialTypeCredentialType": ".skyvern_schemas_credential_type_credential_type",
"TaskBlock": ".task_block",
"TaskBlockDataSchema": ".task_block_data_schema",
"TaskBlockParametersItem": ".task_block_parameters_item",
@@ -1021,9 +1114,11 @@ _dynamic_imports: typing.Dict[str, str] = {
"TaskBlockYaml": ".task_block_yaml",
"TaskBlockYamlDataSchema": ".task_block_yaml_data_schema",
"TaskRunListItem": ".task_run_list_item",
- "TaskRunRequest": ".task_run_request",
- "TaskRunRequestDataExtractionSchema": ".task_run_request_data_extraction_schema",
- "TaskRunRequestProxyLocation": ".task_run_request_proxy_location",
+ "TaskRunRequestInputDataExtractionSchema": ".task_run_request_input_data_extraction_schema",
+ "TaskRunRequestInputProxyLocation": ".task_run_request_input_proxy_location",
+ "TaskRunRequestOutput": ".task_run_request_output",
+ "TaskRunRequestOutputDataExtractionSchema": ".task_run_request_output_data_extraction_schema",
+ "TaskRunRequestOutputProxyLocation": ".task_run_request_output_proxy_location",
"TaskRunResponse": ".task_run_response",
"TaskRunResponseOutput": ".task_run_response_output",
"TaskV2Block": ".task_v2block",
@@ -1114,6 +1209,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"WhileLoopBlockLoopBlocksItem_FileUpload": ".while_loop_block_loop_blocks_item",
"WhileLoopBlockLoopBlocksItem_FileUrlParser": ".while_loop_block_loop_blocks_item",
"WhileLoopBlockLoopBlocksItem_ForLoop": ".while_loop_block_loop_blocks_item",
+ "WhileLoopBlockLoopBlocksItem_GoogleSheetsRead": ".while_loop_block_loop_blocks_item",
+ "WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite": ".while_loop_block_loop_blocks_item",
"WhileLoopBlockLoopBlocksItem_GotoUrl": ".while_loop_block_loop_blocks_item",
"WhileLoopBlockLoopBlocksItem_HttpRequest": ".while_loop_block_loop_blocks_item",
"WhileLoopBlockLoopBlocksItem_HumanInteraction": ".while_loop_block_loop_blocks_item",
@@ -1141,6 +1238,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"WhileLoopBlockYamlLoopBlocksItem_FileUpload": ".while_loop_block_yaml_loop_blocks_item",
"WhileLoopBlockYamlLoopBlocksItem_FileUrlParser": ".while_loop_block_yaml_loop_blocks_item",
"WhileLoopBlockYamlLoopBlocksItem_ForLoop": ".while_loop_block_yaml_loop_blocks_item",
+ "WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsRead": ".while_loop_block_yaml_loop_blocks_item",
+ "WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite": ".while_loop_block_yaml_loop_blocks_item",
"WhileLoopBlockYamlLoopBlocksItem_GotoUrl": ".while_loop_block_yaml_loop_blocks_item",
"WhileLoopBlockYamlLoopBlocksItem_HttpRequest": ".while_loop_block_yaml_loop_blocks_item",
"WhileLoopBlockYamlLoopBlocksItem_HumanInteraction": ".while_loop_block_yaml_loop_blocks_item",
@@ -1171,6 +1270,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"WorkflowDefinitionBlocksItem_FileUpload": ".workflow_definition_blocks_item",
"WorkflowDefinitionBlocksItem_FileUrlParser": ".workflow_definition_blocks_item",
"WorkflowDefinitionBlocksItem_ForLoop": ".workflow_definition_blocks_item",
+ "WorkflowDefinitionBlocksItem_GoogleSheetsRead": ".workflow_definition_blocks_item",
+ "WorkflowDefinitionBlocksItem_GoogleSheetsWrite": ".workflow_definition_blocks_item",
"WorkflowDefinitionBlocksItem_GotoUrl": ".workflow_definition_blocks_item",
"WorkflowDefinitionBlocksItem_HttpRequest": ".workflow_definition_blocks_item",
"WorkflowDefinitionBlocksItem_HumanInteraction": ".workflow_definition_blocks_item",
@@ -1210,6 +1311,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"WorkflowDefinitionYamlBlocksItem_FileUpload": ".workflow_definition_yaml_blocks_item",
"WorkflowDefinitionYamlBlocksItem_FileUrlParser": ".workflow_definition_yaml_blocks_item",
"WorkflowDefinitionYamlBlocksItem_ForLoop": ".workflow_definition_yaml_blocks_item",
+ "WorkflowDefinitionYamlBlocksItem_GoogleSheetsRead": ".workflow_definition_yaml_blocks_item",
+ "WorkflowDefinitionYamlBlocksItem_GoogleSheetsWrite": ".workflow_definition_yaml_blocks_item",
"WorkflowDefinitionYamlBlocksItem_GotoUrl": ".workflow_definition_yaml_blocks_item",
"WorkflowDefinitionYamlBlocksItem_HttpRequest": ".workflow_definition_yaml_blocks_item",
"WorkflowDefinitionYamlBlocksItem_HumanInteraction": ".workflow_definition_yaml_blocks_item",
@@ -1250,8 +1353,9 @@ _dynamic_imports: typing.Dict[str, str] = {
"WorkflowRunBlockNavigationPayload": ".workflow_run_block_navigation_payload",
"WorkflowRunBlockOutput": ".workflow_run_block_output",
"WorkflowRunProxyLocation": ".workflow_run_proxy_location",
- "WorkflowRunRequest": ".workflow_run_request",
- "WorkflowRunRequestProxyLocation": ".workflow_run_request_proxy_location",
+ "WorkflowRunRequestInputProxyLocation": ".workflow_run_request_input_proxy_location",
+ "WorkflowRunRequestOutput": ".workflow_run_request_output",
+ "WorkflowRunRequestOutputProxyLocation": ".workflow_run_request_output_proxy_location",
"WorkflowRunResponse": ".workflow_run_response",
"WorkflowRunResponseOutput": ".workflow_run_response_output",
"WorkflowRunStatus": ".workflow_run_status",
@@ -1320,6 +1424,7 @@ __all__ = [
"ActionBlockParametersItem_Output",
"ActionBlockParametersItem_Workflow",
"ActionBlockYaml",
+ "ActionOutput",
"ActionStatus",
"ActionType",
"Artifact",
@@ -1345,6 +1450,7 @@ __all__ = [
"BranchCriteriaYamlCriteriaType",
"BrowserProfile",
"BrowserSessionResponse",
+ "BulkCancelRunsResponse",
"ClickAction",
"ClickActionData",
"ClickContext",
@@ -1379,6 +1485,7 @@ __all__ = [
"ContextParameterSource_Workflow",
"ContextParameterValue",
"ContextParameterYaml",
+ "CreateBrowserSessionRequestProxyLocation",
"CreateCredentialRequest",
"CreateCredentialRequestCredential",
"CreateScriptResponse",
@@ -1449,6 +1556,8 @@ __all__ = [
"ForLoopBlockLoopBlocksItem_FileUpload",
"ForLoopBlockLoopBlocksItem_FileUrlParser",
"ForLoopBlockLoopBlocksItem_ForLoop",
+ "ForLoopBlockLoopBlocksItem_GoogleSheetsRead",
+ "ForLoopBlockLoopBlocksItem_GoogleSheetsWrite",
"ForLoopBlockLoopBlocksItem_GotoUrl",
"ForLoopBlockLoopBlocksItem_HttpRequest",
"ForLoopBlockLoopBlocksItem_HumanInteraction",
@@ -1489,6 +1598,8 @@ __all__ = [
"ForLoopBlockYamlLoopBlocksItem_FileUpload",
"ForLoopBlockYamlLoopBlocksItem_FileUrlParser",
"ForLoopBlockYamlLoopBlocksItem_ForLoop",
+ "ForLoopBlockYamlLoopBlocksItem_GoogleSheetsRead",
+ "ForLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite",
"ForLoopBlockYamlLoopBlocksItem_GotoUrl",
"ForLoopBlockYamlLoopBlocksItem_HttpRequest",
"ForLoopBlockYamlLoopBlocksItem_HumanInteraction",
@@ -1513,6 +1624,37 @@ __all__ = [
"GetRunResponse_TaskV2",
"GetRunResponse_UiTars",
"GetRunResponse_WorkflowRun",
+ "GetRunResponse_YutoriNavigator",
+ "GoogleSheetsReadBlock",
+ "GoogleSheetsReadBlockParametersItem",
+ "GoogleSheetsReadBlockParametersItem_AwsSecret",
+ "GoogleSheetsReadBlockParametersItem_AzureSecret",
+ "GoogleSheetsReadBlockParametersItem_AzureVaultCredential",
+ "GoogleSheetsReadBlockParametersItem_BitwardenCreditCardData",
+ "GoogleSheetsReadBlockParametersItem_BitwardenLoginCredential",
+ "GoogleSheetsReadBlockParametersItem_BitwardenSensitiveInformation",
+ "GoogleSheetsReadBlockParametersItem_Context",
+ "GoogleSheetsReadBlockParametersItem_Credential",
+ "GoogleSheetsReadBlockParametersItem_Onepassword",
+ "GoogleSheetsReadBlockParametersItem_Output",
+ "GoogleSheetsReadBlockParametersItem_Workflow",
+ "GoogleSheetsReadBlockYaml",
+ "GoogleSheetsWriteBlock",
+ "GoogleSheetsWriteBlockParametersItem",
+ "GoogleSheetsWriteBlockParametersItem_AwsSecret",
+ "GoogleSheetsWriteBlockParametersItem_AzureSecret",
+ "GoogleSheetsWriteBlockParametersItem_AzureVaultCredential",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenCreditCardData",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenLoginCredential",
+ "GoogleSheetsWriteBlockParametersItem_BitwardenSensitiveInformation",
+ "GoogleSheetsWriteBlockParametersItem_Context",
+ "GoogleSheetsWriteBlockParametersItem_Credential",
+ "GoogleSheetsWriteBlockParametersItem_Onepassword",
+ "GoogleSheetsWriteBlockParametersItem_Output",
+ "GoogleSheetsWriteBlockParametersItem_Workflow",
+ "GoogleSheetsWriteBlockWriteMode",
+ "GoogleSheetsWriteBlockYaml",
+ "GoogleSheetsWriteBlockYamlWriteMode",
"HttpRequestBlock",
"HttpRequestBlockParametersItem",
"HttpRequestBlockParametersItem_AwsSecret",
@@ -1623,6 +1765,7 @@ __all__ = [
"RunSdkActionRequestAction_Validate",
"RunSdkActionResponse",
"RunStatus",
+ "RunWebhookReplayResponse",
"Script",
"ScriptFileCreate",
"ScriptRunResponse",
@@ -1634,7 +1777,7 @@ __all__ = [
"SendEmailBlock",
"SendEmailBlockYaml",
"SkyvernForgeSdkSchemasCredentialsCredentialType",
- "SkyvernSchemasRunBlocksCredentialType",
+ "SkyvernSchemasCredentialTypeCredentialType",
"TaskBlock",
"TaskBlockDataSchema",
"TaskBlockParametersItem",
@@ -1652,9 +1795,11 @@ __all__ = [
"TaskBlockYaml",
"TaskBlockYamlDataSchema",
"TaskRunListItem",
- "TaskRunRequest",
- "TaskRunRequestDataExtractionSchema",
- "TaskRunRequestProxyLocation",
+ "TaskRunRequestInputDataExtractionSchema",
+ "TaskRunRequestInputProxyLocation",
+ "TaskRunRequestOutput",
+ "TaskRunRequestOutputDataExtractionSchema",
+ "TaskRunRequestOutputProxyLocation",
"TaskRunResponse",
"TaskRunResponseOutput",
"TaskV2Block",
@@ -1745,6 +1890,8 @@ __all__ = [
"WhileLoopBlockLoopBlocksItem_FileUpload",
"WhileLoopBlockLoopBlocksItem_FileUrlParser",
"WhileLoopBlockLoopBlocksItem_ForLoop",
+ "WhileLoopBlockLoopBlocksItem_GoogleSheetsRead",
+ "WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite",
"WhileLoopBlockLoopBlocksItem_GotoUrl",
"WhileLoopBlockLoopBlocksItem_HttpRequest",
"WhileLoopBlockLoopBlocksItem_HumanInteraction",
@@ -1772,6 +1919,8 @@ __all__ = [
"WhileLoopBlockYamlLoopBlocksItem_FileUpload",
"WhileLoopBlockYamlLoopBlocksItem_FileUrlParser",
"WhileLoopBlockYamlLoopBlocksItem_ForLoop",
+ "WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsRead",
+ "WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite",
"WhileLoopBlockYamlLoopBlocksItem_GotoUrl",
"WhileLoopBlockYamlLoopBlocksItem_HttpRequest",
"WhileLoopBlockYamlLoopBlocksItem_HumanInteraction",
@@ -1802,6 +1951,8 @@ __all__ = [
"WorkflowDefinitionBlocksItem_FileUpload",
"WorkflowDefinitionBlocksItem_FileUrlParser",
"WorkflowDefinitionBlocksItem_ForLoop",
+ "WorkflowDefinitionBlocksItem_GoogleSheetsRead",
+ "WorkflowDefinitionBlocksItem_GoogleSheetsWrite",
"WorkflowDefinitionBlocksItem_GotoUrl",
"WorkflowDefinitionBlocksItem_HttpRequest",
"WorkflowDefinitionBlocksItem_HumanInteraction",
@@ -1841,6 +1992,8 @@ __all__ = [
"WorkflowDefinitionYamlBlocksItem_FileUpload",
"WorkflowDefinitionYamlBlocksItem_FileUrlParser",
"WorkflowDefinitionYamlBlocksItem_ForLoop",
+ "WorkflowDefinitionYamlBlocksItem_GoogleSheetsRead",
+ "WorkflowDefinitionYamlBlocksItem_GoogleSheetsWrite",
"WorkflowDefinitionYamlBlocksItem_GotoUrl",
"WorkflowDefinitionYamlBlocksItem_HttpRequest",
"WorkflowDefinitionYamlBlocksItem_HumanInteraction",
@@ -1881,8 +2034,9 @@ __all__ = [
"WorkflowRunBlockNavigationPayload",
"WorkflowRunBlockOutput",
"WorkflowRunProxyLocation",
- "WorkflowRunRequest",
- "WorkflowRunRequestProxyLocation",
+ "WorkflowRunRequestInputProxyLocation",
+ "WorkflowRunRequestOutput",
+ "WorkflowRunRequestOutputProxyLocation",
"WorkflowRunResponse",
"WorkflowRunResponseOutput",
"WorkflowRunStatus",
diff --git a/skyvern/client/types/action.py b/skyvern/client/types/action.py
index 1611652eb..9a95043af 100644
--- a/skyvern/client/types/action.py
+++ b/skyvern/client/types/action.py
@@ -5,6 +5,7 @@ import typing
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .action_output import ActionOutput
from .action_status import ActionStatus
from .action_type import ActionType
from .click_context import ClickContext
@@ -36,7 +37,9 @@ class Action(UniversalBaseModel):
tool_call_id: typing.Optional[str] = None
xpath: typing.Optional[str] = None
errors: typing.Optional[typing.List[UserDefinedError]] = None
+ terminal_user_errors: typing.Optional[bool] = None
data_extraction_goal: typing.Optional[str] = None
+ output: typing.Optional[ActionOutput] = None
file_name: typing.Optional[str] = None
file_url: typing.Optional[str] = None
download: typing.Optional[bool] = None
diff --git a/skyvern/client/types/action_block.py b/skyvern/client/types/action_block.py
index 139876d8c..aa9b30d0a 100644
--- a/skyvern/client/types/action_block.py
+++ b/skyvern/client/types/action_block.py
@@ -27,6 +27,7 @@ class ActionBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -48,6 +49,7 @@ class ActionBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/action_block_yaml.py b/skyvern/client/types/action_block_yaml.py
index 1e0d31456..dd3abd85c 100644
--- a/skyvern/client/types/action_block_yaml.py
+++ b/skyvern/client/types/action_block_yaml.py
@@ -20,6 +20,7 @@ class ActionBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
diff --git a/skyvern/client/types/task_run_request_data_extraction_schema.py b/skyvern/client/types/action_output.py
similarity index 77%
rename from skyvern/client/types/task_run_request_data_extraction_schema.py
rename to skyvern/client/types/action_output.py
index d315a4c22..07f0cbc26 100644
--- a/skyvern/client/types/task_run_request_data_extraction_schema.py
+++ b/skyvern/client/types/action_output.py
@@ -2,6 +2,6 @@
import typing
-TaskRunRequestDataExtractionSchema = typing.Union[
+ActionOutput = typing.Union[
typing.Dict[str, typing.Optional[typing.Any]], typing.List[typing.Optional[typing.Any]], str
]
diff --git a/skyvern/client/types/action_type.py b/skyvern/client/types/action_type.py
index 1a37282c9..7fe706d12 100644
--- a/skyvern/client/types/action_type.py
+++ b/skyvern/client/types/action_type.py
@@ -21,11 +21,14 @@ ActionType = typing.Union[
"extract",
"verification_code",
"goto_url",
+ "go_back",
+ "go_forward",
"scroll",
"keypress",
"move",
"drag",
"left_mouse",
+ "execute_js",
],
typing.Any,
]
diff --git a/skyvern/client/types/artifact.py b/skyvern/client/types/artifact.py
index 55481168b..f34d6e66c 100644
--- a/skyvern/client/types/artifact.py
+++ b/skyvern/client/types/artifact.py
@@ -22,15 +22,19 @@ class Artifact(UniversalBaseModel):
artifact_type: ArtifactType
uri: str
bundle_key: typing.Optional[str] = None
+ checksum: typing.Optional[str] = None
+ file_size: typing.Optional[int] = None
task_id: typing.Optional[str] = None
step_id: typing.Optional[str] = None
workflow_run_id: typing.Optional[str] = None
workflow_run_block_id: typing.Optional[str] = None
run_id: typing.Optional[str] = None
+ browser_session_id: typing.Optional[str] = None
observer_cruise_id: typing.Optional[str] = None
observer_thought_id: typing.Optional[str] = None
ai_suggestion_id: typing.Optional[str] = None
signed_url: typing.Optional[str] = None
+ archived: typing.Optional[bool] = None
organization_id: str
if IS_PYDANTIC_V2:
diff --git a/skyvern/client/types/artifact_type.py b/skyvern/client/types/artifact_type.py
index 781381086..c9e599864 100644
--- a/skyvern/client/types/artifact_type.py
+++ b/skyvern/client/types/artifact_type.py
@@ -33,6 +33,7 @@ ArtifactType = typing.Union[
"pdf",
"step_archive",
"task_archive",
+ "download",
],
typing.Any,
]
diff --git a/skyvern/client/types/block_type.py b/skyvern/client/types/block_type.py
index 18d6f30cc..8aacc37a1 100644
--- a/skyvern/client/types/block_type.py
+++ b/skyvern/client/types/block_type.py
@@ -29,6 +29,8 @@ BlockType = typing.Union[
"human_interaction",
"print_page",
"workflow_trigger",
+ "google_sheets_read",
+ "google_sheets_write",
],
typing.Any,
]
diff --git a/skyvern/client/types/browser_profile.py b/skyvern/client/types/browser_profile.py
index cce682751..3e9bc7e39 100644
--- a/skyvern/client/types/browser_profile.py
+++ b/skyvern/client/types/browser_profile.py
@@ -12,6 +12,7 @@ class BrowserProfile(UniversalBaseModel):
organization_id: str
name: str
description: typing.Optional[str] = None
+ source_browser_type: typing.Optional[str] = None
created_at: dt.datetime
modified_at: dt.datetime
deleted_at: typing.Optional[dt.datetime] = None
diff --git a/skyvern/client/types/bulk_cancel_runs_response.py b/skyvern/client/types/bulk_cancel_runs_response.py
new file mode 100644
index 000000000..bd80ca4e3
--- /dev/null
+++ b/skyvern/client/types/bulk_cancel_runs_response.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class BulkCancelRunsResponse(UniversalBaseModel):
+ cancelled: typing.List[str] = pydantic.Field()
+ """
+ Run IDs that were successfully cancelled
+ """
+
+ failed: typing.List[str] = pydantic.Field()
+ """
+ Run IDs that could not be cancelled
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/skyvern/client/types/code_block.py b/skyvern/client/types/code_block.py
index 0615ccb5d..ca9857bb6 100644
--- a/skyvern/client/types/code_block.py
+++ b/skyvern/client/types/code_block.py
@@ -25,6 +25,7 @@ class CodeBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
code: str
parameters: typing.Optional[typing.List[CodeBlockParametersItem]] = None
diff --git a/skyvern/client/types/code_block_yaml.py b/skyvern/client/types/code_block_yaml.py
index 1860b5e19..0cea41310 100644
--- a/skyvern/client/types/code_block_yaml.py
+++ b/skyvern/client/types/code_block_yaml.py
@@ -19,6 +19,7 @@ class CodeBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
code: str
parameter_keys: typing.Optional[typing.List[str]] = None
diff --git a/skyvern/client/types/conditional_block.py b/skyvern/client/types/conditional_block.py
index 4d663e9b1..77b62b8d2 100644
--- a/skyvern/client/types/conditional_block.py
+++ b/skyvern/client/types/conditional_block.py
@@ -27,6 +27,7 @@ class ConditionalBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
branch_conditions: typing.Optional[typing.List[BranchCondition]] = None
diff --git a/skyvern/client/types/conditional_block_yaml.py b/skyvern/client/types/conditional_block_yaml.py
index 95caaae49..934eaaf35 100644
--- a/skyvern/client/types/conditional_block_yaml.py
+++ b/skyvern/client/types/conditional_block_yaml.py
@@ -20,6 +20,7 @@ class ConditionalBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
branch_conditions: typing.Optional[typing.List[BranchConditionYaml]] = None
diff --git a/skyvern/client/types/create_browser_session_request_proxy_location.py b/skyvern/client/types/create_browser_session_request_proxy_location.py
new file mode 100644
index 000000000..1324c3528
--- /dev/null
+++ b/skyvern/client/types/create_browser_session_request_proxy_location.py
@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .geo_target import GeoTarget
+from .proxy_location import ProxyLocation
+
+CreateBrowserSessionRequestProxyLocation = typing.Union[
+ ProxyLocation, GeoTarget, typing.Dict[str, typing.Optional[typing.Any]]
+]
diff --git a/skyvern/client/types/download_to_s3block.py b/skyvern/client/types/download_to_s3block.py
index 5b0a74ba5..82d7adbbf 100644
--- a/skyvern/client/types/download_to_s3block.py
+++ b/skyvern/client/types/download_to_s3block.py
@@ -22,6 +22,7 @@ class DownloadToS3Block(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
diff --git a/skyvern/client/types/download_to_s3block_yaml.py b/skyvern/client/types/download_to_s3block_yaml.py
index 8b8335772..ae9e05454 100644
--- a/skyvern/client/types/download_to_s3block_yaml.py
+++ b/skyvern/client/types/download_to_s3block_yaml.py
@@ -19,6 +19,7 @@ class DownloadToS3BlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
diff --git a/skyvern/client/types/extraction_block.py b/skyvern/client/types/extraction_block.py
index 1405ec78d..adb7accd1 100644
--- a/skyvern/client/types/extraction_block.py
+++ b/skyvern/client/types/extraction_block.py
@@ -27,6 +27,7 @@ class ExtractionBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -48,6 +49,7 @@ class ExtractionBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/extraction_block_yaml.py b/skyvern/client/types/extraction_block_yaml.py
index 3e98e42b7..869ed755c 100644
--- a/skyvern/client/types/extraction_block_yaml.py
+++ b/skyvern/client/types/extraction_block_yaml.py
@@ -21,6 +21,7 @@ class ExtractionBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
data_extraction_goal: str
url: typing.Optional[str] = None
diff --git a/skyvern/client/types/file_download_block.py b/skyvern/client/types/file_download_block.py
index ae327e355..ea33b918f 100644
--- a/skyvern/client/types/file_download_block.py
+++ b/skyvern/client/types/file_download_block.py
@@ -27,6 +27,7 @@ class FileDownloadBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -48,6 +49,7 @@ class FileDownloadBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/file_download_block_yaml.py b/skyvern/client/types/file_download_block_yaml.py
index 3c2a6b914..0341cc7d7 100644
--- a/skyvern/client/types/file_download_block_yaml.py
+++ b/skyvern/client/types/file_download_block_yaml.py
@@ -20,6 +20,7 @@ class FileDownloadBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
navigation_goal: str
url: typing.Optional[str] = None
diff --git a/skyvern/client/types/file_info.py b/skyvern/client/types/file_info.py
index 6495fad8a..c693138f2 100644
--- a/skyvern/client/types/file_info.py
+++ b/skyvern/client/types/file_info.py
@@ -27,11 +27,21 @@ class FileInfo(UniversalBaseModel):
Original filename
"""
+ file_size: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ Size of the file in bytes
+ """
+
modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
"""
Modified time of the file
"""
+ artifact_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Artifact row id for refresh-on-read
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/skyvern/client/types/file_parser_block.py b/skyvern/client/types/file_parser_block.py
index e43bf501f..63e6afd34 100644
--- a/skyvern/client/types/file_parser_block.py
+++ b/skyvern/client/types/file_parser_block.py
@@ -23,6 +23,7 @@ class FileParserBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
file_type: typing.Optional[FileType] = None
diff --git a/skyvern/client/types/file_parser_block_yaml.py b/skyvern/client/types/file_parser_block_yaml.py
index fea8c7a9c..66c8b55c0 100644
--- a/skyvern/client/types/file_parser_block_yaml.py
+++ b/skyvern/client/types/file_parser_block_yaml.py
@@ -20,9 +20,10 @@ class FileParserBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
- file_type: FileType
+ file_type: typing.Optional[FileType] = None
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
if IS_PYDANTIC_V2:
diff --git a/skyvern/client/types/file_upload_block.py b/skyvern/client/types/file_upload_block.py
index 521b93a23..540d093aa 100644
--- a/skyvern/client/types/file_upload_block.py
+++ b/skyvern/client/types/file_upload_block.py
@@ -25,6 +25,7 @@ class FileUploadBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
storage_type: typing.Optional[FileStorageType] = None
s3bucket: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_bucket")] = None
diff --git a/skyvern/client/types/file_upload_block_yaml.py b/skyvern/client/types/file_upload_block_yaml.py
index 670bab192..d2976511b 100644
--- a/skyvern/client/types/file_upload_block_yaml.py
+++ b/skyvern/client/types/file_upload_block_yaml.py
@@ -22,6 +22,7 @@ class FileUploadBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
storage_type: typing.Optional[FileStorageType] = None
s3bucket: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_bucket")] = None
diff --git a/skyvern/client/types/for_loop_block.py b/skyvern/client/types/for_loop_block.py
index 30c2f5cc1..c0a2300b1 100644
--- a/skyvern/client/types/for_loop_block.py
+++ b/skyvern/client/types/for_loop_block.py
@@ -26,6 +26,7 @@ class ForLoopBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
loop_blocks: typing.List["ForLoopBlockLoopBlocksItem"]
loop_over: typing.Optional[ForLoopBlockLoopOver] = None
@@ -44,6 +45,15 @@ class ForLoopBlock(UniversalBaseModel):
from .context_parameter import ContextParameter # noqa: E402, F401, I001
-from .for_loop_block_loop_blocks_item import ForLoopBlockLoopBlocksItem # noqa: E402, F401, I001
+
+# Manual patch: Fern v4.31.1 emits bottom-cross-imports that deadlock at module
+# load (for_loop ↔ while_loop ↔ *_loop_blocks_item). Catch the mid-load
+# ImportError; the symmetric *_loop_blocks_item module back-resolves once both
+# unions are fully defined. Reapply on every regen — see fern_build_python_sdk.sh.
+try:
+ from .while_loop_block import WhileLoopBlock # noqa: E402, F401, I001
+ from .for_loop_block_loop_blocks_item import ForLoopBlockLoopBlocksItem # noqa: E402, F401, I001
+except ImportError:
+ pass
update_forward_refs(ForLoopBlock)
diff --git a/skyvern/client/types/for_loop_block_loop_blocks_item.py b/skyvern/client/types/for_loop_block_loop_blocks_item.py
index 4d64a8050..af4e94f33 100644
--- a/skyvern/client/types/for_loop_block_loop_blocks_item.py
+++ b/skyvern/client/types/for_loop_block_loop_blocks_item.py
@@ -21,6 +21,9 @@ from .file_storage_type import FileStorageType
from .file_type import FileType
from .for_loop_block_data_schema import ForLoopBlockDataSchema
from .for_loop_block_loop_over import ForLoopBlockLoopOver
+from .google_sheets_read_block_parameters_item import GoogleSheetsReadBlockParametersItem
+from .google_sheets_write_block_parameters_item import GoogleSheetsWriteBlockParametersItem
+from .google_sheets_write_block_write_mode import GoogleSheetsWriteBlockWriteMode
from .http_request_block_parameters_item import HttpRequestBlockParametersItem
from .human_interaction_block_data_schema import HumanInteractionBlockDataSchema
from .human_interaction_block_parameters_item import HumanInteractionBlockParametersItem
@@ -51,6 +54,7 @@ class ForLoopBlockLoopBlocksItem_Action(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -72,6 +76,7 @@ class ForLoopBlockLoopBlocksItem_Action(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -91,6 +96,7 @@ class ForLoopBlockLoopBlocksItem_Code(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
code: str
parameters: typing.Optional[typing.List[CodeBlockParametersItem]] = None
@@ -113,6 +119,7 @@ class ForLoopBlockLoopBlocksItem_Conditional(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
branch_conditions: typing.Optional[typing.List[BranchCondition]] = None
@@ -134,6 +141,7 @@ class ForLoopBlockLoopBlocksItem_DownloadToS3(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -155,6 +163,7 @@ class ForLoopBlockLoopBlocksItem_Extraction(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -176,6 +185,7 @@ class ForLoopBlockLoopBlocksItem_Extraction(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -195,6 +205,7 @@ class ForLoopBlockLoopBlocksItem_FileDownload(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -216,6 +227,7 @@ class ForLoopBlockLoopBlocksItem_FileDownload(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -235,6 +247,7 @@ class ForLoopBlockLoopBlocksItem_FileUpload(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
storage_type: typing.Optional[FileStorageType] = None
s3bucket: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_bucket")] = None
@@ -264,6 +277,7 @@ class ForLoopBlockLoopBlocksItem_FileUrlParser(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
file_type: typing.Optional[FileType] = None
@@ -287,6 +301,7 @@ class ForLoopBlockLoopBlocksItem_ForLoop(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
loop_blocks: typing.List["ForLoopBlockLoopBlocksItem"]
loop_over: typing.Optional[ForLoopBlockLoopOver] = None
@@ -304,7 +319,61 @@ class ForLoopBlockLoopBlocksItem_ForLoop(UniversalBaseModel):
extra = pydantic.Extra.allow
-from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
+class ForLoopBlockLoopBlocksItem_GoogleSheetsRead(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_read"] = "google_sheets_read"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ output_parameter: OutputParameter
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ has_header_row: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[GoogleSheetsReadBlockParametersItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class ForLoopBlockLoopBlocksItem_GoogleSheetsWrite(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_write"] = "google_sheets_write"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ output_parameter: OutputParameter
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ write_mode: typing.Optional[GoogleSheetsWriteBlockWriteMode] = None
+ values: typing.Optional[str] = None
+ column_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ create_sheet_if_missing: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[GoogleSheetsWriteBlockParametersItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
class ForLoopBlockLoopBlocksItem_GotoUrl(UniversalBaseModel):
@@ -315,6 +384,7 @@ class ForLoopBlockLoopBlocksItem_GotoUrl(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: str
@@ -336,6 +406,7 @@ class ForLoopBlockLoopBlocksItem_GotoUrl(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -355,6 +426,7 @@ class ForLoopBlockLoopBlocksItem_HttpRequest(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
method: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -385,6 +457,7 @@ class ForLoopBlockLoopBlocksItem_HumanInteraction(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -406,6 +479,7 @@ class ForLoopBlockLoopBlocksItem_HumanInteraction(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
instructions: typing.Optional[str] = None
positive_descriptor: typing.Optional[str] = None
negative_descriptor: typing.Optional[str] = None
@@ -433,6 +507,7 @@ class ForLoopBlockLoopBlocksItem_Login(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -454,6 +529,7 @@ class ForLoopBlockLoopBlocksItem_Login(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -473,6 +549,7 @@ class ForLoopBlockLoopBlocksItem_Navigation(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -494,6 +571,7 @@ class ForLoopBlockLoopBlocksItem_Navigation(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -513,6 +591,7 @@ class ForLoopBlockLoopBlocksItem_PdfParser(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -535,6 +614,7 @@ class ForLoopBlockLoopBlocksItem_PrintPage(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
include_timestamp: typing.Optional[bool] = None
custom_filename: typing.Optional[str] = None
@@ -561,6 +641,7 @@ class ForLoopBlockLoopBlocksItem_SendEmail(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
smtp_host: AwsSecretParameter
smtp_port: AwsSecretParameter
@@ -590,6 +671,7 @@ class ForLoopBlockLoopBlocksItem_Task(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -611,6 +693,7 @@ class ForLoopBlockLoopBlocksItem_Task(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -630,6 +713,7 @@ class ForLoopBlockLoopBlocksItem_TaskV2(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
prompt: str
url: typing.Optional[str] = None
@@ -656,6 +740,7 @@ class ForLoopBlockLoopBlocksItem_TextPrompt(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
llm_key: typing.Optional[str] = None
prompt: str
@@ -680,6 +765,7 @@ class ForLoopBlockLoopBlocksItem_UploadToS3(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
path: typing.Optional[str] = None
@@ -701,6 +787,7 @@ class ForLoopBlockLoopBlocksItem_Validation(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -722,6 +809,7 @@ class ForLoopBlockLoopBlocksItem_Validation(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -741,6 +829,7 @@ class ForLoopBlockLoopBlocksItem_Wait(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
wait_sec: int
parameters: typing.Optional[typing.List[WaitBlockParametersItem]] = None
@@ -755,21 +844,18 @@ class ForLoopBlockLoopBlocksItem_Wait(UniversalBaseModel):
extra = pydantic.Extra.allow
-class ForLoopBlockLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
- block_type: typing.Literal["workflow_trigger"] = "workflow_trigger"
+class ForLoopBlockLoopBlocksItem_WhileLoop(UniversalBaseModel):
+ block_type: typing.Literal["while_loop"] = "while_loop"
label: str
next_block_label: typing.Optional[str] = None
output_parameter: OutputParameter
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- workflow_permanent_id: str
- payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
- wait_for_completion: typing.Optional[bool] = None
- browser_session_id: typing.Optional[str] = None
- use_parent_browser_session: typing.Optional[bool] = None
- parameters: typing.Optional[typing.List[WorkflowTriggerBlockParametersItem]] = None
+ loop_blocks: typing.List["WhileLoopBlockLoopBlocksItem"]
+ condition: WhileLoopBlockCondition
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -781,17 +867,26 @@ class ForLoopBlockLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
extra = pydantic.Extra.allow
-class ForLoopBlockLoopBlocksItem_WhileLoop(UniversalBaseModel):
- block_type: typing.Literal["while_loop"] = "while_loop"
+from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
+from .while_loop_block import WhileLoopBlock # noqa: E402, F401, I001
+
+
+class ForLoopBlockLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
+ block_type: typing.Literal["workflow_trigger"] = "workflow_trigger"
label: str
next_block_label: typing.Optional[str] = None
output_parameter: OutputParameter
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- loop_blocks: typing.List["ForLoopBlockLoopBlocksItem"]
- condition: WhileLoopBlockCondition
+ workflow_permanent_id: str
+ payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ wait_for_completion: typing.Optional[bool] = None
+ browser_session_id: typing.Optional[str] = None
+ use_parent_browser_session: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[WorkflowTriggerBlockParametersItem]] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -815,6 +910,8 @@ ForLoopBlockLoopBlocksItem = typing.Union[
ForLoopBlockLoopBlocksItem_FileUpload,
ForLoopBlockLoopBlocksItem_FileUrlParser,
ForLoopBlockLoopBlocksItem_ForLoop,
+ ForLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ ForLoopBlockLoopBlocksItem_GoogleSheetsWrite,
ForLoopBlockLoopBlocksItem_GotoUrl,
ForLoopBlockLoopBlocksItem_HttpRequest,
ForLoopBlockLoopBlocksItem_HumanInteraction,
@@ -832,20 +929,69 @@ ForLoopBlockLoopBlocksItem = typing.Union[
ForLoopBlockLoopBlocksItem_WhileLoop,
ForLoopBlockLoopBlocksItem_WorkflowTrigger,
]
-update_forward_refs(ForLoopBlockLoopBlocksItem_Action)
-update_forward_refs(ForLoopBlockLoopBlocksItem_Code)
-update_forward_refs(ForLoopBlockLoopBlocksItem_Extraction)
-update_forward_refs(ForLoopBlockLoopBlocksItem_FileDownload)
-update_forward_refs(ForLoopBlockLoopBlocksItem_ForLoop)
-update_forward_refs(ForLoopBlockLoopBlocksItem_GotoUrl)
-update_forward_refs(ForLoopBlockLoopBlocksItem_HttpRequest)
-update_forward_refs(ForLoopBlockLoopBlocksItem_HumanInteraction)
-update_forward_refs(ForLoopBlockLoopBlocksItem_Login)
-update_forward_refs(ForLoopBlockLoopBlocksItem_Navigation)
-update_forward_refs(ForLoopBlockLoopBlocksItem_PrintPage)
-update_forward_refs(ForLoopBlockLoopBlocksItem_Task)
-update_forward_refs(ForLoopBlockLoopBlocksItem_TextPrompt)
-update_forward_refs(ForLoopBlockLoopBlocksItem_Validation)
-update_forward_refs(ForLoopBlockLoopBlocksItem_Wait)
-update_forward_refs(ForLoopBlockLoopBlocksItem_WhileLoop)
-update_forward_refs(ForLoopBlockLoopBlocksItem_WorkflowTrigger)
+# Manual patch: see for_loop_block.py header note. The cross-import below fails
+# when this module is loaded mid-chain via while_loop_block_loop_blocks_item.
+# The other side back-resolves us once it finishes loading.
+try:
+ from .while_loop_block_loop_blocks_item import WhileLoopBlockLoopBlocksItem # noqa: E402, F401, I001
+except ImportError:
+ pass
+else:
+ for _cls in (
+ ForLoopBlockLoopBlocksItem_Action,
+ ForLoopBlockLoopBlocksItem_Code,
+ ForLoopBlockLoopBlocksItem_Extraction,
+ ForLoopBlockLoopBlocksItem_FileDownload,
+ ForLoopBlockLoopBlocksItem_ForLoop,
+ ForLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ ForLoopBlockLoopBlocksItem_GoogleSheetsWrite,
+ ForLoopBlockLoopBlocksItem_GotoUrl,
+ ForLoopBlockLoopBlocksItem_HttpRequest,
+ ForLoopBlockLoopBlocksItem_HumanInteraction,
+ ForLoopBlockLoopBlocksItem_Login,
+ ForLoopBlockLoopBlocksItem_Navigation,
+ ForLoopBlockLoopBlocksItem_PrintPage,
+ ForLoopBlockLoopBlocksItem_Task,
+ ForLoopBlockLoopBlocksItem_TextPrompt,
+ ForLoopBlockLoopBlocksItem_Validation,
+ ForLoopBlockLoopBlocksItem_Wait,
+ ForLoopBlockLoopBlocksItem_WhileLoop,
+ ForLoopBlockLoopBlocksItem_WorkflowTrigger,
+ ):
+ update_forward_refs(_cls)
+ # Back-resolve everything that couldn't resolve mid-chain:
+ # 1. while_loop_block_loop_blocks_item variants (need our ForLoopBlockLoopBlocksItem)
+ from . import while_loop_block_loop_blocks_item as _wllb
+ _wllb.ForLoopBlockLoopBlocksItem = ForLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ for _cls in (
+ _wllb.WhileLoopBlockLoopBlocksItem_Action,
+ _wllb.WhileLoopBlockLoopBlocksItem_Code,
+ _wllb.WhileLoopBlockLoopBlocksItem_Extraction,
+ _wllb.WhileLoopBlockLoopBlocksItem_FileDownload,
+ _wllb.WhileLoopBlockLoopBlocksItem_ForLoop,
+ _wllb.WhileLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ _wllb.WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite,
+ _wllb.WhileLoopBlockLoopBlocksItem_GotoUrl,
+ _wllb.WhileLoopBlockLoopBlocksItem_HttpRequest,
+ _wllb.WhileLoopBlockLoopBlocksItem_HumanInteraction,
+ _wllb.WhileLoopBlockLoopBlocksItem_Login,
+ _wllb.WhileLoopBlockLoopBlocksItem_Navigation,
+ _wllb.WhileLoopBlockLoopBlocksItem_PrintPage,
+ _wllb.WhileLoopBlockLoopBlocksItem_Task,
+ _wllb.WhileLoopBlockLoopBlocksItem_TextPrompt,
+ _wllb.WhileLoopBlockLoopBlocksItem_Validation,
+ _wllb.WhileLoopBlockLoopBlocksItem_Wait,
+ _wllb.WhileLoopBlockLoopBlocksItem_WhileLoop,
+ _wllb.WhileLoopBlockLoopBlocksItem_WorkflowTrigger,
+ ):
+ update_forward_refs(_cls)
+ # 2. for_loop_block.ForLoopBlock (needs our ForLoopBlockLoopBlocksItem in its globals)
+ from . import for_loop_block as _flb
+ _flb.ForLoopBlockLoopBlocksItem = ForLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ _flb.WhileLoopBlockLoopBlocksItem = WhileLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_flb.ForLoopBlock)
+ # 3. while_loop_block.WhileLoopBlock
+ from . import while_loop_block as _wlb
+ _wlb.ForLoopBlockLoopBlocksItem = ForLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ _wlb.WhileLoopBlockLoopBlocksItem = WhileLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_wlb.WhileLoopBlock)
diff --git a/skyvern/client/types/for_loop_block_yaml.py b/skyvern/client/types/for_loop_block_yaml.py
index 807562283..4cf687393 100644
--- a/skyvern/client/types/for_loop_block_yaml.py
+++ b/skyvern/client/types/for_loop_block_yaml.py
@@ -22,6 +22,7 @@ class ForLoopBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
loop_blocks: typing.List["ForLoopBlockYamlLoopBlocksItem"]
loop_over_parameter_key: typing.Optional[str] = None
@@ -39,6 +40,12 @@ class ForLoopBlockYaml(UniversalBaseModel):
extra = pydantic.Extra.allow
-from .for_loop_block_yaml_loop_blocks_item import ForLoopBlockYamlLoopBlocksItem # noqa: E402, F401, I001
+# Manual patch: Fern v4.31.1 emits bottom-cross-imports that deadlock at module
+# load. See for_loop_block.py for the explanation.
+try:
+ from .while_loop_block_yaml import WhileLoopBlockYaml # noqa: E402, F401, I001
+ from .for_loop_block_yaml_loop_blocks_item import ForLoopBlockYamlLoopBlocksItem # noqa: E402, F401, I001
+except ImportError:
+ pass
update_forward_refs(ForLoopBlockYaml)
diff --git a/skyvern/client/types/for_loop_block_yaml_loop_blocks_item.py b/skyvern/client/types/for_loop_block_yaml_loop_blocks_item.py
index 7a87b74ec..85a9036fe 100644
--- a/skyvern/client/types/for_loop_block_yaml_loop_blocks_item.py
+++ b/skyvern/client/types/for_loop_block_yaml_loop_blocks_item.py
@@ -14,6 +14,7 @@ from .extraction_block_yaml_data_schema import ExtractionBlockYamlDataSchema
from .file_storage_type import FileStorageType
from .file_type import FileType
from .for_loop_block_yaml_data_schema import ForLoopBlockYamlDataSchema
+from .google_sheets_write_block_yaml_write_mode import GoogleSheetsWriteBlockYamlWriteMode
from .pdf_format import PdfFormat
from .run_engine import RunEngine
from .task_block_yaml_data_schema import TaskBlockYamlDataSchema
@@ -25,6 +26,7 @@ class ForLoopBlockYamlLoopBlocksItem_Task(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -62,6 +64,7 @@ class ForLoopBlockYamlLoopBlocksItem_ForLoop(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
loop_blocks: typing.List["ForLoopBlockYamlLoopBlocksItem"]
loop_over_parameter_key: typing.Optional[str] = None
@@ -79,7 +82,29 @@ class ForLoopBlockYamlLoopBlocksItem_ForLoop(UniversalBaseModel):
extra = pydantic.Extra.allow
+class ForLoopBlockYamlLoopBlocksItem_WhileLoop(UniversalBaseModel):
+ block_type: typing.Literal["while_loop"] = "while_loop"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ loop_blocks: typing.List["WhileLoopBlockYamlLoopBlocksItem"]
+ condition: BranchCriteriaYaml
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
from .for_loop_block_yaml import ForLoopBlockYaml # noqa: E402, F401, I001
+from .while_loop_block_yaml import WhileLoopBlockYaml # noqa: E402, F401, I001
class ForLoopBlockYamlLoopBlocksItem_Code(UniversalBaseModel):
@@ -88,6 +113,7 @@ class ForLoopBlockYamlLoopBlocksItem_Code(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
code: str
parameter_keys: typing.Optional[typing.List[str]] = None
@@ -108,6 +134,7 @@ class ForLoopBlockYamlLoopBlocksItem_TextPrompt(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
llm_key: typing.Optional[str] = None
prompt: str
@@ -130,6 +157,7 @@ class ForLoopBlockYamlLoopBlocksItem_DownloadToS3(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -149,6 +177,7 @@ class ForLoopBlockYamlLoopBlocksItem_UploadToS3(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
path: typing.Optional[str] = None
@@ -168,6 +197,7 @@ class ForLoopBlockYamlLoopBlocksItem_FileUpload(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
storage_type: typing.Optional[FileStorageType] = None
s3bucket: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_bucket")] = None
@@ -196,6 +226,7 @@ class ForLoopBlockYamlLoopBlocksItem_SendEmail(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
smtp_host_secret_parameter_key: str
smtp_port_secret_parameter_key: str
@@ -223,6 +254,7 @@ class ForLoopBlockYamlLoopBlocksItem_FileUrlParser(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
file_type: typing.Optional[FileType] = None
@@ -244,6 +276,7 @@ class ForLoopBlockYamlLoopBlocksItem_Validation(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
complete_criterion: typing.Optional[str] = None
terminate_criterion: typing.Optional[str] = None
@@ -267,6 +300,7 @@ class ForLoopBlockYamlLoopBlocksItem_Action(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -297,6 +331,7 @@ class ForLoopBlockYamlLoopBlocksItem_Navigation(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
navigation_goal: str
url: typing.Optional[str] = None
@@ -332,6 +367,7 @@ class ForLoopBlockYamlLoopBlocksItem_Extraction(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
data_extraction_goal: str
url: typing.Optional[str] = None
@@ -359,6 +395,7 @@ class ForLoopBlockYamlLoopBlocksItem_Login(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -391,6 +428,7 @@ class ForLoopBlockYamlLoopBlocksItem_Wait(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
wait_sec: typing.Optional[int] = None
@@ -410,6 +448,7 @@ class ForLoopBlockYamlLoopBlocksItem_HumanInteraction(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
instructions: typing.Optional[str] = None
positive_descriptor: typing.Optional[str] = None
@@ -436,6 +475,7 @@ class ForLoopBlockYamlLoopBlocksItem_FileDownload(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
navigation_goal: str
url: typing.Optional[str] = None
@@ -467,6 +507,7 @@ class ForLoopBlockYamlLoopBlocksItem_GotoUrl(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -486,6 +527,7 @@ class ForLoopBlockYamlLoopBlocksItem_PdfParser(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -506,6 +548,7 @@ class ForLoopBlockYamlLoopBlocksItem_TaskV2(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
prompt: str
url: typing.Optional[str] = None
@@ -531,6 +574,7 @@ class ForLoopBlockYamlLoopBlocksItem_HttpRequest(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
method: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -559,6 +603,7 @@ class ForLoopBlockYamlLoopBlocksItem_Conditional(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
branch_conditions: typing.Optional[typing.List[BranchConditionYaml]] = None
@@ -578,6 +623,7 @@ class ForLoopBlockYamlLoopBlocksItem_PrintPage(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
include_timestamp: typing.Optional[bool] = None
custom_filename: typing.Optional[str] = None
@@ -602,6 +648,7 @@ class ForLoopBlockYamlLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
workflow_permanent_id: str
payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -620,15 +667,48 @@ class ForLoopBlockYamlLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
extra = pydantic.Extra.allow
-class ForLoopBlockYamlLoopBlocksItem_WhileLoop(UniversalBaseModel):
- block_type: typing.Literal["while_loop"] = "while_loop"
+class ForLoopBlockYamlLoopBlocksItem_GoogleSheetsRead(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_read"] = "google_sheets_read"
label: str
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- loop_blocks: typing.List["ForLoopBlockYamlLoopBlocksItem"]
- condition: BranchCriteriaYaml
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ has_header_row: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class ForLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_write"] = "google_sheets_write"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ write_mode: typing.Optional[GoogleSheetsWriteBlockYamlWriteMode] = None
+ values: typing.Optional[str] = None
+ column_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ create_sheet_if_missing: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -643,6 +723,7 @@ class ForLoopBlockYamlLoopBlocksItem_WhileLoop(UniversalBaseModel):
ForLoopBlockYamlLoopBlocksItem = typing.Union[
ForLoopBlockYamlLoopBlocksItem_Task,
ForLoopBlockYamlLoopBlocksItem_ForLoop,
+ ForLoopBlockYamlLoopBlocksItem_WhileLoop,
ForLoopBlockYamlLoopBlocksItem_Code,
ForLoopBlockYamlLoopBlocksItem_TextPrompt,
ForLoopBlockYamlLoopBlocksItem_DownloadToS3,
@@ -664,8 +745,27 @@ ForLoopBlockYamlLoopBlocksItem = typing.Union[
ForLoopBlockYamlLoopBlocksItem_HttpRequest,
ForLoopBlockYamlLoopBlocksItem_Conditional,
ForLoopBlockYamlLoopBlocksItem_PrintPage,
- ForLoopBlockYamlLoopBlocksItem_WhileLoop,
ForLoopBlockYamlLoopBlocksItem_WorkflowTrigger,
+ ForLoopBlockYamlLoopBlocksItem_GoogleSheetsRead,
+ ForLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite,
]
-update_forward_refs(ForLoopBlockYamlLoopBlocksItem_ForLoop)
-update_forward_refs(ForLoopBlockYamlLoopBlocksItem_WhileLoop)
+# Manual patch: see for_loop_block.py header note.
+try:
+ from .while_loop_block_yaml_loop_blocks_item import WhileLoopBlockYamlLoopBlocksItem # noqa: E402, F401, I001
+except ImportError:
+ pass
+else:
+ update_forward_refs(ForLoopBlockYamlLoopBlocksItem_ForLoop)
+ update_forward_refs(ForLoopBlockYamlLoopBlocksItem_WhileLoop)
+ from . import while_loop_block_yaml_loop_blocks_item as _wlylb
+ _wlylb.ForLoopBlockYamlLoopBlocksItem = ForLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_wlylb.WhileLoopBlockYamlLoopBlocksItem_ForLoop)
+ update_forward_refs(_wlylb.WhileLoopBlockYamlLoopBlocksItem_WhileLoop)
+ from . import for_loop_block_yaml as _flby
+ _flby.ForLoopBlockYamlLoopBlocksItem = ForLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ _flby.WhileLoopBlockYamlLoopBlocksItem = WhileLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_flby.ForLoopBlockYaml)
+ from . import while_loop_block_yaml as _wlby
+ _wlby.ForLoopBlockYamlLoopBlocksItem = ForLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ _wlby.WhileLoopBlockYamlLoopBlocksItem = WhileLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_wlby.WhileLoopBlockYaml)
diff --git a/skyvern/client/types/geo_target.py b/skyvern/client/types/geo_target.py
index 592cc76d6..a9428cbc2 100644
--- a/skyvern/client/types/geo_target.py
+++ b/skyvern/client/types/geo_target.py
@@ -8,17 +8,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
class GeoTarget(UniversalBaseModel):
"""
- Granular geographic targeting for proxy selection.
-
- Supports country, subdivision (state/region), and city level targeting.
- Uses ISO 3166-1 alpha-2 for countries, ISO 3166-2 for subdivisions,
- and GeoNames English names for cities.
-
- Examples:
- - {"country": "US"} - United States (same as RESIDENTIAL)
- - {"country": "US", "subdivision": "CA"} - California, US
- - {"country": "US", "subdivision": "NY", "city": "New York"} - New York City
- - {"country": "GB", "city": "London"} - London, UK
+ Granular proxy geo-targeting request with country, optional subdivision, and optional city.
"""
country: str = pydantic.Field()
diff --git a/skyvern/client/types/get_run_response.py b/skyvern/client/types/get_run_response.py
index 8898a7cb7..2933c6095 100644
--- a/skyvern/client/types/get_run_response.py
+++ b/skyvern/client/types/get_run_response.py
@@ -10,9 +10,9 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from .file_info import FileInfo
from .run_status import RunStatus
from .script_run_response import ScriptRunResponse
-from .task_run_request import TaskRunRequest
+from .task_run_request_output import TaskRunRequestOutput
from .task_run_response_output import TaskRunResponseOutput
-from .workflow_run_request import WorkflowRunRequest
+from .workflow_run_request_output import WorkflowRunRequestOutput
from .workflow_run_response_output import WorkflowRunResponseOutput
@@ -23,6 +23,7 @@ class GetRunResponse_TaskV1(UniversalBaseModel):
output: typing.Optional[TaskRunResponseOutput] = None
downloaded_files: typing.Optional[typing.List[FileInfo]] = None
recording_url: typing.Optional[str] = None
+ recording_archived: typing.Optional[bool] = None
screenshot_urls: typing.Optional[typing.List[str]] = None
failure_reason: typing.Optional[str] = None
created_at: dt.datetime
@@ -37,7 +38,7 @@ class GetRunResponse_TaskV1(UniversalBaseModel):
script_run: typing.Optional[ScriptRunResponse] = None
errors: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
step_count: typing.Optional[int] = None
- run_request: typing.Optional[TaskRunRequest] = None
+ run_request: typing.Optional[TaskRunRequestOutput] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -56,6 +57,7 @@ class GetRunResponse_TaskV2(UniversalBaseModel):
output: typing.Optional[TaskRunResponseOutput] = None
downloaded_files: typing.Optional[typing.List[FileInfo]] = None
recording_url: typing.Optional[str] = None
+ recording_archived: typing.Optional[bool] = None
screenshot_urls: typing.Optional[typing.List[str]] = None
failure_reason: typing.Optional[str] = None
created_at: dt.datetime
@@ -70,7 +72,7 @@ class GetRunResponse_TaskV2(UniversalBaseModel):
script_run: typing.Optional[ScriptRunResponse] = None
errors: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
step_count: typing.Optional[int] = None
- run_request: typing.Optional[TaskRunRequest] = None
+ run_request: typing.Optional[TaskRunRequestOutput] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -89,6 +91,7 @@ class GetRunResponse_OpenaiCua(UniversalBaseModel):
output: typing.Optional[TaskRunResponseOutput] = None
downloaded_files: typing.Optional[typing.List[FileInfo]] = None
recording_url: typing.Optional[str] = None
+ recording_archived: typing.Optional[bool] = None
screenshot_urls: typing.Optional[typing.List[str]] = None
failure_reason: typing.Optional[str] = None
created_at: dt.datetime
@@ -103,7 +106,7 @@ class GetRunResponse_OpenaiCua(UniversalBaseModel):
script_run: typing.Optional[ScriptRunResponse] = None
errors: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
step_count: typing.Optional[int] = None
- run_request: typing.Optional[TaskRunRequest] = None
+ run_request: typing.Optional[TaskRunRequestOutput] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -122,6 +125,7 @@ class GetRunResponse_AnthropicCua(UniversalBaseModel):
output: typing.Optional[TaskRunResponseOutput] = None
downloaded_files: typing.Optional[typing.List[FileInfo]] = None
recording_url: typing.Optional[str] = None
+ recording_archived: typing.Optional[bool] = None
screenshot_urls: typing.Optional[typing.List[str]] = None
failure_reason: typing.Optional[str] = None
created_at: dt.datetime
@@ -136,7 +140,7 @@ class GetRunResponse_AnthropicCua(UniversalBaseModel):
script_run: typing.Optional[ScriptRunResponse] = None
errors: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
step_count: typing.Optional[int] = None
- run_request: typing.Optional[TaskRunRequest] = None
+ run_request: typing.Optional[TaskRunRequestOutput] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -155,6 +159,7 @@ class GetRunResponse_UiTars(UniversalBaseModel):
output: typing.Optional[TaskRunResponseOutput] = None
downloaded_files: typing.Optional[typing.List[FileInfo]] = None
recording_url: typing.Optional[str] = None
+ recording_archived: typing.Optional[bool] = None
screenshot_urls: typing.Optional[typing.List[str]] = None
failure_reason: typing.Optional[str] = None
created_at: dt.datetime
@@ -169,7 +174,41 @@ class GetRunResponse_UiTars(UniversalBaseModel):
script_run: typing.Optional[ScriptRunResponse] = None
errors: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
step_count: typing.Optional[int] = None
- run_request: typing.Optional[TaskRunRequest] = None
+ run_request: typing.Optional[TaskRunRequestOutput] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GetRunResponse_YutoriNavigator(UniversalBaseModel):
+ run_type: typing.Literal["yutori_navigator"] = "yutori_navigator"
+ run_id: str
+ status: RunStatus
+ output: typing.Optional[TaskRunResponseOutput] = None
+ downloaded_files: typing.Optional[typing.List[FileInfo]] = None
+ recording_url: typing.Optional[str] = None
+ recording_archived: typing.Optional[bool] = None
+ screenshot_urls: typing.Optional[typing.List[str]] = None
+ failure_reason: typing.Optional[str] = None
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ queued_at: typing.Optional[dt.datetime] = None
+ started_at: typing.Optional[dt.datetime] = None
+ finished_at: typing.Optional[dt.datetime] = None
+ app_url: typing.Optional[str] = None
+ browser_session_id: typing.Optional[str] = None
+ browser_profile_id: typing.Optional[str] = None
+ max_screenshot_scrolls: typing.Optional[int] = None
+ script_run: typing.Optional[ScriptRunResponse] = None
+ errors: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
+ step_count: typing.Optional[int] = None
+ run_request: typing.Optional[TaskRunRequestOutput] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -188,6 +227,7 @@ class GetRunResponse_WorkflowRun(UniversalBaseModel):
output: typing.Optional[WorkflowRunResponseOutput] = None
downloaded_files: typing.Optional[typing.List[FileInfo]] = None
recording_url: typing.Optional[str] = None
+ recording_archived: typing.Optional[bool] = None
screenshot_urls: typing.Optional[typing.List[str]] = None
failure_reason: typing.Optional[str] = None
created_at: dt.datetime
@@ -204,7 +244,8 @@ class GetRunResponse_WorkflowRun(UniversalBaseModel):
step_count: typing.Optional[int] = None
run_with: typing.Optional[str] = None
ai_fallback: typing.Optional[bool] = None
- run_request: typing.Optional[WorkflowRunRequest] = None
+ script_id: typing.Optional[str] = None
+ run_request: typing.Optional[WorkflowRunRequestOutput] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -222,5 +263,6 @@ GetRunResponse = typing.Union[
GetRunResponse_OpenaiCua,
GetRunResponse_AnthropicCua,
GetRunResponse_UiTars,
+ GetRunResponse_YutoriNavigator,
GetRunResponse_WorkflowRun,
]
diff --git a/skyvern/client/types/google_sheets_read_block.py b/skyvern/client/types/google_sheets_read_block.py
new file mode 100644
index 000000000..127aa0394
--- /dev/null
+++ b/skyvern/client/types/google_sheets_read_block.py
@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel, update_forward_refs
+from .google_sheets_read_block_parameters_item import GoogleSheetsReadBlockParametersItem
+from .output_parameter import OutputParameter
+
+
+class GoogleSheetsReadBlock(UniversalBaseModel):
+ label: str = pydantic.Field()
+ """
+ Author-facing identifier for a block; unique within a workflow.
+ """
+
+ next_block_label: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
+ """
+
+ output_parameter: OutputParameter
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ has_header_row: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[GoogleSheetsReadBlockParametersItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+from .context_parameter import ContextParameter # noqa: E402, F401, I001
+
+update_forward_refs(GoogleSheetsReadBlock)
diff --git a/skyvern/client/types/google_sheets_read_block_parameters_item.py b/skyvern/client/types/google_sheets_read_block_parameters_item.py
new file mode 100644
index 000000000..d06af1366
--- /dev/null
+++ b/skyvern/client/types/google_sheets_read_block_parameters_item.py
@@ -0,0 +1,277 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel, update_forward_refs
+from .context_parameter_value import ContextParameterValue
+from .workflow_parameter_default_value import WorkflowParameterDefaultValue
+from .workflow_parameter_type import WorkflowParameterType
+
+
+class GoogleSheetsReadBlockParametersItem_AwsSecret(UniversalBaseModel):
+ parameter_type: typing.Literal["aws_secret"] = "aws_secret"
+ key: str
+ description: typing.Optional[str] = None
+ aws_secret_parameter_id: str
+ workflow_id: str
+ aws_key: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_AzureSecret(UniversalBaseModel):
+ parameter_type: typing.Literal["azure_secret"] = "azure_secret"
+ key: str
+ description: typing.Optional[str] = None
+ azure_secret_parameter_id: str
+ workflow_id: str
+ azure_key: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_AzureVaultCredential(UniversalBaseModel):
+ parameter_type: typing.Literal["azure_vault_credential"] = "azure_vault_credential"
+ key: str
+ description: typing.Optional[str] = None
+ azure_vault_credential_parameter_id: str
+ workflow_id: str
+ vault_name: str
+ username_key: str
+ password_key: str
+ totp_secret_key: typing.Optional[str] = None
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_BitwardenCreditCardData(UniversalBaseModel):
+ parameter_type: typing.Literal["bitwarden_credit_card_data"] = "bitwarden_credit_card_data"
+ key: str
+ description: typing.Optional[str] = None
+ bitwarden_credit_card_data_parameter_id: str
+ workflow_id: str
+ bitwarden_client_id_aws_secret_key: str
+ bitwarden_client_secret_aws_secret_key: str
+ bitwarden_master_password_aws_secret_key: str
+ bitwarden_collection_id: str
+ bitwarden_item_id: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_BitwardenLoginCredential(UniversalBaseModel):
+ parameter_type: typing.Literal["bitwarden_login_credential"] = "bitwarden_login_credential"
+ key: str
+ description: typing.Optional[str] = None
+ bitwarden_login_credential_parameter_id: str
+ workflow_id: str
+ bitwarden_client_id_aws_secret_key: str
+ bitwarden_client_secret_aws_secret_key: str
+ bitwarden_master_password_aws_secret_key: str
+ url_parameter_key: typing.Optional[str] = None
+ bitwarden_collection_id: typing.Optional[str] = None
+ bitwarden_item_id: typing.Optional[str] = None
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_BitwardenSensitiveInformation(UniversalBaseModel):
+ parameter_type: typing.Literal["bitwarden_sensitive_information"] = "bitwarden_sensitive_information"
+ key: str
+ description: typing.Optional[str] = None
+ bitwarden_sensitive_information_parameter_id: str
+ workflow_id: str
+ bitwarden_client_id_aws_secret_key: str
+ bitwarden_client_secret_aws_secret_key: str
+ bitwarden_master_password_aws_secret_key: str
+ bitwarden_collection_id: str
+ bitwarden_identity_key: str
+ bitwarden_identity_fields: typing.List[str]
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_Context(UniversalBaseModel):
+ parameter_type: typing.Literal["context"] = "context"
+ key: str
+ description: typing.Optional[str] = None
+ source: "ContextParameterSource"
+ value: typing.Optional[ContextParameterValue] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+from .context_parameter import ContextParameter # noqa: E402, F401, I001
+from .context_parameter_source import ContextParameterSource # noqa: E402, F401, I001
+
+
+class GoogleSheetsReadBlockParametersItem_Credential(UniversalBaseModel):
+ parameter_type: typing.Literal["credential"] = "credential"
+ key: str
+ description: typing.Optional[str] = None
+ credential_parameter_id: str
+ workflow_id: str
+ credential_id: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_Onepassword(UniversalBaseModel):
+ parameter_type: typing.Literal["onepassword"] = "onepassword"
+ key: str
+ description: typing.Optional[str] = None
+ onepassword_credential_parameter_id: str
+ workflow_id: str
+ vault_id: str
+ item_id: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_Output(UniversalBaseModel):
+ parameter_type: typing.Literal["output"] = "output"
+ key: str
+ description: typing.Optional[str] = None
+ output_parameter_id: str
+ workflow_id: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsReadBlockParametersItem_Workflow(UniversalBaseModel):
+ parameter_type: typing.Literal["workflow"] = "workflow"
+ key: str
+ description: typing.Optional[str] = None
+ workflow_parameter_id: str
+ workflow_parameter_type: WorkflowParameterType
+ workflow_id: str
+ default_value: typing.Optional[WorkflowParameterDefaultValue] = None
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+GoogleSheetsReadBlockParametersItem = typing.Union[
+ GoogleSheetsReadBlockParametersItem_AwsSecret,
+ GoogleSheetsReadBlockParametersItem_AzureSecret,
+ GoogleSheetsReadBlockParametersItem_AzureVaultCredential,
+ GoogleSheetsReadBlockParametersItem_BitwardenCreditCardData,
+ GoogleSheetsReadBlockParametersItem_BitwardenLoginCredential,
+ GoogleSheetsReadBlockParametersItem_BitwardenSensitiveInformation,
+ GoogleSheetsReadBlockParametersItem_Context,
+ GoogleSheetsReadBlockParametersItem_Credential,
+ GoogleSheetsReadBlockParametersItem_Onepassword,
+ GoogleSheetsReadBlockParametersItem_Output,
+ GoogleSheetsReadBlockParametersItem_Workflow,
+]
+update_forward_refs(GoogleSheetsReadBlockParametersItem_Context)
diff --git a/skyvern/client/types/google_sheets_read_block_yaml.py b/skyvern/client/types/google_sheets_read_block_yaml.py
new file mode 100644
index 000000000..43b16ee0e
--- /dev/null
+++ b/skyvern/client/types/google_sheets_read_block_yaml.py
@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class GoogleSheetsReadBlockYaml(UniversalBaseModel):
+ label: str = pydantic.Field()
+ """
+ Author-facing identifier; must be unique per workflow.
+ """
+
+ next_block_label: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
+ """
+
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ has_header_row: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/skyvern/client/types/google_sheets_write_block.py b/skyvern/client/types/google_sheets_write_block.py
new file mode 100644
index 000000000..c9c0edc64
--- /dev/null
+++ b/skyvern/client/types/google_sheets_write_block.py
@@ -0,0 +1,53 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel, update_forward_refs
+from .google_sheets_write_block_parameters_item import GoogleSheetsWriteBlockParametersItem
+from .google_sheets_write_block_write_mode import GoogleSheetsWriteBlockWriteMode
+from .output_parameter import OutputParameter
+
+
+class GoogleSheetsWriteBlock(UniversalBaseModel):
+ label: str = pydantic.Field()
+ """
+ Author-facing identifier for a block; unique within a workflow.
+ """
+
+ next_block_label: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
+ """
+
+ output_parameter: OutputParameter
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ write_mode: typing.Optional[GoogleSheetsWriteBlockWriteMode] = None
+ values: typing.Optional[str] = None
+ column_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ create_sheet_if_missing: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[GoogleSheetsWriteBlockParametersItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+from .context_parameter import ContextParameter # noqa: E402, F401, I001
+
+update_forward_refs(GoogleSheetsWriteBlock)
diff --git a/skyvern/client/types/google_sheets_write_block_parameters_item.py b/skyvern/client/types/google_sheets_write_block_parameters_item.py
new file mode 100644
index 000000000..0497c61a0
--- /dev/null
+++ b/skyvern/client/types/google_sheets_write_block_parameters_item.py
@@ -0,0 +1,277 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel, update_forward_refs
+from .context_parameter_value import ContextParameterValue
+from .workflow_parameter_default_value import WorkflowParameterDefaultValue
+from .workflow_parameter_type import WorkflowParameterType
+
+
+class GoogleSheetsWriteBlockParametersItem_AwsSecret(UniversalBaseModel):
+ parameter_type: typing.Literal["aws_secret"] = "aws_secret"
+ key: str
+ description: typing.Optional[str] = None
+ aws_secret_parameter_id: str
+ workflow_id: str
+ aws_key: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_AzureSecret(UniversalBaseModel):
+ parameter_type: typing.Literal["azure_secret"] = "azure_secret"
+ key: str
+ description: typing.Optional[str] = None
+ azure_secret_parameter_id: str
+ workflow_id: str
+ azure_key: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_AzureVaultCredential(UniversalBaseModel):
+ parameter_type: typing.Literal["azure_vault_credential"] = "azure_vault_credential"
+ key: str
+ description: typing.Optional[str] = None
+ azure_vault_credential_parameter_id: str
+ workflow_id: str
+ vault_name: str
+ username_key: str
+ password_key: str
+ totp_secret_key: typing.Optional[str] = None
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_BitwardenCreditCardData(UniversalBaseModel):
+ parameter_type: typing.Literal["bitwarden_credit_card_data"] = "bitwarden_credit_card_data"
+ key: str
+ description: typing.Optional[str] = None
+ bitwarden_credit_card_data_parameter_id: str
+ workflow_id: str
+ bitwarden_client_id_aws_secret_key: str
+ bitwarden_client_secret_aws_secret_key: str
+ bitwarden_master_password_aws_secret_key: str
+ bitwarden_collection_id: str
+ bitwarden_item_id: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_BitwardenLoginCredential(UniversalBaseModel):
+ parameter_type: typing.Literal["bitwarden_login_credential"] = "bitwarden_login_credential"
+ key: str
+ description: typing.Optional[str] = None
+ bitwarden_login_credential_parameter_id: str
+ workflow_id: str
+ bitwarden_client_id_aws_secret_key: str
+ bitwarden_client_secret_aws_secret_key: str
+ bitwarden_master_password_aws_secret_key: str
+ url_parameter_key: typing.Optional[str] = None
+ bitwarden_collection_id: typing.Optional[str] = None
+ bitwarden_item_id: typing.Optional[str] = None
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_BitwardenSensitiveInformation(UniversalBaseModel):
+ parameter_type: typing.Literal["bitwarden_sensitive_information"] = "bitwarden_sensitive_information"
+ key: str
+ description: typing.Optional[str] = None
+ bitwarden_sensitive_information_parameter_id: str
+ workflow_id: str
+ bitwarden_client_id_aws_secret_key: str
+ bitwarden_client_secret_aws_secret_key: str
+ bitwarden_master_password_aws_secret_key: str
+ bitwarden_collection_id: str
+ bitwarden_identity_key: str
+ bitwarden_identity_fields: typing.List[str]
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_Context(UniversalBaseModel):
+ parameter_type: typing.Literal["context"] = "context"
+ key: str
+ description: typing.Optional[str] = None
+ source: "ContextParameterSource"
+ value: typing.Optional[ContextParameterValue] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+from .context_parameter import ContextParameter # noqa: E402, F401, I001
+from .context_parameter_source import ContextParameterSource # noqa: E402, F401, I001
+
+
+class GoogleSheetsWriteBlockParametersItem_Credential(UniversalBaseModel):
+ parameter_type: typing.Literal["credential"] = "credential"
+ key: str
+ description: typing.Optional[str] = None
+ credential_parameter_id: str
+ workflow_id: str
+ credential_id: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_Onepassword(UniversalBaseModel):
+ parameter_type: typing.Literal["onepassword"] = "onepassword"
+ key: str
+ description: typing.Optional[str] = None
+ onepassword_credential_parameter_id: str
+ workflow_id: str
+ vault_id: str
+ item_id: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_Output(UniversalBaseModel):
+ parameter_type: typing.Literal["output"] = "output"
+ key: str
+ description: typing.Optional[str] = None
+ output_parameter_id: str
+ workflow_id: str
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class GoogleSheetsWriteBlockParametersItem_Workflow(UniversalBaseModel):
+ parameter_type: typing.Literal["workflow"] = "workflow"
+ key: str
+ description: typing.Optional[str] = None
+ workflow_parameter_id: str
+ workflow_parameter_type: WorkflowParameterType
+ workflow_id: str
+ default_value: typing.Optional[WorkflowParameterDefaultValue] = None
+ created_at: dt.datetime
+ modified_at: dt.datetime
+ deleted_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+GoogleSheetsWriteBlockParametersItem = typing.Union[
+ GoogleSheetsWriteBlockParametersItem_AwsSecret,
+ GoogleSheetsWriteBlockParametersItem_AzureSecret,
+ GoogleSheetsWriteBlockParametersItem_AzureVaultCredential,
+ GoogleSheetsWriteBlockParametersItem_BitwardenCreditCardData,
+ GoogleSheetsWriteBlockParametersItem_BitwardenLoginCredential,
+ GoogleSheetsWriteBlockParametersItem_BitwardenSensitiveInformation,
+ GoogleSheetsWriteBlockParametersItem_Context,
+ GoogleSheetsWriteBlockParametersItem_Credential,
+ GoogleSheetsWriteBlockParametersItem_Onepassword,
+ GoogleSheetsWriteBlockParametersItem_Output,
+ GoogleSheetsWriteBlockParametersItem_Workflow,
+]
+update_forward_refs(GoogleSheetsWriteBlockParametersItem_Context)
diff --git a/skyvern/client/types/google_sheets_write_block_write_mode.py b/skyvern/client/types/google_sheets_write_block_write_mode.py
new file mode 100644
index 000000000..a31e12174
--- /dev/null
+++ b/skyvern/client/types/google_sheets_write_block_write_mode.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GoogleSheetsWriteBlockWriteMode = typing.Union[typing.Literal["append", "update"], typing.Any]
diff --git a/skyvern/client/types/google_sheets_write_block_yaml.py b/skyvern/client/types/google_sheets_write_block_yaml.py
new file mode 100644
index 000000000..c4e1abea7
--- /dev/null
+++ b/skyvern/client/types/google_sheets_write_block_yaml.py
@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .google_sheets_write_block_yaml_write_mode import GoogleSheetsWriteBlockYamlWriteMode
+
+
+class GoogleSheetsWriteBlockYaml(UniversalBaseModel):
+ label: str = pydantic.Field()
+ """
+ Author-facing identifier; must be unique per workflow.
+ """
+
+ next_block_label: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
+ """
+
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ write_mode: typing.Optional[GoogleSheetsWriteBlockYamlWriteMode] = None
+ values: typing.Optional[str] = None
+ column_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ create_sheet_if_missing: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/skyvern/client/types/google_sheets_write_block_yaml_write_mode.py b/skyvern/client/types/google_sheets_write_block_yaml_write_mode.py
new file mode 100644
index 000000000..f1ef4fd5e
--- /dev/null
+++ b/skyvern/client/types/google_sheets_write_block_yaml_write_mode.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GoogleSheetsWriteBlockYamlWriteMode = typing.Union[typing.Literal["append", "update"], typing.Any]
diff --git a/skyvern/client/types/http_request_block.py b/skyvern/client/types/http_request_block.py
index 319258549..4fc1e6e8f 100644
--- a/skyvern/client/types/http_request_block.py
+++ b/skyvern/client/types/http_request_block.py
@@ -25,6 +25,7 @@ class HttpRequestBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
method: typing.Optional[str] = None
url: typing.Optional[str] = None
diff --git a/skyvern/client/types/http_request_block_yaml.py b/skyvern/client/types/http_request_block_yaml.py
index 7d6ef8eb3..b2bd6ae15 100644
--- a/skyvern/client/types/http_request_block_yaml.py
+++ b/skyvern/client/types/http_request_block_yaml.py
@@ -19,6 +19,7 @@ class HttpRequestBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
method: typing.Optional[str] = None
url: typing.Optional[str] = None
diff --git a/skyvern/client/types/human_interaction_block.py b/skyvern/client/types/human_interaction_block.py
index e1e74a138..6c1879ee3 100644
--- a/skyvern/client/types/human_interaction_block.py
+++ b/skyvern/client/types/human_interaction_block.py
@@ -39,6 +39,7 @@ class HumanInteractionBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -60,6 +61,7 @@ class HumanInteractionBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
instructions: typing.Optional[str] = None
positive_descriptor: typing.Optional[str] = None
negative_descriptor: typing.Optional[str] = None
diff --git a/skyvern/client/types/human_interaction_block_yaml.py b/skyvern/client/types/human_interaction_block_yaml.py
index efccee61d..c3c38d91e 100644
--- a/skyvern/client/types/human_interaction_block_yaml.py
+++ b/skyvern/client/types/human_interaction_block_yaml.py
@@ -19,6 +19,7 @@ class HumanInteractionBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
instructions: typing.Optional[str] = None
positive_descriptor: typing.Optional[str] = None
diff --git a/skyvern/client/types/login_block.py b/skyvern/client/types/login_block.py
index b832bb35a..3675e1928 100644
--- a/skyvern/client/types/login_block.py
+++ b/skyvern/client/types/login_block.py
@@ -27,6 +27,7 @@ class LoginBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -48,6 +49,7 @@ class LoginBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/login_block_yaml.py b/skyvern/client/types/login_block_yaml.py
index 480f43c18..b64f4e033 100644
--- a/skyvern/client/types/login_block_yaml.py
+++ b/skyvern/client/types/login_block_yaml.py
@@ -20,6 +20,7 @@ class LoginBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
diff --git a/skyvern/client/types/navigation_block.py b/skyvern/client/types/navigation_block.py
index ccdea0568..31c59b8f7 100644
--- a/skyvern/client/types/navigation_block.py
+++ b/skyvern/client/types/navigation_block.py
@@ -27,6 +27,7 @@ class NavigationBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -48,6 +49,7 @@ class NavigationBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/navigation_block_yaml.py b/skyvern/client/types/navigation_block_yaml.py
index c0bf45ff2..574143688 100644
--- a/skyvern/client/types/navigation_block_yaml.py
+++ b/skyvern/client/types/navigation_block_yaml.py
@@ -20,6 +20,7 @@ class NavigationBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
navigation_goal: str
url: typing.Optional[str] = None
diff --git a/skyvern/client/types/pdf_parser_block.py b/skyvern/client/types/pdf_parser_block.py
index 898dfb4f1..cca9067f4 100644
--- a/skyvern/client/types/pdf_parser_block.py
+++ b/skyvern/client/types/pdf_parser_block.py
@@ -27,6 +27,7 @@ class PdfParserBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
diff --git a/skyvern/client/types/pdf_parser_block_yaml.py b/skyvern/client/types/pdf_parser_block_yaml.py
index 89f336765..c5ff77881 100644
--- a/skyvern/client/types/pdf_parser_block_yaml.py
+++ b/skyvern/client/types/pdf_parser_block_yaml.py
@@ -19,6 +19,7 @@ class PdfParserBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
diff --git a/skyvern/client/types/print_page_block.py b/skyvern/client/types/print_page_block.py
index 608de8d78..aa5735af0 100644
--- a/skyvern/client/types/print_page_block.py
+++ b/skyvern/client/types/print_page_block.py
@@ -25,6 +25,7 @@ class PrintPageBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
include_timestamp: typing.Optional[bool] = None
custom_filename: typing.Optional[str] = None
diff --git a/skyvern/client/types/print_page_block_yaml.py b/skyvern/client/types/print_page_block_yaml.py
index 489415ecb..08d896726 100644
--- a/skyvern/client/types/print_page_block_yaml.py
+++ b/skyvern/client/types/print_page_block_yaml.py
@@ -20,6 +20,7 @@ class PrintPageBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
include_timestamp: typing.Optional[bool] = None
custom_filename: typing.Optional[str] = None
diff --git a/skyvern/client/types/run_engine.py b/skyvern/client/types/run_engine.py
index 15900a49d..71e78ecc6 100644
--- a/skyvern/client/types/run_engine.py
+++ b/skyvern/client/types/run_engine.py
@@ -3,5 +3,6 @@
import typing
RunEngine = typing.Union[
- typing.Literal["skyvern-1.0", "skyvern-2.0", "openai-cua", "anthropic-cua", "ui-tars", "yutori-navigator"], typing.Any
+ typing.Literal["skyvern-1.0", "skyvern-2.0", "openai-cua", "anthropic-cua", "ui-tars", "yutori-navigator"],
+ typing.Any,
]
diff --git a/skyvern/client/types/run_webhook_replay_response.py b/skyvern/client/types/run_webhook_replay_response.py
new file mode 100644
index 000000000..3bb0083d2
--- /dev/null
+++ b/skyvern/client/types/run_webhook_replay_response.py
@@ -0,0 +1,67 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class RunWebhookReplayResponse(UniversalBaseModel):
+ run_id: str = pydantic.Field()
+ """
+ Identifier of the run that was replayed
+ """
+
+ run_type: str = pydantic.Field()
+ """
+ Run type associated with the payload
+ """
+
+ default_webhook_url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Webhook URL stored on the original run configuration
+ """
+
+ target_webhook_url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Webhook URL that the replay attempted to reach
+ """
+
+ payload: str = pydantic.Field()
+ """
+ JSON payload that was delivered during the replay attempt
+ """
+
+ headers: typing.Dict[str, str] = pydantic.Field()
+ """
+ Signed headers that were generated for the replay attempt
+ """
+
+ status_code: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ HTTP status code returned by the webhook receiver, if available
+ """
+
+ latency_ms: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ Round-trip latency in milliseconds for the replay attempt
+ """
+
+ response_body: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Body returned by the webhook receiver (truncated to 2KB)
+ """
+
+ error: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Error message if the replay attempt failed
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/skyvern/client/types/send_email_block.py b/skyvern/client/types/send_email_block.py
index 02253f692..389fae4c6 100644
--- a/skyvern/client/types/send_email_block.py
+++ b/skyvern/client/types/send_email_block.py
@@ -23,6 +23,7 @@ class SendEmailBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
smtp_host: AwsSecretParameter
smtp_port: AwsSecretParameter
diff --git a/skyvern/client/types/send_email_block_yaml.py b/skyvern/client/types/send_email_block_yaml.py
index 3ade6fdf3..be1b4dd36 100644
--- a/skyvern/client/types/send_email_block_yaml.py
+++ b/skyvern/client/types/send_email_block_yaml.py
@@ -19,6 +19,7 @@ class SendEmailBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
smtp_host_secret_parameter_key: str
smtp_port_secret_parameter_key: str
diff --git a/skyvern/client/types/skyvern_schemas_run_blocks_credential_type.py b/skyvern/client/types/skyvern_schemas_credential_type_credential_type.py
similarity index 73%
rename from skyvern/client/types/skyvern_schemas_run_blocks_credential_type.py
rename to skyvern/client/types/skyvern_schemas_credential_type_credential_type.py
index e153f92ec..4341fec22 100644
--- a/skyvern/client/types/skyvern_schemas_run_blocks_credential_type.py
+++ b/skyvern/client/types/skyvern_schemas_credential_type_credential_type.py
@@ -2,6 +2,6 @@
import typing
-SkyvernSchemasRunBlocksCredentialType = typing.Union[
+SkyvernSchemasCredentialTypeCredentialType = typing.Union[
typing.Literal["skyvern", "bitwarden", "1password", "azure_vault"], typing.Any
]
diff --git a/skyvern/client/types/task_block.py b/skyvern/client/types/task_block.py
index afeb98698..39c3db001 100644
--- a/skyvern/client/types/task_block.py
+++ b/skyvern/client/types/task_block.py
@@ -27,6 +27,7 @@ class TaskBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -48,6 +49,7 @@ class TaskBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/task_block_yaml.py b/skyvern/client/types/task_block_yaml.py
index f55bd08ee..0a1d42bdc 100644
--- a/skyvern/client/types/task_block_yaml.py
+++ b/skyvern/client/types/task_block_yaml.py
@@ -21,6 +21,7 @@ class TaskBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
diff --git a/skyvern/client/types/task_run_list_item.py b/skyvern/client/types/task_run_list_item.py
index f5b629da2..f816909de 100644
--- a/skyvern/client/types/task_run_list_item.py
+++ b/skyvern/client/types/task_run_list_item.py
@@ -21,7 +21,7 @@ class TaskRunListItem(UniversalBaseModel):
finished_at: typing.Optional[dt.datetime] = None
created_at: dt.datetime
workflow_permanent_id: typing.Optional[str] = None
- workflow_deleted: bool = False
+ workflow_deleted: typing.Optional[bool] = None
script_run: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
diff --git a/skyvern/client/types/task_run_request_input_data_extraction_schema.py b/skyvern/client/types/task_run_request_input_data_extraction_schema.py
new file mode 100644
index 000000000..d41ea0abd
--- /dev/null
+++ b/skyvern/client/types/task_run_request_input_data_extraction_schema.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TaskRunRequestInputDataExtractionSchema = typing.Union[
+ typing.Dict[str, typing.Optional[typing.Any]], typing.List[typing.Optional[typing.Any]], str
+]
diff --git a/skyvern/client/types/workflow_run_request_proxy_location.py b/skyvern/client/types/task_run_request_input_proxy_location.py
similarity index 56%
rename from skyvern/client/types/workflow_run_request_proxy_location.py
rename to skyvern/client/types/task_run_request_input_proxy_location.py
index b1218e399..a20845410 100644
--- a/skyvern/client/types/workflow_run_request_proxy_location.py
+++ b/skyvern/client/types/task_run_request_input_proxy_location.py
@@ -5,4 +5,4 @@ import typing
from .geo_target import GeoTarget
from .proxy_location import ProxyLocation
-WorkflowRunRequestProxyLocation = typing.Union[ProxyLocation, GeoTarget, typing.Dict[str, typing.Optional[typing.Any]]]
+TaskRunRequestInputProxyLocation = typing.Union[ProxyLocation, GeoTarget, typing.Dict[str, typing.Optional[typing.Any]]]
diff --git a/skyvern/client/types/task_run_request.py b/skyvern/client/types/task_run_request_output.py
similarity index 84%
rename from skyvern/client/types/task_run_request.py
rename to skyvern/client/types/task_run_request_output.py
index cf280707b..7bb105976 100644
--- a/skyvern/client/types/task_run_request.py
+++ b/skyvern/client/types/task_run_request_output.py
@@ -5,11 +5,11 @@ import typing
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from .run_engine import RunEngine
-from .task_run_request_data_extraction_schema import TaskRunRequestDataExtractionSchema
-from .task_run_request_proxy_location import TaskRunRequestProxyLocation
+from .task_run_request_output_data_extraction_schema import TaskRunRequestOutputDataExtractionSchema
+from .task_run_request_output_proxy_location import TaskRunRequestOutputProxyLocation
-class TaskRunRequest(UniversalBaseModel):
+class TaskRunRequestOutput(UniversalBaseModel):
prompt: str = pydantic.Field()
"""
@@ -33,7 +33,7 @@ class TaskRunRequest(UniversalBaseModel):
The title for the task
"""
- proxy_location: typing.Optional[TaskRunRequestProxyLocation] = pydantic.Field(default=None)
+ proxy_location: typing.Optional[TaskRunRequestOutputProxyLocation] = pydantic.Field(default=None)
"""
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -50,6 +50,7 @@ class TaskRunRequest(UniversalBaseModel):
- 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
@@ -66,10 +67,12 @@ class TaskRunRequest(UniversalBaseModel):
- 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:[email protected]: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"}
"""
- data_extraction_schema: typing.Optional[TaskRunRequestDataExtractionSchema] = pydantic.Field(default=None)
+ data_extraction_schema: typing.Optional[TaskRunRequestOutputDataExtractionSchema] = pydantic.Field(default=None)
"""
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/.
@@ -122,6 +125,11 @@ class TaskRunRequest(UniversalBaseModel):
The extra HTTP headers for the requests in browser.
"""
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None)
+ """
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+ """
+
publish_workflow: typing.Optional[bool] = pydantic.Field(default=None)
"""
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.
diff --git a/skyvern/client/types/task_run_request_output_data_extraction_schema.py b/skyvern/client/types/task_run_request_output_data_extraction_schema.py
new file mode 100644
index 000000000..9e291122b
--- /dev/null
+++ b/skyvern/client/types/task_run_request_output_data_extraction_schema.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TaskRunRequestOutputDataExtractionSchema = typing.Union[
+ typing.Dict[str, typing.Optional[typing.Any]], typing.List[typing.Optional[typing.Any]], str
+]
diff --git a/skyvern/client/types/task_run_request_proxy_location.py b/skyvern/client/types/task_run_request_output_proxy_location.py
similarity index 55%
rename from skyvern/client/types/task_run_request_proxy_location.py
rename to skyvern/client/types/task_run_request_output_proxy_location.py
index 7f67743ae..d1f420057 100644
--- a/skyvern/client/types/task_run_request_proxy_location.py
+++ b/skyvern/client/types/task_run_request_output_proxy_location.py
@@ -5,4 +5,6 @@ import typing
from .geo_target import GeoTarget
from .proxy_location import ProxyLocation
-TaskRunRequestProxyLocation = typing.Union[ProxyLocation, GeoTarget, typing.Dict[str, typing.Optional[typing.Any]]]
+TaskRunRequestOutputProxyLocation = typing.Union[
+ ProxyLocation, GeoTarget, typing.Dict[str, typing.Optional[typing.Any]]
+]
diff --git a/skyvern/client/types/task_run_response.py b/skyvern/client/types/task_run_response.py
index 623125ba4..702bb6c9f 100644
--- a/skyvern/client/types/task_run_response.py
+++ b/skyvern/client/types/task_run_response.py
@@ -8,7 +8,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from .file_info import FileInfo
from .run_status import RunStatus
from .script_run_response import ScriptRunResponse
-from .task_run_request import TaskRunRequest
+from .task_run_request_output import TaskRunRequestOutput
from .task_run_response_output import TaskRunResponseOutput
@@ -38,6 +38,11 @@ class TaskRunResponse(UniversalBaseModel):
URL to the recording of the run
"""
+ recording_archived: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ True when the recording exists but has been archived to cold storage and is not currently accessible.
+ """
+
screenshot_urls: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
"""
List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot.
@@ -108,7 +113,7 @@ class TaskRunResponse(UniversalBaseModel):
Total number of steps executed in this run
"""
- run_request: typing.Optional[TaskRunRequest] = pydantic.Field(default=None)
+ run_request: typing.Optional[TaskRunRequestOutput] = pydantic.Field(default=None)
"""
The original request parameters used to start this task run
"""
diff --git a/skyvern/client/types/task_v2block.py b/skyvern/client/types/task_v2block.py
index fd25ffcbf..68592b304 100644
--- a/skyvern/client/types/task_v2block.py
+++ b/skyvern/client/types/task_v2block.py
@@ -22,6 +22,7 @@ class TaskV2Block(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
prompt: str
url: typing.Optional[str] = None
diff --git a/skyvern/client/types/task_v2block_yaml.py b/skyvern/client/types/task_v2block_yaml.py
index 3536eb193..3a93f1d35 100644
--- a/skyvern/client/types/task_v2block_yaml.py
+++ b/skyvern/client/types/task_v2block_yaml.py
@@ -19,6 +19,7 @@ class TaskV2BlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
prompt: str
url: typing.Optional[str] = None
diff --git a/skyvern/client/types/text_prompt_block.py b/skyvern/client/types/text_prompt_block.py
index 9e54f308e..6101df694 100644
--- a/skyvern/client/types/text_prompt_block.py
+++ b/skyvern/client/types/text_prompt_block.py
@@ -25,6 +25,7 @@ class TextPromptBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
llm_key: typing.Optional[str] = None
prompt: str
diff --git a/skyvern/client/types/text_prompt_block_yaml.py b/skyvern/client/types/text_prompt_block_yaml.py
index 627f85514..eda1414d5 100644
--- a/skyvern/client/types/text_prompt_block_yaml.py
+++ b/skyvern/client/types/text_prompt_block_yaml.py
@@ -19,6 +19,7 @@ class TextPromptBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
llm_key: typing.Optional[str] = None
prompt: str
diff --git a/skyvern/client/types/thought.py b/skyvern/client/types/thought.py
index c632dba88..e5e67b1b3 100644
--- a/skyvern/client/types/thought.py
+++ b/skyvern/client/types/thought.py
@@ -29,6 +29,7 @@ class Thought(UniversalBaseModel):
reasoning_token_count: typing.Optional[int] = None
cached_token_count: typing.Optional[int] = None
thought_cost: typing.Optional[float] = None
+ last_llm_model: typing.Optional[str] = None
created_at: dt.datetime
modified_at: dt.datetime
diff --git a/skyvern/client/types/upload_to_s3block.py b/skyvern/client/types/upload_to_s3block.py
index e7dac9eca..f1c9e2e96 100644
--- a/skyvern/client/types/upload_to_s3block.py
+++ b/skyvern/client/types/upload_to_s3block.py
@@ -22,6 +22,7 @@ class UploadToS3Block(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
path: typing.Optional[str] = None
diff --git a/skyvern/client/types/upload_to_s3block_yaml.py b/skyvern/client/types/upload_to_s3block_yaml.py
index c904e0d44..52ea30e07 100644
--- a/skyvern/client/types/upload_to_s3block_yaml.py
+++ b/skyvern/client/types/upload_to_s3block_yaml.py
@@ -19,6 +19,7 @@ class UploadToS3BlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
path: typing.Optional[str] = None
diff --git a/skyvern/client/types/url_block.py b/skyvern/client/types/url_block.py
index 20166c711..f29461d27 100644
--- a/skyvern/client/types/url_block.py
+++ b/skyvern/client/types/url_block.py
@@ -27,6 +27,7 @@ class UrlBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: str
@@ -48,6 +49,7 @@ class UrlBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/url_block_yaml.py b/skyvern/client/types/url_block_yaml.py
index c4d7e2042..dc3d3d213 100644
--- a/skyvern/client/types/url_block_yaml.py
+++ b/skyvern/client/types/url_block_yaml.py
@@ -19,6 +19,7 @@ class UrlBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
diff --git a/skyvern/client/types/user_defined_error.py b/skyvern/client/types/user_defined_error.py
index 4dcd2e01a..85732e98a 100644
--- a/skyvern/client/types/user_defined_error.py
+++ b/skyvern/client/types/user_defined_error.py
@@ -10,6 +10,7 @@ class UserDefinedError(UniversalBaseModel):
error_code: str
reasoning: str
confidence_float: float
+ error_type: typing.Optional[typing.Literal["USER_DEFINED_ERROR"]] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/validation_block.py b/skyvern/client/types/validation_block.py
index 5d6166633..8b9869c65 100644
--- a/skyvern/client/types/validation_block.py
+++ b/skyvern/client/types/validation_block.py
@@ -27,6 +27,7 @@ class ValidationBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -48,6 +49,7 @@ class ValidationBlock(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/skyvern/client/types/validation_block_yaml.py b/skyvern/client/types/validation_block_yaml.py
index 4bdd9434d..ff9ba78a4 100644
--- a/skyvern/client/types/validation_block_yaml.py
+++ b/skyvern/client/types/validation_block_yaml.py
@@ -19,6 +19,7 @@ class ValidationBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
complete_criterion: typing.Optional[str] = None
terminate_criterion: typing.Optional[str] = None
diff --git a/skyvern/client/types/wait_block.py b/skyvern/client/types/wait_block.py
index 79947b709..fdc10986d 100644
--- a/skyvern/client/types/wait_block.py
+++ b/skyvern/client/types/wait_block.py
@@ -25,6 +25,7 @@ class WaitBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
wait_sec: int
parameters: typing.Optional[typing.List[WaitBlockParametersItem]] = None
diff --git a/skyvern/client/types/wait_block_yaml.py b/skyvern/client/types/wait_block_yaml.py
index a5354594a..299776248 100644
--- a/skyvern/client/types/wait_block_yaml.py
+++ b/skyvern/client/types/wait_block_yaml.py
@@ -19,6 +19,7 @@ class WaitBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
wait_sec: typing.Optional[int] = None
diff --git a/skyvern/client/types/while_loop_block.py b/skyvern/client/types/while_loop_block.py
index af4f30334..597f51bf9 100644
--- a/skyvern/client/types/while_loop_block.py
+++ b/skyvern/client/types/while_loop_block.py
@@ -11,6 +11,17 @@ from .while_loop_block_condition import WhileLoopBlockCondition
class WhileLoopBlock(UniversalBaseModel):
+ """
+ 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.
+ """
+
label: str = pydantic.Field()
"""
Author-facing identifier for a block; unique within a workflow.
@@ -25,6 +36,7 @@ class WhileLoopBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
loop_blocks: typing.List["WhileLoopBlockLoopBlocksItem"]
condition: WhileLoopBlockCondition
@@ -40,6 +52,13 @@ class WhileLoopBlock(UniversalBaseModel):
from .context_parameter import ContextParameter # noqa: E402, F401, I001
-from .while_loop_block_loop_blocks_item import WhileLoopBlockLoopBlocksItem # noqa: E402, F401, I001
+
+# Manual patch: Fern v4.31.1 emits bottom-cross-imports that deadlock at module
+# load. See for_loop_block.py for the explanation.
+try:
+ from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
+ from .while_loop_block_loop_blocks_item import WhileLoopBlockLoopBlocksItem # noqa: E402, F401, I001
+except ImportError:
+ pass
update_forward_refs(WhileLoopBlock)
diff --git a/skyvern/client/types/while_loop_block_loop_blocks_item.py b/skyvern/client/types/while_loop_block_loop_blocks_item.py
index fd62a87e0..59d2a0672 100644
--- a/skyvern/client/types/while_loop_block_loop_blocks_item.py
+++ b/skyvern/client/types/while_loop_block_loop_blocks_item.py
@@ -21,6 +21,9 @@ from .file_storage_type import FileStorageType
from .file_type import FileType
from .for_loop_block_data_schema import ForLoopBlockDataSchema
from .for_loop_block_loop_over import ForLoopBlockLoopOver
+from .google_sheets_read_block_parameters_item import GoogleSheetsReadBlockParametersItem
+from .google_sheets_write_block_parameters_item import GoogleSheetsWriteBlockParametersItem
+from .google_sheets_write_block_write_mode import GoogleSheetsWriteBlockWriteMode
from .http_request_block_parameters_item import HttpRequestBlockParametersItem
from .human_interaction_block_data_schema import HumanInteractionBlockDataSchema
from .human_interaction_block_parameters_item import HumanInteractionBlockParametersItem
@@ -51,6 +54,7 @@ class WhileLoopBlockLoopBlocksItem_Action(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -72,6 +76,7 @@ class WhileLoopBlockLoopBlocksItem_Action(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -91,6 +96,7 @@ class WhileLoopBlockLoopBlocksItem_Code(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
code: str
parameters: typing.Optional[typing.List[CodeBlockParametersItem]] = None
@@ -113,6 +119,7 @@ class WhileLoopBlockLoopBlocksItem_Conditional(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
branch_conditions: typing.Optional[typing.List[BranchCondition]] = None
@@ -134,6 +141,7 @@ class WhileLoopBlockLoopBlocksItem_DownloadToS3(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -155,6 +163,7 @@ class WhileLoopBlockLoopBlocksItem_Extraction(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -176,6 +185,7 @@ class WhileLoopBlockLoopBlocksItem_Extraction(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -195,6 +205,7 @@ class WhileLoopBlockLoopBlocksItem_FileDownload(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -216,6 +227,7 @@ class WhileLoopBlockLoopBlocksItem_FileDownload(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -235,6 +247,7 @@ class WhileLoopBlockLoopBlocksItem_FileUpload(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
storage_type: typing.Optional[FileStorageType] = None
s3bucket: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_bucket")] = None
@@ -264,6 +277,7 @@ class WhileLoopBlockLoopBlocksItem_FileUrlParser(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
file_type: typing.Optional[FileType] = None
@@ -287,8 +301,9 @@ class WhileLoopBlockLoopBlocksItem_ForLoop(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- loop_blocks: typing.List["WhileLoopBlockLoopBlocksItem"]
+ loop_blocks: typing.List["ForLoopBlockLoopBlocksItem"]
loop_over: typing.Optional[ForLoopBlockLoopOver] = None
loop_variable_reference: typing.Optional[str] = None
complete_if_empty: typing.Optional[bool] = None
@@ -304,7 +319,61 @@ class WhileLoopBlockLoopBlocksItem_ForLoop(UniversalBaseModel):
extra = pydantic.Extra.allow
-from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
+class WhileLoopBlockLoopBlocksItem_GoogleSheetsRead(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_read"] = "google_sheets_read"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ output_parameter: OutputParameter
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ has_header_row: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[GoogleSheetsReadBlockParametersItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_write"] = "google_sheets_write"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ output_parameter: OutputParameter
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ write_mode: typing.Optional[GoogleSheetsWriteBlockWriteMode] = None
+ values: typing.Optional[str] = None
+ column_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ create_sheet_if_missing: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[GoogleSheetsWriteBlockParametersItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
class WhileLoopBlockLoopBlocksItem_GotoUrl(UniversalBaseModel):
@@ -315,6 +384,7 @@ class WhileLoopBlockLoopBlocksItem_GotoUrl(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: str
@@ -336,6 +406,7 @@ class WhileLoopBlockLoopBlocksItem_GotoUrl(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -355,6 +426,7 @@ class WhileLoopBlockLoopBlocksItem_HttpRequest(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
method: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -385,6 +457,7 @@ class WhileLoopBlockLoopBlocksItem_HumanInteraction(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -406,6 +479,7 @@ class WhileLoopBlockLoopBlocksItem_HumanInteraction(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
instructions: typing.Optional[str] = None
positive_descriptor: typing.Optional[str] = None
negative_descriptor: typing.Optional[str] = None
@@ -433,6 +507,7 @@ class WhileLoopBlockLoopBlocksItem_Login(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -454,6 +529,7 @@ class WhileLoopBlockLoopBlocksItem_Login(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -473,6 +549,7 @@ class WhileLoopBlockLoopBlocksItem_Navigation(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -494,6 +571,7 @@ class WhileLoopBlockLoopBlocksItem_Navigation(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -513,6 +591,7 @@ class WhileLoopBlockLoopBlocksItem_PdfParser(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -535,6 +614,7 @@ class WhileLoopBlockLoopBlocksItem_PrintPage(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
include_timestamp: typing.Optional[bool] = None
custom_filename: typing.Optional[str] = None
@@ -561,6 +641,7 @@ class WhileLoopBlockLoopBlocksItem_SendEmail(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
smtp_host: AwsSecretParameter
smtp_port: AwsSecretParameter
@@ -590,6 +671,7 @@ class WhileLoopBlockLoopBlocksItem_Task(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -611,6 +693,7 @@ class WhileLoopBlockLoopBlocksItem_Task(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -630,6 +713,7 @@ class WhileLoopBlockLoopBlocksItem_TaskV2(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
prompt: str
url: typing.Optional[str] = None
@@ -656,6 +740,7 @@ class WhileLoopBlockLoopBlocksItem_TextPrompt(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
llm_key: typing.Optional[str] = None
prompt: str
@@ -680,6 +765,7 @@ class WhileLoopBlockLoopBlocksItem_UploadToS3(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
path: typing.Optional[str] = None
@@ -701,6 +787,7 @@ class WhileLoopBlockLoopBlocksItem_Validation(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -722,6 +809,7 @@ class WhileLoopBlockLoopBlocksItem_Validation(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -741,6 +829,7 @@ class WhileLoopBlockLoopBlocksItem_Wait(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
wait_sec: int
parameters: typing.Optional[typing.List[WaitBlockParametersItem]] = None
@@ -755,21 +844,18 @@ class WhileLoopBlockLoopBlocksItem_Wait(UniversalBaseModel):
extra = pydantic.Extra.allow
-class WhileLoopBlockLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
- block_type: typing.Literal["workflow_trigger"] = "workflow_trigger"
+class WhileLoopBlockLoopBlocksItem_WhileLoop(UniversalBaseModel):
+ block_type: typing.Literal["while_loop"] = "while_loop"
label: str
next_block_label: typing.Optional[str] = None
output_parameter: OutputParameter
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- workflow_permanent_id: str
- payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
- wait_for_completion: typing.Optional[bool] = None
- browser_session_id: typing.Optional[str] = None
- use_parent_browser_session: typing.Optional[bool] = None
- parameters: typing.Optional[typing.List[WorkflowTriggerBlockParametersItem]] = None
+ loop_blocks: typing.List["WhileLoopBlockLoopBlocksItem"]
+ condition: WhileLoopBlockCondition
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -781,17 +867,26 @@ class WhileLoopBlockLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
extra = pydantic.Extra.allow
-class WhileLoopBlockLoopBlocksItem_WhileLoop(UniversalBaseModel):
- block_type: typing.Literal["while_loop"] = "while_loop"
+from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
+from .while_loop_block import WhileLoopBlock # noqa: E402, F401, I001
+
+
+class WhileLoopBlockLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
+ block_type: typing.Literal["workflow_trigger"] = "workflow_trigger"
label: str
next_block_label: typing.Optional[str] = None
output_parameter: OutputParameter
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- loop_blocks: typing.List["WhileLoopBlockLoopBlocksItem"]
- condition: WhileLoopBlockCondition
+ workflow_permanent_id: str
+ payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ wait_for_completion: typing.Optional[bool] = None
+ browser_session_id: typing.Optional[str] = None
+ use_parent_browser_session: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[WorkflowTriggerBlockParametersItem]] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -815,6 +910,8 @@ WhileLoopBlockLoopBlocksItem = typing.Union[
WhileLoopBlockLoopBlocksItem_FileUpload,
WhileLoopBlockLoopBlocksItem_FileUrlParser,
WhileLoopBlockLoopBlocksItem_ForLoop,
+ WhileLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite,
WhileLoopBlockLoopBlocksItem_GotoUrl,
WhileLoopBlockLoopBlocksItem_HttpRequest,
WhileLoopBlockLoopBlocksItem_HumanInteraction,
@@ -832,20 +929,64 @@ WhileLoopBlockLoopBlocksItem = typing.Union[
WhileLoopBlockLoopBlocksItem_WhileLoop,
WhileLoopBlockLoopBlocksItem_WorkflowTrigger,
]
-update_forward_refs(WhileLoopBlockLoopBlocksItem_Action)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_Code)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_Extraction)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_FileDownload)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_ForLoop)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_GotoUrl)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_HttpRequest)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_HumanInteraction)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_Login)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_Navigation)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_PrintPage)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_Task)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_TextPrompt)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_Validation)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_Wait)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_WhileLoop)
-update_forward_refs(WhileLoopBlockLoopBlocksItem_WorkflowTrigger)
+# Manual patch: see for_loop_block.py header note.
+try:
+ from .for_loop_block_loop_blocks_item import ForLoopBlockLoopBlocksItem # noqa: E402, F401, I001
+except ImportError:
+ pass
+else:
+ for _cls in (
+ WhileLoopBlockLoopBlocksItem_Action,
+ WhileLoopBlockLoopBlocksItem_Code,
+ WhileLoopBlockLoopBlocksItem_Extraction,
+ WhileLoopBlockLoopBlocksItem_FileDownload,
+ WhileLoopBlockLoopBlocksItem_ForLoop,
+ WhileLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ WhileLoopBlockLoopBlocksItem_GoogleSheetsWrite,
+ WhileLoopBlockLoopBlocksItem_GotoUrl,
+ WhileLoopBlockLoopBlocksItem_HttpRequest,
+ WhileLoopBlockLoopBlocksItem_HumanInteraction,
+ WhileLoopBlockLoopBlocksItem_Login,
+ WhileLoopBlockLoopBlocksItem_Navigation,
+ WhileLoopBlockLoopBlocksItem_PrintPage,
+ WhileLoopBlockLoopBlocksItem_Task,
+ WhileLoopBlockLoopBlocksItem_TextPrompt,
+ WhileLoopBlockLoopBlocksItem_Validation,
+ WhileLoopBlockLoopBlocksItem_Wait,
+ WhileLoopBlockLoopBlocksItem_WhileLoop,
+ WhileLoopBlockLoopBlocksItem_WorkflowTrigger,
+ ):
+ update_forward_refs(_cls)
+ # Back-resolve everything that couldn't resolve mid-chain.
+ from . import for_loop_block_loop_blocks_item as _fllb
+ _fllb.WhileLoopBlockLoopBlocksItem = WhileLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ for _cls in (
+ _fllb.ForLoopBlockLoopBlocksItem_Action,
+ _fllb.ForLoopBlockLoopBlocksItem_Code,
+ _fllb.ForLoopBlockLoopBlocksItem_Extraction,
+ _fllb.ForLoopBlockLoopBlocksItem_FileDownload,
+ _fllb.ForLoopBlockLoopBlocksItem_ForLoop,
+ _fllb.ForLoopBlockLoopBlocksItem_GoogleSheetsRead,
+ _fllb.ForLoopBlockLoopBlocksItem_GoogleSheetsWrite,
+ _fllb.ForLoopBlockLoopBlocksItem_GotoUrl,
+ _fllb.ForLoopBlockLoopBlocksItem_HttpRequest,
+ _fllb.ForLoopBlockLoopBlocksItem_HumanInteraction,
+ _fllb.ForLoopBlockLoopBlocksItem_Login,
+ _fllb.ForLoopBlockLoopBlocksItem_Navigation,
+ _fllb.ForLoopBlockLoopBlocksItem_PrintPage,
+ _fllb.ForLoopBlockLoopBlocksItem_Task,
+ _fllb.ForLoopBlockLoopBlocksItem_TextPrompt,
+ _fllb.ForLoopBlockLoopBlocksItem_Validation,
+ _fllb.ForLoopBlockLoopBlocksItem_Wait,
+ _fllb.ForLoopBlockLoopBlocksItem_WhileLoop,
+ _fllb.ForLoopBlockLoopBlocksItem_WorkflowTrigger,
+ ):
+ update_forward_refs(_cls)
+ from . import for_loop_block as _flb
+ _flb.ForLoopBlockLoopBlocksItem = ForLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ _flb.WhileLoopBlockLoopBlocksItem = WhileLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_flb.ForLoopBlock)
+ from . import while_loop_block as _wlb
+ _wlb.ForLoopBlockLoopBlocksItem = ForLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ _wlb.WhileLoopBlockLoopBlocksItem = WhileLoopBlockLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_wlb.WhileLoopBlock)
diff --git a/skyvern/client/types/while_loop_block_yaml.py b/skyvern/client/types/while_loop_block_yaml.py
index 76fcb45ee..a58e8eeab 100644
--- a/skyvern/client/types/while_loop_block_yaml.py
+++ b/skyvern/client/types/while_loop_block_yaml.py
@@ -22,6 +22,7 @@ class WhileLoopBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
loop_blocks: typing.List["WhileLoopBlockYamlLoopBlocksItem"]
condition: BranchCriteriaYaml
@@ -36,6 +37,12 @@ class WhileLoopBlockYaml(UniversalBaseModel):
extra = pydantic.Extra.allow
-from .while_loop_block_yaml_loop_blocks_item import WhileLoopBlockYamlLoopBlocksItem # noqa: E402, F401, I001
+# Manual patch: Fern v4.31.1 emits bottom-cross-imports that deadlock at module
+# load. See for_loop_block.py for the explanation.
+try:
+ from .for_loop_block_yaml import ForLoopBlockYaml # noqa: E402, F401, I001
+ from .while_loop_block_yaml_loop_blocks_item import WhileLoopBlockYamlLoopBlocksItem # noqa: E402, F401, I001
+except ImportError:
+ pass
update_forward_refs(WhileLoopBlockYaml)
diff --git a/skyvern/client/types/while_loop_block_yaml_loop_blocks_item.py b/skyvern/client/types/while_loop_block_yaml_loop_blocks_item.py
index c604507f9..0c4480b18 100644
--- a/skyvern/client/types/while_loop_block_yaml_loop_blocks_item.py
+++ b/skyvern/client/types/while_loop_block_yaml_loop_blocks_item.py
@@ -14,6 +14,7 @@ from .extraction_block_yaml_data_schema import ExtractionBlockYamlDataSchema
from .file_storage_type import FileStorageType
from .file_type import FileType
from .for_loop_block_yaml_data_schema import ForLoopBlockYamlDataSchema
+from .google_sheets_write_block_yaml_write_mode import GoogleSheetsWriteBlockYamlWriteMode
from .pdf_format import PdfFormat
from .run_engine import RunEngine
from .task_block_yaml_data_schema import TaskBlockYamlDataSchema
@@ -25,6 +26,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Task(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -62,8 +64,9 @@ class WhileLoopBlockYamlLoopBlocksItem_ForLoop(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- loop_blocks: typing.List["WhileLoopBlockYamlLoopBlocksItem"]
+ loop_blocks: typing.List["ForLoopBlockYamlLoopBlocksItem"]
loop_over_parameter_key: typing.Optional[str] = None
loop_variable_reference: typing.Optional[str] = None
complete_if_empty: typing.Optional[bool] = None
@@ -79,7 +82,29 @@ class WhileLoopBlockYamlLoopBlocksItem_ForLoop(UniversalBaseModel):
extra = pydantic.Extra.allow
+class WhileLoopBlockYamlLoopBlocksItem_WhileLoop(UniversalBaseModel):
+ block_type: typing.Literal["while_loop"] = "while_loop"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ loop_blocks: typing.List["WhileLoopBlockYamlLoopBlocksItem"]
+ condition: BranchCriteriaYaml
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
from .for_loop_block_yaml import ForLoopBlockYaml # noqa: E402, F401, I001
+from .while_loop_block_yaml import WhileLoopBlockYaml # noqa: E402, F401, I001
class WhileLoopBlockYamlLoopBlocksItem_Code(UniversalBaseModel):
@@ -88,6 +113,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Code(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
code: str
parameter_keys: typing.Optional[typing.List[str]] = None
@@ -108,6 +134,7 @@ class WhileLoopBlockYamlLoopBlocksItem_TextPrompt(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
llm_key: typing.Optional[str] = None
prompt: str
@@ -130,6 +157,7 @@ class WhileLoopBlockYamlLoopBlocksItem_DownloadToS3(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -149,6 +177,7 @@ class WhileLoopBlockYamlLoopBlocksItem_UploadToS3(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
path: typing.Optional[str] = None
@@ -168,6 +197,7 @@ class WhileLoopBlockYamlLoopBlocksItem_FileUpload(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
storage_type: typing.Optional[FileStorageType] = None
s3bucket: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_bucket")] = None
@@ -196,6 +226,7 @@ class WhileLoopBlockYamlLoopBlocksItem_SendEmail(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
smtp_host_secret_parameter_key: str
smtp_port_secret_parameter_key: str
@@ -223,6 +254,7 @@ class WhileLoopBlockYamlLoopBlocksItem_FileUrlParser(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
file_type: typing.Optional[FileType] = None
@@ -244,6 +276,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Validation(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
complete_criterion: typing.Optional[str] = None
terminate_criterion: typing.Optional[str] = None
@@ -267,6 +300,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Action(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -297,6 +331,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Navigation(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
navigation_goal: str
url: typing.Optional[str] = None
@@ -332,6 +367,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Extraction(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
data_extraction_goal: str
url: typing.Optional[str] = None
@@ -359,6 +395,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Login(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -391,6 +428,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Wait(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
wait_sec: typing.Optional[int] = None
@@ -410,6 +448,7 @@ class WhileLoopBlockYamlLoopBlocksItem_HumanInteraction(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
instructions: typing.Optional[str] = None
positive_descriptor: typing.Optional[str] = None
@@ -436,6 +475,7 @@ class WhileLoopBlockYamlLoopBlocksItem_FileDownload(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
navigation_goal: str
url: typing.Optional[str] = None
@@ -467,6 +507,7 @@ class WhileLoopBlockYamlLoopBlocksItem_GotoUrl(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -486,6 +527,7 @@ class WhileLoopBlockYamlLoopBlocksItem_PdfParser(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -506,6 +548,7 @@ class WhileLoopBlockYamlLoopBlocksItem_TaskV2(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
prompt: str
url: typing.Optional[str] = None
@@ -531,6 +574,7 @@ class WhileLoopBlockYamlLoopBlocksItem_HttpRequest(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
method: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -559,6 +603,7 @@ class WhileLoopBlockYamlLoopBlocksItem_Conditional(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
branch_conditions: typing.Optional[typing.List[BranchConditionYaml]] = None
@@ -578,6 +623,7 @@ class WhileLoopBlockYamlLoopBlocksItem_PrintPage(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
include_timestamp: typing.Optional[bool] = None
custom_filename: typing.Optional[str] = None
@@ -602,6 +648,7 @@ class WhileLoopBlockYamlLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
workflow_permanent_id: str
payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -620,15 +667,48 @@ class WhileLoopBlockYamlLoopBlocksItem_WorkflowTrigger(UniversalBaseModel):
extra = pydantic.Extra.allow
-class WhileLoopBlockYamlLoopBlocksItem_WhileLoop(UniversalBaseModel):
- block_type: typing.Literal["while_loop"] = "while_loop"
+class WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsRead(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_read"] = "google_sheets_read"
label: str
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- loop_blocks: typing.List["WhileLoopBlockYamlLoopBlocksItem"]
- condition: BranchCriteriaYaml
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ has_header_row: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_write"] = "google_sheets_write"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ write_mode: typing.Optional[GoogleSheetsWriteBlockYamlWriteMode] = None
+ values: typing.Optional[str] = None
+ column_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ create_sheet_if_missing: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -643,6 +723,7 @@ class WhileLoopBlockYamlLoopBlocksItem_WhileLoop(UniversalBaseModel):
WhileLoopBlockYamlLoopBlocksItem = typing.Union[
WhileLoopBlockYamlLoopBlocksItem_Task,
WhileLoopBlockYamlLoopBlocksItem_ForLoop,
+ WhileLoopBlockYamlLoopBlocksItem_WhileLoop,
WhileLoopBlockYamlLoopBlocksItem_Code,
WhileLoopBlockYamlLoopBlocksItem_TextPrompt,
WhileLoopBlockYamlLoopBlocksItem_DownloadToS3,
@@ -664,8 +745,27 @@ WhileLoopBlockYamlLoopBlocksItem = typing.Union[
WhileLoopBlockYamlLoopBlocksItem_HttpRequest,
WhileLoopBlockYamlLoopBlocksItem_Conditional,
WhileLoopBlockYamlLoopBlocksItem_PrintPage,
- WhileLoopBlockYamlLoopBlocksItem_WhileLoop,
WhileLoopBlockYamlLoopBlocksItem_WorkflowTrigger,
+ WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsRead,
+ WhileLoopBlockYamlLoopBlocksItem_GoogleSheetsWrite,
]
-update_forward_refs(WhileLoopBlockYamlLoopBlocksItem_ForLoop)
-update_forward_refs(WhileLoopBlockYamlLoopBlocksItem_WhileLoop)
+# Manual patch: see for_loop_block.py header note.
+try:
+ from .for_loop_block_yaml_loop_blocks_item import ForLoopBlockYamlLoopBlocksItem # noqa: E402, F401, I001
+except ImportError:
+ pass
+else:
+ update_forward_refs(WhileLoopBlockYamlLoopBlocksItem_ForLoop)
+ update_forward_refs(WhileLoopBlockYamlLoopBlocksItem_WhileLoop)
+ from . import for_loop_block_yaml_loop_blocks_item as _flylb
+ _flylb.WhileLoopBlockYamlLoopBlocksItem = WhileLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_flylb.ForLoopBlockYamlLoopBlocksItem_ForLoop)
+ update_forward_refs(_flylb.ForLoopBlockYamlLoopBlocksItem_WhileLoop)
+ from . import for_loop_block_yaml as _flby
+ _flby.ForLoopBlockYamlLoopBlocksItem = ForLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ _flby.WhileLoopBlockYamlLoopBlocksItem = WhileLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_flby.ForLoopBlockYaml)
+ from . import while_loop_block_yaml as _wlby
+ _wlby.ForLoopBlockYamlLoopBlocksItem = ForLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ _wlby.WhileLoopBlockYamlLoopBlocksItem = WhileLoopBlockYamlLoopBlocksItem # type: ignore[attr-defined]
+ update_forward_refs(_wlby.WhileLoopBlockYaml)
diff --git a/skyvern/client/types/workflow.py b/skyvern/client/types/workflow.py
index 9b4af933e..99bec408d 100644
--- a/skyvern/client/types/workflow.py
+++ b/skyvern/client/types/workflow.py
@@ -27,10 +27,13 @@ class Workflow(UniversalBaseModel):
totp_verification_url: typing.Optional[str] = None
totp_identifier: typing.Optional[str] = None
persist_browser_session: typing.Optional[bool] = None
+ browser_profile_id: typing.Optional[str] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
status: typing.Optional[WorkflowStatus] = None
max_screenshot_scrolls: typing.Optional[int] = None
+ max_elapsed_time_minutes: typing.Optional[int] = None
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
run_with: typing.Optional[str] = None
ai_fallback: typing.Optional[bool] = None
cache_key: typing.Optional[str] = None
@@ -41,6 +44,8 @@ class Workflow(UniversalBaseModel):
sequential_key: typing.Optional[str] = None
folder_id: typing.Optional[str] = None
import_error: typing.Optional[str] = None
+ created_by: typing.Optional[str] = None
+ edited_by: typing.Optional[str] = None
created_at: dt.datetime
modified_at: dt.datetime
deleted_at: typing.Optional[dt.datetime] = None
@@ -57,5 +62,6 @@ class Workflow(UniversalBaseModel):
from .context_parameter import ContextParameter # noqa: E402, F401, I001
from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
+from .while_loop_block import WhileLoopBlock # noqa: E402, F401, I001
update_forward_refs(Workflow)
diff --git a/skyvern/client/types/workflow_create_yaml_request.py b/skyvern/client/types/workflow_create_yaml_request.py
index e30c75e13..d97f912a1 100644
--- a/skyvern/client/types/workflow_create_yaml_request.py
+++ b/skyvern/client/types/workflow_create_yaml_request.py
@@ -19,11 +19,14 @@ class WorkflowCreateYamlRequest(UniversalBaseModel):
totp_verification_url: typing.Optional[str] = None
totp_identifier: typing.Optional[str] = None
persist_browser_session: typing.Optional[bool] = None
+ browser_profile_id: typing.Optional[str] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
workflow_definition: WorkflowDefinitionYaml
is_saved_task: typing.Optional[bool] = None
max_screenshot_scrolls: typing.Optional[int] = None
+ max_elapsed_time_minutes: typing.Optional[int] = None
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
status: typing.Optional[WorkflowStatus] = None
run_with: typing.Optional[str] = None
ai_fallback: typing.Optional[bool] = None
@@ -46,5 +49,6 @@ class WorkflowCreateYamlRequest(UniversalBaseModel):
from .for_loop_block_yaml import ForLoopBlockYaml # noqa: E402, F401, I001
+from .while_loop_block_yaml import WhileLoopBlockYaml # noqa: E402, F401, I001
update_forward_refs(WorkflowCreateYamlRequest)
diff --git a/skyvern/client/types/workflow_definition.py b/skyvern/client/types/workflow_definition.py
index 55d611f8e..72c4bdde4 100644
--- a/skyvern/client/types/workflow_definition.py
+++ b/skyvern/client/types/workflow_definition.py
@@ -15,6 +15,8 @@ class WorkflowDefinition(UniversalBaseModel):
parameters: typing.List[WorkflowDefinitionParametersItem]
blocks: typing.List[WorkflowDefinitionBlocksItem]
finally_block_label: typing.Optional[str] = None
+ error_code_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ workflow_system_prompt: typing.Optional[str] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -28,5 +30,6 @@ class WorkflowDefinition(UniversalBaseModel):
from .context_parameter import ContextParameter # noqa: E402, F401, I001
from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
+from .while_loop_block import WhileLoopBlock # noqa: E402, F401, I001
update_forward_refs(WorkflowDefinition)
diff --git a/skyvern/client/types/workflow_definition_blocks_item.py b/skyvern/client/types/workflow_definition_blocks_item.py
index b7f8a85b0..f36781f02 100644
--- a/skyvern/client/types/workflow_definition_blocks_item.py
+++ b/skyvern/client/types/workflow_definition_blocks_item.py
@@ -21,6 +21,9 @@ from .file_storage_type import FileStorageType
from .file_type import FileType
from .for_loop_block_data_schema import ForLoopBlockDataSchema
from .for_loop_block_loop_over import ForLoopBlockLoopOver
+from .google_sheets_read_block_parameters_item import GoogleSheetsReadBlockParametersItem
+from .google_sheets_write_block_parameters_item import GoogleSheetsWriteBlockParametersItem
+from .google_sheets_write_block_write_mode import GoogleSheetsWriteBlockWriteMode
from .http_request_block_parameters_item import HttpRequestBlockParametersItem
from .human_interaction_block_data_schema import HumanInteractionBlockDataSchema
from .human_interaction_block_parameters_item import HumanInteractionBlockParametersItem
@@ -51,6 +54,7 @@ class WorkflowDefinitionBlocksItem_Action(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -72,6 +76,7 @@ class WorkflowDefinitionBlocksItem_Action(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -91,6 +96,7 @@ class WorkflowDefinitionBlocksItem_Code(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
code: str
parameters: typing.Optional[typing.List[CodeBlockParametersItem]] = None
@@ -113,6 +119,7 @@ class WorkflowDefinitionBlocksItem_Conditional(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
branch_conditions: typing.Optional[typing.List[BranchCondition]] = None
@@ -134,6 +141,7 @@ class WorkflowDefinitionBlocksItem_DownloadToS3(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -155,6 +163,7 @@ class WorkflowDefinitionBlocksItem_Extraction(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -176,6 +185,7 @@ class WorkflowDefinitionBlocksItem_Extraction(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -195,6 +205,7 @@ class WorkflowDefinitionBlocksItem_FileDownload(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -216,6 +227,7 @@ class WorkflowDefinitionBlocksItem_FileDownload(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -235,6 +247,7 @@ class WorkflowDefinitionBlocksItem_FileUpload(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
storage_type: typing.Optional[FileStorageType] = None
s3bucket: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_bucket")] = None
@@ -264,6 +277,7 @@ class WorkflowDefinitionBlocksItem_FileUrlParser(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
file_type: typing.Optional[FileType] = None
@@ -287,6 +301,7 @@ class WorkflowDefinitionBlocksItem_ForLoop(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
loop_blocks: typing.List["ForLoopBlockLoopBlocksItem"]
loop_over: typing.Optional[ForLoopBlockLoopOver] = None
@@ -304,10 +319,66 @@ class WorkflowDefinitionBlocksItem_ForLoop(UniversalBaseModel):
extra = pydantic.Extra.allow
-from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
from .for_loop_block_loop_blocks_item import ForLoopBlockLoopBlocksItem # noqa: E402, F401, I001
+class WorkflowDefinitionBlocksItem_GoogleSheetsRead(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_read"] = "google_sheets_read"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ output_parameter: OutputParameter
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ has_header_row: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[GoogleSheetsReadBlockParametersItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class WorkflowDefinitionBlocksItem_GoogleSheetsWrite(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_write"] = "google_sheets_write"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ output_parameter: OutputParameter
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ write_mode: typing.Optional[GoogleSheetsWriteBlockWriteMode] = None
+ values: typing.Optional[str] = None
+ column_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ create_sheet_if_missing: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[GoogleSheetsWriteBlockParametersItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
class WorkflowDefinitionBlocksItem_GotoUrl(UniversalBaseModel):
block_type: typing.Literal["goto_url"] = "goto_url"
label: str
@@ -316,6 +387,7 @@ class WorkflowDefinitionBlocksItem_GotoUrl(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: str
@@ -337,6 +409,7 @@ class WorkflowDefinitionBlocksItem_GotoUrl(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -356,6 +429,7 @@ class WorkflowDefinitionBlocksItem_HttpRequest(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
method: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -386,6 +460,7 @@ class WorkflowDefinitionBlocksItem_HumanInteraction(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -407,6 +482,7 @@ class WorkflowDefinitionBlocksItem_HumanInteraction(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
instructions: typing.Optional[str] = None
positive_descriptor: typing.Optional[str] = None
negative_descriptor: typing.Optional[str] = None
@@ -434,6 +510,7 @@ class WorkflowDefinitionBlocksItem_Login(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -455,6 +532,7 @@ class WorkflowDefinitionBlocksItem_Login(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -474,6 +552,7 @@ class WorkflowDefinitionBlocksItem_Navigation(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -495,6 +574,7 @@ class WorkflowDefinitionBlocksItem_Navigation(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -514,6 +594,7 @@ class WorkflowDefinitionBlocksItem_PdfParser(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -536,6 +617,7 @@ class WorkflowDefinitionBlocksItem_PrintPage(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
include_timestamp: typing.Optional[bool] = None
custom_filename: typing.Optional[str] = None
@@ -562,6 +644,7 @@ class WorkflowDefinitionBlocksItem_SendEmail(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
smtp_host: AwsSecretParameter
smtp_port: AwsSecretParameter
@@ -591,6 +674,7 @@ class WorkflowDefinitionBlocksItem_Task(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -612,6 +696,7 @@ class WorkflowDefinitionBlocksItem_Task(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -631,6 +716,7 @@ class WorkflowDefinitionBlocksItem_TaskV2(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
prompt: str
url: typing.Optional[str] = None
@@ -657,6 +743,7 @@ class WorkflowDefinitionBlocksItem_TextPrompt(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
llm_key: typing.Optional[str] = None
prompt: str
@@ -681,6 +768,7 @@ class WorkflowDefinitionBlocksItem_UploadToS3(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
path: typing.Optional[str] = None
@@ -702,6 +790,7 @@ class WorkflowDefinitionBlocksItem_Validation(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
task_type: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -723,6 +812,7 @@ class WorkflowDefinitionBlocksItem_Validation(UniversalBaseModel):
complete_verification: typing.Optional[bool] = None
include_action_history_in_verification: typing.Optional[bool] = None
download_timeout: typing.Optional[float] = None
+ include_extracted_text: typing.Optional[bool] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -742,6 +832,7 @@ class WorkflowDefinitionBlocksItem_Wait(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
wait_sec: int
parameters: typing.Optional[typing.List[WaitBlockParametersItem]] = None
@@ -756,21 +847,18 @@ class WorkflowDefinitionBlocksItem_Wait(UniversalBaseModel):
extra = pydantic.Extra.allow
-class WorkflowDefinitionBlocksItem_WorkflowTrigger(UniversalBaseModel):
- block_type: typing.Literal["workflow_trigger"] = "workflow_trigger"
+class WorkflowDefinitionBlocksItem_WhileLoop(UniversalBaseModel):
+ block_type: typing.Literal["while_loop"] = "while_loop"
label: str
next_block_label: typing.Optional[str] = None
output_parameter: OutputParameter
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- workflow_permanent_id: str
- payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
- wait_for_completion: typing.Optional[bool] = None
- browser_session_id: typing.Optional[str] = None
- use_parent_browser_session: typing.Optional[bool] = None
- parameters: typing.Optional[typing.List[WorkflowTriggerBlockParametersItem]] = None
+ loop_blocks: typing.List["WhileLoopBlockLoopBlocksItem"]
+ condition: WhileLoopBlockCondition
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -782,17 +870,27 @@ class WorkflowDefinitionBlocksItem_WorkflowTrigger(UniversalBaseModel):
extra = pydantic.Extra.allow
-class WorkflowDefinitionBlocksItem_WhileLoop(UniversalBaseModel):
- block_type: typing.Literal["while_loop"] = "while_loop"
+from .for_loop_block import ForLoopBlock # noqa: E402, F401, I001
+from .while_loop_block import WhileLoopBlock # noqa: E402, F401, I001
+from .while_loop_block_loop_blocks_item import WhileLoopBlockLoopBlocksItem # noqa: E402, F401, I001
+
+
+class WorkflowDefinitionBlocksItem_WorkflowTrigger(UniversalBaseModel):
+ block_type: typing.Literal["workflow_trigger"] = "workflow_trigger"
label: str
next_block_label: typing.Optional[str] = None
output_parameter: OutputParameter
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- loop_blocks: typing.List["WorkflowDefinitionBlocksItem"]
- condition: WhileLoopBlockCondition
+ workflow_permanent_id: str
+ payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ wait_for_completion: typing.Optional[bool] = None
+ browser_session_id: typing.Optional[str] = None
+ use_parent_browser_session: typing.Optional[bool] = None
+ parameters: typing.Optional[typing.List[WorkflowTriggerBlockParametersItem]] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -816,6 +914,8 @@ WorkflowDefinitionBlocksItem = typing.Union[
WorkflowDefinitionBlocksItem_FileUpload,
WorkflowDefinitionBlocksItem_FileUrlParser,
WorkflowDefinitionBlocksItem_ForLoop,
+ WorkflowDefinitionBlocksItem_GoogleSheetsRead,
+ WorkflowDefinitionBlocksItem_GoogleSheetsWrite,
WorkflowDefinitionBlocksItem_GotoUrl,
WorkflowDefinitionBlocksItem_HttpRequest,
WorkflowDefinitionBlocksItem_HumanInteraction,
@@ -838,6 +938,8 @@ update_forward_refs(WorkflowDefinitionBlocksItem_Code)
update_forward_refs(WorkflowDefinitionBlocksItem_Extraction)
update_forward_refs(WorkflowDefinitionBlocksItem_FileDownload)
update_forward_refs(WorkflowDefinitionBlocksItem_ForLoop)
+update_forward_refs(WorkflowDefinitionBlocksItem_GoogleSheetsRead)
+update_forward_refs(WorkflowDefinitionBlocksItem_GoogleSheetsWrite)
update_forward_refs(WorkflowDefinitionBlocksItem_GotoUrl)
update_forward_refs(WorkflowDefinitionBlocksItem_HttpRequest)
update_forward_refs(WorkflowDefinitionBlocksItem_HumanInteraction)
diff --git a/skyvern/client/types/workflow_definition_yaml.py b/skyvern/client/types/workflow_definition_yaml.py
index b59071b12..be5309f08 100644
--- a/skyvern/client/types/workflow_definition_yaml.py
+++ b/skyvern/client/types/workflow_definition_yaml.py
@@ -15,6 +15,8 @@ class WorkflowDefinitionYaml(UniversalBaseModel):
parameters: typing.List[WorkflowDefinitionYamlParametersItem]
blocks: typing.List[WorkflowDefinitionYamlBlocksItem]
finally_block_label: typing.Optional[str] = None
+ error_code_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ workflow_system_prompt: typing.Optional[str] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -27,5 +29,6 @@ class WorkflowDefinitionYaml(UniversalBaseModel):
from .for_loop_block_yaml import ForLoopBlockYaml # noqa: E402, F401, I001
+from .while_loop_block_yaml import WhileLoopBlockYaml # noqa: E402, F401, I001
update_forward_refs(WorkflowDefinitionYaml)
diff --git a/skyvern/client/types/workflow_definition_yaml_blocks_item.py b/skyvern/client/types/workflow_definition_yaml_blocks_item.py
index e43eee71b..5c0b65fd4 100644
--- a/skyvern/client/types/workflow_definition_yaml_blocks_item.py
+++ b/skyvern/client/types/workflow_definition_yaml_blocks_item.py
@@ -14,6 +14,7 @@ from .extraction_block_yaml_data_schema import ExtractionBlockYamlDataSchema
from .file_storage_type import FileStorageType
from .file_type import FileType
from .for_loop_block_yaml_data_schema import ForLoopBlockYamlDataSchema
+from .google_sheets_write_block_yaml_write_mode import GoogleSheetsWriteBlockYamlWriteMode
from .pdf_format import PdfFormat
from .run_engine import RunEngine
from .task_block_yaml_data_schema import TaskBlockYamlDataSchema
@@ -25,6 +26,7 @@ class WorkflowDefinitionYamlBlocksItem_Action(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -55,6 +57,7 @@ class WorkflowDefinitionYamlBlocksItem_Code(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
code: str
parameter_keys: typing.Optional[typing.List[str]] = None
@@ -75,6 +78,7 @@ class WorkflowDefinitionYamlBlocksItem_Conditional(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
branch_conditions: typing.Optional[typing.List[BranchConditionYaml]] = None
@@ -94,6 +98,7 @@ class WorkflowDefinitionYamlBlocksItem_DownloadToS3(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -113,6 +118,7 @@ class WorkflowDefinitionYamlBlocksItem_Extraction(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
data_extraction_goal: str
url: typing.Optional[str] = None
@@ -140,6 +146,7 @@ class WorkflowDefinitionYamlBlocksItem_FileDownload(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
navigation_goal: str
url: typing.Optional[str] = None
@@ -171,6 +178,7 @@ class WorkflowDefinitionYamlBlocksItem_FileUpload(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
storage_type: typing.Optional[FileStorageType] = None
s3bucket: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_bucket")] = None
@@ -199,6 +207,7 @@ class WorkflowDefinitionYamlBlocksItem_FileUrlParser(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
file_type: typing.Optional[FileType] = None
@@ -220,6 +229,7 @@ class WorkflowDefinitionYamlBlocksItem_ForLoop(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
loop_blocks: typing.List["ForLoopBlockYamlLoopBlocksItem"]
loop_over_parameter_key: typing.Optional[str] = None
@@ -237,16 +247,69 @@ class WorkflowDefinitionYamlBlocksItem_ForLoop(UniversalBaseModel):
extra = pydantic.Extra.allow
-from .for_loop_block_yaml import ForLoopBlockYaml # noqa: E402, F401, I001
from .for_loop_block_yaml_loop_blocks_item import ForLoopBlockYamlLoopBlocksItem # noqa: E402, F401, I001
+class WorkflowDefinitionYamlBlocksItem_GoogleSheetsRead(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_read"] = "google_sheets_read"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ has_header_row: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class WorkflowDefinitionYamlBlocksItem_GoogleSheetsWrite(UniversalBaseModel):
+ block_type: typing.Literal["google_sheets_write"] = "google_sheets_write"
+ label: str
+ next_block_label: typing.Optional[str] = None
+ continue_on_failure: typing.Optional[bool] = None
+ model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
+ next_loop_on_failure: typing.Optional[bool] = None
+ spreadsheet_url: str
+ sheet_name: typing.Optional[str] = None
+ range: typing.Optional[str] = None
+ credential_id: typing.Optional[str] = None
+ write_mode: typing.Optional[GoogleSheetsWriteBlockYamlWriteMode] = None
+ values: typing.Optional[str] = None
+ column_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ create_sheet_if_missing: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
class WorkflowDefinitionYamlBlocksItem_GotoUrl(UniversalBaseModel):
block_type: typing.Literal["goto_url"] = "goto_url"
label: str
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: str
@@ -266,6 +329,7 @@ class WorkflowDefinitionYamlBlocksItem_HttpRequest(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
method: typing.Optional[str] = None
url: typing.Optional[str] = None
@@ -294,6 +358,7 @@ class WorkflowDefinitionYamlBlocksItem_HumanInteraction(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
instructions: typing.Optional[str] = None
positive_descriptor: typing.Optional[str] = None
@@ -320,6 +385,7 @@ class WorkflowDefinitionYamlBlocksItem_Login(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -352,6 +418,7 @@ class WorkflowDefinitionYamlBlocksItem_Navigation(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
navigation_goal: str
url: typing.Optional[str] = None
@@ -387,6 +454,7 @@ class WorkflowDefinitionYamlBlocksItem_PdfParser(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
file_url: str
json_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -407,6 +475,7 @@ class WorkflowDefinitionYamlBlocksItem_PrintPage(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
include_timestamp: typing.Optional[bool] = None
custom_filename: typing.Optional[str] = None
@@ -431,6 +500,7 @@ class WorkflowDefinitionYamlBlocksItem_SendEmail(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
smtp_host_secret_parameter_key: str
smtp_port_secret_parameter_key: str
@@ -458,6 +528,7 @@ class WorkflowDefinitionYamlBlocksItem_Task(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
url: typing.Optional[str] = None
title: typing.Optional[str] = None
@@ -495,6 +566,7 @@ class WorkflowDefinitionYamlBlocksItem_TaskV2(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
prompt: str
url: typing.Optional[str] = None
@@ -520,6 +592,7 @@ class WorkflowDefinitionYamlBlocksItem_TextPrompt(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
llm_key: typing.Optional[str] = None
prompt: str
@@ -542,6 +615,7 @@ class WorkflowDefinitionYamlBlocksItem_UploadToS3(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
path: typing.Optional[str] = None
@@ -561,6 +635,7 @@ class WorkflowDefinitionYamlBlocksItem_Validation(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
complete_criterion: typing.Optional[str] = None
terminate_criterion: typing.Optional[str] = None
@@ -584,6 +659,7 @@ class WorkflowDefinitionYamlBlocksItem_Wait(UniversalBaseModel):
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
wait_sec: typing.Optional[int] = None
@@ -597,19 +673,16 @@ class WorkflowDefinitionYamlBlocksItem_Wait(UniversalBaseModel):
extra = pydantic.Extra.allow
-class WorkflowDefinitionYamlBlocksItem_WorkflowTrigger(UniversalBaseModel):
- block_type: typing.Literal["workflow_trigger"] = "workflow_trigger"
+class WorkflowDefinitionYamlBlocksItem_WhileLoop(UniversalBaseModel):
+ block_type: typing.Literal["while_loop"] = "while_loop"
label: str
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- workflow_permanent_id: str
- payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
- wait_for_completion: typing.Optional[bool] = None
- browser_session_id: typing.Optional[str] = None
- use_parent_browser_session: typing.Optional[bool] = None
- parameter_keys: typing.Optional[typing.List[str]] = None
+ loop_blocks: typing.List["WhileLoopBlockYamlLoopBlocksItem"]
+ condition: BranchCriteriaYaml
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -621,15 +694,25 @@ class WorkflowDefinitionYamlBlocksItem_WorkflowTrigger(UniversalBaseModel):
extra = pydantic.Extra.allow
-class WorkflowDefinitionYamlBlocksItem_WhileLoop(UniversalBaseModel):
- block_type: typing.Literal["while_loop"] = "while_loop"
+from .for_loop_block_yaml import ForLoopBlockYaml # noqa: E402, F401, I001
+from .while_loop_block_yaml import WhileLoopBlockYaml # noqa: E402, F401, I001
+from .while_loop_block_yaml_loop_blocks_item import WhileLoopBlockYamlLoopBlocksItem # noqa: E402, F401, I001
+
+
+class WorkflowDefinitionYamlBlocksItem_WorkflowTrigger(UniversalBaseModel):
+ block_type: typing.Literal["workflow_trigger"] = "workflow_trigger"
label: str
next_block_label: typing.Optional[str] = None
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
- loop_blocks: typing.List["WorkflowDefinitionYamlBlocksItem"]
- condition: BranchCriteriaYaml
+ workflow_permanent_id: str
+ payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ wait_for_completion: typing.Optional[bool] = None
+ browser_session_id: typing.Optional[str] = None
+ use_parent_browser_session: typing.Optional[bool] = None
+ parameter_keys: typing.Optional[typing.List[str]] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -651,6 +734,8 @@ WorkflowDefinitionYamlBlocksItem = typing.Union[
WorkflowDefinitionYamlBlocksItem_FileUpload,
WorkflowDefinitionYamlBlocksItem_FileUrlParser,
WorkflowDefinitionYamlBlocksItem_ForLoop,
+ WorkflowDefinitionYamlBlocksItem_GoogleSheetsRead,
+ WorkflowDefinitionYamlBlocksItem_GoogleSheetsWrite,
WorkflowDefinitionYamlBlocksItem_GotoUrl,
WorkflowDefinitionYamlBlocksItem_HttpRequest,
WorkflowDefinitionYamlBlocksItem_HumanInteraction,
diff --git a/skyvern/client/types/workflow_request.py b/skyvern/client/types/workflow_request.py
index bfe77684e..b21566e65 100644
--- a/skyvern/client/types/workflow_request.py
+++ b/skyvern/client/types/workflow_request.py
@@ -31,5 +31,6 @@ class WorkflowRequest(UniversalBaseModel):
from .for_loop_block_yaml import ForLoopBlockYaml # noqa: E402, F401, I001
+from .while_loop_block_yaml import WhileLoopBlockYaml # noqa: E402, F401, I001
update_forward_refs(WorkflowRequest)
diff --git a/skyvern/client/types/workflow_run.py b/skyvern/client/types/workflow_run.py
index c1bb8e7ab..a201c2188 100644
--- a/skyvern/client/types/workflow_run.py
+++ b/skyvern/client/types/workflow_run.py
@@ -21,6 +21,7 @@ class WorkflowRun(UniversalBaseModel):
debug_session_id: typing.Optional[str] = None
status: WorkflowRunStatus
extra_http_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None
proxy_location: typing.Optional[WorkflowRunProxyLocation] = None
webhook_callback_url: typing.Optional[str] = None
webhook_failure_reason: typing.Optional[str] = None
@@ -31,6 +32,7 @@ class WorkflowRun(UniversalBaseModel):
parent_workflow_run_id: typing.Optional[str] = None
workflow_title: typing.Optional[str] = None
max_screenshot_scrolls: typing.Optional[int] = None
+ max_elapsed_time_minutes: typing.Optional[int] = None
browser_address: typing.Optional[str] = None
run_with: typing.Optional[str] = None
script_run: typing.Optional[ScriptRunResponse] = None
@@ -41,6 +43,10 @@ class WorkflowRun(UniversalBaseModel):
code_gen: typing.Optional[bool] = None
trigger_type: typing.Optional[WorkflowRunTriggerType] = None
workflow_schedule_id: typing.Optional[str] = None
+ ignore_inherited_workflow_system_prompt: typing.Optional[bool] = None
+ copilot_session_id: typing.Optional[str] = None
+ credits_used: typing.Optional[int] = None
+ cached_credits_used: typing.Optional[int] = None
queued_at: typing.Optional[dt.datetime] = None
started_at: typing.Optional[dt.datetime] = None
finished_at: typing.Optional[dt.datetime] = None
diff --git a/skyvern/client/types/workflow_run_block.py b/skyvern/client/types/workflow_run_block.py
index b47642342..22d32371b 100644
--- a/skyvern/client/types/workflow_run_block.py
+++ b/skyvern/client/types/workflow_run_block.py
@@ -41,6 +41,7 @@ class WorkflowRunBlock(UniversalBaseModel):
created_at: dt.datetime
modified_at: dt.datetime
include_action_history_in_verification: typing.Optional[bool] = None
+ include_extracted_text: typing.Optional[bool] = None
duration: typing.Optional[float] = None
loop_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
current_value: typing.Optional[str] = None
diff --git a/skyvern/client/types/workflow_run_request_input_proxy_location.py b/skyvern/client/types/workflow_run_request_input_proxy_location.py
new file mode 100644
index 000000000..f9bba1334
--- /dev/null
+++ b/skyvern/client/types/workflow_run_request_input_proxy_location.py
@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .geo_target import GeoTarget
+from .proxy_location import ProxyLocation
+
+WorkflowRunRequestInputProxyLocation = typing.Union[
+ ProxyLocation, GeoTarget, typing.Dict[str, typing.Optional[typing.Any]]
+]
diff --git a/skyvern/client/types/workflow_run_request.py b/skyvern/client/types/workflow_run_request_output.py
similarity index 81%
rename from skyvern/client/types/workflow_run_request.py
rename to skyvern/client/types/workflow_run_request_output.py
index 57fdb1cd2..5c6a2ba49 100644
--- a/skyvern/client/types/workflow_run_request.py
+++ b/skyvern/client/types/workflow_run_request_output.py
@@ -4,10 +4,10 @@ import typing
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .workflow_run_request_proxy_location import WorkflowRunRequestProxyLocation
+from .workflow_run_request_output_proxy_location import WorkflowRunRequestOutputProxyLocation
-class WorkflowRunRequest(UniversalBaseModel):
+class WorkflowRunRequestOutput(UniversalBaseModel):
workflow_id: str = pydantic.Field()
"""
ID of the workflow to run. Workflow ID starts with `wpid_`.
@@ -23,7 +23,7 @@ class WorkflowRunRequest(UniversalBaseModel):
The title for this workflow run
"""
- proxy_location: typing.Optional[WorkflowRunRequestProxyLocation] = pydantic.Field(default=None)
+ proxy_location: typing.Optional[WorkflowRunRequestOutputProxyLocation] = pydantic.Field(default=None)
"""
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -40,6 +40,7 @@ class WorkflowRunRequest(UniversalBaseModel):
- 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
@@ -56,6 +57,8 @@ class WorkflowRunRequest(UniversalBaseModel):
- 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:[email protected]: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"}
"""
@@ -101,6 +104,11 @@ class WorkflowRunRequest(UniversalBaseModel):
The extra HTTP headers for the requests in browser.
"""
+ cdp_connect_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None)
+ """
+ HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
+ """
+
browser_address: typing.Optional[str] = pydantic.Field(default=None)
"""
The CDP address for the workflow run.
@@ -116,7 +124,7 @@ class WorkflowRunRequest(UniversalBaseModel):
Whether to run the workflow with agent or code. Null inherits from the workflow setting.
"""
- run_metadata: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
+ run_metadata: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None)
"""
String key/value metadata to attach to this workflow run for analytics tag filtering.
"""
diff --git a/skyvern/client/types/workflow_run_request_output_proxy_location.py b/skyvern/client/types/workflow_run_request_output_proxy_location.py
new file mode 100644
index 000000000..2415bee9c
--- /dev/null
+++ b/skyvern/client/types/workflow_run_request_output_proxy_location.py
@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .geo_target import GeoTarget
+from .proxy_location import ProxyLocation
+
+WorkflowRunRequestOutputProxyLocation = typing.Union[
+ ProxyLocation, GeoTarget, typing.Dict[str, typing.Optional[typing.Any]]
+]
diff --git a/skyvern/client/types/workflow_run_response.py b/skyvern/client/types/workflow_run_response.py
index b0476102b..9bcb192f9 100644
--- a/skyvern/client/types/workflow_run_response.py
+++ b/skyvern/client/types/workflow_run_response.py
@@ -8,7 +8,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from .file_info import FileInfo
from .run_status import RunStatus
from .script_run_response import ScriptRunResponse
-from .workflow_run_request import WorkflowRunRequest
+from .workflow_run_request_output import WorkflowRunRequestOutput
from .workflow_run_response_output import WorkflowRunResponseOutput
@@ -38,6 +38,11 @@ class WorkflowRunResponse(UniversalBaseModel):
URL to the recording of the run
"""
+ recording_archived: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ True when the recording exists but has been archived to cold storage and is not currently accessible.
+ """
+
screenshot_urls: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
"""
List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot.
@@ -118,7 +123,12 @@ class WorkflowRunResponse(UniversalBaseModel):
Whether to fallback to AI if code run fails.
"""
- run_request: typing.Optional[WorkflowRunRequest] = pydantic.Field(default=None)
+ script_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ ID of the cached script used for this workflow run, if any.
+ """
+
+ run_request: typing.Optional[WorkflowRunRequestOutput] = pydantic.Field(default=None)
"""
The original request parameters used to start this workflow run
"""
diff --git a/skyvern/client/types/workflow_trigger_block.py b/skyvern/client/types/workflow_trigger_block.py
index 6fac10299..2938083f3 100644
--- a/skyvern/client/types/workflow_trigger_block.py
+++ b/skyvern/client/types/workflow_trigger_block.py
@@ -25,6 +25,7 @@ class WorkflowTriggerBlock(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
disable_cache: typing.Optional[bool] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
workflow_permanent_id: str
payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
diff --git a/skyvern/client/types/workflow_trigger_block_yaml.py b/skyvern/client/types/workflow_trigger_block_yaml.py
index 94d24c387..73945b571 100644
--- a/skyvern/client/types/workflow_trigger_block_yaml.py
+++ b/skyvern/client/types/workflow_trigger_block_yaml.py
@@ -19,6 +19,7 @@ class WorkflowTriggerBlockYaml(UniversalBaseModel):
continue_on_failure: typing.Optional[bool] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ ignore_workflow_system_prompt: typing.Optional[bool] = None
next_loop_on_failure: typing.Optional[bool] = None
workflow_permanent_id: str
payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
diff --git a/skyvern/client/workflows/__init__.py b/skyvern/client/workflows/__init__.py
new file mode 100644
index 000000000..5cde0202d
--- /dev/null
+++ b/skyvern/client/workflows/__init__.py
@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
diff --git a/skyvern/client/workflows/client.py b/skyvern/client/workflows/client.py
new file mode 100644
index 000000000..ce7c2c376
--- /dev/null
+++ b/skyvern/client/workflows/client.py
@@ -0,0 +1,115 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawWorkflowsClient, RawWorkflowsClient
+
+
+class WorkflowsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawWorkflowsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawWorkflowsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawWorkflowsClient
+ """
+ return self._raw_client
+
+ def reset_workflow_browser_profile(
+ self, workflow_permanent_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> None:
+ """
+ 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.
+
+ Parameters
+ ----------
+ workflow_permanent_id : str
+ The permanent ID of the workflow. Starts with `wpid_`.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ None
+
+ Examples
+ --------
+ from skyvern import Skyvern
+
+ client = Skyvern(
+ api_key="YOUR_API_KEY",
+ )
+ client.workflows.reset_workflow_browser_profile(
+ workflow_permanent_id="wpid_123",
+ )
+ """
+ _response = self._raw_client.reset_workflow_browser_profile(
+ workflow_permanent_id, request_options=request_options
+ )
+ return _response.data
+
+
+class AsyncWorkflowsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawWorkflowsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawWorkflowsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawWorkflowsClient
+ """
+ return self._raw_client
+
+ async def reset_workflow_browser_profile(
+ self, workflow_permanent_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> None:
+ """
+ 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.
+
+ Parameters
+ ----------
+ workflow_permanent_id : str
+ The permanent ID of the workflow. Starts with `wpid_`.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ None
+
+ Examples
+ --------
+ import asyncio
+
+ from skyvern import AsyncSkyvern
+
+ client = AsyncSkyvern(
+ api_key="YOUR_API_KEY",
+ )
+
+
+ async def main() -> None:
+ await client.workflows.reset_workflow_browser_profile(
+ workflow_permanent_id="wpid_123",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.reset_workflow_browser_profile(
+ workflow_permanent_id, request_options=request_options
+ )
+ return _response.data
diff --git a/skyvern/client/workflows/raw_client.py b/skyvern/client/workflows/raw_client.py
new file mode 100644
index 000000000..75aa6b882
--- /dev/null
+++ b/skyvern/client/workflows/raw_client.py
@@ -0,0 +1,152 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..errors.internal_server_error import InternalServerError
+from ..errors.not_found_error import NotFoundError
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+
+
+class RawWorkflowsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def reset_workflow_browser_profile(
+ self, workflow_permanent_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[None]:
+ """
+ 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.
+
+ Parameters
+ ----------
+ workflow_permanent_id : str
+ The permanent ID of the workflow. Starts with `wpid_`.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[None]
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"v1/workflows/{jsonable_encoder(workflow_permanent_id)}/browser_session/reset_profile",
+ method="POST",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ return HttpResponse(response=_response, data=None)
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 422:
+ raise UnprocessableEntityError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawWorkflowsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def reset_workflow_browser_profile(
+ self, workflow_permanent_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[None]:
+ """
+ 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.
+
+ Parameters
+ ----------
+ workflow_permanent_id : str
+ The permanent ID of the workflow. Starts with `wpid_`.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[None]
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"v1/workflows/{jsonable_encoder(workflow_permanent_id)}/browser_session/reset_profile",
+ method="POST",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ return AsyncHttpResponse(response=_response, data=None)
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 422:
+ raise UnprocessableEntityError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ parse_obj_as(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/skyvern/forge/sdk/copilot/turn_intent.py b/skyvern/forge/sdk/copilot/turn_intent.py
index 71af1fef2..6b5fbec00 100644
--- a/skyvern/forge/sdk/copilot/turn_intent.py
+++ b/skyvern/forge/sdk/copilot/turn_intent.py
@@ -169,6 +169,8 @@ _GOAL_MAX_CHARS = 240
_BUILD_TERMS = ("build", "create", "make", "generate")
_NEW_BROWSER_TASK_TERMS = ("go to", "navigate to", "open", "visit", "search for")
_EDIT_TERMS = ("edit", "update", "change", "modify", "replace", "fix")
+# Verbs that also commonly appear as step/block names ("the delete step").
+_EDIT_NOUNY_TERMS = ("add", "insert", "remove", "delete")
_DIAGNOSE_TERMS = ("debug", "diagnose", "failed", "failure", "error", "result")
_RUN_CONTEXT_REQUEST_TERMS = ("get_run_results", "workflow_run_id", "run result", "run results")
# Subset of _DIAGNOSE_TERMS that name unambiguous diagnose intent. "result" is in
@@ -177,17 +179,36 @@ _RUN_CONTEXT_REQUEST_TERMS = ("get_run_results", "workflow_run_id", "run result"
_CLEAR_DIAGNOSE_TERMS = ("debug", "diagnose", "failed", "failure", "error")
_DOCS_TERMS = (
"explain",
+ "tell me what",
"how do",
"how does",
"what is",
"what are",
+ "what does",
"why",
"docs",
"documentation",
+ "where should",
" vs ",
" versus ",
"difference between",
)
+_LEADING_NOUNY_FAILURE_RE = re.compile(
+ rf"^\s*(?:the\s+)?(?:{'|'.join(_EDIT_NOUNY_TERMS)})\s+(?:steps?|blocks?)\s+"
+ r"(?:failed|failure|errored?|errors?)\b",
+ re.I,
+)
+# Anchored structure requests catch "I need a step..." without treating
+# reference/help questions like "where should a step go?" as mutation.
+_STRUCTURE_REQUEST_RE = re.compile(
+ r"^\s*(?:(?:please|pls)\s+)?(?:"
+ r"(?:i|we)\s+(?:need|want|would\s+like)\s+"
+ r"(?:(?:(?:you\s+to|to)\s+(?:create|make|build|generate|add|insert)\s+)?)"
+ r"|(?:can|could|would)\s+you\s+(?:(?:please)\s+)?(?:create|make|build|generate|add|insert)\s+"
+ r"|(?:create|make|build|generate|add|insert)\s+"
+ r")(?:(?:a|an|another|extra|new|some)\s+)?(?:steps?|blocks?)\b",
+ re.I,
+)
_IDENTIFIER_REF_RE = r"[A-Za-z][A-Za-z0-9]*(?:_[A-Za-z0-9]+)+"
_CODE_IDENTIFIER_REF_RE = re.compile(rf"`(?P<ref>{_IDENTIFIER_REF_RE})`")
_BLOCK_IDENTIFIER_REF_RE = re.compile(
@@ -319,6 +340,12 @@ def _unresolved_explicit_block_refs(user_message: str, workflow_yaml: str | None
return unresolved
+def _mutation_mode(has_workflow: bool) -> tuple[TurnIntentMode, TurnIntentExpectedOutput]:
+ if has_workflow:
+ return TurnIntentMode.EDIT, TurnIntentExpectedOutput.WORKFLOW_UPDATE
+ return TurnIntentMode.BUILD, TurnIntentExpectedOutput.WORKFLOW_DRAFT
+
+
def _mode_from_keywords(
user_message: str,
*,
@@ -326,6 +353,8 @@ def _mode_from_keywords(
has_workflow_blocks: bool,
has_prior_run_signal: bool,
) -> tuple[TurnIntentMode, TurnIntentExpectedOutput] | None:
+ if _LEADING_NOUNY_FAILURE_RE.search(user_message or ""):
+ return TurnIntentMode.DIAGNOSE, TurnIntentExpectedOutput.RUN_RESULT
if has_workflow and _contains_any(user_message, _EDIT_TERMS):
return TurnIntentMode.EDIT, TurnIntentExpectedOutput.WORKFLOW_UPDATE
# A browser-task verb on a saved workflow with no buildable blocks is a new
@@ -345,6 +374,8 @@ def _mode_from_keywords(
return TurnIntentMode.DIAGNOSE, TurnIntentExpectedOutput.RUN_RESULT
if _contains_any(user_message, _DOCS_TERMS):
return TurnIntentMode.DOCS_ANSWER, TurnIntentExpectedOutput.EXPLANATION
+ if _STRUCTURE_REQUEST_RE.search(user_message or ""):
+ return _mutation_mode(has_workflow)
if _contains_any(user_message, _BUILD_TERMS):
return TurnIntentMode.BUILD, TurnIntentExpectedOutput.WORKFLOW_DRAFT
if not has_workflow and _contains_any(user_message, _NEW_BROWSER_TASK_TERMS):
diff --git a/tests/unit/test_copilot_turn_intent.py b/tests/unit/test_copilot_turn_intent.py
index 4951ec4ad..5cb4eb40e 100644
--- a/tests/unit/test_copilot_turn_intent.py
+++ b/tests/unit/test_copilot_turn_intent.py
@@ -633,6 +633,214 @@ def test_answer_only_turn_intent_hides_get_run_results_tool() -> None:
assert filtered == []
+def test_build_turn_intent_marks_declarative_step_request_as_edit() -> None:
+ intent = build_turn_intent(
+ user_message="I need a step where the page scrolls to the right.",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.EDIT
+
+
+def test_build_turn_intent_marks_create_step_request_as_edit() -> None:
+ intent = build_turn_intent(
+ user_message="create a step in my workflow where the page scrolls to the right",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.EDIT
+
+
+def test_build_turn_intent_marks_declarative_plural_step_request_as_edit() -> None:
+ intent = build_turn_intent(
+ user_message="I need steps that log in and download the report.",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.EDIT
+
+
+def test_build_turn_intent_marks_another_step_request_as_edit() -> None:
+ intent = build_turn_intent(
+ user_message="I need another step after the login block.",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.EDIT
+
+
+def test_build_turn_intent_marks_declarative_step_request_as_build_without_workflow() -> None:
+ intent = build_turn_intent(
+ user_message="I want a step that clicks the login button.",
+ workflow_yaml="",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(),
+ )
+
+ assert intent.mode == TurnIntentMode.BUILD
+
+
+def test_build_turn_intent_marks_leading_add_step_as_edit() -> None:
+ intent = build_turn_intent(
+ user_message="add a step that downloads the invoice PDF",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.EDIT
+
+
+def test_build_turn_intent_does_not_classify_leading_remove_named_block_as_edit() -> None:
+ intent = build_turn_intent(
+ user_message="remove the login block",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.UNKNOWN
+
+
+def test_build_turn_intent_leading_add_with_failure_clause_is_edit() -> None:
+ intent = build_turn_intent(
+ user_message="Add a step that fails if the invoice total is missing.",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.EDIT
+
+
+def test_build_turn_intent_leading_nouny_docs_question_stays_docs_answer() -> None:
+ intent = build_turn_intent(
+ user_message="delete is a step type, what does it do?",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(),
+ )
+
+ assert intent.mode == TurnIntentMode.DOCS_ANSWER
+ assert intent.authority.may_update_workflow is False
+
+
+def test_build_turn_intent_leading_delete_step_docs_question_stays_docs_answer() -> None:
+ intent = build_turn_intent(
+ user_message="delete step - what does it do?",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(),
+ )
+
+ assert intent.mode == TurnIntentMode.DOCS_ANSWER
+ assert intent.authority.may_update_workflow is False
+
+
+def test_build_turn_intent_docs_question_with_nouny_edit_word_stays_docs_answer() -> None:
+ intent = build_turn_intent(
+ user_message="What does the delete step do?",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(),
+ )
+
+ assert intent.mode == TurnIntentMode.DOCS_ANSWER
+ assert intent.authority.may_update_workflow is False
+
+
+def test_build_turn_intent_failure_report_with_nouny_step_name_is_diagnose() -> None:
+ intent = build_turn_intent(
+ user_message="The delete step failed.",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_update_workflow=False, allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.DIAGNOSE
+
+
+def test_build_turn_intent_leading_nouny_failure_report_is_diagnose() -> None:
+ intent = build_turn_intent(
+ user_message="delete step failed.",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_update_workflow=False, allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.DIAGNOSE
+
+
+def test_build_turn_intent_leading_nouny_block_failure_report_is_diagnose() -> None:
+ intent = build_turn_intent(
+ user_message="Remove block failed after login.",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(allow_update_workflow=False, allow_run_blocks=False),
+ )
+
+ assert intent.mode == TurnIntentMode.DIAGNOSE
+
+
+def test_build_turn_intent_does_not_mutate_on_existing_block_reference() -> None:
+ intent = build_turn_intent(
+ user_message="thanks, that step looks great",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(),
+ )
+
+ assert intent.mode not in (TurnIntentMode.EDIT, TurnIntentMode.BUILD)
+
+
+def test_build_turn_intent_docs_question_with_structure_noun_stays_docs_answer() -> None:
+ intent = build_turn_intent(
+ user_message="Can you tell me what a block is supposed to do?",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(),
+ )
+
+ assert intent.mode == TurnIntentMode.DOCS_ANSWER
+ assert intent.authority.may_update_workflow is False
+
+
+def test_build_turn_intent_structure_reference_question_does_not_mutate() -> None:
+ intent = build_turn_intent(
+ user_message="Where should a step go in the workflow?",
+ workflow_yaml="blocks: []",
+ chat_history=[],
+ global_llm_context="",
+ request_policy=RequestPolicy(),
+ )
+
+ assert intent.mode not in (TurnIntentMode.EDIT, TurnIntentMode.BUILD)
+
+
def _structured_context_with_run_decision() -> str:
return StructuredContext(
decisions_made=[
diff --git a/tests/unit/test_mcp_block_type_parity.py b/tests/unit/test_mcp_block_type_parity.py
index 13935260e..9ee5c6fee 100644
--- a/tests/unit/test_mcp_block_type_parity.py
+++ b/tests/unit/test_mcp_block_type_parity.py
@@ -94,22 +94,7 @@ class BlockDriftEntry:
# Allowlist: block types present in the backend but not yet regenerated into
# the vendored Fern SDK. Run `fern generate` using the Skyvern Cloud-only
# runbook to resync, then remove the entry here.
-_KNOWN_DRIFT_ALLOWLIST: tuple[BlockDriftEntry, ...] = (
- BlockDriftEntry(
- block_type="google_sheets_read",
- ticket="SKY-9227",
- owner="@wintonzheng",
- added_at=date(2026, 4, 23),
- notes="Clears with `google_sheets_write` at the next Fern SDK regeneration.",
- ),
- BlockDriftEntry(
- block_type="google_sheets_write",
- ticket="SKY-9227",
- owner="@wintonzheng",
- added_at=date(2026, 4, 23),
- notes="Clears with `google_sheets_read` at the next Fern SDK regeneration.",
- ),
-)
+_KNOWN_DRIFT_ALLOWLIST: tuple[BlockDriftEntry, ...] = ()
def _allowlisted_block_types() -> set[str]:
diff --git a/tests/unit/test_sdk_run_metadata.py b/tests/unit/test_sdk_run_metadata.py
index dc7c8589c..11e7a2e93 100644
--- a/tests/unit/test_sdk_run_metadata.py
+++ b/tests/unit/test_sdk_run_metadata.py
@@ -5,7 +5,7 @@ import httpx
import pytest
from skyvern.client import AsyncSkyvern, Skyvern
-from skyvern.client.types.workflow_run_request import WorkflowRunRequest
+from skyvern.client.types.workflow_run_request_output import WorkflowRunRequestOutput as WorkflowRunRequest
def test_workflow_run_request_accepts_run_metadata() -> None:
diff --git a/uv.lock b/uv.lock
index 088286ea1..d43dad90a 100644
--- a/uv.lock
+++ b/uv.lock
@@ -5715,7 +5715,7 @@ wheels = [
[[package]]
name = "skyvern"
-version = "1.0.36"
+version = "1.0.37"
source = { editable = "." }
dependencies = [
{ name = "cachetools" },