Automated Learning

The Automated Learning API contains methods for both it's related models: Documents, which contains the text to perform them, and Questions, which are assigned to Documents.

API SUBPATH: eva-al

Documents

Pagination and Listing

Returns the pagination of a Bot's Documents. Pagination starts at page 1 instead of the standard 0.

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

pageinteger · int32 · default: 1optional

The number of page and the default is 1

Example: 1

linesPerPageinteger · int32 · default: 5optional

The number of services per pages and the default is 5

Example: 1

orderBystring · default: "updatedAt"optional

Field want to ordernate, the default is 'updatedAt'

directionstring · default: "DESC"optional

Direction of ordenation, ASC or DESC. The default is DESC

searchTermsstring[]optional

Names or tags to filter the search

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination'

200

400

401

403

404

409

422

500

200

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "storageFileName": "text",
      "filename": "text",
      "questions": 1,
      "questionsIds": [
        "text"
      ],
      "enabled": true,
      "selected": true,
      "date": 1,
      "uploaded": {
        "uuid": "text",
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "number": 1,
  "empty": true
}

Ok

Returns a list of possible words to autocomplete in a search for Document names

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

searchTermstringrequired

Word or part of word to get suggestion names of documents

limitinteger · int64 · default: 6optional

The limit of suggestions names in the response. The default value is 6

Example: 1

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

Returns a complete list containing all of the Bot's Documents

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/list'

200

400

401

403

404

409

422

500

200

[
  {
    "uuid": "text",
    "filename": "text",
    "storageFileName": "text",
    "questionSize": 1,
    "questions": [
      {
        "name": "text",
        "questionVariables": [
          {
            "id": "text",
            "variable": "text"
          }
        ],
        "enabled": true,
        "removed": true,
        "updatedAt": "2025-04-02T06:35:12.612Z"
      }
    ],
    "enabled": true,
    "removed": true,
    "updatedAt": "2025-04-02T06:35:12.612Z",
    "trainingStatus": "text"
  }
]

Ok

CRUD Operations

Retrieves information from a specific Document, provided its UUID.

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

documentUUIDstringrequired

A valid service Uuid

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}'

200

400

401

403

404

409

422

500

200

{
  "filename": "text",
  "content": "text",
  "enabled": true,
  "lastEdition": {
    "name": "text",
    "image": "text",
    "date": 1
  },
  "questionCount": 1,
  "questionsIds": [
    "text"
  ]
}

Ok

Uploads a new document

post

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

documentstring · binaryrequired

The txt document to upload

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents' \
  --header 'Content-Type: application/json' \
  --data '{
    "document": "binary"
  }'

201

400

401

403

404

409

422

500

201

{
  "uuid": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": true
}

Created

Enable or disables a Document. All questions whose UUID are provided also have their enabling set by the sent value.

put

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

documentUUIDstringrequired

A valid service Uuid

Body

enabledbooleanoptional

questionIdsstring[]optional

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true,
    "questionIds": [
      "text"
    ]
  }'

204

400

401

403

404

409

422

500

204

No body

No content

Removes a Document from the Bot

delete

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

documentUUIDstringrequired

A valid document Uuid

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

204

400

401

403

404

409

422

500

204

No body

No Content

Bulk Operations

Bulk removes Documents with the provided uuid list.

delete

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]optional

A list of Uuid of question

Responses

application/json

*/*

*/*

*/*

application/json

*/*

