Update Copy to cURL buttons to reference the new Runs API spec (#3765)
Co-authored-by: Shuchang Zheng <wintonzheng0325@gmail.com>
This commit is contained in:
79
skyvern-frontend/src/util/taskRunPayload.ts
Normal file
79
skyvern-frontend/src/util/taskRunPayload.ts
Normal file
@@ -0,0 +1,79 @@
|
||||
import type { CreateTaskRequest, ProxyLocation } from "@/api/types";
|
||||
|
||||
type TaskRunPayload = {
|
||||
prompt: string;
|
||||
url?: string | null;
|
||||
proxy_location?: ProxyLocation | null;
|
||||
data_extraction_schema?: CreateTaskRequest["extracted_information_schema"];
|
||||
error_code_mapping?: Record<string, string> | null;
|
||||
extra_http_headers?: Record<string, string> | null;
|
||||
webhook_url?: string | null;
|
||||
totp_identifier?: string | null;
|
||||
browser_address?: string | null;
|
||||
include_action_history_in_verification?: boolean | null;
|
||||
max_screenshot_scrolls?: number | null;
|
||||
title?: string | null;
|
||||
};
|
||||
|
||||
// Helper to trim and check for empty strings
|
||||
const trim = (s: string | null | undefined): string | undefined => {
|
||||
const t = s?.trim();
|
||||
return t && t.length > 0 ? t : undefined;
|
||||
};
|
||||
|
||||
// Build prompt from navigation_goal + data_extraction_goal
|
||||
function buildPrompt(request: CreateTaskRequest): string {
|
||||
const nav = trim(request.navigation_goal);
|
||||
const extract = trim(request.data_extraction_goal);
|
||||
|
||||
const parts = [nav, extract].filter(Boolean);
|
||||
if (parts.length > 0) return parts.join("\n\n");
|
||||
|
||||
// Fallback chain: try title, then goals again, then url, then default
|
||||
return (
|
||||
trim(request.title) ??
|
||||
nav ??
|
||||
extract ??
|
||||
trim(request.url) ??
|
||||
"Task run triggered from Skyvern UI"
|
||||
);
|
||||
}
|
||||
|
||||
function isValidRecord(val: unknown): val is Record<string, string> {
|
||||
return val != null && typeof val === "object" && !Array.isArray(val);
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a CreateTaskRequest (old schema) to TaskRunPayload (Runs API v2 schema).
|
||||
*
|
||||
* Key transformations:
|
||||
* - navigation_goal + data_extraction_goal → prompt (combined)
|
||||
* - extracted_information_schema → data_extraction_schema
|
||||
* - webhook_callback_url → webhook_url
|
||||
*
|
||||
* Note: max_steps is optional and can be added manually to the cURL if needed.
|
||||
*/
|
||||
function buildTaskRunPayload(request: CreateTaskRequest): TaskRunPayload {
|
||||
return {
|
||||
prompt: buildPrompt(request),
|
||||
url: trim(request.url) ?? null,
|
||||
proxy_location: request.proxy_location ?? null,
|
||||
data_extraction_schema: request.extracted_information_schema,
|
||||
webhook_url: trim(request.webhook_callback_url),
|
||||
totp_identifier: trim(request.totp_identifier),
|
||||
browser_address: trim(request.browser_address),
|
||||
include_action_history_in_verification:
|
||||
request.include_action_history_in_verification,
|
||||
max_screenshot_scrolls: request.max_screenshot_scrolls,
|
||||
title: trim(request.title),
|
||||
extra_http_headers: isValidRecord(request.extra_http_headers)
|
||||
? request.extra_http_headers
|
||||
: undefined,
|
||||
error_code_mapping: isValidRecord(request.error_code_mapping)
|
||||
? request.error_code_mapping
|
||||
: undefined,
|
||||
};
|
||||
}
|
||||
|
||||
export type { TaskRunPayload };
|
||||
export { buildTaskRunPayload };
|
||||
Reference in New Issue
Block a user