Dialog Manager

The Dialog Manager is where you configure and draw your flows; Those are the methods you'll need to setup a user flow, configure each Cell and link them.

API SUBPATH: eva-dialog-manager

Flows

Pagination and Listings

Its function is to provide a list of Flow in page format

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows

Path parameters

orgUUIDstringrequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringrequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringrequired

It is the bot where the flow is, used to filter Flows

Query parameters

enabledbooleanrequired

It is the status of the flow, represents whether it is active, default value true

Example: true

pageinteger · int32required

It is the number of pages that will be returned, default value 0

Example: 1

linesPerPageinteger · int32 · default: 5required

It is the number of Flow per page, default value 5

Example: 1

orderBystring · default: namerequired

It is the flow attribute used for the page, default attribute name

directionstring · default: ASCrequired

It is the sorting type, default value ASC

searchTermsstring[]required

It is the parameter that contains the user data entry, that will be used to filter the flows

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows?enabled=true&page=0&linesPerPage=5&orderBy=name&direction=ASC&searchTerms=text'

200

400

401

403

404

409

422

500

200

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "size": 1,
      "lastModified": {
        "uuid": "text",
        "image": "text",
        "name": "text",
        "timeStamp": 1
      },
      "rules": {
        "delete": true,
        "jumped": true,
        "children": [
          "text"
        ]
      },
      "type": "USER_JOURNEY",
      "tags": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Ok

Its service is used to search a flows by name

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/quicksearch

Path parameters

orgUUIDstringrequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringrequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringrequired

It is the bot where the flow is, used to filter Flows

Query parameters

namestringrequired

It is the parameter used to search for flows related to the entered value

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/quicksearch?name=text'

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

CRUD Operations

Service responsible for creating a flow.

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows

Path parameters

orgUUIDstringrequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringrequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringrequired

It is the bot where the flow is, used to filter Flows

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

namestring

Name of the flow.

descriptionstring

Description of the flow.

typestring · enum

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

Options: USER_JOURNEY, WELCOME, NOT_EXPECTED, JUMP, DRAFT

tagsobject[]

These are the tags used in the Flow.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows' \
  --header 'Content-Type: application/json' \
  --data '{"type":"USER_JOURNEY","tags":[{}]}'

201

400

401

403

404

409

422

500

201

{
  "uuid": "text",
  "name": "text",
  "size": 1,
  "lastModified": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 1
  },
  "rules": {
    "delete": true,
    "jumped": true,
    "children": [
      "text"
    ]
  },
  "type": "USER_JOURNEY",
  "tags": [
    {
      "name": "text"
    }
  ]
}

CREATED

Its function is to find the Flow data and provide it for updating

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}

Path parameters

orgUUIDstringrequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringrequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringrequired

It is the bot where the flow is, used to filter Flows

uuidstringrequired

It is the uuid used to search for a Flow

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}'

200

400

401

403

404

409

422

500

200

{
  "name": "text",
  "description": "text",
  "uuid": "text",
  "createdBy": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 1
  },
  "rules": {
    "delete": true,
    "jumped": true,
    "children": [
      "text"
    ]
  },
  "disconnected": true,
  "jumpFrom": {},
  "type": "USER_JOURNEY",
  "tags": [
    {
      "name": "text"
    }
  ],
  "editors": [
    {
      "uuid": "text",
      "image": "text",
      "name": "text",
      "timeStamp": 1
    }
  ],
  "cellsType": [
    {
      "size": 1,
      "cellType": "text",
      "names": [
        "text"
      ]
    }
  ]
}

Ok

Service responsible for updating a flow

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}

Path parameters

orgUUIDstringrequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringrequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringrequired

It is the bot where the flow is, used to filter Flows

uuidstringrequired

It is the uuid used to search for the Flow that will be updated

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

namestring

Name of the flow.

