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

Ok

application/json

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/pagination HTTP/1.1
Host: 
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

Ok

application/json

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/list HTTP/1.1
Host: 
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

Ok

application/json

Responsestring[]

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/quicksearch?searchTerm=text HTTP/1.1
Host: 
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

application/json

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

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections HTTP/1.1
Host: 
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": "2025-09-16T15:07:13.929Z",
      "createdBy": "text",
      "updatedAt": "2025-09-16T15:07:13.929Z",
      "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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": "2025-09-16T15:07:13.929Z",
      "createdBy": "text",
      "updatedAt": "2025-09-16T15:07:13.929Z",
      "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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

Ok

application/json

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID} HTTP/1.1
Host: 
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": "2025-09-16T15:07:13.929Z",
      "createdBy": "text",
      "updatedAt": "2025-09-16T15:07:13.929Z",
      "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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

application/json

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

Ok

application/json

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

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID} HTTP/1.1
Host: 
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": "2025-09-16T15:07:13.929Z",
      "createdBy": "text",
      "updatedAt": "2025-09-16T15:07:13.929Z",
      "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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": "2025-09-16T15:07:13.929Z",
      "createdBy": "text",
      "updatedAt": "2025-09-16T15:07:13.929Z",
      "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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": "2025-09-16T15:07:13.929Z",
            "createdBy": "text",
            "updatedAt": "2025-09-16T15:07:13.929Z",
            "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": "2025-09-16T15:07:13.929Z",
          "updatedAt": "2025-09-16T15:07:13.929Z",
          "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

Ok

application/json

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

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID} HTTP/1.1
Host: 
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

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

Responses

204

No Content

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

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/validation-name HTTP/1.1
Host: 
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

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination HTTP/1.1
Host: 
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

Ok

*/*

Responsestring[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/quicksearch?searchTerm=text HTTP/1.1
Host: 
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

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

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

[
  {
    "uuid": "text",
    "filename": "text",
    "storageFileName": "text",
    "collectionUUID": "text",
    "windowsLength": 1,
    "overlap": 1,
    "questionSize": 1,
    "enabled": true,
    "removed": true,
    "updatedAt": "2025-09-16T15:07:13.929Z",
    "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

multipart/form-data

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

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents HTTP/1.1
Host: 
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

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host: 
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

multipart/form-data

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

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}/update HTTP/1.1
Host: 
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

application/json

enabledbooleanOptional

Responses

200

OK

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

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host: 
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

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host: 
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

application/json

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

200

Ok

*/*

Responsestring · byte[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export HTTP/1.1
Host: 
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

application/json

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

200

Ok

application/json

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

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete HTTP/1.1
Host: 
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

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination HTTP/1.1
Host: 
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": "2025-09-16T15:07:13.929Z"
    }
  ],
  "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

Ok

*/*

Responsestring[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/quicksearch?searchTerm=text HTTP/1.1
Host: 
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

application/json

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

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions HTTP/1.1
Host: 
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

OK

*/*

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID} HTTP/1.1
Host: 
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": "2025-09-16T15:07:13.929Z",
  "updatedAt": "2025-09-16T15:07:13.929Z",
  "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

application/json

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

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID} HTTP/1.1
Host: 
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": "2025-09-16T15:07:13.929Z",
  "updatedAt": "2025-09-16T15:07:13.929Z",
  "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

application/json

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

200

No Content

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions HTTP/1.1
Host: 
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

application/json

variablestringOptional

Example of the question

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable HTTP/1.1
Host: 
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

application/json

questionsIdsstring[]Optional

List the questions ids

Responses

204

No Content

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

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable HTTP/1.1
Host: 
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

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/collections/limits HTTP/1.1
Host: 
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

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

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

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