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

Collections

Pagination and Listing

Get paginated collections

get

Path parameters

orgUUIDstringRequired

Organization UUID

envUUIDstringRequired

Environment UUID

botUUIDstringRequired

Bot UUID

Query parameters

pageinteger · int32Optional

Page number

Default: 1Example: 1

linesPerPageinteger · int32Optional

Lines per page

Default: 5Example: 5

orderBystringOptional

Order by field

Default: updatedAt

directionstringOptional

Sorting direction

Default: DESC

searchTermstringOptional

Optional search term

Header parameters

x-request-idstringOptional

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

Responses

200

application/json

Data Transfer Object for collection pagination

uuidstringOptional

Unique identifier for the collection

namestringOptional

Name of the collection

isDefaultbooleanOptional

A boolean indicating if this collection is default or not

documentCountinteger · int32Optional

Count of documents in the collection

questionCountinteger · int32Optional

Count of questions in the collection

updateAtinteger · int64Optional

Timestamp of the last update (in milliseconds)

trainingStatusstringOptional

Training status of the collection

400

Bad Request

*/*

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

application/json

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/pagination HTTP/1.1
Accept: */*

{
  "uuid": "text",
  "name": "text",
  "isDefault": true,
  "documentCount": 1,
  "questionCount": 1,
  "updateAt": 1,
  "trainingStatus": "text",
  "user": {
    "uuid": "text",
    "name": "text",
    "imageUrl": "text"
  },
  "agents": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

List all collections

get

Path parameters

orgUUIDstringRequired

Organization UUID

envUUIDstringRequired

Environment UUID

botUUIDstringRequired

Bot UUID

Header parameters

x-request-idstringOptional

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

Responses

200

application/json

DTO for a list of collections.

400

Bad Request

*/*

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

application/json

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/list HTTP/1.1
Accept: */*

{
  "collections": [
    {
      "uuid": "text",
      "name": "text",
      "trainingStatus": "text"
    }
  ]
}

Quick search for collection names

get

Path parameters

orgUUIDstringRequired

Organization UUID

envUUIDstringRequired

Environment UUID

botUUIDstringRequired

Bot UUID

Query parameters

searchTermstringRequired

Search term

limitinteger · int64Optional

Limit for results

Default: 6Example: 6

Header parameters

x-request-idstringOptional

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

Responses

200

application/json

string[]Optional

400

Bad Request

*/*

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

application/json

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/quicksearch?searchTerm=text HTTP/1.1
Accept: */*

[
  "text"
]

CRUD Operations

Create a new collection

post

Path parameters

orgUUIDstringRequired

Organization UUID

envUUIDstringRequired

Environment UUID

botUUIDstringRequired

Bot UUID

Header parameters

x-request-idstringOptional

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

Body

Data Transfer Object for Collection Requests

namestring · max: 100Required

Name of the collection

descriptionstring · max: 250Optional

Description of the collection

previousUserInputinteger · int32 · max: 5Required

Previous user input rating

thresholdinteger · int32 · min: 1 · max: 100Required

Threshold value

topKinteger · int32 · min: 1 · max: 10Required

Top K value for results

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2462

{
  "name": "text",
  "description": "text",
  "searchType": {
    "type": "text",
    "semanticWeight": 1,
    "fullTextWeight": 1,
    "weights": {
      "uuid": "text",
      "botUuid": "text",
      "name": "text",
      "description": "text",
      "isDefault": true,
      "semanticWeight": 1,
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1,
      "trainingStatus": "text",
      "removed": true,
      "createdAt": "2026-04-02T08:42:56.982Z",
      "createdBy": "text",
      "updatedAt": "2026-04-02T08:42:56.982Z",
      "updatedBy": "text",
      "documents": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ],
      "documentsNotRemoved": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ]
    }
  },
  "previousUserInput": 1,
  "threshold": 1,
  "topK": 1
}

