Knowledge AI

The Knowledge AI (former 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

Returnig a pagination list of bot's documents

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

pageinteger · int32 · default: 1

The number of page and the default is 1

Example: 1

linesPerPageinteger · int32 · default: 5

The number of services per pages and the default is 5

Example: 1

orderBystring · default: updatedAt

Field want to ordernate, the default is 'updatedAt'

directionstring · default: DESC

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

searchTermsstring[]

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": {
    "unpaged": true,
    "pageSize": 1,
    "paged": true,
    "pageNumber": 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",
      "storageFileName": "text",
      "filename": "text",
      "collectionUUID": "text",
      "questions": 1,
      "enabled": true,
      "selected": true,
      "date": 1,
      "uploaded": {
        "uuid": "text",
        "name": "text",
        "imageUrl": "text"
      },
      "format": "text",
      "questionsIds": [
        "text"
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

Ok

Returning a list of possible words to autocomplete in search

get

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

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: 6

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

Returnig a pagination list of bot's documents

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/list

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",
    "collectionUUID": "text",
    "questionSize": 1,
    "enabled": true,
    "removed": true,
    "updatedAt": "2025-02-21T18:16:44.676Z",
    "trainingStatus": "text",
    "format": "text"
  }
]

Ok

CRUD Operations

Upload new document

post

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

tagstring[]

The tag name to save with document

Body

documentstring · binaryrequired

The document to upload

namestring

The document name to save

collectionUUIDstring

Optional. Symbolic collectionUUID for document organizing.

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":"text"}'

201

400

401

403

404

409

422

500

201

{
  "uuid": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": true,
  "tags": [
    "text"
  ]
}

Created

Show a document

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}

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
  },
  "collectionUUID": "text",
  "questionCount": 1,
  "format": "text",
  "questionsIds": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ]
}

Ok

Update one document, the file document or the data (name, tags...)

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}/update

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.

documentUUIDstringrequired

It is the identification of the document

Query parameters

tagstring[]

The tag name to save with document

Body

documentstring · binary

It is the new file to update

namestringrequired

It is the new document name to update

collectionUUIDstring

Optional. Symbolic collectionUUID for document organizing. Sending this as null will overwrite existing repository Id.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}/update' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"name":"text"}'

200

400

401

403

404

409

422

500

200

{
  "uuid": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": true,
  "tags": [
    "text"
  ]
}

Ok

Enable or disable document

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

documentUUIDstringrequired

A valid service Uuid

Body

enabledboolean

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}' \
  --header 'Content-Type: application/json'

200

204

400

401

403

404

409

422

500

200

No body

OK

Remove document

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}

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

Exports more than one document

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]

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":[null]}'

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

Bulk removes Documents with the provided uuid list.

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]

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":[null]}'

200

400

401

403

404

409

422

500

200

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

Ok

Questions

Paginations and Listings

Returnig a pagination list of bot's questions

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

pageinteger · int32 · default: 1

The number of page and the default is 1

Example: 1

linesPerPageinteger · int32 · default: 5

The number of services per pages and the default is 5

Example: 1

orderBystring · default: updatedAt

Field want to ordernate, the default is 'updatedAt'

directionstring · default: DESC

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

filenamesstring[]

Filename to filter the search

searchTermsstring[]

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": {
    "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": [
    {
      "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
      },
      "updatedAt": "2025-02-21T18:16:44.676Z",
      "tags": [
        "text"
      ]
    }
  ]
}

Ok

Returning a list of possible words to autocomplete in search

get

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

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: 6

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

Create a brand new Question

post

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

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

descriptionstring

Question descrciption

enabledbooleanrequired

Question enabled/disabled status

evaluableboolean

Question evaluable status

transactionalboolean

Question transactional status

webhookstring

Webhook address endpoint

headersobject

Webhook headers

variablesstring[]

List of examples of question

answerTemplatesobject[]required

Questions answer templates

tagsobject[]

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","enabled":true,"headers":{},"variables":[null],"answerTemplates":[{"content":{},"channelTypeId":1,"channelId":"text"}],"tags":[{"name":"text"}]}'

201

400

401

403

404

409

422

500

201

{
  "questionId": "text"
}

Created

Retrieve info a specific given question

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}

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}'

200

201

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",
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "updateContent": true,
  "evaluable": true,
  "createdAt": "2025-02-21T18:16:44.676Z",
  "updatedAt": "2025-02-21T18:16:44.676Z",
  "updatedBy": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ]
}

OK

Updates an question

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}

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

descriptionstring

Question descrciption

enabledbooleanrequired

Question enabled/disabled status

evaluableboolean

Question evaluable status

transactionalboolean

Question transactional status

webhookstring

Webhook address endpoint

headersobject

Webhook headers

variablesstring[]

List of examples of question

answerTemplatesobject[]required

Questions answer templates

tagsobject[]

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","enabled":true,"headers":{},"variables":[null],"answerTemplates":[{"content":{},"channelTypeId":1,"channelId":"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",
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "updateContent": true,
  "evaluable": true,
  "createdAt": "2025-02-21T18:16:44.676Z",
  "updatedAt": "2025-02-21T18:16:44.676Z",
  "updatedBy": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ]
}

Ok

Delete an question. The question is disabled via the 'removed' parameter rather than deleted from the DB

delete

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]

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":[null]}'

200

400

401

403

404

409

422

500

200

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

No Content

Auxiliary Methods

Validate examples

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

variablestring

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'

200

400

401

403

404

409

422

500

200

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

Ok

Enable and disable questions

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

questionsIdsstring[]

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":[null]}'

204

400

401

403

404

409

422

500

204

No body

No Content

Knowledge AI

Return all limits to upload documents

get

/org/{orgUUID}/env/{envUUID}/documents/limits

Path parameters

orgUUIDstringrequired

It is the id that represents an organization.

envUUIDstringrequired

It is the id that represents an environment.

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}/documents/limits'

200

400

401

403

404

409

422

500

200

{
  "size": {
    "txt": 1,
    "pdf": 1
  },
  "textSize": {
    "txt": "text",
    "pdf": "text"
  },
  "page": {
    "pdf": 1
  },
  "limit": 1
}

Ok