Dorod-Sky/skyvern-ts/client/reference.md

Reference

client.runSdkAction({ ...params }) -> Skyvern.RunSdkActionResponse

📝 Description

Execute a single SDK action with the specified parameters

🔌 Usage

await client.runSdkAction({
    url: "url",
    action: {
        type: "ai_act"
    }
});

⚙️ Parameters

request: Skyvern.RunSdkActionRequest

requestOptions: SkyvernClient.RequestOptions

Workflows

client.workflows.setWorkflowTemplateStatus(workflowPermanentId, { ...params }) -> Record

📝 Description

Set or unset a workflow as a template.

Template status is stored at the workflow_permanent_id level (not per-version), meaning all versions of a workflow share the same template status.

🔌 Usage

await client.workflows.setWorkflowTemplateStatus("workflow_permanent_id", {
    is_template: true
});

⚙️ Parameters

workflowPermanentId: string

request: Skyvern.SetWorkflowTemplateStatusV1WorkflowsWorkflowPermanentIdTemplatePutRequest

requestOptions: Workflows.RequestOptions

Scripts

client.scripts.runScript(scriptId) -> unknown

📝 Description

Run a script

🔌 Usage

await client.scripts.runScript("s_abc123");

⚙️ Parameters

scriptId: string — The unique identifier of the script

requestOptions: Scripts.RequestOptions