{
  "name": "text",
  "description": "text",
  "searchType": {
    "type": "text",
    "semanticWeight": 1,
    "fullTextWeight": 1,
    "weights": {
      "uuid": "text",
      "botUuid": "text",
      "name": "text",
      "description": "text",
      "isDefault": true,
      "semanticWeight": 1,
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1,
      "trainingStatus": "text",
      "removed": true,
      "createdAt": "2026-04-02T08:42:56.982Z",
      "createdBy": "text",
      "updatedAt": "2026-04-02T08:42:56.982Z",
      "updatedBy": "text",
      "documents": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ],
      "documentsNotRemoved": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ]
    }
  },
  "previousUserInput": 1,
  "threshold": 1,
  "topK": 1,
  "uuid": "text",
  "isDefault": true,
  "documentCount": 1
}

Find a specific collection

get

Path parameters

orgUUIDstringRequired

Organization UUID

envUUIDstringRequired

Environment UUID

botUUIDstringRequired

Bot UUID

collectionUUIDstringRequired

Collection UUID

Header parameters

x-request-idstringOptional

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

Responses

200

application/json

DTO for Collection response

namestring · max: 100Required

Name of the collection

descriptionstring · max: 250Optional

Description of the collection

previousUserInputinteger · int32 · max: 5Required

Previous user input rating

thresholdinteger · int32 · min: 1 · max: 100Required

Threshold value

topKinteger · int32 · min: 1 · max: 10Required

Top K value for results

uuidstringOptional

Universal Unique Identifier for the collection

isDefaultbooleanOptional

A boolean indicating if this collection is default or not

documentCountinteger · int32Optional

Count of documents in the collection

400

Bad Request

*/*

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

application/json

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID}

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID} HTTP/1.1
Accept: */*

{
  "name": "text",
  "description": "text",
  "searchType": {
    "type": "text",
    "semanticWeight": 1,
    "fullTextWeight": 1,
    "weights": {
      "uuid": "text",
      "botUuid": "text",
      "name": "text",
      "description": "text",
      "isDefault": true,
      "semanticWeight": 1,
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1,
      "trainingStatus": "text",
      "removed": true,
      "createdAt": "2026-04-02T08:42:56.982Z",
      "createdBy": "text",
      "updatedAt": "2026-04-02T08:42:56.982Z",
      "updatedBy": "text",
      "documents": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ],
      "documentsNotRemoved": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ]
    }
  },
  "previousUserInput": 1,
  "threshold": 1,
  "topK": 1,
  "uuid": "text",
  "isDefault": true,
  "documentCount": 1
}

Update a specific collection

put

Path parameters

orgUUIDstringRequired

Organization UUID

envUUIDstringRequired

Environment UUID

botUUIDstringRequired

Bot UUID

collectionUUIDstringRequired

Collection UUID

Header parameters

x-request-idstringOptional

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

Body

Data Transfer Object for Collection Requests

namestring · max: 100Required

Name of the collection

descriptionstring · max: 250Optional

Description of the collection

previousUserInputinteger · int32 · max: 5Required

Previous user input rating

thresholdinteger · int32 · min: 1 · max: 100Required

Threshold value

topKinteger · int32 · min: 1 · max: 10Required

Top K value for results

Responses

200

application/json

DTO for Collection response

namestring · max: 100Required

Name of the collection

descriptionstring · max: 250Optional

Description of the collection

previousUserInputinteger · int32 · max: 5Required

Previous user input rating

thresholdinteger · int32 · min: 1 · max: 100Required

Threshold value

topKinteger · int32 · min: 1 · max: 10Required

Top K value for results

uuidstringOptional

Universal Unique Identifier for the collection

isDefaultbooleanOptional

A boolean indicating if this collection is default or not

documentCountinteger · int32Optional

Count of documents in the collection

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID}

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2462