descriptionstring

Description of the flow.

typestring · enum

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

Options: USER_JOURNEY, WELCOME, NOT_EXPECTED, JUMP, DRAFT

tagsobject[]

These are the tags used in the Flow.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}' \
  --header 'Content-Type: application/json' \
  --data '{"type":"USER_JOURNEY","tags":[{}]}'

200

400

401

403

404

409

422

500

200

{
  "uuid": "text",
  "name": "text",
  "size": 1,
  "lastModified": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 1
  },
  "rules": {
    "delete": true,
    "jumped": true,
    "children": [
      "text"
    ]
  },
  "type": "USER_JOURNEY",
  "tags": [
    {
      "name": "text"
    }
  ]
}

OK

Service responsible for updating a flow

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}

Path parameters

orgUUIDstringrequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringrequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringrequired

It is the bot where the flow is, used to filter Flows

uuidstringrequired

It is the uuid used to search for the Flow that will be deleted

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}'

204

400

401

403

404

409

422

500

204

No body

NO_CONTENT

Auxiliary Methods

Analyzes which types of Flows have already been created, and returns a list of possible types that can still be created

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/types-to-create

Path parameters

orgUUIDstringrequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringrequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringrequired

It is the bot where the flow is, used to filter Flows

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/types-to-create'

200

400

401

403

404

409

422

500

200

[
  "USER_JOURNEY"
]

Ok

Endpoint to list the flow names of one bot that have cells with the type passed as parameter

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/by-cellType

Path parameters

orgUUIDstringrequired

It is the organization uuid where the bot is

envUUIDstringrequired

It is the environment uuid where the bot is

botUUIDstringrequired

It is the identification of the bot

Query parameters

userUUIDstring

It is the user uuid is making the request

cellTypestring · enumrequired

It is the cell type to find the flow with. Possible values: ANSWER, ANYTHING_ELSE, INTENT,ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, WELCOME_MESSAGE, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END and START

Options: ANSWER, ANYTHING_ELSE, INTENT, ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END, START

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/by-cellType?cellType=ANSWER'

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

Flow Tree

Its function is to find the Flow data, containing the complete tree, rules and so on

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}/tree

Path parameters

orgUUIDstringrequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringrequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringrequired

It is the bot where the flow is, used to filter Flows

uuidstringrequired

It is the uuid used to search for a Flow

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}/tree'

200

400

401

403

404

409

422

500

200

