User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • ๐Ÿš€GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • ๐Ÿ’ฌBUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • โœจGENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • ๐ŸŒCHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • โš™๏ธCONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • ๐Ÿ“ŠANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Instance API

Entity

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

PreviousDialog ManagerNextGenerative Service

Last updated 5 months ago

Was this helpful?

API SUBPATH: eva-entity

Entities

Pagination and Listings

CRUD Operations

Auxiliary Methods

System Entities

Pagination and Listings

CRUD Operations

System entities are not created or deleted - They are instead a standard, default group of entities which are available for all Virtual Agents. Rather than creating them, you will enable or disable them.

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
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
maskingFilterstring ยท enumOptional

Used to filter masked entities, defaulted to ALL

Default: ALLPossible values:
searchTermstringOptional

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

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities?page=1&size=1 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-05-09T11:20:07.662Z",
        "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.

get
Path parameters
orgUUIDstringRequired

It is the organization where the entities are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the entities are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the entities are, it is used to filter entities

Query parameters
searchTermstringRequired

Term being searched

limitinteger ยท int32Optional

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

Default: 6
Responses
200
Ok
application/json
Responsestring[]
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
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

It is the organization where the entities are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the entities are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the entities are, it is used to filter entities

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
application/json
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",
          "samples": [
            "text"
          ]
        }
      ]
    }
  ],
  "systemEntities": [
    {
      "id": 1,
      "name": "text",
      "enabled": true
    }
  ]
}

Retrieves info from a specific given entity.

get
Path parameters
orgUUIDstringRequired

It is the organization where the entities are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the entities are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the entities are, it is used to filter entities

uuidstringRequired

The entity's uuid

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Resource not found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
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-05-09T11:20:07.662Z",
    "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.

delete
Path parameters
orgUUIDstringRequired

It is the organization where the entities are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the entities are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the entities are, it is used to filter entities

uuidstringRequired

The entity's uuid

Responses
200
Ok
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
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
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/system-entities?page=1&size=1 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
}

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
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
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

It is the organization where the entities are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the entities are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the entities are, it is used to filter entities

Body

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

namestringRequired

Name of the entity being created.

descriptionstringOptional

Description of the entity.

typestringRequired

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

cellEnablebooleanOptional

Whether or not this entity is enabled for cells.

maskedbooleanOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
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"
      ]
    }
  ]
}

Updates an existing entity according to sent DTO.

put
Path parameters
orgUUIDstringRequired

It is the organization where the entities are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the entities are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the entities are, it is used to filter entities

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.

descriptionstringOptional

Description of the entity.

typestringRequired

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

cellEnablebooleanOptional

Whether or not this entity is enabled for cells.

maskedbooleanOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
put
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-05-09T11:20:07.662Z",
    "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 existence of a synonym. Returns 200 if term is available, and 400 otherwise.

post
Path parameters
orgUUIDstringRequired

It is the organization where the entities are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the entities are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the entities are, it is used to filter entities

Body

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

synonymstringRequired

Name of the Synonym. Capitalization does not matter.

Responses
200
Ok
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Term not available
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
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 existence of a pattern. Returns 200 if term is available, and 409 otherwise.

post
Path parameters
orgUUIDstringRequired

It is the organization where the entities are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the entities are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the entities are, it is used to filter entities

Body

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

patternstringRequired

Name of the Pattern. Capitalization matters.

Responses
200
Ok
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Term not available
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
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

  • Entities
  • Pagination and Listings
  • GETSearches and paginates through existing entities in a given bot.
  • GETSearches (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.
  • GETReturn 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
  • CRUD Operations
  • POSTCreates a brand new entity
  • GETRetrieves info from a specific given entity.
  • PUTUpdates an existing entity according to sent DTO.
  • DELETEDeletes an entity. The entity is disabled rather than removed, but all of it's values and samples are permanently deleted.
  • Auxiliary Methods
  • POSTChecks for the existence of a synonym. Returns 200 if term is available, and 400 otherwise.
  • POSTChecks for the existence of a pattern. Returns 200 if term is available, and 409 otherwise.
  • System Entities
  • Pagination and Listings
  • GETFetches a list of all System Entities and their status.
  • CRUD Operations
  • GETFetches a bot's System Entity and it's status.
  • PUTUpdates one of a bot's system Entities.

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
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
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"
    }
  ]
}