*/*

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "uuids": [
      "text"
    ]
  }'

200

400

401

403

404

409

422

500

200

{
  "success": [
    "text"
  ],
  "errors": [
    "text"
  ]
}

Ok

Exports more than one document

post

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]optional

A list of Uuid of question

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export' \
  --header 'Content-Type: application/json' \
  --data '{
    "uuids": [
      "text"
    ]
  }'

200

400

401

403

404

409

422

500

200

[
  "Ynl0ZXM="
]

Ok

Questions

Paginations and Listings

Returns the pagination of a Bot's Questions. Pagination starts at page 1 instead of the standard 0.

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

pageinteger · int32 · default: 1optional

The number of page and the default is 1

Example: 1

linesPerPageinteger · int32 · default: 5optional

The number of services per pages and the default is 5

Example: 1

orderBystring · default: "updatedAt"optional

Field want to ordernate, the default is 'updatedAt'

directionstring · default: "DESC"optional

Direction of ordenation, ASC or DESC. The default is DESC

filenamesstring[]optional

Filename to filter the search

searchTermsstring[]optional

Names or tags to filter the search

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination'

200

400

401

403

404

409

422

500

200

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "variables": 1,
      "document": {
        "uuid": "text",
        "storageFilename": "text",
        "filename": "text",
        "enabled": true
      },
      "enabled": true,
      "selected": true,
      "lastModified": {
        "name": "text",
        "image": "text",
        "date": 1
      },
      "tags": [
        "text"
      ],
      "updatedAt": "2025-04-02T06:35:12.612Z"
    }
  ],
  "number": 1,
  "empty": true
}

Ok

Returns a list of possible words to autocomplete in a search for Question names

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

searchTermstringrequired

Word or part of word to get suggestion names of documents

limitinteger · int64 · default: 6optional

The limit of suggestions names in the response. The default value is 6

Example: 1

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

CRUD Operations

Retrieves information from a specific Question, provided its UUID.

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

questionUUIDstringrequired

A valid question Uuid

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}'

201

400

401

403

404

409

422

500

201

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "evaluable": true,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "createdAt": "2025-04-02T06:35:12.612Z",
  "updatedAt": "2025-04-02T06:35:12.612Z",
  "updatedBy": "text"
}

Created

Create a brand new Question

post

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

documentIdstringrequired

A Uuid of a document assigned to this question.

namestringrequired

Question name

descriptionstringoptional

Question descrciption

variablesstring[]optional

List of examples of question

enabledbooleanrequired

Question enabled/disabled status

evaluablebooleanoptional

Question evaluable status

transactionalbooleanoptional

Question transactional status

webhookstringoptional

Webhook address endpoint

headersobjectoptional

Webhook headers

answerTemplatesobject[]required

Questions answer templates

tagsobject[]optional

Questions tags

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions' \
  --header 'Content-Type: application/json' \
  --data '{
    "documentId": "text",
    "name": "text",
    "description": "text",
    "variables": [
      "text"
    ],
    "enabled": true,
    "evaluable": true,
    "transactional": true,
    "webhook": "text",
    "headers": {},
    "answerTemplates": [
      {
        "id": "text",
        "content": {},
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "tags": [
      {
        "name": "text"
      }
    ]
  }'

201

400

401

403

404

409

422

500

201

{
  "questionId": "text"
}

Created

Updates a Question.

put

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

questionUUIDstringrequired

A valid question Uuid

Body

documentIdstringrequired

A Uuid of a document assigned to this question.

namestringrequired

Question name

descriptionstringoptional

Question descrciption

variablesstring[]optional

List of examples of question

enabledbooleanrequired

Question enabled/disabled status

evaluablebooleanoptional

Question evaluable status

transactionalbooleanoptional

Question transactional status

webhookstringoptional

Webhook address endpoint

headersobjectoptional

Webhook headers

answerTemplatesobject[]required

Questions answer templates

tagsobject[]optional

Questions tags

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}' \
  --header 'Content-Type: application/json' \
  --data '{
    "documentId": "text",
    "name": "text",
    "description": "text",
    "variables": [
      "text"
    ],
    "enabled": true,
    "evaluable": true,
    "transactional": true,
    "webhook": "text",
    "headers": {},
    "answerTemplates": [
      {
        "id": "text",
        "content": {},
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "tags": [
      {
        "name": "text"
      }
    ]
  }'

200

400

401

403

404

409

422

500

200

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "evaluable": true,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "createdAt": "2025-04-02T06:35:12.612Z",
  "updatedAt": "2025-04-02T06:35:12.612Z",
  "updatedBy": "text"
}

Ok

Deletes a Question. The question is symbolically removed via the 'removed' parameter rather than deleted from the database.

delete

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]optional

A list of Uuid of question

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions' \
  --header 'Content-Type: application/json' \
  --data '{
    "uuids": [
      "text"
    ]
  }'

200

400

401

403

404

409

422

500

200

{
  "success": [
    "text"
  ],
  "errors": [
    "text"
  ]
}

No Content

Auxiliary Methods

Validate sample availability. This endpoint returns if a variable/sample for the question is not previously registered and still available. Variables sent through the Create Question endpoint should be validated here beforehand. The Question Creation endpoint will not inform you the cause of the error it will throw otherwise.

post

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

variablestringoptional

Example of the question

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable' \
  --header 'Content-Type: application/json' \
  --data '{
    "variable": "text"
  }'

200

400

401

403

404

409

422

500

200

[
  {
    "id": "text",
    "variable": "text"
  }
]

Ok

Bulk enables or disables Questions. All questions included whose UUID are included in the body have their enabling field reversed.

put

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

questionsIdsstring[]optional

List the questions ids

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable' \
  --header 'Content-Type: application/json' \
  --data '{
    "questionsIds": [
      "text"
    ]
  }'

204

400

401

403

404

409

422

500

204

No body

No Content

Automated Learning

Endpoint to enable or disable the Automated Learning in a bot. This change has no effect unless the bot's corresponding environment also has this feature enabled.

put

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

valuebooleanrequired

Parameter's value

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-learning/change-bot-enable' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": true
  }'

200

400

401

403

404

409

422

500

200

No body

Ok