  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   alpha 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      Understanding Actions  When building a workflow on Leap you can create different types of actions  actions are essentially integrations on top of services which allow you to call each service with full flexibility while still benefiting   Currently Leap supports OpenAi  Astria  and Replicate   The schema for each of the services follows the following structure       json copy      pathParams          key    string          queryParams          key    string          body          key    string number array object             Most services only require passing  body  into the object  and Leap handles setting the rest   Depending on the service you choose  you may also need or want to provide  pathParams  or  queryParams    We purposefully keep this interface low level to give you flexibility when interacting with services as these are constantly updated      The Http Utility  If you want to call a service outside of the ones that Leap provides  you will likely resort to the  HTTP Utility  action  This action enables you to call any HTTP endpoint you wish   The interface is very similar to actions  but with the addition of the  url  and  method  and  headers  options       json copy      url    someapp com api      method    POST      headers          key    string          pathParams          key    string          queryParams          key    string          body          key    string number array object                On Service Webhooks  Its important to note that if a service accepts a webhook in the aciton body  e g  Replicate   Leap workflows makes use of this value  And will ignore your value override it regardless of what you pass in the  body    This is because webhooks need for the Leap engine to be aware of job completions  If you d like to retrieve results  simply provide your  webhook url  when calling the Leap SDK or API  and not as part of step configurations  

Workflows API

  Leap Services  This document outlines the parameters to pass into Leap Services in workflows      SDXL Parameters       prompt      str  or  List str    optional   The prompt or prompts to guide the image generation       prompt 2      str  or  List str    optional   Secondary prompts for tokenizer 2 and text encoder 2       height      int   optional   The height in pixels of the generated image  defaults to 1024       width      int   optional   The width in pixels of the generated image  defaults to 1024       num inference steps      int   optional   The number of denoising steps  defaults to 50       denoising end      float   optional   Fraction of the denoising process to be completed  between 0 0 and 1 0       guidance scale      float   optional   Classifier Free Diffusion Guidance scale  defaults to 5 0   Use with caution  high values can significantly affect image quality        negative prompt      str  or  List str    optional   Prompts not to guide the image generation       negative prompt 2      str  or  List str    optional   Secondary set of negative prompts       num images per prompt      int   optional   The number of images to generate per prompt  defaults to 1       eta      float   optional   DDIM scheduler parameter  defaults to 0 0   Adjust carefully as this may impact the generation process        latents      torch FloatTensor   optional   Pre generated noisy latents for image generation   Using custom latents can yield unpredictable results        prompt embeds      torch FloatTensor   optional   Pre generated text embeddings       negative prompt embeds      torch FloatTensor   optional   Pre generated negative text embeddings       pooled prompt embeds      torch FloatTensor   optional   Pre generated pooled text embeddings       negative pooled prompt embeds      torch FloatTensor   optional   Pre generated negative pooled text embeddings       guidance rescale      float   optional   Guidance rescale factor  defaults to 0 0   Use with caution  may impact image fidelity        crops coords top left      Tuple int    optional   Coordinates for cropping the image  defaults to  0  0        target size      Tuple int    optional   The target size of the generated image  defaults to  1024  1024        negative original size      Tuple int    optional   Negative conditioning based on image resolution   Use at your own risk  this can alter generation logic        negative crops coords top left      Tuple int    optional   Negative conditioning based on crop coordinates   Use at your own risk  this can alter generation logic        negative target size      Tuple int    optional   Negative conditioning based on target image resolution   Use at your own risk  this can alter generation logic        callback on step end      Callable   optional   Function called at the end of each denoising step   This is an advanced feature that may affect the generation process        callback on step end tensor inputs      List   optional   Tensor inputs for the  callback on step end  function   This should be used with a thorough understanding of the tensors involved        Example Body    json      body          prompt    A fantasy landscape with mountains      The text prompt for image generation      height   1024     Height of the generated image in pixels      width   1024     Width of the generated image in pixels      num inference steps   50     Number of denoising steps      negative prompt    No urban elements      Negative prompt to avoid certain elements      num images per prompt   1    Number of images to generate per prompt            Other advanced parameters if you wish to pass them in               Musicgen Parameters       prompt      str    Text to guide the music generation       duration      int   optional   Duration of the generated music piece  defaults to 10 seconds   This has a maximum of 60 seconds        format      str   optional   The format of the generated music  defaults to  wav        melody      str   optional   Melodic guide for the music generation       Example Body     json      body          prompt    A serene and peaceful melody      The text prompt for music generation      duration   10     Duration of the generated music piece in seconds      format    wav     Format of the generated music            Other advanced parameters if you wish to pass them in          

Leap Services

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

Leap

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

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

workflow_run_id

The workflow run details have been successfully retrieved.

Run a workflow

Responses

200 OK

401 Unauthorized

Authorization