{
  "name": "text",
  "description": "text",
  "uuid": "text",
  "createdBy": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 1
  },
  "rules": {
    "delete": true,
    "jumped": true,
    "children": [
      "text"
    ]
  },
  "disconnected": true,
  "jumpFrom": {},
  "tree": {
    "uuid": "text",
    "cellFirst": true,
    "cellParentUUID": "text",
    "buttonParentUUID": "text",
    "flowUUID": "text",
    "draftText": "text",
    "cellName": "text",
    "cellType": "text",
    "modelVersion": "text",
    "cellEnable": true,
    "expressionCode": "text",
    "objectRef": "text",
    "editor": {
      "uuid": "text",
      "lastModified": true,
      "lastEdition": 1
    },
    "jumpTo": {
      "cellDestination": "text",
      "cellDestinationName": "text",
      "flowDestination": "text",
      "flowDestinationName": "text"
    },
    "rules": {
      "connectionOnTheLeft": true,
      "connectionOnTheRight": true,
      "connectionOnTheBottom": true,
      "delete": true,
      "children": [
        "text"
      ],
      "sequence": [
        "text"
      ],
      "jump": [
        "text"
      ]
    },
    "disconnected": true,
    "executionLimit": 1,
    "hasSibling": true,
    "description": "text",
    "template": "text",
    "jumpFrom": [
      {
        "cellOrigin": "text",
        "flowOrigin": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "objectRef": "text",
        "tagTypeId": 1
      }
    ],
    "children": [
      {
        "uuid": "text",
        "cellFirst": true,
        "cellParentUUID": "text",
        "buttonParentUUID": "text",
        "flowUUID": "text",
        "draftText": "text",
        "cellName": "text",
        "cellType": "text",
        "modelVersion": "text",
        "cellEnable": true,
        "expressionCode": "text",
        "objectRef": "text",
        "editor": {
          "uuid": "text",
          "lastModified": true,
          "lastEdition": 1
        },
        "jumpTo": {
          "cellDestination": "text",
          "cellDestinationName": "text",
          "flowDestination": "text",
          "flowDestinationName": "text"
        },
        "rules": {
          "connectionOnTheLeft": true,
          "connectionOnTheRight": true,
          "connectionOnTheBottom": true,
          "delete": true,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ],
          "jump": [
            "text"
          ]
        },
        "disconnected": true,
        "executionLimit": 1,
        "hasSibling": true,
        "description": "text",
        "template": "text",
        "jumpFrom": [
          {
            "cellOrigin": "text",
            "flowOrigin": "text"
          }
        ],
        "tags": [
          {
            "name": "text",
            "objectRef": "text",
            "tagTypeId": 1
          }
        ],
        "children": [
          {
            "uuid": "text",
            "cellFirst": true,
            "cellParentUUID": "text",
            "buttonParentUUID": "text",
            "flowUUID": "text",
            "draftText": "text",
            "cellName": "text",
            "cellType": "text",
            "modelVersion": "text",
            "cellEnable": true,
            "expressionCode": "text",
            "objectRef": "text",
            "editor": {
              "uuid": "text",
              "lastModified": true,
              "lastEdition": 1
            },
            "jumpTo": {
              "cellDestination": "text",
              "cellDestinationName": "text",
              "flowDestination": "text",
              "flowDestinationName": "text"
            },
            "rules": {
              "connectionOnTheLeft": true,
              "connectionOnTheRight": true,
              "connectionOnTheBottom": true,
              "delete": true,
              "children": [
                "text"
              ],
              "sequence": [
                "text"
              ],
              "jump": [
                "text"
              ]
            },
            "disconnected": true,
            "executionLimit": 1,
            "hasSibling": true,
            "description": "text",
            "template": "text",
            "jumpFrom": [
              {
                "cellOrigin": "text",
                "flowOrigin": "text"
              }
            ],
            "tags": [
              {
                "name": "text",
                "objectRef": "text",
                "tagTypeId": 1
              }
            ],
            "children": "[Circular Reference]",
            "options": [
              {
                "buttonUUID": "text",
                "cockpitUUID": "text",
                "urlRedirect": true,
                "buttonUrl": "text",
                "buttonType": "text",
                "buttonText": "text",
                "expressionCode": "text",
                "connectedTo": "text",
                "disconnected": true,
                "rules": {
                  "connectionOnTheLeft": true,
                  "connectionOnTheRight": true,
                  "connectionOnTheBottom": true,
                  "children": [
                    "text"
                  ],
                  "sequence": [
                    "text"
                  ]
                }
              }
            ]
          }
        ],
        "options": [
          {
            "buttonUUID": "text",
            "cockpitUUID": "text",
            "urlRedirect": true,
            "buttonUrl": "text",
            "buttonType": "text",
            "buttonText": "text",
            "expressionCode": "text",
            "connectedTo": "text",
            "disconnected": true,
            "rules": {
              "connectionOnTheLeft": true,
              "connectionOnTheRight": true,
              "connectionOnTheBottom": true,
              "children": [
                "text"
              ],
              "sequence": [
                "text"
              ]
            }
          }
        ]
      }
    ],
    "options": [
      {
        "buttonUUID": "text",
        "cockpitUUID": "text",
        "urlRedirect": true,
        "buttonUrl": "text",
        "buttonType": "text",
        "buttonText": "text",
        "expressionCode": "text",
        "connectedTo": "text",
        "disconnected": true,
        "rules": {
          "connectionOnTheLeft": true,
          "connectionOnTheRight": true,
          "connectionOnTheBottom": true,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ]
        }
      }
    ]
  },
  "type": "USER_JOURNEY",
  "tags": [
    {
      "name": "text"
    }
  ],
  "editors": [
    {
      "uuid": "text",
      "image": "text",
      "name": "text",
      "timeStamp": 1
    }
  ],
  "cellsType": [
    {
      "size": 1,
      "cellType": "text",
      "names": [
        "text"
      ]
    }
  ]
}