{
  "name": "text",
  "description": "text",
  "searchType": {
    "type": "text",
    "semanticWeight": 1,
    "fullTextWeight": 1,
    "weights": {
      "uuid": "text",
      "botUuid": "text",
      "name": "text",
      "description": "text",
      "isDefault": true,
      "semanticWeight": 1,
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1,
      "trainingStatus": "text",
      "removed": true,
      "createdAt": "2026-04-02T08:42:56.982Z",
      "createdBy": "text",
      "updatedAt": "2026-04-02T08:42:56.982Z",
      "updatedBy": "text",
      "documents": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ],
      "documentsNotRemoved": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ]
    }
  },
  "previousUserInput": 1,
  "threshold": 1,
  "topK": 1
}

{
  "name": "text",
  "description": "text",
  "searchType": {
    "type": "text",
    "semanticWeight": 1,
    "fullTextWeight": 1,
    "weights": {
      "uuid": "text",
      "botUuid": "text",
      "name": "text",
      "description": "text",
      "isDefault": true,
      "semanticWeight": 1,
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1,
      "trainingStatus": "text",
      "removed": true,
      "createdAt": "2026-04-02T08:42:56.982Z",
      "createdBy": "text",
      "updatedAt": "2026-04-02T08:42:56.982Z",
      "updatedBy": "text",
      "documents": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ],
      "documentsNotRemoved": [
        {
          "uuid": "text",
          "botUuid": "text",
          "collection": {
            "uuid": "text",
            "botUuid": "text",
            "name": "text",
            "description": "text",
            "isDefault": true,
            "semanticWeight": 1,
            "previousUserInput": 1,
            "threshold": 1,
            "topK": 1,
            "trainingStatus": "text",
            "removed": true,
            "createdAt": "2026-04-02T08:42:56.982Z",
            "createdBy": "text",
            "updatedAt": "2026-04-02T08:42:56.982Z",
            "updatedBy": "text",
            "documents": "[Circular Reference]",
            "documentsNotRemoved": "[Circular Reference]"
          },
          "format": {
            "id": 1,
            "format": "text",
            "description": "text",
            "pdf": true
          },
          "storageFilename": "text",
          "trainingStatus": "text",
          "filename": "text",
          "windowsLength": 1,
          "overlap": 1,
          "enabled": true,
          "removed": true,
          "createdBy": "text",
          "updatedBy": "text",
          "createdAt": "2026-04-02T08:42:56.982Z",
          "updatedAt": "2026-04-02T08:42:56.982Z",
          "questions": [
            "[Circular Reference]"
          ],
          "questionsSize": 1,
          "formatText": "text",
          "deleted": true,
          "toUpdateCollection": true,
          "toRegister": true,
          "toDelete": true,
          "questionsNotRemoved": [
            "[Circular Reference]"
          ],
          "formatId": 1,
          "registered": true,
          "active": true
        }
      ]
    }
  },
  "previousUserInput": 1,
  "threshold": 1,
  "topK": 1,
  "uuid": "text",
  "isDefault": true,
  "documentCount": 1
}

Delete a specific collection

delete

Path parameters

orgUUIDstringRequired

Organization UUID

envUUIDstringRequired

Environment UUID

botUUIDstringRequired

Bot UUID

collectionUUIDstringRequired

Collection UUID

Header parameters

x-request-idstringOptional

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

Responses

200

application/json

Represents a simple collection DTO with uuid and name.

uuidstringOptional

Universally Unique Identifier for the collection.

namestringRequired

Name of the collection.

trainingStatusstringOptional

Collection current status

400

Bad Request

*/*

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

application/json

delete

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID}

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID} HTTP/1.1
Accept: */*

{
  "uuid": "text",
  "name": "text",
  "trainingStatus": "text"
}

Auxiliary Methods

Validate collection name

post

Path parameters

orgUUIDstringRequired

Organization UUID

envUUIDstringRequired

Environment UUID

botUUIDstringRequired

Bot UUID

Header parameters

x-request-idstringOptional

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

Body

Represents a simple collection DTO with uuid and name.

uuidstringOptional

Universally Unique Identifier for the collection.

namestringRequired

Name of the collection.

trainingStatusstringOptional

Collection current status

Responses

204

No Content

400

Bad Request

