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.
Collections
Pagination and Listing
Organization UUID
Environment UUID
Bot UUID
Page number
1
Example: 1
Lines per page
5
Example: 5
Order by field
updatedAt
Sorting direction
DESC
Optional search term
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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"
}
]
}
Organization UUID
Environment UUID
Bot UUID
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/list HTTP/1.1
Host:
Accept: */*
{
"collections": [
{
"uuid": "text",
"name": "text",
"trainingStatus": "text"
}
]
}
Organization UUID
Environment UUID
Bot UUID
Search term
Limit for results
6
Example: 6
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/quicksearch?searchTerm=text HTTP/1.1
Host:
Accept: */*
[
"text"
]
CRUD Operations
Organization UUID
Environment UUID
Bot UUID
It is an identifier provided by the API client that will be used to identify distributed logs.
Data Transfer Object for Collection Requests
Name of the collection
Description of the collection
Previous user input rating
Threshold value
Top K value for results
Created
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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
}
Organization UUID
Environment UUID
Bot UUID
Collection UUID
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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
}
Organization UUID
Environment UUID
Bot UUID
Collection UUID
It is an identifier provided by the API client that will be used to identify distributed logs.
Data Transfer Object for Collection Requests
Name of the collection
Description of the collection
Previous user input rating
Threshold value
Top K value for results
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"createdBy": "text",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"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
}
Organization UUID
Environment UUID
Bot UUID
Collection UUID
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/collections/{collectionUUID} HTTP/1.1
Host:
Accept: */*
{
"uuid": "text",
"name": "text",
"trainingStatus": "text"
}
Auxiliary Methods
Organization UUID
Environment UUID
Bot UUID
It is an identifier provided by the API client that will be used to identify distributed logs.
Represents a simple collection DTO with uuid and name.
Universally Unique Identifier for the collection.
Name of the collection.
Collection current status
No Content
No content
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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.
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Optional collection UUID
The number of page and the default is 1
1
Example: 1
The number of services per pages and the default is 5
5
Example: 1
Field want to ordernate, the default is 'updatedAt'
updatedAt
Direction of ordenation, ASC or DESC. The default is DESC
DESC
Names or tags to filter the search
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Optional collection UUID
Word or part of word to get suggestion names of documents
The limit of suggestions names in the response. The default value is 6
6
Example: 1
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/quicksearch?searchTerm=text HTTP/1.1
Host:
Accept: */*
[
"text"
]
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Optional collection UUID
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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-03T13:01:35.574Z",
"trainingStatus": "text",
"format": "text"
}
]
CRUD Operations
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
The length of windows for document processing, default value is 2000
The overlap length for document processing, default value is 0
The tag name to save with document
The document to upload
The document name to save
Optional. Symbolic collectionUUID for document organizing.
Created
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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"
]
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid service Uuid
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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"
}
It is the organization uuid where the bot is.
It is the environment uuid where the bot is.
It is the identification of the bot.
It is the identification of the document
The length of windows for document processing, default value is 2000
The overlap length for document processing, default value is 0
The tag name to save with document
It is the new file to update
It is the new document name to update
Optional. Symbolic collectionUUID for document organizing. Sending this as null will overwrite existing repository Id.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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"
]
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid service Uuid
OK
No content
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
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
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid document Uuid
No Content
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host:
Accept: */*
No content
Bulk Operations
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Document uuids to delete
A list of Uuid of question
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"uuids": [
"text"
]
}
[
"Ynl0ZXM="
]
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Document uuids to delete
A list of Uuid of question
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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.
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Optional collection UUID
The number of page and the default is 1
1
Example: 1
The number of services per pages and the default is 5
5
Example: 1
Field want to ordernate, the default is 'updatedAt'
updatedAt
Direction of ordenation, ASC or DESC. The default is DESC
DESC
Filename to filter the search
Names or tags to filter the search
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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-03T13:01:35.574Z"
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"empty": true
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Optional collection UUID
Word or part of word to get suggestion names of documents
The limit of suggestions names in the response. The default value is 6
6
Example: 1
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/quicksearch?searchTerm=text HTTP/1.1
Host:
Accept: */*
[
"text"
]
CRUD Operations
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A Uuid of a document assigned to this question.
Question name
Question description
List of examples of question
Question enabled/disabled status
Question evaluable status
Question transactional status
Webhook address endpoint
Webhook headers
Created
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
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"
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid question Uuid
OK
Created
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"updatedBy": "text"
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid question Uuid
A Uuid of a document assigned to this question.
Question name
Question description
List of examples of question
Question enabled/disabled status
Question evaluable status
Question transactional status
Webhook address endpoint
Webhook headers
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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-03T13:01:35.574Z",
"updatedAt": "2025-09-03T13:01:35.574Z",
"updatedBy": "text"
}
Deletes a Question. The question is symbolically removed via the 'removed' parameter
rather than deleted from the database.
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Document uuids to delete
A list of Uuid of question
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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.
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Example of the question
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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.
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
List the questions ids
No Content
No content
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
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
UUID of the organization
UUID of the environment
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Request Timeout
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/collections/limits HTTP/1.1
Host:
Accept: */*
{
"quantity": 1
}
It is the id that represents an organization.
It is the id that represents an environment.
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
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
}
Last updated
Was this helpful?