Ok

Cells

CRUD Operations

Create new cells

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

flowUUIDstringrequired

Uuid flow to insert the new cell

cellParentUUIDstring

Uuid of the parent cell. Necessary if it is not the first cell of flow

buttonUUIDstring

Uuid of the button. Necessary if it's a service cell parent

actionstring · enum · default: CHILDREN

Type of insertion

Options: SEQUENCE, CHILDREN

Body

cellNamestringrequired

Name of the cell

descriptionstring

Description of the cell

objectRefstring

Uuid of object to relationate. It can be intent, entity, service...

expressionCodestringrequired

Expression code of the cell

jumpToobject

DTO and entity used to request create of jump cell

templatestring

Template of the cell. It's required if cell is code or rule type

executionLimitinteger · int64

Number of times that the cell has to execute repeatedly

cellTypestring · enumrequired

Type of the cell

Options: ANSWER, ANYTHING_ELSE, INTENT, ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END, START

optionsobject[]

Options of the cell. It's required if cell is service type

tagsobject[]

Tags of the cell

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells?flowUUID=text' \
  --header 'Content-Type: application/json' \
  --data '{"cellName":"text","expressionCode":"text","jumpTo":{},"cellType":"ANSWER","options":[{"buttonType":"text","buttonText":"text"}],"tags":[{}]}'

201

400

401

403

404

409

422

500

201