*/*

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

application/json

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/validation-name

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/validation-name HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "uuid": "text",
  "name": "text",
  "trainingStatus": "text"
}

No content

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

collectionUUIDstringOptional

Optional collection UUID

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

linesPerPageinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt

directionstringOptional

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

Default: DESC

searchTermsstring[]Optional

Names or tags to filter the search

Responses

200

*/*

totalPagesinteger · int32Optional

totalElementsinteger · int64Optional

numberOfElementsinteger · int32Optional

firstbooleanOptional

lastbooleanOptional

sizeinteger · int32Optional

numberinteger · int32Optional

emptybooleanOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination HTTP/1.1
Accept: */*

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

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

collectionUUIDstringOptional

Optional collection UUID

searchTermstringRequired

Word or part of word to get suggestion names of documents

limitinteger · int64Optional

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

Default: 6Example: 1

Responses

200

*/*

string[]Optional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/quicksearch?searchTerm=text HTTP/1.1
Accept: */*

[
  "text"
]

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

Query parameters

collectionUUIDstringOptional

Optional collection UUID

Responses

200

*/*

DTO response with documents data

uuidstringOptional

Document uuid

filenamestringOptional

Document name

storageFileNamestringOptional

Document storage filename

collectionUUIDstringOptional

Optional. Symbolic collectionUUID for document organizing

windowsLengthinteger · int32Optional

Length of windows used in processing

overlapinteger · int32Optional

Overlap value for document processing

questionSizeinteger · int32Optional

Number of questions

enabledbooleanOptional

Document enabled

removedbooleanOptional

Document removed

updatedAtstring · date-timeOptional

Date of last document update

trainingStatusstringOptional

Document training status

formatstringOptional

Format of the document. The possibles is inside enum DocumentFormat

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/list HTTP/1.1
Accept: */*

[
  {
    "uuid": "text",
    "filename": "text",
    "storageFileName": "text",
    "collectionUUID": "text",
    "windowsLength": 1,
    "overlap": 1,
    "questionSize": 1,
    "enabled": true,
    "removed": true,
    "updatedAt": "2026-04-02T08:42:56.982Z",
    "trainingStatus": "text",
    "format": "text"
  }
]

CRUD Operations

Upload new document

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

windowsLengthinteger · int32Optional

The length of windows for document processing, default value is 2000

overlapinteger · int32Optional

The overlap length for document processing, default value is 0

tagstring[]Optional

The tag name to save with document

Body

documentstring · binaryRequired

The document to upload

namestringOptional

The document name to save

collectionUUIDstringOptional

Optional. Symbolic collectionUUID for document organizing.

Responses

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 59

{
  "document": "binary",
  "name": "text",
  "collectionUUID": "text"
}

{
  "uuid": "text",
  "collectionUUID": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": true,
  "windowsLength": 1,
  "overlap": 1,
  "tags": [
    "text"
  ]
}

Show a document

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

documentUUIDstringRequired

A valid service Uuid

Responses

200

*/*

DTO document content response

filenamestringOptional

Document name

enabledbooleanOptional

Document enabled

collectionUUIDstringOptional

Optional. Symbolic collectionUUID for document organizing.

windowsLengthinteger · int32Optional

Length of windows used in processing

overlapinteger · int32Optional

Overlap value for document processing

questionCountinteger · int32Optional

Number of questions

questionsIdsstring[]Optional

Question uuids inside the document

formatstringOptional

Format of the document. The possibles is inside enum DocumentFormat

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Accept: */*

{
  "filename": "text",
  "enabled": true,
  "lastEdition": {
    "name": "text",
    "image": "text",
    "date": 1
  },
  "collectionUUID": "text",
  "windowsLength": 1,
  "overlap": 1,
  "questionCount": 1,
  "questionsIds": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "format": "text"
}

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

put

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

windowsLengthinteger · int32Optional

The length of windows for document processing, default value is 2000

overlapinteger · int32Optional

The overlap length for document processing, default value is 0

tagstring[]Optional

The tag name to save with document

Body

documentstring · binaryOptional

It is the new file to update

namestringRequired

It is the new document name to update

collectionUUIDstringOptional

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

Responses

200

*/*

