Leap Workflows

The Leap Workflows API allows developers to run workflows, fetch workflow runs, and provide other utility functions related to workflow runs. Please use the X-Api-Key for authenticated requests.

Table of Contents

• Installation
• Getting Started
• Reference
  • leap.bulkWorkflowRuns.getBulk
  • leap.bulkWorkflowRuns.runBulk
  • leap.workflowRuns.getWorkflowRun
  • leap.workflowRuns.workflow

Installation

npm i @leap-ai/workflows

pnpm i @leap-ai/workflows

yarn add @leap-ai/workflows

Getting Started

import { Leap } from "@leap-ai/workflows";

const leap = new Leap({
  // Defining the base path is optional and defaults to https://api.workflows.tryleap.ai
  // basePath: "https://api.workflows.tryleap.ai",
  apiKey: "API_KEY",
});

const getBulkResponse = await leap.bulkWorkflowRuns.getBulk({
  bulkRunId: "bulkRunId_example",
});

console.log(getBulkResponse);

Reference

leap.bulkWorkflowRuns.getBulk

This endpoint retrieves the details of a specific bulk workflow run using its bulk_run_id.

🛠️ Usage

const getBulkResponse = await leap.bulkWorkflowRuns.getBulk({
  bulkRunId: "bulkRunId_example",
});

⚙️ Parameters

bulkRunId: string

The ID of the bulk run to retrieve.

🔄 Return

BulkRunSchema

🌐 Endpoint

/v1/runs/bulk/{bulk_run_id} GET

🔙 Back to Table of Contents

leap.bulkWorkflowRuns.runBulk

This endpoint lets the user run a specified workflow with the provided csv in bulk.

🛠️ Usage

const runBulkResponse = await leap.bulkWorkflowRuns.runBulk({
  workflow_id: "wkf_i3F5UjpZ2Vg",
  input_csv_url: "https://myapp.com/input.csv",
  webhook_url: "https://myapp.com/webhook",
});

⚙️ Parameters

workflow_id: string

The ID of the workflow to be run in bulk.

input_csv_url: string

A CSV file containing the input data for the bulk run. Each row should contain the input data for a single run.

webhook_url: string

The URL to which the bulk run results should be sent to on completion.

🔄 Return

BulkRunSchema

🌐 Endpoint

/v1/runs/bulk POST

🔙 Back to Table of Contents

leap.workflowRuns.getWorkflowRun

This endpoint retrieves the details of a specific workflow run using its workflow_run_id.

🛠️ Usage

const getWorkflowRunResponse = await leap.workflowRuns.getWorkflowRun({
  workflowRunId: "workflowRunId_example",
});

⚙️ Parameters

workflowRunId: string

The ID of the workflow run to retrieve.

🔄 Return

WorkflowRunSchema

🌐 Endpoint

/v1/runs/{workflow_run_id} GET

🔙 Back to Table of Contents

leap.workflowRuns.workflow

This endpoint lets the user run a specified workflow with the provided workflow definition.

🛠️ Usage

const workflowResponse = await leap.workflowRuns.workflow({
  workflow_id: "wkf_i3F5UjpZ2Vg",
  webhook_url: "https://myapp.com/webhook",
});

⚙️ Parameters

workflow_id: string

The ID of the workflow to be run.

webhook_url: string

The URL to which the workflow results should be sent to on completion.

input: { [key: string]: any; }

Variables that the workflow can use globally and their values.

🔄 Return

WorkflowRunSchema

🌐 Endpoint

/v1/runs POST

🔙 Back to Table of Contents

Author

This TypeScript package is automatically generated by Konfig