[
  {
    "uuid": "text",
    "cellFirst": true,
    "cellParentUUID": "text",
    "buttonParentUUID": "text",
    "flowUUID": "text",
    "draftText": "text",
    "cellName": "text",
    "cellType": "text",
    "modelVersion": "text",
    "cellEnable": true,
    "expressionCode": "text",
    "objectRef": "text",
    "editor": {
      "uuid": "text",
      "lastModified": true,
      "lastEdition": 1
    },
    "jumpTo": {
      "cellDestination": "text",
      "cellDestinationName": "text",
      "flowDestination": "text",
      "flowDestinationName": "text"
    },
    "rules": {
      "connectionOnTheLeft": true,
      "connectionOnTheRight": true,
      "connectionOnTheBottom": true,
      "delete": true,
      "children": [
        "text"
      ],
      "sequence": [
        "text"
      ],
      "jump": [
        "text"
      ]
    },
    "disconnected": true,
    "executionLimit": 1,
    "hasSibling": true,
    "description": "text",
    "template": "text",
    "jumpFrom": [
      {
        "cellOrigin": "text",
        "flowOrigin": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "objectRef": "text",
        "tagTypeId": 1
      }
    ],
    "children": [
      {
        "uuid": "text",
        "cellFirst": true,
        "cellParentUUID": "text",
        "buttonParentUUID": "text",
        "flowUUID": "text",
        "draftText": "text",
        "cellName": "text",
        "cellType": "text",
        "modelVersion": "text",
        "cellEnable": true,
        "expressionCode": "text",
        "objectRef": "text",
        "editor": {
          "uuid": "text",
          "lastModified": true,
          "lastEdition": 1
        },
        "jumpTo": {
          "cellDestination": "text",
          "cellDestinationName": "text",
          "flowDestination": "text",
          "flowDestinationName": "text"
        },
        "rules": {
          "connectionOnTheLeft": true,
          "connectionOnTheRight": true,
          "connectionOnTheBottom": true,
          "delete": true,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ],
          "jump": [
            "text"
          ]
        },
        "disconnected": true,
        "executionLimit": 1,
        "hasSibling": true,
        "description": "text",
        "template": "text",
        "jumpFrom": [
          {
            "cellOrigin": "text",
            "flowOrigin": "text"
          }
        ],
        "tags": [
          {
            "name": "text",
            "objectRef": "text",
            "tagTypeId": 1
          }
        ],
        "children": [
          {
            "uuid": "text",
            "cellFirst": true,
            "cellParentUUID": "text",
            "buttonParentUUID": "text",
            "flowUUID": "text",
            "draftText": "text",
            "cellName": "text",
            "cellType": "text",
            "modelVersion": "text",
            "cellEnable": true,
            "expressionCode": "text",
            "objectRef": "text",
            "editor": {
              "uuid": "text",
              "lastModified": true,
              "lastEdition": 1
            },
            "jumpTo": {
              "cellDestination": "text",
              "cellDestinationName": "text",
              "flowDestination": "text",
              "flowDestinationName": "text"
            },
            "rules": {
              "connectionOnTheLeft": true,
              "connectionOnTheRight": true,
              "connectionOnTheBottom": true,
              "delete": true,
              "children": [
                "text"
              ],
              "sequence": [
                "text"
              ],
              "jump": [
                "text"
              ]
            },
            "disconnected": true,
            "executionLimit": 1,
            "hasSibling": true,
            "description": "text",
            "template": "text",
            "jumpFrom": [
              {
                "cellOrigin": "text",
                "flowOrigin": "text"
              }
            ],
            "tags": [
              {
                "name": "text",
                "objectRef": "text",
                "tagTypeId": 1
              }
            ],
            "children": "[Circular Reference]",
            "options": [
              {
                "buttonUUID": "text",
                "cockpitUUID": "text",
                "urlRedirect": true,
                "buttonUrl": "text",
                "buttonType": "text",
                "buttonText": "text",
                "expressionCode": "text",
                "connectedTo": "text",
                "disconnected": true,
                "rules": {
                  "connectionOnTheLeft": true,
                  "connectionOnTheRight": true,
                  "connectionOnTheBottom": true,
                  "children": [
                    "text"
                  ],
                  "sequence": [
                    "text"
                  ]
                }
              }
            ]
          }
        ],
        "options": [
          {
            "buttonUUID": "text",
            "cockpitUUID": "text",
            "urlRedirect": true,
            "buttonUrl": "text",
            "buttonType": "text",
            "buttonText": "text",
            "expressionCode": "text",
            "connectedTo": "text",
            "disconnected": true,
            "rules": {
              "connectionOnTheLeft": true,
              "connectionOnTheRight": true,
              "connectionOnTheBottom": true,
              "children": [
                "text"
              ],
              "sequence": [
                "text"
              ]
            }
          }
        ]
      }
    ],
    "options": [
      {
        "buttonUUID": "text",
        "cockpitUUID": "text",
        "urlRedirect": true,
        "buttonUrl": "text",
        "buttonType": "text",
        "buttonText": "text",
        "expressionCode": "text",
        "connectedTo": "text",
        "disconnected": true,
        "rules": {
          "connectionOnTheLeft": true,
          "connectionOnTheRight": true,
          "connectionOnTheBottom": true,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ]
        }
      }
    ]
  }
]

Created

Search cells

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

cellUUIDstringrequired

A valid cell Uuid

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}'

200

400

401

403

404

409

422

500

200

