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.
Documents
Pagination and Listing
A valid organization Uuid
A valid environment Uuid
A valid bot 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
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination HTTP/1.1
Host:
Accept: */*
{
"totalPages": 1,
"totalElements": 1,
"pageable": {
"unpaged": true,
"pageSize": 1,
"paged": true,
"pageNumber": 1,
"offset": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"numberOfElements": 1,
"size": 1,
"content": [
{
"uuid": "text",
"storageFileName": "text",
"filename": "text",
"collectionUUID": "text",
"questions": 1,
"questionsIds": [
"text"
],
"enabled": true,
"selected": true,
"date": 1,
"uploaded": {
"uuid": "text",
"name": "text",
"imageUrl": "text"
},
"tags": [
"text"
],
"format": "text"
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}
A valid organization Uuid
A valid environment Uuid
A valid bot 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
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
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/list HTTP/1.1
Host:
Accept: */*
[
{
"uuid": "text",
"filename": "text",
"storageFileName": "text",
"collectionUUID": "text",
"questionSize": 1,
"enabled": true,
"removed": true,
"updatedAt": "2025-07-10T18:59:24.066Z",
"trainingStatus": "text",
"format": "text"
}
]
CRUD Operations
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
The tag name to save with document
The document to upload
The document name to save
Optional. Symbolic collectionUUID for document organizing.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"document": "binary",
"name": "text",
"collectionUUID": "text"
}
{
"uuid": "text",
"storageFilename": "text",
"filename": "text",
"enabled": true,
"tags": [
"text"
]
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid service Uuid
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",
"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 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.
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",
"storageFilename": "text",
"filename": "text",
"enabled": true,
"tags": [
"text"
]
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid service Uuid
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
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
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
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
A valid organization Uuid
A valid environment Uuid
A valid bot 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
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,
"size": 1,
"content": [
{
"id": "text",
"name": "text",
"description": "text",
"variables": 1,
"document": {
"uuid": "text",
"storageFilename": "text",
"filename": "text",
"enabled": true
},
"enabled": true,
"selected": true,
"lastModified": {
"name": "text",
"image": "text",
"date": 1
},
"tags": [
"text"
],
"updatedAt": "2025-07-10T18:59:24.066Z"
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}
A valid organization Uuid
A valid environment Uuid
A valid bot 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
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
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
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"botId": "text",
"document": {
"uuid": "text",
"storageFilename": "text",
"filename": "text",
"enabled": true
},
"name": "text",
"description": "text",
"variables": [
{
"id": "text",
"variable": "text"
}
],
"webhook": "text",
"headers": "text",
"transactional": true,
"enabled": true,
"removed": true,
"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-07-10T18:59:24.066Z",
"updatedAt": "2025-07-10T18:59:24.066Z",
"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
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",
"storageFilename": "text",
"filename": "text",
"enabled": true
},
"name": "text",
"description": "text",
"variables": [
{
"id": "text",
"variable": "text"
}
],
"webhook": "text",
"headers": "text",
"transactional": true,
"enabled": true,
"removed": true,
"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-07-10T18:59:24.066Z",
"updatedAt": "2025-07-10T18:59:24.066Z",
"updatedBy": "text"
}
Delete an question. The question is disabled via the 'removed' parameter rather than deleted from the DB
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Document uuids to delete
A list of Uuid of question
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
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Example of the question
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"
}
]
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
List the questions ids
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
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.
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?