import {z} from 'zod' export type GetApiV1RunsRunIdTimelineArgs = {run_id: string, 'x-api-key'?: (string | null) | undefined}; export type GetApiV1RunsRunIdTimelineOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const workflowRunTimelineType = z.enum(["thought", "block"]); export const blockType = z.enum(["task", "task_v2", "for_loop", "while_loop", "conditional", "code", "text_prompt", "download_to_s3", "upload_to_s3", "file_upload", "send_email", "file_url_parser", "validation", "action", "navigation", "extraction", "login", "wait", "file_download", "goto_url", "pdf_parser", "http_request", "web_search", "human_interaction", "print_page", "workflow_trigger", "google_sheets_read", "google_sheets_write", "pdf_fill", "split_pdf", "email_inbox", "data_export", "terminate"]); export const runEngine = z.enum(["skyvern-1.0", "skyvern-2.0", "skyvern-3.0", "openai-cua", "anthropic-cua", "ui-tars"]); export const actionType = z.enum(["click", "input_text", "paste_text", "upload_file", "download_file", "select_option", "checkbox", "wait", "hover", "null_action", "solve_captcha", "terminate", "complete", "reload_page", "close_page", "new_tab", "switch_tab", "extract", "verification_code", "goto_url", "go_back", "go_forward", "scroll", "keypress", "move", "drag", "left_mouse", "execute_js"]); export const actionStatus = z.enum(["pending", "skipped", "failed", "completed"]); export const userDefinedError = z.object({error_code: z.string(), reasoning: z.string(), confidence_float: z.number().gte(0).lte(1), error_type: z.literal("USER_DEFINED_ERROR").optional()}); export const inputOrSelectContext = z.object({intention: z.string().nullable().optional(), field: z.string().nullable().optional(), is_required: z.boolean().nullable().optional(), is_search_bar: z.boolean().nullable().optional(), is_location_input: z.boolean().nullable().optional(), is_date_related: z.boolean().nullable().optional(), date_format: z.string().nullable().optional(), is_text_captcha: z.boolean().nullable().optional()}); export const selectOption = z.object({label: z.string().nullable().optional(), value: z.string().nullable().optional(), index: z.number().int().nullable().optional()}); export const clickContext = z.object({thought: z.string().nullable().optional(), single_option_click: z.boolean().nullable().optional(), desired_state: z.boolean().nullable().optional()}); export const action = z.object({action_type: actionType, status: actionStatus.optional(), action_id: z.string().nullable().optional(), source_action_id: z.string().nullable().optional(), organization_id: z.string().nullable().optional(), workflow_run_id: z.string().nullable().optional(), task_id: z.string().nullable().optional(), step_id: z.string().nullable().optional(), step_order: z.number().int().nullable().optional(), action_order: z.number().int().nullable().optional(), confidence_float: z.number().nullable().optional(), description: z.string().nullable().optional(), reasoning: z.string().nullable().optional(), intention: z.string().nullable().optional(), response: z.string().nullable().optional(), element_id: z.string().nullable().optional(), skyvern_element_hash: z.string().nullable().optional(), skyvern_element_data: z.record(z.string(), z.unknown()).nullable().optional(), screenshot_artifact_id: z.string().nullable().optional(), tool_call_id: z.string().nullable().optional(), xpath: z.string().nullable().optional(), errors: z.array(userDefinedError).nullable().optional(), terminal_user_errors: z.boolean().optional(), data_extraction_goal: z.string().nullable().optional(), output: z.union([z.record(z.string(), z.unknown()), z.array(z.unknown()), z.string()]).nullable().optional(), file_name: z.string().nullable().optional(), file_url: z.string().nullable().optional(), download: z.boolean().nullable().optional(), download_triggered: z.boolean().nullable().optional(), downloaded_files: z.array(z.string()).nullable().optional(), is_upload_file_tag: z.boolean().nullable().optional(), text: z.string().nullable().optional(), input_or_select_context: inputOrSelectContext.nullable().optional(), option: selectOption.nullable().optional(), is_checked: z.boolean().nullable().optional(), verified: z.boolean().optional(), click_context: clickContext.nullable().optional(), totp_timing_info: z.record(z.string(), z.unknown()).nullable().optional(), has_mini_agent: z.boolean().nullable().optional(), skip_auto_complete_tab: z.boolean().optional(), started_at: z.string().nullable().optional(), finished_at: z.string().nullable().optional(), created_at: z.string().nullable().optional(), modified_at: z.string().nullable().optional(), created_by: 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 workflowRunBlock = z.object({workflow_run_block_id: z.string(), block_workflow_run_id: z.string().nullable().optional(), workflow_run_id: z.string(), attempt_number: z.number().int().nullable().optional(), organization_id: z.string(), description: z.string().nullable().optional(), parent_workflow_run_block_id: z.string().nullable().optional(), block_type: blockType, label: z.string().nullable().optional(), status: z.string().nullable().optional(), output: z.union([z.record(z.string(), z.unknown()), z.array(z.unknown()), z.string()]).nullable().optional(), continue_on_failure: z.boolean().optional(), failure_reason: z.string().nullable().optional(), error_codes: z.array(z.string()).optional(), engine: runEngine.nullable().optional(), task_id: z.string().nullable().optional(), url: z.string().nullable().optional(), final_url: z.string().nullable().optional(), finish_reason: z.string().nullable().optional(), navigation_goal: z.string().nullable().optional(), navigation_payload: z.union([z.record(z.string(), z.unknown()), z.array(z.unknown()), z.string()]).nullable().optional(), data_extraction_goal: z.string().nullable().optional(), data_schema: z.union([z.record(z.string(), z.unknown()), z.array(z.unknown()), z.string()]).nullable().optional(), terminate_criterion: z.string().nullable().optional(), complete_criterion: z.string().nullable().optional(), actions: z.array(action).optional(), created_at: z.string(), modified_at: z.string(), include_action_history_in_verification: z.boolean().nullable().optional(), include_extracted_text: z.boolean().optional(), duration: z.number().nullable().optional(), loop_values: z.array(z.unknown()).nullable().optional(), current_value: z.string().nullable().optional(), current_index: z.number().int().nullable().optional(), recipients: z.array(z.string()).nullable().optional(), attachments: z.array(z.string()).nullable().optional(), subject: z.string().nullable().optional(), body: z.string().nullable().optional(), prompt: z.string().nullable().optional(), instructions: z.string().nullable().optional(), positive_descriptor: z.string().nullable().optional(), negative_descriptor: z.string().nullable().optional(), executed_branch_id: z.string().nullable().optional(), executed_branch_expression: z.string().nullable().optional(), executed_branch_result: z.boolean().nullable().optional(), executed_branch_next_block: z.string().nullable().optional(), script_run: scriptRunResponse.nullable().optional(), downloaded_file_count: z.number().int().nullable().optional()}); export const thoughtType = z.enum(["plan", "metadata", "user_goal_check", "internal_plan", "failure_describe", "termination"]); export const thoughtScenario = z.enum(["generate_plan", "user_goal_check", "failure_describe", "summarization", "generate_metadata", "extract_loop_values", "generate_task_in_loop", "generate_general_task", "termination"]); export const thought = z.object({thought_id: z.string(), task_id: z.string(), organization_id: z.string(), workflow_run_id: z.string().nullable().optional(), workflow_run_block_id: z.string().nullable().optional(), workflow_id: z.string().nullable().optional(), workflow_permanent_id: z.string().nullable().optional(), user_input: z.string().nullable().optional(), observation: z.string().nullable().optional(), thought: z.string().nullable().optional(), answer: z.string().nullable().optional(), thought_type: thoughtType.nullable().optional(), thought_scenario: thoughtScenario.nullable().optional(), output: z.record(z.string(), z.unknown()).nullable().optional(), input_token_count: z.number().int().nullable().optional(), output_token_count: z.number().int().nullable().optional(), reasoning_token_count: z.number().int().nullable().optional(), cached_token_count: z.number().int().nullable().optional(), thought_cost: z.number().nullable().optional(), last_llm_model: z.string().nullable().optional(), created_at: z.string(), modified_at: z.string()}); export const workflowRunTimeline: z.ZodType = z.object({type: workflowRunTimelineType, attempt: z.number().int().optional(), block: workflowRunBlock.nullable().optional(), thought: thought.nullable().optional(), children: z.array(z.lazy(() => workflowRunTimeline)).optional(), created_at: z.string(), modified_at: z.string()}); export const getApiV1RunsRunIdTimelineResponse = z.array(workflowRunTimeline); 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 timeline * * GET /v1/runs/{run_id}/timeline */ export const getApiV1RunsRunIdTimeline = async (args: GetApiV1RunsRunIdTimelineArgs, options?: GetApiV1RunsRunIdTimelineOptions) => { const {baseUrl = "https://api.skyvern.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['x-api-key'] != null) headers.set("x-api-key", String(args['x-api-key'])) const url = `${baseUrl.replace(/\/+$/, '')}/v1/runs/${encodeURIComponent(String(args.run_id))}/timeline${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(getApiV1RunsRunIdTimelineResponse, await res.json()) };