Entity
The Entity API handle the CRUD operations for Entities, System Entities, and also an auxiliary method for the Dialog Manager.
Entities
Pagination and Listings
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Current page, starting at 1
1Size of the page
5Criteria to order result, defaulted to updatedAt date. Possible fields include name, createdAt, updatedAt, createdBy and updatedBy.
updatedAtOrder direction(ASC/DESC), defaulted to DESC
DESCUsed to filter masked entities, defaulted to ALL
ALLPossible values: Term being searched. This expects one optional String matching the name of an entity.
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities?page=1&size=5 HTTP/1.1
Host:
Accept: */*
{
"totalPages": 1,
"totalElements": 1,
"numberOfElements": 1,
"pageable": {
"unpaged": true,
"paged": true,
"pageNumber": 1,
"pageSize": 1,
"offset": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"size": 1,
"content": [
{
"flows": [
{
"flowId": "text",
"flowName": "text"
}
],
"entity": {
"id": "text",
"name": "text",
"description": "text",
"isMasked": true,
"updatedAt": "2025-07-04T19:17:10.497Z",
"updatedBy": "text",
"user": {
"uuid": "text",
"name": "text",
"imageUrl": "text"
},
"entityValues": [
{
"type": "text"
}
],
"tags": [
{
"uuid": "text",
"name": "text",
"objectRef": "text",
"tagTypeId": 1
}
]
}
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}Searches (greedily) for any entity names that exists in a bot, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.
It is the organization where the entities are, it is used to connect to the correct database
It is the environment where the entities are, it is used to connect to the correct database
It is the bot where the entities are, it is used to filter entities
Term being searched
How many items will be returned in the list. Defaults to 6.
6GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/quicksearch?searchTerm=text HTTP/1.1
Host:
Accept: */*
[
"text"
]Return all bot entities not removed and all system entities enabled or not. Used inside the flow to choose one of them and create a entity cell
It is the organization where the entities are, it is used to connect to the correct database
It is the environment where the entities are, it is used to connect to the correct database
It is the bot where the entities are, it is used to filter entities
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/list-on-flow HTTP/1.1
Host:
Accept: */*
{
"entities": [
{
"id": "text",
"name": "text",
"tags": [
"text"
],
"entityValues": [
{
"id": "text",
"value": "text",
"type": "text",
"samples": [
"text"
]
}
]
}
],
"systemEntities": [
{
"id": 1,
"name": "text",
"enabled": true
}
]
}CRUD Operations
It is the organization where the entities are, it is used to connect to the correct database
It is the environment where the entities are, it is used to connect to the correct database
It is the bot where the entities are, it is used to filter entities
Structure used both to request the creation of a new entity and to request an update
Name of the entity being created.
Description of the entity.
Type of the entity being created -- Expected values are either 'Synonym' or 'Pattern'. Anything else will be rejected.
Whether or not this entity is enabled for cells.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 237
{
"name": "text",
"description": "text",
"type": "text",
"tags": [
{
"id": "text",
"name": "text"
}
],
"entityValue": [
{
"id": "text",
"value": "text",
"type": "text",
"samples": [
"text"
],
"synonyms": [
"text"
],
"patterns": [
"text"
]
}
],
"cellEnable": true,
"masked": true
}{
"status": "text",
"id": "text",
"entityValue": [
{
"id": "text",
"value": "text",
"type": "text",
"samples": [
"text"
]
}
]
}It is the organization where the entities are, it is used to connect to the correct database
It is the environment where the entities are, it is used to connect to the correct database
It is the bot where the entities are, it is used to filter entities
The entity's uuid
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/{uuid} HTTP/1.1
Host:
Accept: */*
{
"entity": {
"id": "text",
"name": "text",
"description": "text",
"isMasked": true,
"updatedAt": "2025-07-04T19:17:10.497Z",
"updatedBy": "text",
"user": {
"uuid": "text",
"name": "text",
"imageUrl": "text"
},
"tags": [
{
"uuid": "text",
"name": "text",
"objectRef": "text",
"tagTypeId": 1
}
]
},
"entityValue": [
{
"id": "text",
"type": "text",
"value": "text",
"synonyms": [
"text"
],
"patterns": [
"text"
]
}
],
"flows": [
{
"flowId": "text",
"flowName": "text"
}
]
}It is the organization where the entities are, it is used to connect to the correct database
It is the environment where the entities are, it is used to connect to the correct database
It is the bot where the entities are, it is used to filter entities
The entity's uuid
Structure used both to request the creation of a new entity and to request an update
Name of the entity being created.
Description of the entity.
Type of the entity being created -- Expected values are either 'Synonym' or 'Pattern'. Anything else will be rejected.
Whether or not this entity is enabled for cells.
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/{uuid} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 237
{
"name": "text",
"description": "text",
"type": "text",
"tags": [
{
"id": "text",
"name": "text"
}
],
"entityValue": [
{
"id": "text",
"value": "text",
"type": "text",
"samples": [
"text"
],
"synonyms": [
"text"
],
"patterns": [
"text"
]
}
],
"cellEnable": true,
"masked": true
}{
"entity": {
"id": "text",
"name": "text",
"description": "text",
"isMasked": true,
"updatedAt": "2025-07-04T19:17:10.497Z",
"updatedBy": "text",
"user": {
"uuid": "text",
"name": "text",
"imageUrl": "text"
},
"tags": [
{
"uuid": "text",
"name": "text",
"objectRef": "text",
"tagTypeId": 1
}
]
},
"entityValue": [
{
"id": "text",
"type": "text",
"value": "text",
"synonyms": [
"text"
],
"patterns": [
"text"
]
}
],
"flows": [
{
"flowId": "text",
"flowName": "text"
}
]
}Deletes an entity. The entity is disabled rather than removed, but all of it's values and samples are permanently deleted.
It is the organization where the entities are, it is used to connect to the correct database
It is the environment where the entities are, it is used to connect to the correct database
It is the bot where the entities are, it is used to filter entities
The entity's uuid
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/{uuid} HTTP/1.1
Host:
Accept: */*
No content
Auxiliary Methods
It is the organization where the entities are, it is used to connect to the correct database
It is the environment where the entities are, it is used to connect to the correct database
It is the bot where the entities are, it is used to filter entities
Structure used to infer whether a Synonym is available to a bot or not.
Name of the Synonym. Capitalization does not matter.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/synonyms HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"synonym": "text"
}No content
It is the organization where the entities are, it is used to connect to the correct database
It is the environment where the entities are, it is used to connect to the correct database
It is the bot where the entities are, it is used to filter entities
Structure used to infer whether a Pattern is available to a bot or not.
Name of the Pattern. Capitalization matters.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/patterns HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"pattern": "text"
}No content
System Entities
Pagination and Listings
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
Current page, starting at 1
1Size of the page
5GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/system-entities?page=1&size=5 HTTP/1.1
Host:
Accept: */*
{
"totalPages": 1,
"totalElements": 1,
"numberOfElements": 1,
"pageable": {
"unpaged": true,
"paged": true,
"pageNumber": 1,
"pageSize": 1,
"offset": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"size": 1,
"content": [
{
"id": 1,
"name": "text",
"enabled": true
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}CRUD Operations
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/system-entities/{id} HTTP/1.1
Host:
Accept: */*
{
"systemEntity": {
"id": 1,
"name": "text",
"enabled": true
},
"flows": [
{
"uuid": "text",
"name": "text"
}
]
}A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
The structure for the update
Wether you are enabling or disabling the system entity.
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/system-entities/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"enabled": true
}{
"systemEntity": {
"id": 1,
"name": "text",
"enabled": true
},
"flows": [
{
"uuid": "text",
"name": "text"
}
]
}Last updated
Was this helpful?