{
  "uuid": "text",
  "cellFirst": true,
  "cellParentUUID": "text",
  "buttonParentUUID": "text",
  "flowUUID": "text",
  "draftText": "text",
  "cellName": "text",
  "cellType": "text",
  "modelVersion": "text",
  "cellEnable": true,
  "expressionCode": "text",
  "objectRef": "text",
  "editor": {
    "uuid": "text",
    "lastModified": true,
    "lastEdition": 1
  },
  "jumpTo": {
    "cellDestination": "text",
    "cellDestinationName": "text",
    "flowDestination": "text",
    "flowDestinationName": "text"
  },
  "rules": {
    "connectionOnTheLeft": true,
    "connectionOnTheRight": true,
    "connectionOnTheBottom": true,
    "delete": true,
    "children": [
      "text"
    ],
    "sequence": [
      "text"
    ],
    "jump": [
      "text"
    ]
  },
  "disconnected": true,
  "executionLimit": 1,
  "hasSibling": true,
  "description": "text",
  "template": "text",
  "jumpFrom": [
    {
      "cellOrigin": "text",
      "flowOrigin": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "objectRef": "text",
      "tagTypeId": 1
    }
  ],
  "children": [
    {
      "uuid": "text",
      "cellFirst": true,
      "cellParentUUID": "text",
      "buttonParentUUID": "text",
      "flowUUID": "text",
      "draftText": "text",
      "cellName": "text",
      "cellType": "text",
      "modelVersion": "text",
      "cellEnable": true,
      "expressionCode": "text",
      "objectRef": "text",
      "editor": {
        "uuid": "text",
        "lastModified": true,
        "lastEdition": 1
      },
      "jumpTo": {
        "cellDestination": "text",
        "cellDestinationName": "text",
        "flowDestination": "text",
        "flowDestinationName": "text"
      },
      "rules": {
        "connectionOnTheLeft": true,
        "connectionOnTheRight": true,
        "connectionOnTheBottom": true,
        "delete": true,
        "children": [
          "text"
        ],
        "sequence": [
          "text"
        ],
        "jump": [
          "text"
        ]
      },
      "disconnected": true,
      "executionLimit": 1,
      "hasSibling": true,
      "description": "text",
      "template": "text",
      "jumpFrom": [
        {
          "cellOrigin": "text",
          "flowOrigin": "text"
        }
      ],
      "tags": [
        {
          "name": "text",
          "objectRef": "text",
          "tagTypeId": 1
        }
      ],
      "children": [
        {
          "uuid": "text",
          "cellFirst": true,
          "cellParentUUID": "text",
          "buttonParentUUID": "text",
          "flowUUID": "text",
          "draftText": "text",
          "cellName": "text",
          "cellType": "text",
          "modelVersion": "text",
          "cellEnable": true,
          "expressionCode": "text",
          "objectRef": "text",
          "editor": {
            "uuid": "text",
            "lastModified": true,
            "lastEdition": 1
          },
          "jumpTo": {
            "cellDestination": "text",
            "cellDestinationName": "text",
            "flowDestination": "text",
            "flowDestinationName": "text"
          },
          "rules": {
            "connectionOnTheLeft": true,
            "connectionOnTheRight": true,
            "connectionOnTheBottom": true,
            "delete": true,
            "children": [
              "text"
            ],
            "sequence": [
              "text"
            ],
            "jump": [
              "text"
            ]
          },
          "disconnected": true,
          "executionLimit": 1,
          "hasSibling": true,
          "description": "text",
          "template": "text",
          "jumpFrom": [
            {
              "cellOrigin": "text",
              "flowOrigin": "text"
            }
          ],
          "tags": [
            {
              "name": "text",
              "objectRef": "text",
              "tagTypeId": 1
            }
          ],
          "children": "[Circular Reference]",
          "options": [
            {
              "buttonUUID": "text",
              "cockpitUUID": "text",
              "urlRedirect": true,
              "buttonUrl": "text",
              "buttonType": "text",
              "buttonText": "text",
              "expressionCode": "text",
              "connectedTo": "text",
              "disconnected": true,
              "rules": {
                "connectionOnTheLeft": true,
                "connectionOnTheRight": true,
                "connectionOnTheBottom": true,
                "children": [
                  "text"
                ],
                "sequence": [
                  "text"
                ]
              }
            }
          ]
        }
      ],
      "options": [
        {
          "buttonUUID": "text",
          "cockpitUUID": "text",
          "urlRedirect": true,
          "buttonUrl": "text",
          "buttonType": "text",
          "buttonText": "text",
          "expressionCode": "text",
          "connectedTo": "text",
          "disconnected": true,
          "rules": {
            "connectionOnTheLeft": true,
            "connectionOnTheRight": true,
            "connectionOnTheBottom": true,
            "children": [
              "text"
            ],
            "sequence": [
              "text"
            ]
          }
        }
      ]
    }
  ],
  "options": [
    {
      "buttonUUID": "text",
      "cockpitUUID": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "buttonType": "text",
      "buttonText": "text",
      "expressionCode": "text",
      "connectedTo": "text",
      "disconnected": true,
      "rules": {
        "connectionOnTheLeft": true,
        "connectionOnTheRight": true,
        "connectionOnTheBottom": true,
        "children": [
          "text"
        ],
        "sequence": [
          "text"
        ]
      }
    }
  ]
}

