Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
import { WorkflowApiResponse } from "@/routes/workflows/types/workflowTypes";
export type DownloadedFileInfo = {
url: string;
filename: string | null;
checksum: string | null;
file_size: number | null;
modified_at: string | null;
artifact_id: string | null;
};
export const ArtifactType = {
Recording: "recording",
SessionReplay: "session_replay",
Screenshot: "screenshot",
ActionScreenshot: "screenshot_action",
LLMScreenshot: "screenshot_llm",
EvalScore: "eval_score",
LLMResponseRaw: "llm_response",
LLMResponseParsed: "llm_response_parsed",
VisibleElementsTree: "visible_elements_tree",
VisibleElementsTreeTrimmed: "visible_elements_tree_trimmed",
VisibleElementsTreeInPrompt: "visible_elements_tree_in_prompt",
LLMPrompt: "llm_prompt",
LLMRequest: "llm_request",
HTMLScrape: "html_scrape",
SkyvernLog: "skyvern_log",
SkyvernLogRaw: "skyvern_log_raw",
PDF: "pdf",
} as const;
export type ArtifactType = (typeof ArtifactType)[keyof typeof ArtifactType];
export const TriggerType = {
Manual: "manual",
Mcp: "mcp",
Api: "api",
Scheduled: "scheduled",
} as const;
export type TriggerType = (typeof TriggerType)[keyof typeof TriggerType];
export const Status = {
Created: "created",
Running: "running",
Failed: "failed",
Terminated: "terminated",
Completed: "completed",
Queued: "queued",
TimedOut: "timed_out",
Canceled: "canceled",
Skipped: "skipped",
Paused: "paused",
} as const;
export type Status = (typeof Status)[keyof typeof Status];
export const ProxyLocation = {
Residential: "RESIDENTIAL",
ResidentialIE: "RESIDENTIAL_IE",
ResidentialES: "RESIDENTIAL_ES",
ResidentialIN: "RESIDENTIAL_IN",
ResidentialJP: "RESIDENTIAL_JP",
ResidentialGB: "RESIDENTIAL_GB",
ResidentialFR: "RESIDENTIAL_FR",
ResidentialDE: "RESIDENTIAL_DE",
ResidentialNZ: "RESIDENTIAL_NZ",
ResidentialZA: "RESIDENTIAL_ZA",
ResidentialAR: "RESIDENTIAL_AR",
ResidentialAU: "RESIDENTIAL_AU",
ResidentialBR: "RESIDENTIAL_BR",
ResidentialTR: "RESIDENTIAL_TR",
ResidentialCA: "RESIDENTIAL_CA",
ResidentialMX: "RESIDENTIAL_MX",
ResidentialIT: "RESIDENTIAL_IT",
ResidentialNL: "RESIDENTIAL_NL",
ResidentialPH: "RESIDENTIAL_PH",
ResidentialKR: "RESIDENTIAL_KR",
ResidentialSA: "RESIDENTIAL_SA",
ResidentialISP: "RESIDENTIAL_ISP",
None: "NONE",
} as const;
export type LegacyProxyLocation =
(typeof ProxyLocation)[keyof typeof ProxyLocation];
export type GeoTarget = {
country: string;
subdivision?: string;
city?: string;
isISP?: boolean;
};
export type ProxyLocation = LegacyProxyLocation | GeoTarget | null;
export const PINNED_RESIDENTIAL_ISP_PROXY_LOCATION =
"RESIDENTIAL_ISP" satisfies LegacyProxyLocation;
export type ArtifactApiResponse = {
created_at: string;
modified_at: string;
artifact_id: string;
task_id: string;
step_id: string;
artifact_type: ArtifactType;
uri: string;
signed_url?: string | null;
archived?: boolean;
organization_id: string;
};
export type ActionResultApiResponse = {
success: boolean;
};
export type ActionAndResultApiResponse = [
ActionApiResponse,
Array<ActionResultApiResponse>,
];
export type StepApiResponse = {
step_id: string;
task_id: string;
created_at: string;
modified_at: string;
input_token_count: number;
is_last: boolean;
order: number;
organization_id: string;
output?: {
actions_and_results: ActionAndResultApiResponse[];
errors: unknown[];
};
retry_index: number;
status: Status;
step_cost: number;
created_by?: string | null;
};
export type Task = {
task_id: string;
status: Status;
created_at: string; // ISO 8601
modified_at: string; // ISO 8601
started_at: string | null; // ISO 8601
finished_at: string | null; // ISO 8601
extracted_information: Record<string, unknown> | string | null;
screenshot_url: string | null;
recording_url: string | null;
organization_id: string;
workflow_run_id: string | null;
order: number | null;
retry: number | null;
max_steps_per_run: number | null;
errors: Array<Record<string, unknown>>;
title: string | null;
url: string;
webhook_callback_url: string | null;
webhook_failure_reason: string | null;
navigation_goal: string | null;
data_extraction_goal: string | null;
navigation_payload: Record<string, unknown> | string | null;
complete_criterion: string | null;
terminate_criterion: string | null;
application: string | null;
};
export type FailureCategory = {
category: string;
confidence_float: number;
reasoning: string;
reason_code?: string | null;
};
export type TaskApiResponse = {
request: CreateTaskRequest;
task_id: string;
status: Status;
created_at: string; // ISO 8601
modified_at: string; // ISO 8601
extracted_information: Record<string, unknown> | string | null;
screenshot_url: string | null;
recording_url: string | null;
recording_archived?: boolean;
failure_reason: string | null;
failure_category: Array<FailureCategory> | null;
webhook_failure_reason: string | null;
errors: Array<Record<string, unknown>>;
max_steps_per_run: number | null;
task_v2: TaskV2 | null;
workflow_run_id: string | null;
browser_session_id: string | null;
waiting_for_verification_code?: boolean;
verification_code_identifier?: string | null;
verification_code_polling_started_at?: string | null;
};
export type CreateTaskRequest = {
title?: string | null;
url: string;
webhook_callback_url?: string | null;
navigation_goal?: string | null;
data_extraction_goal?: string | null;
navigation_payload?: Record<string, unknown> | string | null;
extracted_information_schema?: Record<string, unknown> | string | null;
extra_http_headers?: Record<string, string> | null;
error_code_mapping?: Record<string, string> | null;
proxy_location?: ProxyLocation | null;
totp_verification_url?: string | null;
totp_identifier?: string | null;
application?: string | null;
include_action_history_in_verification?: boolean | null;
max_screenshot_scrolls?: number | null;
browser_address?: string | null;
};
export type User = {
id: string;
email: string;
name: string;
createdAt?: Date;
};
export type OrganizationApiResponse = {
created_at: string;
modified_at: string;
default_llm_key?: string | null;
default_secondary_llm_key?: string | null;
max_retries_per_step: number | null;
max_steps_per_run: number | null;
// Optional because the field is added in a backend image rollout; until
// every API host has the new schema this property may be absent from the
// response payload.
max_steps_per_workflow_run?: number | null;
artifact_url_expiry_seconds?: number | null;
organization_id: string;
organization_name: string;
webhook_callback_url: string | null;
};
export type ApiKeyApiResponse = {
id: string;
organization_id: string;
token: string;
created_at: string;
modified_at: string;
token_type: string;
valid: boolean;
};
export type OnePasswordTokenSource = "organization" | "instance_default";
export type OnePasswordTokenStatus = {
configured: boolean;
source: OnePasswordTokenSource | null;
instance_default_available: boolean;
modified_at: string | null;
};
export type OnePasswordTokenApiResponse = {
id: string;
organization_id: string;
created_at: string;
modified_at: string;
token_type: string;
valid: boolean;
};
export type OnePasswordItemApiResponse = {
item_id: string;
title: string;
vault_id: string;
vault_name: string;
category: string;
importable?: boolean;
url?: string | null;
};
export type OnePasswordItemsApiResponse = {
configured: boolean;
source: OnePasswordTokenSource | null;
items: Array<OnePasswordItemApiResponse>;
};
export const ONEPASSWORD_CREDENTIALS_REQUEST_LIMIT = 500;
export type OnePasswordCredentialImportRequest = {
folder_id?: string;
items: Array<{ vault_id: string; item_id: string }>;
};
export type OnePasswordCredentialImportResult = {
vault_id: string;
item_id: string;
status: "imported" | "updated" | "skipped";
reason?: string | null;
};
export type OnePasswordCredentialImportResponse = {
results: Array<OnePasswordCredentialImportResult>;
};
export type OnePasswordCredentialRefreshResult = {
vault_id: string;
item_id: string;
status: "refreshed" | "stale" | "skipped";
reason?: string | null;
};
export type OnePasswordCredentialRefreshResponse = {
refreshed: number;
stale: number;
skipped: number;
results: Array<OnePasswordCredentialRefreshResult>;
};
export type BitwardenItemApiResponse = {
item_id: string;
title: string;
collection_id?: string | null;
credential_type: "password" | "credit_card" | "secret";
url?: string | null;
};
export type BitwardenItemsApiResponse = {
configured: boolean;
items: Array<BitwardenItemApiResponse>;
};
export type CreateOnePasswordTokenRequest = {
token: string;
};
export type CreateOnePasswordTokenResponse = {
token: OnePasswordTokenApiResponse;
};
export type ClearOrganizationAuthTokenResponse = {
success: boolean;
};
export type CustomLLMProvider =
| "openai_compatible"
| "ollama"
| "openrouter"
| "gemini";
export type CustomLLMConfig = {
display_name: string;
provider: CustomLLMProvider;
model_name: string;
api_base?: string | null;
api_key?: string | null;
api_version?: string | null;
supports_vision: boolean;
add_assistant_prefix: boolean;
max_completion_tokens?: number | null;
temperature?: number | null;
reasoning_effort?: string | null;
extra_parameters?: Record<string, unknown> | null;
};
export type CustomLLM = {
id: string;
organization_id: string;
config: CustomLLMConfig;
created_at: string;
modified_at: string;
valid: boolean;
};
export type CustomLLMListResponse = {
custom_llms: Array<CustomLLM>;
};
export type CustomLLMResponse = {
custom_llm: CustomLLM;
};
export type CustomLLMCreateRequest = {
config: CustomLLMConfig;
};
export type CustomLLMUpdateRequest = {
config: CustomLLMConfig;
};
export interface AzureClientSecretCredential {
tenant_id: string;
client_id: string;
client_secret: string;
}
export interface AzureOrganizationAuthToken {
id: string;
organization_id: string;
credential: AzureClientSecretCredential;
created_at: string;
modified_at: string;
token_type: string;
valid: boolean;
}
export interface CreateAzureClientSecretCredentialRequest {
credential: AzureClientSecretCredential;
}
export interface AzureClientSecretCredentialResponse {
token: AzureOrganizationAuthToken;
}
export interface GoogleOAuthCredential {
id: string;
organization_id: string;
credential_name: string;
email_address?: string | null;
provider?: string;
state?: string;
scopes_requested?: string[] | string | null;
scopes_granted?: string[] | string | null;
scopes?: string[] | string | null;
valid?: boolean | null;
// Decided by the server: active, send permission granted, and a verified account identity on record.
gmail_send_ready?: boolean;
created_at: string;
modified_at: string;
}
export interface GoogleOAuthCredentialResponse {
credential: GoogleOAuthCredential;
app_origin?: string | null;
}
export interface GoogleOAuthCredentialListResponse {
credentials: GoogleOAuthCredential[];
}
export interface GoogleOAuthClientConfigSafe {
client_id: string | null;
redirect_hosts: string[];
app_origins: string[];
client_secret_configured: boolean;
configured: boolean;
source: string;
encryption_enabled: boolean;
}
export interface GoogleOAuthClientConfigResponse {
config: GoogleOAuthClientConfigSafe;
}
export interface UpdateGoogleOAuthClientConfigRequest {
client_id: string;
client_secret?: string | null;
redirect_hosts: string[];
app_origins: string[];
}
export type GoogleOAuthScopeProfile =
| "google_sheets"
| "gmail"
| "google_drive"
| "gmail_send"
| "gmail_read_send";
export interface CreateGoogleOAuthAuthorizeRequest {
redirect_uri: string;
credential_name?: string;
scope_profile?: GoogleOAuthScopeProfile;
app_origin?: string;
// Existing credential to re-authenticate in place, preserving its id so
// workflows referencing it keep working without edits.
credential_id?: string;
}
export interface GoogleOAuthAuthorizeResponse {
authorize_url: string;
state: string;
}
export interface CreateGoogleOAuthCallbackRequest {
code: string;
state: string;
}
export interface MicrosoftOAuthCredential {
id: string;
organization_id: string;
credential_name: string;
email_address?: string | null;
state?: string;
scopes_requested?: string[] | string | null;
scopes_granted?: string[] | string | null;
scopes?: string[] | string | null;
valid?: boolean | null;
created_at: string;
modified_at: string;
}
export interface MicrosoftOAuthCredentialResponse {
credential: MicrosoftOAuthCredential;
app_origin?: string | null;
}
export interface MicrosoftOAuthCredentialListResponse {
credentials: MicrosoftOAuthCredential[];
}
export interface CreateMicrosoftOAuthAuthorizeRequest {
redirect_uri: string;
credential_name?: string;
scope_profile?: "outlook_mail";
app_origin?: string;
}
export interface MicrosoftOAuthAuthorizeResponse {
authorize_url: string;
state: string;
}
export interface CreateMicrosoftOAuthCallbackRequest {
code: string;
state: string;
}
export interface GoogleSpreadsheetSummary {
id: string;
name: string;
modified_time: string | null;
web_view_link: string | null;
}
export interface PagedGoogleSpreadsheets {
spreadsheets: GoogleSpreadsheetSummary[];
next_page_token: string | null;
}
export interface GoogleSheetTab {
sheet_id: number;
title: string;
index: number;
}
export interface ListGoogleSheetTabsResponse {
tabs: GoogleSheetTab[];
}
export interface SheetHeader {
letter: string;
name: string;
}
export interface GetSheetHeadersResponse {
headers: SheetHeader[];
}
export interface GetSheetDimensionsResponse {
sheet_id: number;
title: string;
column_count: number;
row_count: number;
last_column_letter: string;
headers: SheetHeader[];
}
export interface CreateGoogleSpreadsheetResponse {
spreadsheet: GoogleSpreadsheetSummary;
first_sheet_name: string | null;
}
export interface CreateGoogleSheetTabResponse {
tab: GoogleSheetTab;
}
export interface GoogleSheetsReconnectRequiredError {
code: "reconnect_required";
missing_scope: string | null;
}
export interface BitwardenCredential {
email: string;
master_password: string;
}
export interface BitwardenCredentialSafe {
email: string;
}
export interface BitwardenOrganizationAuthToken {
id: string;
organization_id: string;
credential: BitwardenCredentialSafe;
created_at: string;
modified_at: string;
token_type: string;
valid: boolean;
}
export interface CreateBitwardenCredentialRequest {
credential: BitwardenCredential;
}
export interface BitwardenCredentialResponse {
token: BitwardenOrganizationAuthToken;
}
export interface CustomCredentialServiceConfig {
api_base_url: string;
api_token: string;
}
export interface CustomCredentialServiceOrganizationAuthToken {
id: string;
organization_id: string;
token: string; // JSON string containing CustomCredentialServiceConfig
created_at: string;
modified_at: string;
token_type: string;
valid: boolean;
}
export interface CreateCustomCredentialServiceConfigRequest {
config: CustomCredentialServiceConfig;
}
export interface CustomCredentialServiceConfigResponse {
token: CustomCredentialServiceOrganizationAuthToken;
}
// TODO complete this
export const ActionTypes = {
InputText: "input_text",
PasteText: "paste_text",
Click: "click",
Hover: "hover",
SelectOption: "select_option",
UploadFile: "upload_file",
DownloadFile: "download_file",
complete: "complete",
wait: "wait",
terminate: "terminate",
SolveCaptcha: "solve_captcha",
extract: "extract",
ReloadPage: "reload_page",
KeyPress: "keypress",
Scroll: "scroll",
Move: "move",
NullAction: "null_action",
VerificationCode: "verification_code",
Drag: "drag",
LeftMouse: "left_mouse",
GotoUrl: "goto_url",
ClosePage: "close_page",
ExecuteJs: "execute_js",
} as const;
export type ActionType = (typeof ActionTypes)[keyof typeof ActionTypes];
export const ReadableActionTypes: {
[key in ActionType]: string;
} = {
input_text: "Input Text",
paste_text: "Paste Text",
click: "Click",
hover: "Hover",
select_option: "Select Option",
upload_file: "Upload File",
download_file: "Download File",
complete: "Complete",
wait: "Wait",
terminate: "Terminate",
solve_captcha: "Solve Captcha",
extract: "Extract Data",
reload_page: "Reload Page",
keypress: "Press Keys",
scroll: "Scroll",
move: "Move",
null_action: "Screenshot",
verification_code: "Verification Code",
drag: "Drag",
left_mouse: "Left Mouse",
goto_url: "Goto URL",
close_page: "Close Page",
execute_js: "Execute JS",
};
type GetReadableActionTypeOptions = {
nullActionLabel?: string;
};
// Recorded code-block actions can carry an action_type the readable map doesn't
// list yet (the runtime recorder maps more Playwright calls than the UI enumerates).
// Humanize unknown types instead of rendering a blank badge.
export function getReadableActionType(
actionType: string,
options: GetReadableActionTypeOptions = {},
): string {
if (actionType === ActionTypes.NullAction && options.nullActionLabel) {
return options.nullActionLabel;
}
const known = ReadableActionTypes[actionType as ActionType];
if (known) {
return known;
}
if (!actionType) {
return "Step";
}
return actionType
.split("_")
.filter(Boolean)
.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
.join(" ");
}
export type Option = {
label: string;
index: number;
value: string;
};
export type ActionApiResponse = {
reasoning: string;
confidence_float?: number;
action_type: ActionType;
text: string | null;
option: Option | null;
file_url: string | null;
created_by: string | null;
screenshot_artifact_id?: string | null;
};
export type ActionSummaryBody = {
// Trimmed but not collapsed: paragraph breaks survive for a card that renders blocks. A caller
// rendering one line must collapse them itself (normalizeInlineText) — InlineMarkdown joins
// paragraphs with no separator at all.
text: string;
// Only the model's own prose is markdown. A typed value or a recorded outcome is literal text and
// must render verbatim — a password containing "*" is not emphasis.
isProse: boolean;
};
export type ActionSummary = {
// What the action set out to do.
body: ActionSummaryBody | null;
// What it actually did, when the run recorded it. Shown beside the body, never instead of it: a
// card that let the plan stand for the effect reads a dead end as a successful navigation.
outcome: string | null;
};
export type Action = {
// The text the card shows, already resolved through getActionSummary: a Task V3 action often
// carries no reasoning, and then its intention or its recorded outcome is all it has.
summary: ActionSummary | null;
confidence?: number;
type: ActionType;
input: string;
success: boolean;
stepId: string;
index: number;
created_by: string | null;
screenshotArtifactId?: string | null;
};
export type EvalKind = "workflow" | "task" | "browser_session";
export interface Eval {
kind: EvalKind;
created_at: string;
organization_id: string;
status: Status;
title: string | null;
workflow_permanent_id: string | null;
workflow_run_id: string | null;
}
export interface EvalWorkflow extends Eval {
kind: "workflow";
}
export interface EvalTask extends Eval {
kind: "task";
task_id: string;
url: string | null;
}
export interface EvalBrowserSession extends Eval {
kind: "browser_session";
session_id: string;
arm?: string | null;
difficulty?: "easy" | "medium" | "hard" | null;
model?: string | null;
task_id?: string | null;
task_title?: string | null;
perfect?: boolean | null;
rubric_avg?: number | null;
started_at?: string | null;
finished_at?: string | null;
duration_s?: number | null;
}
export type EvalApiResponse = Array<
EvalWorkflow | EvalTask | EvalBrowserSession
>;
export interface EvalModelTierStat {
total: number;
perfect_count: number;
pass_rate: number | null;
}
export interface EvalModelSummary {
model: string | null;
total: number;
perfect_count: number;
graded_count: number;
pass_rate: number | null;
rubric_avg: number | null;
duration_avg_s: number | null;
last_started_at: string | null;
tiers?: Partial<Record<"easy" | "medium" | "hard", EvalModelTierStat>>;
}
export interface EvalSummaryResponse {
models: EvalModelSummary[];
total_runs: number;
}
export interface RuntimeCostTierMetrics {
steps: number | null;
duration_min: number | null;
tokens: number | null;
cost: number | null;
}
export interface RuntimeCostModelSummary {
model: string;
runs: number;
steps: number | null;
duration_min: number | null;
tokens: number | null;
output_tokens: number | null;
cost: number | null;
token_coverage: number;
tiers: Partial<Record<"easy" | "medium" | "hard", RuntimeCostTierMetrics>>;
}
export interface RuntimeCostSummaryResponse {
task_set_size: number;
captured_at: string | null;
models: RuntimeCostModelSummary[];
}
export type DebugSessionApiResponse = {
debug_session_id: string;
browser_session_id: string;
workflow_permanent_id: string | null;
created_at: string;
modified_at: string;
vnc_streaming_supported: boolean | null;
pbs_browser_profile_id: string | null;
};
export type DebugSessionViewerStateApiResponse = {
active_run_session_id: string | null;
};
export type DebugLoginBlockCompatibilityResponse = {
compatible: boolean;
reason: "pbs_no_profile" | "pbs_different_profile" | null;
};
export type WorkflowRunAttempt = {
attempt_number: number;
status: Status;
failure_reason: string | null;
error_codes: Array<string>;
started_at: string | null;
finished_at: string | null;
retry_decision: string | null;
decision_reason: string | null;
next_attempt_at: string | null;
webhook_sent_at: string | null;
};
export type WorkflowRunRetryFields = {
attempt?: number;
retry_pending?: boolean;
next_attempt_at?: string | null;
attempts?: Array<WorkflowRunAttempt>;
};
export type WorkflowRunApiResponse = {
created_at: string;
failure_reason: string | null;
started_at: string | null; // ISO 8601
finished_at: string | null; // ISO 8601
modified_at: string;
proxy_location: ProxyLocation | null;
script_run: boolean | null;
status: Status;
title?: string;
trigger_type?: TriggerType | null;
schedule_id?: string | null;
schedule_name?: string | null;
schedule_cron?: string | null;
scheduled_for?: string | null;
webhook_callback_url: string;
workflow_id: string;
workflow_permanent_id: string;
workflow_run_id: string;
workflow_title: string | null;
retried_from_workflow_run_id?: string | null;
} & Pick<
WorkflowRunRetryFields,
"attempt" | "retry_pending" | "next_attempt_at"
>;
export const TaskRunType = {
TaskV1: "task_v1",
TaskV2: "task_v2",
WorkflowRun: "workflow_run",
OpenaiCua: "openai_cua",
AnthropicCua: "anthropic_cua",
UiTars: "ui_tars",
YutoriNavigator: "yutori_navigator",
} as const;
export type TaskRunType = (typeof TaskRunType)[keyof typeof TaskRunType];
export type TaskRunListItem = {
task_run_id: string;
task_run_type: TaskRunType;
run_id: string;
title: string | null;
status: string;
started_at: string | null;
finished_at: string | null;
created_at: string;
workflow_permanent_id: string | null;
workflow_deleted: boolean;
script_run: boolean;
trigger_type?: TriggerType | null;
created_by?: string | null;
searchable_text: string | null;
} & Pick<
WorkflowRunRetryFields,
"attempt" | "retry_pending" | "next_attempt_at"
>;
export type WorkflowRunStatusApiResponse = {
workflow_id: string;
workflow_run_id: string;
status: Status;
proxy_location: ProxyLocation | null;
webhook_callback_url: string | null;
totp_verification_url: string | null;
totp_identifier: string | null;
extra_http_headers: Record<string, string> | null;
created_at: string;
queued_at: string | null;
started_at: string | null;
finished_at: string;
modified_at: string;
parameters: Record<string, unknown>;
screenshot_urls: Array<string> | null;
recording_url: string | null;
recording_urls: Array<string> | null;
recording_archived?: boolean;
outputs: Record<string, unknown> | null;
failure_reason: string | null;
failure_category: Array<FailureCategory> | null;
webhook_failure_reason: string | null;
downloaded_file_urls: Array<string> | null;
downloaded_files: Array<DownloadedFileInfo> | null;
errors: Array<Record<string, unknown>> | null;
total_steps: number | null;
total_cost: number | null;
credits_used: number;
cached_credits_used: number;
task_v2: TaskV2 | null;
workflow_title: string | null;
browser_session_id: string | null;
browser_profile_id: string | null;
max_screenshot_scrolls: number | null;
run_with: string | null;
waiting_for_verification_code?: boolean;
verification_code_identifier?: string | null;
verification_code_polling_started_at?: string | null;
retried_from_workflow_run_id?: string | null;
retried_by_workflow_run_id?: string | null;
} & WorkflowRunRetryFields;
export type WorkflowRunStatusApiResponseWithWorkflow = {
workflow_id: string;
workflow_run_id: string;
status: Status;
proxy_location: ProxyLocation | null;
webhook_callback_url: string | null;
totp_verification_url: string | null;
totp_identifier: string | null;
extra_http_headers: Record<string, string> | null;
created_at: string;
queued_at: string | null;
started_at: string | null;
finished_at: string;
modified_at: string;
parameters: Record<string, unknown>;
screenshot_urls: Array<string> | null;
recording_url: string | null;
recording_urls: Array<string> | null;
recording_archived?: boolean;
outputs: Record<string, unknown> | null;
failure_reason: string | null;
failure_category: Array<FailureCategory> | null;
webhook_failure_reason: string | null;
downloaded_file_urls: Array<string> | null;
downloaded_files: Array<DownloadedFileInfo> | null;
errors: Array<Record<string, unknown>> | null;
total_steps: number | null;
total_cost: number | null;
credits_used: number;
cached_credits_used: number;
task_v2: TaskV2 | null;
workflow_title: string | null;
browser_session_id: string | null;
browser_profile_id: string | null;
browser_type?: string | null;
max_screenshot_scrolls: number | null;
run_with: string | null;
workflow: WorkflowApiResponse;
waiting_for_verification_code?: boolean;
verification_code_identifier?: string | null;
verification_code_polling_started_at?: string | null;
retried_from_workflow_run_id?: string | null;
retried_by_workflow_run_id?: string | null;
} & WorkflowRunRetryFields;
export type TaskGenerationApiResponse = {
suggested_title: string | null;
url: string | null;
navigation_goal: string | null;
data_extraction_goal: string | null;
navigation_payload: Record<string, unknown> | null;
extracted_information_schema: Record<string, unknown> | null;
};
export type ActionsApiResponse = {
action_id: string;
action_type: ActionType;
status: Status;
task_id: string | null;
step_id: string | null;
step_order: number | null;
action_order: number | null;
confidence_float: number | null;
description: string | null;
reasoning: string | null;
intention: string | null;
response: string | null;
created_by: string | null;
text: string | null;
screenshot_artifact_id?: string | null;
// On the base Action, so it survives the timeline's `list[Action]` serialization. Subclass-only
// fields (url, keys) do not and must not be declared here.
file_name?: string | null;
// Code block recorded actions carry code_line and duration_ms here.
output?:
| { code_line?: number | null; duration_ms?: number | null }
| Record<string, unknown>
| null;
};
export type TaskV2 = {
task_id: string;
status: Status;
workflow_run_id: string | null;
workflow_id: string | null;
workflow_permanent_id: string | null;
prompt: string | null;
url: string | null;
created_at: string;
modified_at: string;
output: Record<string, unknown> | null;
summary: string | null;
webhook_callback_url: string | null;
webhook_failure_reason: string | null;
totp_verification_url: string | null;
totp_identifier: string | null;
proxy_location: ProxyLocation | null;
extra_http_headers: Record<string, string> | null;
};
export type Createv2TaskRequest = {
user_prompt: string;
webhook_callback_url?: string | null;
proxy_location?: ProxyLocation | null;
browser_session_id?: string | null;
};
export type BrowserProfileApiResponse = {
browser_profile_id: string;
organization_id: string;
name: string;
description: string | null;
source_browser_type: string | null;
proxy_location?: ProxyLocation | null;
proxy_session_id?: string | null;
is_managed?: boolean;
workflow_permanent_id?: string | null;
// Batched by the list endpoint so rows show the credential-login role without a per-row usage fetch.
linked_credential_name?: string | null;
created_at: string;
modified_at: string;
deleted_at: string | null;
};
export type BrowserProfileUsageWorkflow = {
workflow_permanent_id: string;
title: string;
via: "browser_profile_id" | "seed_browser_profile_id";
};
export type BrowserProfileUsageCredential = {
credential_id: string;
name: string;
};
export type BrowserProfileUsage = {
workflows: Array<BrowserProfileUsageWorkflow>;
credentials: Array<BrowserProfileUsageCredential>;
recent_seeded_run_count: number;
};
export type PasswordCredentialApiResponse = {
username: string;
totp_type: "authenticator" | "email" | "text" | "passkey" | "none";
totp_identifier?: string | null;
};
export type CredentialTotpCodeResponse = {
code: string;
seconds_remaining: number;
};
export type CreditCardCredentialApiResponse = {
last_four: string;
brand: string;
};
export type SecretCredentialResponse = {
secret_label?: string | null;
};
export type CredentialApiResponse = {
credential_id: string;
credential:
| PasswordCredentialApiResponse
| CreditCardCredentialApiResponse
| SecretCredentialResponse;
credential_type: "password" | "credit_card" | "secret";
name: string;
vault_type?:
| "skyvern"
| "bitwarden"
| "azure_vault"
| "gcp"
| "custom"
| "onepassword"
| null;
vault_id?: string | null;
item_id?: string | null;
upstream_missing_at?: string | null;
browser_profile_id?: string | null;
auto_profile_disabled?: boolean | null;
pin_saved_session_ip?: boolean | null;
tested_url?: string | null;
user_context?: string | null;
save_browser_session_intent?: boolean | null;
run_sequentially?: boolean | null;
folder_id?: string | null;
proxy_location?: ProxyLocation | null;
proxy_session_id?: string | null;
created_by?: string | null;
};
export function isPasswordCredential(
credential:
| PasswordCredentialApiResponse
| CreditCardCredentialApiResponse
| SecretCredentialResponse,
): credential is PasswordCredentialApiResponse {
return "username" in credential;
}
export function isCreditCardCredential(
credential:
| PasswordCredentialApiResponse
| CreditCardCredentialApiResponse
| SecretCredentialResponse,
): credential is CreditCardCredentialApiResponse {
return "last_four" in credential;
}
export function isSecretCredential(
credential:
| PasswordCredentialApiResponse
| CreditCardCredentialApiResponse
| SecretCredentialResponse,
): credential is SecretCredentialResponse {
return !("username" in credential) && !("last_four" in credential);
}
export type CreateCredentialRequest = {
name: string;
credential_type: "password" | "credit_card" | "secret";
credential: PasswordCredential | CreditCardCredential | SecretCredential;
vault_type?: "custom";
proxy_location?: ProxyLocation | null;
proxy_session_id?: string | null;
rotate_proxy_session_id?: boolean;
browser_profile_id?: string | null;
auto_profile_disabled?: boolean;
pin_saved_session_ip?: boolean;
};
export type PasswordCredential = {
username: string;
/** Omit on an overwrite to keep the stored password; "" blanks it. */
password?: string;
totp: string | null;
totp_type: "authenticator" | "email" | "text" | "passkey" | "none";
totp_identifier?: string | null;
};
export type CreditCardCredential = {
card_number: string;
card_cvv: string;
card_exp_month: string;
card_exp_year: string;
card_brand: string;
card_holder_name: string;
billing_address?: CreditCardBillingAddress | null;
billing_email?: string | null;
billing_phone?: string | null;
metadata?: Record<string, string> | null;
};
export type CreditCardBillingAddress = {
line1?: string | null;
line2?: string | null;
city?: string | null;
state?: string | null;
state_code?: string | null;
postal_code?: string | null;
country?: string | null;
country_code?: string | null;
};
export type SecretCredential = {
secret_value: string;
secret_label?: string | null;
};
export const OtpType = {
Totp: "totp",
MagicLink: "magic_link",
} as const;
export type OtpType = (typeof OtpType)[keyof typeof OtpType];
export type TotpCode = {
totp_code_id: string;
totp_identifier: string | null;
code: string;
content: string;
workflow_run_id: string | null;
workflow_id: string | null;
task_id: string | null;
source: string | null;
otp_type: OtpType | null;
expired_at: string | null;
created_at: string;
modified_at: string;
};
export type TotpCodeListParams = {
totp_identifier?: string;
workflow_run_id?: string;
otp_type?: OtpType;
limit?: number;
};
export type ModelsResponse = {
models: Record<string, string>;
};
export const RunEngine = {
SkyvernV1: "skyvern-1.0",
SkyvernV2: "skyvern-2.0",
SkyvernV3: "skyvern-3.0",
OpenaiCua: "openai-cua",
AnthropicCua: "anthropic-cua",
YutoriNavigator: "yutori-navigator",
} as const;
export type RunEngine = (typeof RunEngine)[keyof typeof RunEngine];
export type PylonEmailHash = {
hash: string;
};
export type RunFeedbackTargetType =
| "workflow_run"
| "task"
| "browser_recording";
export type FeedbackRating = "up" | "down";
export type RunFeedbackApiResponse = {
run_feedback_id: string;
organization_id: string;
target_type: RunFeedbackTargetType;
target_id: string;
context_id: string | null;
rating: FeedbackRating;
reason: string | null;
needs_support: boolean;
submitted_by: string | null;
created_at: string;
modified_at: string;
};
export const BROWSER_DOWNLOAD_TIMEOUT_SECONDS = 120 as const;
// Mirrors MIN_TIMEOUT/MAX_TIMEOUT in skyvern/schemas/browser_session_timeouts.py.
export const BROWSER_SESSION_MIN_TIMEOUT_MINUTES = 5 as const;
export const BROWSER_SESSION_MAX_TIMEOUT_MINUTES = 240 as const;
export type TestLoginResponse = {
credential_id: string;
workflow_run_id: string;
status: string;
};
export type TestCredentialStatusResponse = {
credential_id: string;
workflow_run_id: string;
status:
| "created"
| "queued"
| "running"
| "completed"
| "failed"
| "timed_out"
| "terminated"
| "canceled";
failure_reason?: string | null;
browser_profile_id?: string | null;
tested_url?: string | null;
browser_profile_failure_reason?: string | null;
};