api-fixed.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Leap Workflows API",
    "description": "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.",
    "version": "1.0",
    "contact": {
      "name": "Leap Support",
      "url": "https://tryleap.ai/",
      "email": "help@tryleap.ai"
    },
    "termsOfService": "https://app.getterms.io/view/dlM8u/tos/en-us"
  },
  "servers": [
    {
      "description": "Base API Server",
      "url": "https://api.workflows.tryleap.ai"
    }
  ],
  "tags": [
    {
      "description": "Endpoints related to workflow run operations",
      "name": "Workflow Runs"
    },
    {
      "description": "Endpoints related to bulk workflow run operations",
      "name": "Bulk Workflow Runs"
    }
  ],
  "paths": {
    "/v1/runs": {
      "post": {
        "tags": [
          "Workflow Runs"
        ],
        "summary": "Run a workflow",
        "operationId": "run_workflow",
        "security": [
          {
            "api_key": [
            ]
          }
        ],
        "description": "This endpoint lets the user run a specified workflow with the provided workflow definition.",
        "parameters": [
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RunWorkflowSchema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The workflow has been successfully initiated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkflowRunSchema"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized."
          }
        }
      }
    },
    "/v1/runs/{workflow_run_id}": {
      "get": {
        "tags": [
          "Workflow Runs"
        ],
        "summary": "Get a workflow run",
        "operationId": "WorkflowRuns_getWorkflowRun",
        "security": [
          {
            "api_key": [
            ]
          }
        ],
        "description": "This endpoint retrieves the details of a specific workflow run using its `workflow_run_id`.",
        "parameters": [
          {
            "description": "The ID of the workflow run to retrieve.",
            "name": "workflow_run_id",
            "required": true,
            "in": "path",
            "example": "rnp_x3p27VQk6MyJfLe",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The workflow run details have been successfully retrieved.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkflowRunSchema"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized."
          }
        }
      }
    },
    "/v1/runs/bulk": {
      "post": {
        "tags": [
          "Bulk Workflow Runs"
        ],
        "summary": "Run a workflow in bulk",
        "operationId": "BulkWorkflowRuns_runBulk",
        "security": [
          {
            "api_key": [
            ]
          }
        ],
        "description": "This endpoint lets the user run a specified workflow with the provided csv in bulk.",
        "parameters": [
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RunBulkWorkflowSchema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The bulk workflow run has been successfully initiated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkRunSchema"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized."
          }
        }
      }
    },
    "/v1/runs/bulk/{bulk_run_id}": {
      "get": {
        "tags": [
          "Bulk Workflow Runs"
        ],
        "summary": "Get a bulk workflow run",
        "operationId": "BulkWorkflowRuns_getBulk",
        "security": [
          {
            "api_key": [
            ]
          }
        ],
        "description": "This endpoint retrieves the details of a specific bulk workflow run using its `bulk_run_id`.",
        "parameters": [
          {
            "description": "The ID of the bulk run to retrieve.",
            "name": "bulk_run_id",
            "required": true,
            "in": "path",
            "example": "bulk_9Nmenl7rxIu2FiSsnqNyTe9G",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The bulk run details have been successfully retrieved.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkRunSchema"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Key"
      }
    },
    "schemas": {
      "RunWorkflowSchema": {
        "type": "object",
        "properties": {
          "workflow_id": {
            "description": "The ID of the workflow to be run.",
            "type": "string",
            "format": "",
            "example": "wkf_i3F5UjpZ2Vg"
          },
          "webhook_url": {
            "description": "The URL to which the workflow results should be sent to on completion.",
            "type": "string",
            "example": "https://myapp.com/webhook"
          },
          "input": {
            "description": "Variables that the workflow can use globally and their values.",
            "type": "object",
            "additionalProperties": true,
            "example": {
              "first_name": "Sam",
              "last_name": "Altman"
            }
          }
        },
        "required": [
          "workflow_id"
        ]
      },
      "WorkflowRunSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "version_id": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "completed",
              "running",
              "failed",
              "queued",
              "cancelled"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "started_at": {
            "type": "string",
            "nullable": true,
            "default": null
          },
          "ended_at": {
            "type": "string",
            "nullable": true,
            "default": null
          },
          "workflow_id": {
            "type": "string"
          },
          "error": {
            "type": "string",
            "nullable": true,
            "default": null
          },
          "input": {
            "type": "object",
            "nullable": true,
            "default": null
          },
          "output": {
            "type": "object",
            "nullable": true,
            "default": null
          }
        },
        "required": [
          "id",
          "version_id",
          "status",
          "created_at",
          "started_at",
          "ended_at",
          "workflow_id",
          "error",
          "input",
          "output"
        ]
      },
      "RunBulkWorkflowSchema": {
        "type": "object",
        "properties": {
          "workflow_id": {
            "description": "The ID of the workflow to be run in bulk.",
            "type": "string",
            "format": "",
            "example": "wkf_i3F5UjpZ2Vg"
          },
          "input_csv_url": {
            "description": "A CSV file containing the input data for the bulk run. Each row should contain the input data for a single run.",
            "type": "string",
            "format": "",
            "example": "https://myapp.com/input.csv"
          },
          "webhook_url": {
            "description": "The URL to which the bulk run results should be sent to on completion.",
            "type": "string",
            "example": "https://myapp.com/webhook"
          }
        },
        "required": [
          "workflow_id",
          "input_csv_url"
        ]
      },
      "BulkRunSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "version_id": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "completed",
              "running",
              "failed",
              "queued",
              "cancelled"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "workflow_id": {
            "type": "string"
          },
          "input_csv_url": {
            "type": "string"
          },
          "output_csv_url": {
            "type": "string",
            "nullable": true,
            "default": null
          },
          "error": {
            "type": "string",
            "nullable": true,
            "default": null
          },
          "row_count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "version_id",
          "status",
          "created_at",
          "workflow_id",
          "input_csv_url",
          "output_csv_url",
          "error",
          "row_count"
        ]
      }
    }
  }
}