# Entity

{% hint style="info" %}
**API SUBPATH**: eva-entity
{% endhint %}

## Entities

### Pagination and Listings

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities" method="get" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/quicksearch" method="get" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/list-on-flow" method="get" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

### CRUD Operations

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities" method="post" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/{uuid}" method="get" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/{uuid}" method="put" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/{uuid}" method="delete" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

### Auxiliary Methods

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/synonyms" method="post" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/entities/patterns" method="post" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

## System Entities

### Pagination and Listings

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/system-entities" method="get" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

### CRUD Operations

{% hint style="info" %}
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.
{% endhint %}

{% openapi src="/files/D38hSkC3yS9MNQJTwtuv" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/system-entities/{id}" method="get" %}
[eva-entity-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2F0nxc71V3Qqp2SmkIMX83%2Feva-entity-4.7.0.yaml?alt=media\&token=fb5369f3-88c9-41fe-8dc6-6cd5861abf70)
{% endopenapi %}

{% openapi src="/files/KPpMr2dehjZllPAbzQfe" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/system-entities/{id}" method="put" %}
[eva-entity-4.1.0.yaml](https://content.gitbook.com/content/n6zS4HeuuVpRHZEvDiFU/blobs/yjZRuGfxCkseTDoXdBBK/eva-entity-4.1.0.yaml)
{% endopenapi %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/entity.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.