Ok

Update cells

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

cellUUIDstringrequired

A valid cell Uuid

Body

cellNamestringrequired

Name of the cell

descriptionstring

Description of the cell

objectRefstring

Uuid of object to relationate. It can be intent, entity, service...

expressionCodestringrequired

Expression code of the cell

cellEnablebooleanrequired

True if wants to enable cell or false if not

jumpToobject

DTO and entity used to request create of jump cell

templatestring

Template of the cell. It's required if cell is code or rule type

executionLimitinteger · int64

Number of times that the cell has to execute repeatedly

optionsobject[]

Options of the cell. It's required if cell is service type

tagsobject[]

Tags of the cell

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}' \
  --header 'Content-Type: application/json' \
  --data '{"cellName":"text","expressionCode":"text","cellEnable":true,"jumpTo":{},"options":[{"cockpitUUID":"text","urlRedirect":true,"buttonUrl":"text","buttonType":"text","buttonText":"text"}],"tags":[{}]}'

204

400

401

403

404

409

422

500

204

No body

No Content

Update cells

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

cellUUIDstringrequired

A valid cell Uuid

Query parameters

deleteInCascadeboolean · default: true

True if wants to delete all children of the cell. False if wants to delete only the cell and converting it to Placeholder type

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}'

204

400

401

403

404

409

422

500

204

No body

No Content

Auxiliary Methods

Valid the template of cell

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/template/validate

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

cellTypestring · enumrequired

Type of cell to list

Options: ANSWER, ANYTHING_ELSE, INTENT, ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END, START

Body

templatestring

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/template/validate?cellType=ANSWER' \
  --header 'Content-Type: application/json'

200

400

401

403

404

409

422

500

200

{
  "valid": true,
  "message": "text"
}

Ok

List all cells of a bot by the type passed in parameter

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

cellTypestring · enumrequired

Type of cell to list

Options: ANSWER, ANYTHING_ELSE, INTENT, ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END, START

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type?cellType=ANSWER'

200

400

401

403

404

409

422

500

200

[
  {
    "objectRef": "text",
    "cellType": "text"
  }
]

Ok

List all objectRef of cells that are the first cell of any flow in one bot

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/start-flows

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

cellTypestring · enumrequired

Type of cell to list

Options: ANSWER, ANYTHING_ELSE, INTENT, ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END, START

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/start-flows?cellType=ANSWER'

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

List all buttons of service cell

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/buttons

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

cellTypestring · enumrequired

Type of cell to list

Options: ANSWER, ANYTHING_ELSE, INTENT, ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END, START

objectRefstringrequired

Id of the object intent, entity, service...

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/buttons?cellType=ANSWER&objectRef=text'

