Entity

The Entity API handle the CRUD operations for Entities, System Entities, and also an auxiliary method for the Dialog Manager.

PreviousDialog Manager NextGenerative Service

Was this helpful?

#144: 4.5 - Gen AI (KAI, Rephrase, Assist) + What's New (Notifications)

Change request updated 1 year ago

Searches and paginates through existing entities in a given bot.

get

Path parameters

orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Query parameters

searchTermstringOptional

Term being searched. This expects one optional String matching the name of an entity.

pageinteger · int32Required

Current page, starting at 1

Default: 1

sizeinteger · int32Required

Size of the page

Default: 5

orderBystringOptional

Criteria to order result, defaulted to updatedAt date. Possible fields include name, createdAt, updatedAt, createdBy and updatedBy.

Default: updatedAt

directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC

Responses

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities?page=1&size=1 HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "first": true,
  "last": true,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "flows": [
        {
          "flowId": "text",
          "flowName": "text"
        }
      ],
      "entity": {
        "id": "text",
        "name": "text",
        "updatedAt": "2025-04-27T11:33:13.266Z",
        "updatedBy": "text",
        "user": {
          "uuid": "text",
          "name": "text",
          "imageUrl": "text"
        },
        "entityValues": [
          {
            "type": "text"
          }
        ],
        "tags": [
          {
            "uuid": "text",
            "name": "text",
            "objectRef": "text",
            "tagTypeId": 1
          }
        ]
      }
    }
  ],
  "number": 1,
  "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.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot uuid to search

Query parameters

searchTermstringRequired

Term being searched

limitinteger · int32Optional

How many items will be returned in the list. Defaults to 6.

Default: 6

Responses

Responsestring[]

get

GET /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

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Responses

get

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"
        }
      ]
    }
  ],
  "systemEntities": [
    {
      "id": 1,
      "name": "text",
      "enabled": true
    }
  ]
}

Deletes an entity. The entity is disabled rather than removed, but all of it's values and samples are permanently deleted.

delete

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

uuidstringRequired

The entity's uuid

Responses

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/{uuid} HTTP/1.1
Host: 
Accept: */*

No content

Fetches a list of all System Entities and their status.

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters

pageinteger · int32Required

Current page, starting at 1

Default: 1

sizeinteger · int32Required

Size of the page

Default: 5

Responses

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/system-entities?page=1&size=1 HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "first": true,
  "last": true,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "id": 1,
      "name": "text",
      "enabled": true
    }
  ],
  "number": 1,
  "empty": true
}

Fetches a bot's System Entity and it's status.

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

idinteger · int64Required

Responses

get

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"
    }
  ]
}

Creates a brand new entity

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Structure used both to request the creation of a new entity and to request an update.

namestringRequired

Name of the entity being created.

typestringRequired

Type of the entity being created -- Expected values are either 'Synonym' or 'Pattern'. Anything else will be rejected.

cellEnablebooleanOptional

Wether or not this entity is enabled for cells.

Responses

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 202

{
  "name": "text",
  "type": "text",
  "tags": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "entityValue": [
    {
      "id": "text",
      "value": "text",
      "type": "text",
      "samples": [
        "text"
      ],
      "synonyms": [
        "text"
      ],
      "patterns": [
        "text"
      ]
    }
  ],
  "cellEnable": true
}

{
  "status": "text",
  "id": "text",
  "entityValue": [
    {
      "id": "text",
      "value": "text",
      "type": "text"
    }
  ]
}

Updates an existing Entity according to sent DTO.

put

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

uuidstringRequired

The entity's uuid

Body

Structure used both to request the creation of a new entity and to request an update.

namestringRequired

Name of the entity being created.

typestringRequired

Type of the entity being created -- Expected values are either 'Synonym' or 'Pattern'. Anything else will be rejected.

cellEnablebooleanOptional

Wether or not this entity is enabled for cells.

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/{uuid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 202

{
  "name": "text",
  "type": "text",
  "tags": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "entityValue": [
    {
      "id": "text",
      "value": "text",
      "type": "text",
      "samples": [
        "text"
      ],
      "synonyms": [
        "text"
      ],
      "patterns": [
        "text"
      ]
    }
  ],
  "cellEnable": true
}

{
  "entity": {
    "id": "text",
    "name": "text",
    "updatedAt": "2025-04-27T11:33:13.266Z",
    "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"
    }
  ]
}

Checks for the existance of a synonym. Retuns 200 if term is available, and 400 otherwise.

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Structure used to infer wether a Synonym is available to a bot or not.

synonymstringRequired

Name of the Synonym. Capitalization does not matter.

Responses

post

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

Checks for the existance of a pattern. Retuns 200 if term is available, and 409 otherwise.

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Structure used to infer wether a Pattern is available to a bot or not.

patternstringRequired

Name of the Pattern. Capitalization matters.

Responses

post

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

Updates one of a bot's system Entities.

put

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

idinteger · int64Required

Body

The structure for the update

enabledbooleanOptional

Wether you are enabling or disabling the system entity.

Responses

put

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"
    }
  ]
}

Entity

Entity

Entities

CRUD Operations

Auxiliary Methods

System Entities

CRUD Operations

Entities

CRUD Operations

Auxiliary Methods

System Entities

CRUD Operations

Searches and paginates through existing entities in a given bot.

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.

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

Deletes an entity. The entity is disabled rather than removed, but all of it's values and samples are permanently deleted.

Fetches a list of all System Entities and their status.

Fetches a bot's System Entity and it's status.

Creates a brand new entity

Updates an existing Entity according to sent DTO.

Checks for the existance of a synonym. Retuns 200 if term is available, and 400 otherwise.

Checks for the existance of a pattern. Retuns 200 if term is available, and 409 otherwise.

Updates one of a bot's system Entities.

Entities

Pagination and Listings

CRUD Operations

Auxiliary Methods

System Entities

Pagination and Listings

CRUD Operations

Entities

Pagination and Listings

CRUD Operations

Auxiliary Methods

System Entities

Pagination and Listings

CRUD Operations

Searches and paginates through existing entities in a given bot.

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.

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

Deletes an entity. The entity is disabled rather than removed, but all of it's values and samples are permanently deleted.

Fetches a list of all System Entities and their status.

Fetches a bot's System Entity and it's status.

Creates a brand new entity

Updates an existing Entity according to sent DTO.

Checks for the existance of a synonym. Retuns 200 if term is available, and 400 otherwise.

Checks for the existance of a pattern. Retuns 200 if term is available, and 409 otherwise.

Updates one of a bot's system Entities.