Base

This is the general endpoint for the backend

Usage

Leverage Base to easily design your API and prototype apps, UX, or screens. To experiment with different outcomes, set "cached" to false

Using /base with "cached" is equivalent to direclty calling the function after is creation, all none neccesary params will be ignored.

POST /base

Creates a new flow with one or more actions, installs dependencies, builds tests and executes the resulting code.

Actions can be agents, backend functions, or cloud functions.

Headers

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

Body

Name	Type	Required	Description
name	string		Name of the flow to summarize the actions
prompt	string		The instructions for AgentBase to transform in to code
data	object		The data example or parameters for your function to work
schedule	string		The cron calendar for the function to run automatically
return	object		The data example of your expected return
model	string		The model to run for your prompt
errors	array		List or possible errors your function needs to catch
cached	boolean		It will use the last version of the function whenever is available to save time and tokens

Response

200

{
  "run_id": 1,
  "return": {
    "message" : "message example"
  },
  "status" : {
    "code" : 5,
    "status" : "deploying tool",
    "error": null
  },
  "error": null
}

400

{
  "error": "Invalid request"
}

Body Example

{
    "function": "create_lead",
    "prompt": "create a new lead and send an email to the sales team with the info",
    "data" : {
        "email": "[email protected]",
        "subject": "subject example",
        "message": "message example"
    },
    "return" : {
        "agent_message" : {
            "type" : "string",
            "description" : "the customer success agent message"
        }
    }, 
}