import {z} from 'zod' export type GetApiV1RunsRunIdArgs = {run_id: string}; export type GetApiV1RunsRunIdOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const runStatus = z.enum(["created", "queued", "running", "paused", "timed_out", "failed", "terminated", "completed", "canceled"]); export const fileInfo = z.object({url: z.string(), checksum: z.string().nullable().optional(), filename: z.string().nullable().optional(), file_size: z.number().int().nullable().optional(), modified_at: z.string().nullable().optional(), artifact_id: z.string().nullable().optional()}); export const scriptRunResponse = z.object({ai_fallback_triggered: z.boolean().optional(), script_id: z.string().nullable().optional(), script_revision_id: z.string().nullable().optional()}); export const runEngine = z.enum(["skyvern-1.0", "skyvern-2.0", "skyvern-3.0", "openai-cua", "anthropic-cua", "ui-tars"]); export const proxyLocation = z.enum(["RESIDENTIAL", "US-CA", "US-NY", "US-TX", "US-FL", "US-WA", "RESIDENTIAL_ES", "RESIDENTIAL_IE", "RESIDENTIAL_GB", "RESIDENTIAL_IN", "RESIDENTIAL_JP", "RESIDENTIAL_FR", "RESIDENTIAL_DE", "RESIDENTIAL_NZ", "RESIDENTIAL_ZA", "RESIDENTIAL_AR", "RESIDENTIAL_AU", "RESIDENTIAL_BR", "RESIDENTIAL_TR", "RESIDENTIAL_CA", "RESIDENTIAL_MX", "RESIDENTIAL_IT", "RESIDENTIAL_NL", "RESIDENTIAL_PH", "RESIDENTIAL_KR", "RESIDENTIAL_SA", "RESIDENTIAL_ISP", "NONE"]); export const geoTarget = z.object({country: z.string().min(2).max(2), subdivision: z.string().max(10).nullable().optional(), city: z.string().max(100).nullable().optional(), isISP: z.boolean().optional()}); export const taskRunRequestOutput = z.object({prompt: z.string(), url: z.string().nullable().optional(), engine: runEngine.optional(), title: z.string().nullable().optional(), proxy_location: z.union([proxyLocation, geoTarget, z.record(z.string(), z.unknown())]).nullable().optional(), data_extraction_schema: z.union([z.record(z.string(), z.unknown()), z.array(z.unknown()), z.string()]).nullable().optional(), error_code_mapping: z.record(z.string(), z.string()).nullable().optional(), max_steps: z.number().int().nullable().optional(), webhook_url: z.string().nullable().optional(), totp_identifier: z.string().nullable().optional(), totp_url: z.string().nullable().optional(), browser_session_id: z.string().nullable().optional(), browser_profile_id: z.string().nullable().optional(), start_fresh_browser: z.boolean().optional(), model: z.record(z.string(), z.unknown()).nullable().optional(), extra_http_headers: z.record(z.string(), z.string()).nullable().optional(), cdp_connect_headers: z.record(z.string(), z.string()).nullable().optional(), publish_workflow: z.boolean().optional(), include_action_history_in_verification: z.boolean().nullable().optional(), max_screenshot_scrolls: z.number().int().nullable().optional(), browser_address: z.string().nullable().optional(), run_with: z.string().nullable().optional(), file_ids: z.array(z.string()).nullable().optional()}); export const taskRunResponse = z.object({run_id: z.string(), status: runStatus, output: z.union([z.record(z.string(), z.unknown()), z.array(z.unknown()), z.string()]).nullable().optional(), downloaded_files: z.array(fileInfo).nullable().optional(), recording_url: z.string().nullable().optional(), recording_archived: z.boolean().optional(), screenshot_urls: z.array(z.string()).nullable().optional(), failure_reason: z.string().nullable().optional(), created_at: z.string(), modified_at: z.string(), queued_at: z.string().nullable().optional(), started_at: z.string().nullable().optional(), finished_at: z.string().nullable().optional(), app_url: z.string().nullable().optional(), browser_session_id: z.string().nullable().optional(), browser_profile_id: z.string().nullable().optional(), max_screenshot_scrolls: z.number().int().nullable().optional(), script_run: scriptRunResponse.nullable().optional(), errors: z.array(z.record(z.string(), z.unknown())).nullable().optional(), step_count: z.number().int().nullable().optional(), run_type: z.enum(["task_v1", "task_v2", "task_v3", "openai_cua", "anthropic_cua", "ui_tars"]), run_request: taskRunRequestOutput.nullable().optional()}); export const workflowRunAttempt = z.object({attempt_number: z.number().int(), status: runStatus, failure_reason: z.string().nullable().optional(), error_codes: z.array(z.string()).optional(), started_at: z.string().nullable().optional(), finished_at: z.string().nullable().optional(), retry_decision: z.string().nullable().optional(), decision_reason: z.string().nullable().optional(), next_attempt_at: z.string().nullable().optional(), webhook_sent_at: z.string().nullable().optional()}); export const browserSeedSource = z.enum(["override", "picked", "own_memory", "credential", "fresh", "degraded_fresh"]); export const browserSettingsSource = z.enum(["workflow_version", "session_request", "existing_session"]); export const browserSettingsStatus = z.enum(["verified", "mismatch", "unapplied", "unknown"]); export const browserSettingsReceipt = z.object({requested_timezone_id: z.string(), actual_timezone_id: z.string().nullable().optional(), source: browserSettingsSource, status: browserSettingsStatus, warning: z.string().nullable().optional()}); export const workflowRunRequestOutput = z.object({workflow_id: z.string(), parameters: z.record(z.string(), z.unknown()).nullable().optional(), title: z.string().nullable().optional(), proxy_location: z.union([proxyLocation, geoTarget, z.record(z.string(), z.unknown())]).nullable().optional(), webhook_url: z.string().nullable().optional(), totp_url: z.string().nullable().optional(), totp_identifier: z.string().nullable().optional(), browser_session_id: z.string().nullable().optional(), reuse_browser_session: z.boolean().nullable().optional(), browser_profile_id: z.string().nullable().optional(), start_fresh_browser: z.boolean().optional(), max_screenshot_scrolls: z.number().int().nullable().optional(), max_elapsed_time_minutes: z.number().int().gte(1).lte(480).nullable().optional(), extra_http_headers: z.record(z.string(), z.string()).nullable().optional(), cdp_connect_headers: z.record(z.string(), z.string()).nullable().optional(), browser_address: z.string().nullable().optional(), ai_fallback: z.boolean().nullable().optional(), run_with: z.string().nullable().optional(), browser_type: z.string().nullable().optional(), run_metadata: z.record(z.string(), z.string()).nullable().optional(), file_ids: z.array(z.string()).nullable().optional()}); export const workflowRunResponse = z.object({run_id: z.string(), status: runStatus, output: z.union([z.record(z.string(), z.unknown()), z.array(z.unknown()), z.string()]).nullable().optional(), downloaded_files: z.array(fileInfo).nullable().optional(), recording_url: z.string().nullable().optional(), recording_archived: z.boolean().optional(), screenshot_urls: z.array(z.string()).nullable().optional(), failure_reason: z.string().nullable().optional(), created_at: z.string(), modified_at: z.string(), queued_at: z.string().nullable().optional(), started_at: z.string().nullable().optional(), finished_at: z.string().nullable().optional(), app_url: z.string().nullable().optional(), browser_session_id: z.string().nullable().optional(), browser_profile_id: z.string().nullable().optional(), max_screenshot_scrolls: z.number().int().nullable().optional(), script_run: scriptRunResponse.nullable().optional(), errors: z.array(z.record(z.string(), z.unknown())).nullable().optional(), step_count: z.number().int().nullable().optional(), run_type: z.literal("workflow_run"), attempt: z.number().int().optional(), retry_pending: z.boolean().optional(), next_attempt_at: z.string().nullable().optional(), attempts: z.array(workflowRunAttempt).optional(), run_with: z.string().optional(), ai_fallback: z.boolean().nullable().optional(), script_id: z.string().nullable().optional(), browser_seed_source: browserSeedSource.nullable().optional(), browser_settings_receipt: browserSettingsReceipt.nullable().optional(), run_request: workflowRunRequestOutput.nullable().optional()}); export const getApiV1RunsRunIdResponse = z.discriminatedUnion("run_type", [taskRunResponse, workflowRunResponse]); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get run info by id * * GET /v1/runs/{run_id} */ export const getApiV1RunsRunId = async (args: GetApiV1RunsRunIdArgs, options?: GetApiV1RunsRunIdOptions) => { const {baseUrl = "https://api.skyvern.com", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("x-api-key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v1/runs/${encodeURIComponent(String(args.run_id))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiV1RunsRunIdResponse, await res.json()) };