Flow

A flow is a process with a sequence of agents and functions

Overview

A flow consists of actions that are either a Function or an Agent, arranged in a specific sequence.

Usage

After a flow is created on /base, you can call the flow with /flow/flow-name

POST /flow

The return, data, logs and code of the function can be passed around through different agents trough the agent sequence you decide.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Required	Description
name	string		Name of the function
data	object		The data example or parameters for your function to work
version	number		The version of the function to execute
bearer_token	string		Auth0 user session token to validate and ACL to database

Response

200

{
  "run_id": 1,
  "return": {
    "message" : "message example"
  },
  "error": null
}

400

{
  "error": "Invalid request"
}

//body example
{
    "name": "create_lead"
    "data" : {
        "email": "[email protected]"
        "subject": "subject example"
        "message": "message example"
    }
}