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.getFolders({ ...params }) -> Skyvern.Folder[]

📝 Description

Get all folders for the organization

🔌 Usage

await client.workflows.getFolders({
    page: 1,
    page_size: 1,
    search: "search"
});

⚙️ Parameters

request: Skyvern.GetFoldersV1FoldersGetRequest

requestOptions: Workflows.RequestOptions

client.workflows.createFolder({ ...params }) -> Skyvern.Folder

📝 Description

Create a new folder to organize workflows

🔌 Usage

await client.workflows.createFolder({
    title: "title"
});

⚙️ Parameters

request: Skyvern.FolderCreate

requestOptions: Workflows.RequestOptions

client.workflows.getFolder(folderId) -> Skyvern.Folder

📝 Description

Get a specific folder by ID

🔌 Usage

await client.workflows.getFolder("fld_123");

⚙️ Parameters

folderId: string — Folder ID

requestOptions: Workflows.RequestOptions

client.workflows.updateFolder(folderId, { ...params }) -> Skyvern.Folder

📝 Description

Update a folder's title or description

🔌 Usage

await client.workflows.updateFolder("fld_123");

⚙️ Parameters

folderId: string — Folder ID

request: Skyvern.FolderUpdate

requestOptions: Workflows.RequestOptions

client.workflows.deleteFolder(folderId, { ...params }) -> Record

📝 Description

Delete a folder. Optionally delete all workflows in the folder.

🔌 Usage

await client.workflows.deleteFolder("fld_123", {
    delete_workflows: true
});

⚙️ Parameters

folderId: string — Folder ID

request: Skyvern.DeleteFolderV1FoldersFolderIdDeleteRequest

requestOptions: Workflows.RequestOptions

client.workflows.updateWorkflowFolder(workflowPermanentId, { ...params }) -> Skyvern.Workflow

📝 Description

Update a workflow's folder assignment for the latest version

🔌 Usage

await client.workflows.updateWorkflowFolder("wpid_123");

⚙️ Parameters

workflowPermanentId: string — Workflow permanent ID

request: Skyvern.UpdateWorkflowFolderRequest

requestOptions: Workflows.RequestOptions

BrowserProfiles

client.browserProfiles.listBrowserProfiles({ ...params }) -> Skyvern.BrowserProfile[]

📝 Description

Get all browser profiles for the organization

🔌 Usage

await client.browserProfiles.listBrowserProfiles({
    include_deleted: true
});

⚙️ Parameters

request: Skyvern.ListBrowserProfilesV1BrowserProfilesGetRequest

requestOptions: BrowserProfiles.RequestOptions

client.browserProfiles.createBrowserProfile({ ...params }) -> Skyvern.BrowserProfile

🔌 Usage

await client.browserProfiles.createBrowserProfile({
    name: "name"
});

⚙️ Parameters

request: Skyvern.CreateBrowserProfileRequest

requestOptions: BrowserProfiles.RequestOptions

client.browserProfiles.getBrowserProfile(profileId) -> Skyvern.BrowserProfile

📝 Description

Get a specific browser profile by ID

🔌 Usage

await client.browserProfiles.getBrowserProfile("bp_123456");

⚙️ Parameters

profileId: string — The ID of the browser profile. browser_profile_id starts with bp_

requestOptions: BrowserProfiles.RequestOptions

client.browserProfiles.deleteBrowserProfile(profileId) -> void

📝 Description

Delete a browser profile (soft delete)

🔌 Usage

await client.browserProfiles.deleteBrowserProfile("bp_123456");

⚙️ Parameters

profileId: string — The ID of the browser profile to delete. browser_profile_id starts with bp_

requestOptions: BrowserProfiles.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