200

400

401

403

404

409

422

500

200

[
  {
    "buttonUUID": "text",
    "cockpitUUID": "text",
    "urlRedirect": true,
    "buttonUrl": "text",
    "buttonType": "text",
    "buttonText": "text",
    "expressionCode": "text",
    "connectedTo": "text"
  }
]

Ok

List all cells informing if can be connected left, bottom or right

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

uuidstringrequired

A valid cell Uuid

directionstring · enumrequired

Direction that wants to know the possible connections. It can be left, bottom or right

Options: LEFT, RIGHT, BOTTOM

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection?uuid=text&direction=LEFT'

200

400

401

403

404

409

422

500

200

[
  {
    "uuid": "text",
    "connectionOnTheLeft": true,
    "connectionOnTheRight": true,
    "connectionOnTheBottom": true
  }
]

Ok

List all flows that is possible to jump

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/jump

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

flowUUIDstringrequired

A valid flow Uuid

cellParentUUIDstringrequired

Uuid of the parent cell

actionstring · enum · default: CHILDREN

Type of insertion

Options: SEQUENCE, CHILDREN

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/jump?flowUUID=text&cellParentUUID=text'

200

400

401

403

404

409

422

500

200

[
  {
    "uuid": "text",
    "name": "text",
    "enabled": true,
    "error": "text",
    "type": "USER_JOURNEY"
  }
]

Ok

Massive update

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/massive

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

cellTypestring · enumrequired

Type of cell to update

Options: ANSWER, ANYTHING_ELSE, INTENT, ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END, START

objectRefstringrequired

Id of the object (intent, entity, service...

Body

cellNamestringrequired

Name of the cell

descriptionstring

Description of the cell

expressionCodestringrequired

Expression code of the cell

cellEnablebooleanrequired

True if wants to enable cell or false if not

executionLimitinteger · int64

Number of times that the cell has to execute repeatedly

templatestring

Template of the cell, in this case is used to rest connector cell

optionsobject[]

Options of the cell. It's required if cell is service type

tagsobject[]

Tags of the cell

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/massive?cellType=ANSWER&objectRef=text' \
  --header 'Content-Type: application/json' \
  --data '{"cellName":"text","expressionCode":"text","cellEnable":true,"options":[{"cockpitUUID":"text","urlRedirect":true,"buttonUrl":"text","buttonType":"text","buttonText":"text"}],"tags":[{}]}'

204

400

401

403

404

409

422

500

204

No body

No Content

Connect cells

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

cellOriginstringrequired

UUID of origin cell to connect

cellDestinationstringrequired

UUID of destination cell to connect

buttonUUIDstringrequired

UUID of button to connect if is service cell

directionstring · enumrequired

Direction that wants to know the possible connections. It can be left, bottom or right

Options: LEFT, RIGHT, BOTTOM

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection?cellOrigin=text&cellDestination=text&buttonUUID=&direction=LEFT'

204

400

401

403

404

409

422

500

204

No body

No Content

Change visibility of one cell

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/change-visibility

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

botIdstringrequired

Uuid of the bot

objectRefstringrequired

Uuid of object to relationate. It can be intent, entity, service...

visibilitybooleanrequired

true if you want to make visible, false if not

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/change-visibility' \
  --header 'Content-Type: application/json' \
  --data '{"botId":"text","objectRef":"text","visibility":true}'

204

400

401

403

404

409

422

500

204

No body

No Content

Remove cells by its type

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

cellTypestring · enumrequired

Type of cell to remove

Options: ANSWER, ANYTHING_ELSE, INTENT, ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END, START

objectRefstringrequired

Id of the object (intent, entity, service...

deleteInCascadeboolean

True if wants to delete all children of the cell. False if wants to delete only the cell and converting it to Placeholder type

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type?cellType=ANSWER&objectRef=text'

204

400

401

403

404

409

422

500

204

No body

No Content