API DOCSVOICE GATEWAYSECURITY

Knowledge AI

The Knowledge AI (former Automated Learning) API contains methods for both it's related models: Documents, which contains the text to perform them, and Questions, which are assigned to Documents.

API SUBPATH: eva-al

Documents

Pagination and Listing

Returnig a pagination list of bot's documents

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
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
*/*
get
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
}

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

[
  "text"
]

Returnig a pagination list of bot's documents

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Responses
200
Ok
*/*
get
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

Upload new document

post
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
tagstring[]Optional

The tag name to save with document

Body
documentstring · binaryRequired

The document to upload

namestringOptional

The document name to save

collectionUUIDstringOptional

Optional. Symbolic collectionUUID for document organizing.

Responses
201
Created
*/*
post
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"
  ]
}

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
*/*
get
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"
}

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
tagstring[]Optional

The tag name to save with document

Body
documentstring · binaryOptional

It is the new file to update

namestringRequired

It is the new document name to update

collectionUUIDstringOptional

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

Responses
200
Ok
*/*
put
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"
  ]
}

Enable or disable document

put
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

documentUUIDstringRequired

A valid service Uuid

Body
enabledbooleanOptional
Responses
200
OK
put
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
delete
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

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses
200
Ok
*/*
Responsestring · byte[]
post
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

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses
200
Ok
application/json
delete
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

Returnig a pagination list of bot's questions

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
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
*/*
get
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
}

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
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[]
get
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
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
*/*
post
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"
}

Retrieve info a specific given question

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
*/*
get
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"
}

Updates an question

put
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

questionUUIDstringRequired

A valid question Uuid

Body
documentIdstringRequired

A Uuid of a document assigned to this question.

namestringRequired

Question name

descriptionstringOptional

Question description

variablesstring[]Optional

List of examples of question

enabledbooleanRequired

Question enabled/disabled status

evaluablebooleanOptional

Question evaluable status

transactionalbooleanOptional

Question transactional status

webhookstringOptional

Webhook address endpoint

headersobjectOptional

Webhook headers

Responses
200
Ok
*/*
put
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

delete
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses
200
No Content
*/*
delete
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 examples

post
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body
variablestringOptional

Example of the question

Responses
200
Ok
*/*
post
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"
  }
]

Enable and disable questions

put
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body
questionsIdsstring[]Optional

List the questions ids

Responses
204
No Content
put
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

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
*/*
get
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
}
PreviousInstance APINextKnowledge AI NLP

Last updated

Was this helpful?