  Workflows API  This document outlines how to call the new Leap workflows API      Authenticating Your Account  To access workflows  you first need to set up an account at  https   app tryleap ai  and generate an API key  This API key must be included in your request header under the  X Api Key  key to authenticate your account      Initiating a Workflow  Workflows can be initiated by calling the run method in the SDK  or sending a  POST  request to the following endpoint      text copy https   api workflows tryleap ai v1 runs      Your request body must include the following      json copy      workflow id    123      Unique ID of the workflow you want to run    webhook url          Optional  The URL to receive notifications of workflow completion or failure    inputs          foo    bar     Inputs you want to pass to the workflow               Understanding the Workflow Run Object  Once a workflow is initiated  the API will immediately respond with a Workflow Run object   If you ve specified a  webhook url  when submitting your run  this object will also be sent in the body of a  POST  request once the workflow has completed or failed      typescript copy      id   string     Unique ID of the workflow run    version id   string     Version of the workflow being run    status    completed     running     failed      Current status of the workflow    created at   string     Date and time when the workflow was initiated    started at   string   null     Date and time when the workflow actually started  if applicable    ended at   string   null     Date and time when the workflow ended  if applicable    workflow id   string     ID of the workflow    error   string   null     Any error that occurred during the workflow  or null if the workflow completed successfully    input        Inputs used in the workflow     key  string   any         output   unknown   null     Output of the workflow  or null if the workflow failed        This document should help you navigate and access Leap s new workflows  Feel free to contact us if you encounter issues or have additional questions 

Workflows API

  Webhooks  Leap workflows currently supports two versions of webhooks  with v2 being the latest       Version 2  latest   Our v2 webhooks support defining your own output schema   This means that when catching a webhook response  the  output  object shape will match the outputs that you configure inside of your workflow            Successful Run Example       json      id    rnp OegyoGJxj9lyk4xbtQ      version id    vsp shsgJaeiT1d8H9      status    completed      created at    2023 12 30T19 35 10 428941 00 00      started at    2023 12 30T19 35 12 028968 00 00      ended at    2023 12 30T19 35 20 872681 00 00      workflow id    wkf RL2LDs8LNO4LI6      error   null     input          prompt    8k portrait of a beatiful tuxedo cat sleeping on a bed  realistic  unlreal engine 5          output          imageUrl         PXO4eirXsolvofZLy uo jpeg                    Failed Run Example        json      id    rnp dqsrbuAvpOIw1h48G2      version id    vsp vZhmfFZnF0Avb1      status    failed      created at    2023 12 30T21 49 26 994177 00 00      started at    2023 12 30T21 49 28 366564 00 00      ended at   null     workflow id    wkf RL2LDs8LNO4LI6      error    Variable  proompt  not found  Available variables to use  nproompt      input          prompt    8k portrait of a beatiful tuxedo cat sleeping on a bed  realistic  unlreal engine 5          output   null              Version 1  If you created your workflow before Dec 30 2023  your workflow is likely set to still use the v1 schema for webhooks   x20   In this version  the  output  object will contain the entire workflow context  This is often very verbose and can be hard to work with as it contains the full output of every step   It is recommended that you upgrade to webhooks version 2        Checking or Setting Webhook Version  Webhook versions are set per Workflow  This means you can have different Workflows using different versions and is something we do for backwards compatibility as we roll out changes to the webhook schema   You can view your Workflow s active webhook version or upgrade it to a newer version by visiting the Webhook Settings page     figure  img src   gitbook assets Screenshot 2023 12 30 at 1 22 13 PM png  alt     figcaption   figcaption   figure     

Webhooks

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

Run a workflow

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

Get a workflow run

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

Run a workflow in bulk

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

Get a bulk workflow run

Leap

Leap Workflows

Variables that the workflow can use globally and their values.

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

The workflow has been successfully initiated.

X-Api-Key

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

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

The ID of the workflow to be run in bulk.

Leap Support

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.

Leap Workflows API

The bulk workflow run has been successfully initiated.

bulk_run_id

The bulk run details have been successfully retrieved.

workflow_run_id

The workflow run details have been successfully retrieved.

Run a workflow

Responses

200 OK

401 Unauthorized

Authorization