DTO response with document created with tags

uuidstringOptional

Document uuid

collectionUUIDstringOptional

Collection uuid for the document

storageFilenamestringOptional

Filename in minio

filenamestringOptional

Filename in database

enabledbooleanOptional

True if document is enabled and false if not

windowsLengthinteger · int32Optional

Length of windows used in processing

overlapinteger · int32Optional

Overlap value for document processing

tagsstring[]Optional

Tags saved to the document

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}/update HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 59

{
  "document": "binary",
  "name": "text",
  "collectionUUID": "text"
}

{
  "uuid": "text",
  "collectionUUID": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": true,
  "windowsLength": 1,
  "overlap": 1,
  "tags": [
    "text"
  ]
}

Enable or disable document

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

Responses

200

No content

204

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}

No content

Remove document

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

documentUUIDstringRequired

A valid document Uuid

Responses

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

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

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Accept: */*

No content

Bulk Operations

Exports more than one document

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

200

*/*

string · byte[]Optional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

[
  "Ynl0ZXM="
]

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

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

200

application/json

DTO response with massive document deletion data

successstring[]Optional

Name of files deleted successfully

errorsstring[]Optional

name of files with error in deletion

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

application/json

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

application/json

delete

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

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

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

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

collectionUUIDstringOptional

Optional collection UUID

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

linesPerPageinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt

directionstringOptional

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

Default: DESC

filenamesstring[]Optional

Filename to filter the search

searchTermsstring[]Optional

Names or tags to filter the search

Responses

200

*/*

totalPagesinteger · int32Optional

totalElementsinteger · int64Optional

numberOfElementsinteger · int32Optional

firstbooleanOptional

lastbooleanOptional

sizeinteger · int32Optional

numberinteger · int32Optional

emptybooleanOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination HTTP/1.1
Accept: */*

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

Returning a list of possible words to autocomplete in search

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

collectionUUIDstringOptional

Optional collection UUID

searchTermstringRequired

Word or part of word to get suggestion names of documents

limitinteger · int64Optional

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

Default: 6Example: 1

Responses

200

*/*

string[]Optional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/quicksearch?searchTerm=text HTTP/1.1
Accept: */*

[
  "text"
]

CRUD Operations

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 description

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

Responses

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 527

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "variables": [
    "text"
  ],
  "enabled": true,
  "evaluable": true,
  "transactional": true,
  "transactionalAuth": {
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "webhook": "text",
  "headers": {},
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ]
}

{
  "questionId": "text"
}

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

200

*/*

idstringOptional

Question id

botIdstringOptional

A uuid of bot assigned to this question

namestringOptional

Question name

descriptionstringOptional

Question description

webhookstringOptional

Answer endpoint webhook

headersstringOptional

Webhook headers

transactionalbooleanOptional

Question transactional status

enabledbooleanOptional

Question enabled status

removedbooleanOptional

Question removed status

updateContentbooleanOptional

True if the question content can be predict again because document update

evaluablebooleanOptional

Question evaluable status

createdAtstring · date-timeOptional

When question was created

updatedAtstring · date-timeOptional

When question was updated

updatedBystringOptional

User uuid that changed

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID} HTTP/1.1
Accept: */*

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "collectionUUID": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true,
    "windowsLength": 1,
    "overlap": 1
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "updateContent": true,
  "evaluable": true,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "transactionalAuth": {
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "createdAt": "2026-04-02T08:42:56.982Z",
  "updatedAt": "2026-04-02T08:42:56.982Z",
  "updatedBy": "text"
}

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 description

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

Responses

200

*/*

idstringOptional

Question id

botIdstringOptional

A uuid of bot assigned to this question

namestringOptional

Question name

descriptionstringOptional

Question description

webhookstringOptional

Answer endpoint webhook

headersstringOptional

Webhook headers

transactionalbooleanOptional

Question transactional status

enabledbooleanOptional

Question enabled status

removedbooleanOptional

Question removed status

updateContentbooleanOptional

True if the question content can be predict again because document update

evaluablebooleanOptional

Question evaluable status

createdAtstring · date-timeOptional

When question was created

updatedAtstring · date-timeOptional

When question was updated

updatedBystringOptional

User uuid that changed

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 527

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "variables": [
    "text"
  ],
  "enabled": true,
  "evaluable": true,
  "transactional": true,
  "transactionalAuth": {
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "webhook": "text",
  "headers": {},
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ]
}

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "collectionUUID": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true,
    "windowsLength": 1,
    "overlap": 1
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "updateContent": true,
  "evaluable": true,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "transactionalAuth": {
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "createdAt": "2026-04-02T08:42:56.982Z",
  "updatedAt": "2026-04-02T08:42:56.982Z",
  "updatedBy": "text"
}

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

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

200

No Content

*/*

DTO response with massive document deletion data

successstring[]Optional

Name of files deleted successfully

errorsstring[]Optional

name of files with error in deletion

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

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

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

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

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

200

*/*

Question variables

idstringOptional

Variable id

variablestringOptional

The variable value

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "variable": "text"
}

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

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

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "questionsIds": [
    "text"
  ]
}

No content

Knowledge AI

Retrieve collection limits for a specific organization and environment

get

Path parameters

orgUUIDstringRequired

UUID of the organization

envUUIDstringRequired

UUID of the environment

Header parameters

x-request-idstringOptional

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

Responses

200

*/*

DTO for representing the collection limit.

quantityinteger · int32Optional

Quantity indicating the limit of the collection per bot.

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/collections/limits HTTP/1.1
Accept: */*

{
  "quantity": 1
}

Return all limits to upload documents

get

Path parameters

orgUUIDstringRequired

It is the id that represents an organization.

envUUIDstringRequired

It is the id that represents an environment.

Header parameters

x-request-idstringOptional

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

Responses

200

*/*

DTO with limits to upload documents. Size of files and limit of documents per bot

limitinteger · int32Optional

Maximum of documents per bot

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/documents/limits HTTP/1.1
Accept: */*

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

PreviousAgent NextKnowledge AI NLP

Last updated 7 months ago

Was this helpful?

hashtagCollections

hashtagPagination and Listing

hashtagGet paginated collections

hashtagList all collections

hashtagQuick search for collection names

hashtagCRUD Operations

hashtagCreate a new collection

hashtagFind a specific collection

hashtagUpdate a specific collection

hashtagDelete a specific collection

hashtagAuxiliary Methods

hashtagValidate collection name

hashtagDocuments

hashtagPagination and Listing

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

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

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

hashtagCRUD Operations

hashtagUpload new document

hashtagShow a document

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

hashtagEnable or disable document

hashtagRemove document

hashtagBulk Operations

hashtagExports more than one document

hashtagBulk removes Documents with the provided uuid list.

hashtagQuestions

hashtagPaginations and Listings

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

hashtagReturning a list of possible words to autocomplete in search

hashtagCRUD Operations

hashtagCreate a brand new Question

hashtagRetrieves information from a specific Question, provided its UUID.

hashtagUpdates a Question.

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

hashtagAuxiliary Methods

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

hashtagKnowledge AI

hashtagRetrieve collection limits for a specific organization and environment

hashtagReturn all limits to upload documents

Collections

Pagination and Listing

Get paginated collections

List all collections

Quick search for collection names

CRUD Operations

Create a new collection

Find a specific collection

Update a specific collection

Delete a specific collection

Auxiliary Methods

Validate collection name

Documents

Pagination and Listing

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

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

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

CRUD Operations

Upload new document

Show a document

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

Enable or disable document

Remove document

Bulk Operations

Exports more than one document

Bulk removes Documents with the provided uuid list.

Questions

Paginations and Listings

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

Returning a list of possible words to autocomplete in search

CRUD Operations

Create a brand new Question

Retrieves information from a specific Question, provided its UUID.

Updates a Question.

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

Auxiliary Methods

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

Knowledge AI

Retrieve collection limits for a specific organization and environment

Return all limits to upload documents