{"_id":"5845a4a89f6fbb1b004307cd","category":{"_id":"5845a4a89f6fbb1b004307ba","__v":0,"version":"5845a4a89f6fbb1b004307b7","project":"54d3007669578e0d002730c9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-30T06:53:33.020Z","from_sync":false,"order":2,"slug":"api-reference","title":"API reference"},"parentDoc":null,"project":"54d3007669578e0d002730c9","user":"55bf6cdcad601c2b00762d13","version":{"_id":"5845a4a89f6fbb1b004307b7","project":"54d3007669578e0d002730c9","__v":2,"createdAt":"2016-12-05T17:32:24.708Z","releaseDate":"2016-12-05T17:32:24.708Z","categories":["5845a4a89f6fbb1b004307b8","5845a4a89f6fbb1b004307b9","5845a4a89f6fbb1b004307ba","5845a4a89f6fbb1b004307bb","5845a4a89f6fbb1b004307bc","5845a4a89f6fbb1b004307bd","5845a4a89f6fbb1b004307be","5845a4a89f6fbb1b004307bf","5845a4a89f6fbb1b004307c0","592deb23644f060f008e5aa6"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"25.0.0","version":"25"},"__v":0,"updates":["5751787b60235d1700cf07df"],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T22:36:51.189Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"* [Overview](#overview)\n* [URLs and Objects](#urls-and-objects)\n* [GET /entities](#get-entities)\n* [GET /entities/{eid}](#get-entitieseid)\n* [POST /entities](#post-entities)\n* [POST /entities/{eid}/entries](#post-entitieseidentries)\n* [PUT /entities](#put-entities)\n* [PUT /entities/{eid}](#put-entitieseid)\n* [PUT /entities/{eid}/entries](#put-entitieseidentries)\n* [DELETE /entities/{eid}](#delete-entitieseid)\n* [DELETE /entities/{eid}/entries](#delete-entitieseidentries)\n* [Entity Object](#entity-object) \n* [Array of Entity Entry Objects](#array-of-entity-entry-objects)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Overview\"\n}\n[/block]\nThe **entities** endpoint is used to create, retrieve, update, and delete developer-defined entity objects.\n\nSee <a href=\"https://docs.api.ai/docs/concept-entities\" target=\"_blank\">Entity Overview</a> for detailed information on entities.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URLs and Objects\"\n}\n[/block]\nThe following URLs are available:\n[block:parameters]\n{\n  \"data\": {\n    \"h-1\": \"Definition\",\n    \"h-0\": \"URL\",\n    \"0-1\": \"Retrieves a list of all entities for the agent.\",\n    \"0-0\": \"[`GET /entities`](entities#get-entities)\",\n    \"1-0\": \"[`GET /entities/{eid}`](entities#get-entitieseid)\",\n    \"2-0\": \"[`POST /entities`](entities#post-entities)\",\n    \"5-0\": \"[`PUT /entities/{eid}`](entities#put-entitieseid)\",\n    \"7-0\": \"[`DELETE /entities/{eid}`](entities#delete-entitieseid)\",\n    \"7-1\": \"Deletes the specified entity.\",\n    \"5-1\": \"Updates the specified entity.\",\n    \"2-1\": \"Creates a new entity.\",\n    \"1-1\": \"Retrieves the specified entity.\",\n    \"4-1\": \"Creates or updates multiple entities.\",\n    \"4-0\": \"[`PUT /entities`](entities#put-entities)\",\n    \"3-0\": \"[`POST /entities/{eid}/entries`](#post-entitieseidentries)\",\n    \"3-1\": \"Adds an array of entity entries to the specified entity.\",\n    \"6-0\": \"[`PUT /entities/{eid}/entries`](#put-entitieseidentries)\",\n    \"6-1\": \"Updates an array of entity entries in the specified entity.\",\n    \"8-0\": \"[`DELETE /entities/{eid}/entries`](#delete-entitieseidentries)\",\n    \"8-1\": \"Deletes an array of entity entries from the specified entity.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n[Entity object](entities#entity-object) contains information about an entity, including its ID, name, and entries.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /entities\"\n}\n[/block]\nRetrieves a list of all entities for the agent. \n\n### GET /entities Sample Request\n\nThe following request returns all entities for the agent that is associated with the access token.\n\n    GET https://api.api.ai/v1/entities\n\t\n\tHeaders:\n\tAuthorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\n\t\n### GET /entities Sample cURL request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -k -H \\\"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" \\\"https://api.api.ai/v1/entities?v=20150910\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### GET /entities Response\n\nThe response will be a JSON object with the following fields:\n[block:html]\n{\n  \"html\": \"<div></div>\\n<table>\\n<tr>\\n  <th colspan=\\\"2\\\">Name</th>\\n  <th>Type</th> \\n  <th>Description</th>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">entities</td>\\n  <td>Array of objects</td> \\n  <td>An array of entity description objects</td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>id</td>\\n  <td>String</td> \\n  <td>ID of the entity</td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>name</td>\\n  <td>String</td> \\n  <td>Name of the entity</td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>count</td>\\n  <td>int</td> \\n  <td>The total number of synonyms in the entity</td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>preview</td>\\n  <td>String</td> \\n  <td>A string that contains summary information about the entity</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">status</td>\\n  <td><a href=\\\"https://docs.api.ai/docs/status-object\\\" target=\\\"_blank\\\">Status object</a></td> \\n  <td>Contains data on how the request succeeded or failed.</td>\\n</tr>\\n</table>\\n<style></style>\"\n}\n[/block]\n### GET /entities Sample Response\n\n    [\n      {\n        \"id\": \"33868522-5747-4a31-88fb-3cd13bd18684\",\n        \"name\": \"Appliances\",\n        \"count\": 11,\n        \"preview\": \"Coffee Maker <= (coffee maker, coffee machine, coffee), ...\"\n      },\n      {\n        \"id\": \"6d6b7d50-7510-4fec-927b-ac3c3aaff009\",\n        \"name\": \"Utilities\",\n        \"count\": 4,\n        \"preview\": \"Electricity <= (electricity, electrical), ...\"\n      }\n    ]\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /entities/{eid}\"\n}\n[/block]\nRetrieves the specified entity.\n\n`{eid}` is the ID of the entity to retrieve. You can specify the entity by its name instead of its ID.\n\n### GET /entities/{eid} Sample Request\n\nThe following request returns the entity with ID of 33868522-5747-4a31-88fb-3cd13bd18684.\n\n    GET https://api.api.ai/v1/entities/33868522-5747-4a31-88fb-3cd13bd18684?v=20150910\n\t\n\tHeaders:\n\tAuthorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\n\t\n#### GET /entities/{eid} Sample cURL Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -k -H \\\"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" \\\"https://api.api.ai/v1/entities/33868522-5747-4a31-88fb-3cd13bd18684?v=20150910\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### GET /entities/{eid} Response\n\nThe response is an [entity object](entities#entity-object).\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /entities\"\n}\n[/block]\nCreates a new entity.\n\n### POST /entities Request\n\nThe POST body is an [entity object](entities#entity-object) without the `\"id\"`, `\"isEnum\"`, and `\"automatedExpansion\"` elements.\n\n### POST /entities Sample Request\n\nThe following request creates an entity that could be used for recognizing appliances.\n\n    POST https://api.api.ai/v1/entities?v=20150910\n\t\n\tHeaders:\n\tAuthorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\n\tContent-Type: application/json; charset=utf-8\n\n\tPOST body:\n\t{\n\t\t\"name\": \"Appliances\",\n\t\t\"entries\": [{\n\t\t\t\"value\": \"Coffee Maker\",\n\t\t\t\"synonyms\": [\"coffee maker\", \"coffee machine\",  \"coffee\"]\n\t\t}, {\n\t\t\t\"value\": \"Thermostat\",\n\t\t\t\"synonyms\": [\"Thermostat\", \"heat\", \"air conditioning\"]\n\t\t}, {\n\t\t\t\"value\": \"Lights\",\n\t\t\t\"synonyms\": [\"lights\", \"light\", \"lamps\"]\n\t\t}, {\n\t\t\t\"value\": \"Garage door\",\n\t\t\t\"synonyms\": [\"garage door\", \"garage\"]\n\t\t}]\n\t}\n\n\n### POST /entities Sample cURL request\n\nThis curl request creates an entity for utilities such as electricity, gas, and water.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -k -H \\\"Content-Type: application/json; charset=utf-8\\\" -H \\\"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" --data \\\" {'name':'Utilities','entries':[{'value':'Electricity','synonyms':['electricity','electrical']},{'value':'Gas','synonyms':['gas','natural gas']},{'value':'Water','synonyms':['water']}]}\\\" \\\"https://api.api.ai/v1/entities?v=20150910\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### POST /entities Response\n\nPOST /entities Response has the following fields:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The ID of the new entity.\",\n    \"1-2\": \"Contains data on how the request succeeded or failed.\",\n    \"1-1\": \"<a href=\\\"https://apiai.readme.io/docs/status-object\\\" target=\\\"_blank\\\">Status object</a>\",\n    \"0-1\": \"String\",\n    \"0-0\": \"id\",\n    \"1-0\": \"status\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n### POST /entities Sample Response\n\n    {\n      \"id\": \"6d6b7d50-7510-4fec-927b-ac3c3aaff009\",\n      \"status\": {\n        \"code\": 200,\n        \"errorType\": \"success\"\n      }\n    }\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /entities/{eid}/entries\"\n}\n[/block]\nAdds entries to the specified entity.\n\n`{eid}` is the ID of the entity to which the entries will be added. You can specify the entity by its name instead of its ID.\n\n### POST /entities/{eid}/entries Request\n\nThe POST body is an [array of entity entry objects in JSON format](entities#array-of-entity-entry-objects).\n\n### POST /entities/{eid}/entries cURL Sample Request\n\nThe following request adds two entries to the entity with the ID cdc72cfd-78da-41cb-8af4-e4237bd93101.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -i -X POST -H \\\"Content-Type:application/json\\\" -H \\\"Authorization:Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" -d '[{\\\"value\\\": \\\"parrot\\\",\\\"synonyms\\\": [\\\"parrot\\\", \\\"parrots\\\"]},{\\\"value\\\": \\\"rabbit\\\",\\\"synonyms\\\": [\\\"rabbit\\\", \\\"rabbits\\\"]}]' 'https://api.api.ai/v1/entities/cdc72cfd-78da-41cb-8af4-e4237bd93101/entries?v=20150910'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /entities\"\n}\n[/block]\nCreates or updates an array of entities. \n\n#### PUT /entities Request\n\nThe PUT body consists of an array of [entity objects](entities#entity-object) without the `\"id\"`, `\"isEnum\"`, and `\"automatedExpansion\"` elements.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n   {\\n      \\\"name\\\":\\\"cat\\\",\\n      \\\"entries\\\":[\\n         {\\n            \\\"value\\\":\\\"cat\\\",\\n            \\\"synonyms\\\":[\\n               \\\"cat\\\",\\n               \\\"kitty\\\"\\n            ]\\n         }\\n      ]\\n   },\\n   {\\n      \\\"name\\\":\\\"dog\\\",\\n      \\\"entries\\\":[\\n         {\\n            \\\"value\\\":\\\"dog\\\",\\n            \\\"synonyms\\\":[\\n               \\\"dog\\\",\\n               \\\"puppy\\\"\\n            ]\\n         }\\n      ]\\n   }\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n#### PUT /entities Sample cURL request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -k -X PUT -H \\\"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" -H \\\"Content-Type: application/json\\\" --data \\\"[{'name': 'cat', 'entries': [{'value':'cat', 'synonyms':['cat', 'kitty']} ]}, {'name': 'dog', 'entries': [{'value':'dog', 'synonyms':['dog', 'puppy']} ]}]\\\"  \\\"https://api.api.ai/v1/entities?v=20150910\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /entities/{eid}\"\n}\n[/block]\nUpdates the specified entity.\n\n`{eid}` is the ID of the entity to update. You can specify the entity by its name instead of its ID.\n\n### PUT /entities/{eid} Request\n\nThe PUT body is an [entity object](entities#entity-object).\n\n### PUT /entities/{eid} Sample Request\nThe following request updates an entity of ID 80f817e8-23fb-4e8e-ba62-eca1fcef7c3a, changing the name to \"Utility-Types\".\n\n    PUT https://api.api.ai/v1/entities/80f817e8-23fb-4e8e-ba62-eca1fcef7c3a?v=20150910\n\t\n\tHeaders:\n\tAuthorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\n\tContent-Type: application/json; charset=utf-8\n\n\tPUT body:\n\t{\n\t  \"id\":\"80f817e8-23fb-4e8e-ba62-eca1fcef7c3a\",\n\t  \"name\": \"Utility-Types\",\n\t  \"entries\": [\n\t    {\n\t      \"value\": \"Electricity\",\n\t      \"synonyms\": [\n\t        \"electricity\",\n\t        \"electrical\"\n\t      ]\n\t    },\n\t    {\n\t      \"value\": \"Gas\",\n\t      \"synonyms\": [\n\t        \"gas\",\n\t        \"natural gas\",\n\t      ]\n\t    },\n\t    {\n\t      \"value\": \"Water\",\n\t      \"synonyms\": [\n\t        \"water\"\n\t      ]\n\t    }\n\t  ]\n\t}\n\t\n### PUT /entities/{eid} Sample cURL request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -k -X PUT -H \\\"Content-Type: application/json; charset=utf-8\\\" -H \\\"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" --data \\\"{'id':'80f817e8-23fb-4e8e-ba62-eca1fcef7c3a','name':'Utility-Types','entries':[{'value':'Electricity','synonyms':['electricity','electrical']},{'value':'Gas','synonyms':['gas']},{'value':'Water','synonyms':['water']}]}\\\" \\\"https://api.api.ai/v1/entities/80f817e8-23fb-4e8e-ba62-eca1fcef7c3a?v=20150910\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### PUT /entities/{eid} Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"status\",\n    \"0-1\": \"<a href=\\\"https://docs.api.ai/docs/status-object\\\" target=\\\"_blank\\\">Status object</a>\",\n    \"0-2\": \"Contains data on how the request succeeded or failed.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /entities/{eid}/entries\"\n}\n[/block]\nUpdates entity entries.\n\n`{eid}` is the ID of the entity in which entries will be updated. You can specify the entity by its name instead of its ID.\n\n### PUT /entities/{eid}/entries Request\n\nThe PUT body is an [array of entity entry objects in JSON format](entities#array-of-entity-entry-objects).\n\n### PUT /entities/{eid}/entries Sample cURL Request\n\nThe following request updates the `:::at:::color` entity entry corresponding to the reference value \"blue\".\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -i -X PUT -H \\\"Accept:application/json\\\" -H \\\"Content-Type:application/json\\\" -H \\\"Authorization:Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" -d '[{\\\"value\\\":\\\"blue\\\", \\\"synonyms\\\": [\\\"blue\\\", \\\"turquoise\\\"]}]' 'https://api.api.ai/v1/entities/color/entries?v=20150910'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"Delete /entities/{eid}\"\n}\n[/block]\nDeletes the specified entity.\n\n`{eid}` is the ID of the entity to delete. You can specify the entity by its name instead of its ID.\n\n### Delete /entities/{eid} Sample Request\nThe following request deletes an entity of ID 80f817e8-23fb-4e8e-ba62-eca1fcef7c3a.\n\n    DELETE https://api.api.ai/v1/entities/80f817e8-23fb-4e8e-ba62-eca1fcef7c3a?v=20150910\n\t\n\tHeaders:\n\tAuthorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\n\t\n#### Delete /entities/{eid} Sample cURL Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -k -X DELETE -H \\\"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" \\\"https://api.api.ai/v1/entities/6d6b7d50-7510-4fec-927b-ac3c3aaff009?20150910?v=20150910\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### Delete /entities/{eid} Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"Contains data on how the request succeeded or failed.\",\n    \"0-1\": \"<a href=\\\"https://docs.api.ai/docs/status-object\\\" target=\\\"_blank\\\">Status object</a>\",\n    \"0-0\": \"status\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"DELETE /entities/{eid}/entries\"\n}\n[/block]\nDeletes entity entries.\n\n`{eid}` is the ID of the entity from which entries will be deleted. You can specify the entity by its name instead of its ID.\n\n### DELETE /entities/{eid}/entries Request\n\nThe DELETE body is an array of strings corresponding to the reference values of entity entries to be deleted.\n\n### DELETE /entities/{eid}/entries Sample cURL Request\n\nThe following request deletes the entry with the reference value \"blue\" from the `@color` entity.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -i -X DELETE -H \\\"Accept:application/json\\\" -H \\\"Content-Type:application/json\\\" -H \\\"Authorization:Bearer YOUR_DEVELOPER_ACCESS_TOKEN\\\" -d '[\\\"blue\\\"]' 'https://api.api.ai/v1/entities/color/entries?v=20150910'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Entity Object\"\n}\n[/block]\nThe entity JSON object contains all information about an entity, including its ID, name, and entries. \n\nThe entity object has the following fields:\n[block:html]\n{\n  \"html\": \"<div></div>\\n<table>\\n<tr>\\n  <th colspan=\\\"2\\\">Name</th>\\n  <th>Type</th> \\n  <th>Description</th>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">id</td>\\n  <td>String</td> \\n  <td>A unique identifier for the entity.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">name</td>\\n  <td>Legal Name</td> \\n  <td>The name of the entity.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">entries</td>\\n  <td>Array of objects</td> \\n  <td>An array of entry objects, which contain reference values and synonyms.</td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>value</td>\\n  <td>String</td> \\n  <td>\\n    <ul>\\n      <li>For <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\\\" target=\\\"_blank\\\">mapping entities</a>: a canonical name to be used in place of synonyms.<br/> Example: <code>\\\"New York\\\"</code>\\n      </li>\\n      <br>\\n      <li>For <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\\\" target=\\\"_blank\\\">enum type entities</a>: a string that can contain references to other entities (with or without aliases).<br>Example: <code>\\\"@sys.color:color @size:size @clothes:clothes\\\"</code>\\n      </li>\\n    </ul>\\n  </td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>synonyms</td>\\n  <td>Array of strings that can include simple strings (for words and phrases) or references to other entites (with or without aliases).\\t\\t</td> \\n  <td>\\n     <ul>\\n       <li>For <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\\\" target=\\\"_blank\\\">mapping entities</a>: an array of synonyms.<br/> Example: <code>[\\\"New York\\\", \\\"NYC\\\", \\\"big Apple\\\"]</code><br>\\n      \\t</li>\\n        <br>\\n      \\t<li>For <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\\\" target=\\\"_blank\\\">enum type entities</a>: a string that is identical to the value string.<br>Example: <code>\\\"@sys.color:color @size:size @clothes:clothes\\\"</code>\\n      \\t</li>\\n    \\t</ul>\\n\\t\\t</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">isEnum</td>\\n  <td>Boolean</td> \\n  <td>Indicates if the entity is a <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\\\" target=\\\"_blank\\\">mapping</a> or an <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\\\" target=\\\"_blank\\\">enum type</a> entity.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">automatedExpansion</td>\\n  <td>Boolean</td> \\n  <td>Indicates if the entity can be automatically expanded.</td>\\n</tr>\\n</table>\\n<style></style>\"\n}\n[/block]\n### Sample Mapping Entity Object\n\n    {\n      \"id\": \"1de251bf-46a6-4056-af9c-96b6ca89dfd0\",\n      \"name\": \"appliances\",\n      \"entries\": [\n        {\n          \"value\": \"coffee maker\",\n          \"synonyms\": [\n            \"coffee maker\",\n            \"coffee\"\n          ]\n        },\n        {\n          \"value\": \"thermostat\",\n          \"synonyms\": [\n            \"thermostat\",\n            \"heat\",\n            \"air conditioning\"\n          ]\n        },\n        {\n          \"value\": \"lights\",\n          \"synonyms\": [\n            \"lights\",\n            \"light\",\n            \"lamps\"\n          ]\n        },\n        {\n          \"value\": \"garage door\",\n          \"synonyms\": [\n            \"garage door\",\n            \"garage\"\n          ]\n        }\n      ],\n      \"isEnum\": false,\n      \"automatedExpansion\": false\n    }\n    \n### Sample Enum Type Composite Entity Object\n\n    {\n      \"id\": \"0f2c0b53-8681-4e76-9f26-04947bbc48d9\",\n      \"name\": \"item\",\n      \"entries\": [\n        {\n          \"value\": \"@sys.color:color @size:size @clothes:clothes\",\n          \"synonyms\": [\n            \"@sys.color:color @size:size @clothes:clothes\"\n          ]\n        },\n        {\n          \"value\": \"@sys.color:color @clothes:clothes of @size:size\",\n          \"synonyms\": [\n            \"@sys.color:color @clothes:clothes of @size:size\"\n          ]\n        }\n      ],\n      \"isEnum\": true,\n      \"automatedExpansion\": false\n    }\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Array of Entity Entry Objects\"\n}\n[/block]\nArray of entity entry objects contains information about entity entries. \n\nEach object has the following fields: \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"value\",\n    \"0-1\": \"String\",\n    \"0-2\": \"- For <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\\\" target=\\\"_blank\\\">mapping entities</a>: a reference value.\\n\\n- For <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\\\" target=\\\"_blank\\\">enum type entities</a>: a string that can contain references to other entities (with or without aliases).\",\n    \"1-0\": \"synonyms\",\n    \"1-1\": \"Array of strings\",\n    \"1-2\": \"- For <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\\\" target=\\\"_blank\\\">mapping entities</a>: an array of synonyms.\\n\\n- For <a href=\\\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\\\" target=\\\"_blank\\\">enum type entities</a>: a string that is identical to the value string.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n### Sample Array of Mapping Entity Entry Objects\n\n    [{\n    \t\"value\": \"dog\",\n    \t\"synonyms\": [\n    \t\t\"dog\",\n    \t\t\"dogs\"\n    \t]\n    }, {\n    \t\"value\": \"cat\",\n    \t\"synonyms\": [\n    \t\t\"cat\",\n    \t\t\"cats\",\n    \t\t\"kitten\",\n    \t\t\"kittens\"\n    \t]\n    }]","excerpt":"","slug":"entities","type":"basic","title":"/entities"}
* [Overview](#overview) * [URLs and Objects](#urls-and-objects) * [GET /entities](#get-entities) * [GET /entities/{eid}](#get-entitieseid) * [POST /entities](#post-entities) * [POST /entities/{eid}/entries](#post-entitieseidentries) * [PUT /entities](#put-entities) * [PUT /entities/{eid}](#put-entitieseid) * [PUT /entities/{eid}/entries](#put-entitieseidentries) * [DELETE /entities/{eid}](#delete-entitieseid) * [DELETE /entities/{eid}/entries](#delete-entitieseidentries) * [Entity Object](#entity-object) * [Array of Entity Entry Objects](#array-of-entity-entry-objects) [block:api-header] { "type": "basic", "title": "Overview" } [/block] The **entities** endpoint is used to create, retrieve, update, and delete developer-defined entity objects. See <a href="https://docs.api.ai/docs/concept-entities" target="_blank">Entity Overview</a> for detailed information on entities. [block:api-header] { "type": "basic", "title": "URLs and Objects" } [/block] The following URLs are available: [block:parameters] { "data": { "h-1": "Definition", "h-0": "URL", "0-1": "Retrieves a list of all entities for the agent.", "0-0": "[`GET /entities`](entities#get-entities)", "1-0": "[`GET /entities/{eid}`](entities#get-entitieseid)", "2-0": "[`POST /entities`](entities#post-entities)", "5-0": "[`PUT /entities/{eid}`](entities#put-entitieseid)", "7-0": "[`DELETE /entities/{eid}`](entities#delete-entitieseid)", "7-1": "Deletes the specified entity.", "5-1": "Updates the specified entity.", "2-1": "Creates a new entity.", "1-1": "Retrieves the specified entity.", "4-1": "Creates or updates multiple entities.", "4-0": "[`PUT /entities`](entities#put-entities)", "3-0": "[`POST /entities/{eid}/entries`](#post-entitieseidentries)", "3-1": "Adds an array of entity entries to the specified entity.", "6-0": "[`PUT /entities/{eid}/entries`](#put-entitieseidentries)", "6-1": "Updates an array of entity entries in the specified entity.", "8-0": "[`DELETE /entities/{eid}/entries`](#delete-entitieseidentries)", "8-1": "Deletes an array of entity entries from the specified entity." }, "cols": 2, "rows": 9 } [/block] [Entity object](entities#entity-object) contains information about an entity, including its ID, name, and entries. [block:api-header] { "type": "get", "title": "GET /entities" } [/block] Retrieves a list of all entities for the agent. ### GET /entities Sample Request The following request returns all entities for the agent that is associated with the access token. GET https://api.api.ai/v1/entities Headers: Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN ### GET /entities Sample cURL request [block:code] { "codes": [ { "code": "curl -k -H \"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" \"https://api.api.ai/v1/entities?v=20150910\"", "language": "curl" } ] } [/block] ### GET /entities Response The response will be a JSON object with the following fields: [block:html] { "html": "<div></div>\n<table>\n<tr>\n <th colspan=\"2\">Name</th>\n <th>Type</th> \n <th>Description</th>\n</tr>\n<tr>\n <td colspan=\"2\">entities</td>\n <td>Array of objects</td> \n <td>An array of entity description objects</td>\n</tr>\n<tr>\n <td></td>\n <td>id</td>\n <td>String</td> \n <td>ID of the entity</td>\n</tr>\n<tr>\n <td></td>\n <td>name</td>\n <td>String</td> \n <td>Name of the entity</td>\n</tr>\n<tr>\n <td></td>\n <td>count</td>\n <td>int</td> \n <td>The total number of synonyms in the entity</td>\n</tr>\n<tr>\n <td></td>\n <td>preview</td>\n <td>String</td> \n <td>A string that contains summary information about the entity</td>\n</tr>\n<tr>\n <td colspan=\"2\">status</td>\n <td><a href=\"https://docs.api.ai/docs/status-object\" target=\"_blank\">Status object</a></td> \n <td>Contains data on how the request succeeded or failed.</td>\n</tr>\n</table>\n<style></style>" } [/block] ### GET /entities Sample Response [   {     "id": "33868522-5747-4a31-88fb-3cd13bd18684",     "name": "Appliances",     "count": 11,     "preview": "Coffee Maker <= (coffee maker, coffee machine, coffee), ..."   },   {     "id": "6d6b7d50-7510-4fec-927b-ac3c3aaff009",     "name": "Utilities",     "count": 4,     "preview": "Electricity <= (electricity, electrical), ..."   } ] [block:api-header] { "type": "get", "title": "GET /entities/{eid}" } [/block] Retrieves the specified entity. `{eid}` is the ID of the entity to retrieve. You can specify the entity by its name instead of its ID. ### GET /entities/{eid} Sample Request The following request returns the entity with ID of 33868522-5747-4a31-88fb-3cd13bd18684. GET https://api.api.ai/v1/entities/33868522-5747-4a31-88fb-3cd13bd18684?v=20150910 Headers: Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN #### GET /entities/{eid} Sample cURL Request [block:code] { "codes": [ { "code": "curl -k -H \"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" \"https://api.api.ai/v1/entities/33868522-5747-4a31-88fb-3cd13bd18684?v=20150910\"", "language": "curl" } ] } [/block] ### GET /entities/{eid} Response The response is an [entity object](entities#entity-object). [block:api-header] { "type": "post", "title": "POST /entities" } [/block] Creates a new entity. ### POST /entities Request The POST body is an [entity object](entities#entity-object) without the `"id"`, `"isEnum"`, and `"automatedExpansion"` elements. ### POST /entities Sample Request The following request creates an entity that could be used for recognizing appliances. POST https://api.api.ai/v1/entities?v=20150910 Headers: Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN Content-Type: application/json; charset=utf-8 POST body: { "name": "Appliances", "entries": [{ "value": "Coffee Maker", "synonyms": ["coffee maker", "coffee machine",  "coffee"] }, { "value": "Thermostat", "synonyms": ["Thermostat", "heat", "air conditioning"] }, { "value": "Lights", "synonyms": ["lights", "light", "lamps"] }, { "value": "Garage door", "synonyms": ["garage door", "garage"] }] } ### POST /entities Sample cURL request This curl request creates an entity for utilities such as electricity, gas, and water. [block:code] { "codes": [ { "code": "curl -k -H \"Content-Type: application/json; charset=utf-8\" -H \"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" --data \" {'name':'Utilities','entries':[{'value':'Electricity','synonyms':['electricity','electrical']},{'value':'Gas','synonyms':['gas','natural gas']},{'value':'Water','synonyms':['water']}]}\" \"https://api.api.ai/v1/entities?v=20150910\"", "language": "curl" } ] } [/block] ### POST /entities Response POST /entities Response has the following fields: [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-2": "The ID of the new entity.", "1-2": "Contains data on how the request succeeded or failed.", "1-1": "<a href=\"https://apiai.readme.io/docs/status-object\" target=\"_blank\">Status object</a>", "0-1": "String", "0-0": "id", "1-0": "status" }, "cols": 3, "rows": 2 } [/block] ### POST /entities Sample Response {   "id": "6d6b7d50-7510-4fec-927b-ac3c3aaff009",   "status": {     "code": 200,     "errorType": "success"   } } [block:api-header] { "type": "post", "title": "POST /entities/{eid}/entries" } [/block] Adds entries to the specified entity. `{eid}` is the ID of the entity to which the entries will be added. You can specify the entity by its name instead of its ID. ### POST /entities/{eid}/entries Request The POST body is an [array of entity entry objects in JSON format](entities#array-of-entity-entry-objects). ### POST /entities/{eid}/entries cURL Sample Request The following request adds two entries to the entity with the ID cdc72cfd-78da-41cb-8af4-e4237bd93101. [block:code] { "codes": [ { "code": "curl -i -X POST -H \"Content-Type:application/json\" -H \"Authorization:Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" -d '[{\"value\": \"parrot\",\"synonyms\": [\"parrot\", \"parrots\"]},{\"value\": \"rabbit\",\"synonyms\": [\"rabbit\", \"rabbits\"]}]' 'https://api.api.ai/v1/entities/cdc72cfd-78da-41cb-8af4-e4237bd93101/entries?v=20150910'", "language": "curl" } ] } [/block] [block:api-header] { "type": "put", "title": "PUT /entities" } [/block] Creates or updates an array of entities. #### PUT /entities Request The PUT body consists of an array of [entity objects](entities#entity-object) without the `"id"`, `"isEnum"`, and `"automatedExpansion"` elements. [block:code] { "codes": [ { "code": "[\n {\n \"name\":\"cat\",\n \"entries\":[\n {\n \"value\":\"cat\",\n \"synonyms\":[\n \"cat\",\n \"kitty\"\n ]\n }\n ]\n },\n {\n \"name\":\"dog\",\n \"entries\":[\n {\n \"value\":\"dog\",\n \"synonyms\":[\n \"dog\",\n \"puppy\"\n ]\n }\n ]\n }\n]", "language": "json" } ] } [/block] #### PUT /entities Sample cURL request [block:code] { "codes": [ { "code": "curl -k -X PUT -H \"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" -H \"Content-Type: application/json\" --data \"[{'name': 'cat', 'entries': [{'value':'cat', 'synonyms':['cat', 'kitty']} ]}, {'name': 'dog', 'entries': [{'value':'dog', 'synonyms':['dog', 'puppy']} ]}]\" \"https://api.api.ai/v1/entities?v=20150910\"", "language": "curl" } ] } [/block] [block:api-header] { "type": "put", "title": "PUT /entities/{eid}" } [/block] Updates the specified entity. `{eid}` is the ID of the entity to update. You can specify the entity by its name instead of its ID. ### PUT /entities/{eid} Request The PUT body is an [entity object](entities#entity-object). ### PUT /entities/{eid} Sample Request The following request updates an entity of ID 80f817e8-23fb-4e8e-ba62-eca1fcef7c3a, changing the name to "Utility-Types". PUT https://api.api.ai/v1/entities/80f817e8-23fb-4e8e-ba62-eca1fcef7c3a?v=20150910 Headers: Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN Content-Type: application/json; charset=utf-8 PUT body: { "id":"80f817e8-23fb-4e8e-ba62-eca1fcef7c3a",   "name": "Utility-Types",   "entries": [     {       "value": "Electricity",       "synonyms": [         "electricity",         "electrical"       ]     },     {       "value": "Gas",       "synonyms": [         "gas",         "natural gas",       ]     },     {       "value": "Water",       "synonyms": [         "water"       ]     }   ] } ### PUT /entities/{eid} Sample cURL request [block:code] { "codes": [ { "code": "curl -k -X PUT -H \"Content-Type: application/json; charset=utf-8\" -H \"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" --data \"{'id':'80f817e8-23fb-4e8e-ba62-eca1fcef7c3a','name':'Utility-Types','entries':[{'value':'Electricity','synonyms':['electricity','electrical']},{'value':'Gas','synonyms':['gas']},{'value':'Water','synonyms':['water']}]}\" \"https://api.api.ai/v1/entities/80f817e8-23fb-4e8e-ba62-eca1fcef7c3a?v=20150910\"", "language": "curl" } ] } [/block] ### PUT /entities/{eid} Response [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "status", "0-1": "<a href=\"https://docs.api.ai/docs/status-object\" target=\"_blank\">Status object</a>", "0-2": "Contains data on how the request succeeded or failed." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "put", "title": "PUT /entities/{eid}/entries" } [/block] Updates entity entries. `{eid}` is the ID of the entity in which entries will be updated. You can specify the entity by its name instead of its ID. ### PUT /entities/{eid}/entries Request The PUT body is an [array of entity entry objects in JSON format](entities#array-of-entity-entry-objects). ### PUT /entities/{eid}/entries Sample cURL Request The following request updates the `@color` entity entry corresponding to the reference value "blue". [block:code] { "codes": [ { "code": "curl -i -X PUT -H \"Accept:application/json\" -H \"Content-Type:application/json\" -H \"Authorization:Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" -d '[{\"value\":\"blue\", \"synonyms\": [\"blue\", \"turquoise\"]}]' 'https://api.api.ai/v1/entities/color/entries?v=20150910'", "language": "curl" } ] } [/block] [block:api-header] { "type": "delete", "title": "Delete /entities/{eid}" } [/block] Deletes the specified entity. `{eid}` is the ID of the entity to delete. You can specify the entity by its name instead of its ID. ### Delete /entities/{eid} Sample Request The following request deletes an entity of ID 80f817e8-23fb-4e8e-ba62-eca1fcef7c3a. DELETE https://api.api.ai/v1/entities/80f817e8-23fb-4e8e-ba62-eca1fcef7c3a?v=20150910 Headers: Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN #### Delete /entities/{eid} Sample cURL Request [block:code] { "codes": [ { "code": "curl -k -X DELETE -H \"Authorization: Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" \"https://api.api.ai/v1/entities/6d6b7d50-7510-4fec-927b-ac3c3aaff009?20150910?v=20150910\"", "language": "curl" } ] } [/block] ### Delete /entities/{eid} Response [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-2": "Contains data on how the request succeeded or failed.", "0-1": "<a href=\"https://docs.api.ai/docs/status-object\" target=\"_blank\">Status object</a>", "0-0": "status" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "delete", "title": "DELETE /entities/{eid}/entries" } [/block] Deletes entity entries. `{eid}` is the ID of the entity from which entries will be deleted. You can specify the entity by its name instead of its ID. ### DELETE /entities/{eid}/entries Request The DELETE body is an array of strings corresponding to the reference values of entity entries to be deleted. ### DELETE /entities/{eid}/entries Sample cURL Request The following request deletes the entry with the reference value "blue" from the `@color` entity. [block:code] { "codes": [ { "code": "curl -i -X DELETE -H \"Accept:application/json\" -H \"Content-Type:application/json\" -H \"Authorization:Bearer YOUR_DEVELOPER_ACCESS_TOKEN\" -d '[\"blue\"]' 'https://api.api.ai/v1/entities/color/entries?v=20150910'", "language": "curl" } ] } [/block] [block:api-header] { "type": "basic", "title": "Entity Object" } [/block] The entity JSON object contains all information about an entity, including its ID, name, and entries. The entity object has the following fields: [block:html] { "html": "<div></div>\n<table>\n<tr>\n <th colspan=\"2\">Name</th>\n <th>Type</th> \n <th>Description</th>\n</tr>\n<tr>\n <td colspan=\"2\">id</td>\n <td>String</td> \n <td>A unique identifier for the entity.</td>\n</tr>\n<tr>\n <td colspan=\"2\">name</td>\n <td>Legal Name</td> \n <td>The name of the entity.</td>\n</tr>\n<tr>\n <td colspan=\"2\">entries</td>\n <td>Array of objects</td> \n <td>An array of entry objects, which contain reference values and synonyms.</td>\n</tr>\n<tr>\n <td></td>\n <td>value</td>\n <td>String</td> \n <td>\n <ul>\n <li>For <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\" target=\"_blank\">mapping entities</a>: a canonical name to be used in place of synonyms.<br/> Example: <code>\"New York\"</code>\n </li>\n <br>\n <li>For <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\" target=\"_blank\">enum type entities</a>: a string that can contain references to other entities (with or without aliases).<br>Example: <code>\"@sys.color:color @size:size @clothes:clothes\"</code>\n </li>\n </ul>\n </td>\n</tr>\n<tr>\n <td></td>\n <td>synonyms</td>\n <td>Array of strings that can include simple strings (for words and phrases) or references to other entites (with or without aliases).\t\t</td> \n <td>\n <ul>\n <li>For <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\" target=\"_blank\">mapping entities</a>: an array of synonyms.<br/> Example: <code>[\"New York\", \"NYC\", \"big Apple\"]</code><br>\n \t</li>\n <br>\n \t<li>For <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\" target=\"_blank\">enum type entities</a>: a string that is identical to the value string.<br>Example: <code>\"@sys.color:color @size:size @clothes:clothes\"</code>\n \t</li>\n \t</ul>\n\t\t</td>\n</tr>\n<tr>\n <td colspan=\"2\">isEnum</td>\n <td>Boolean</td> \n <td>Indicates if the entity is a <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\" target=\"_blank\">mapping</a> or an <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\" target=\"_blank\">enum type</a> entity.</td>\n</tr>\n<tr>\n <td colspan=\"2\">automatedExpansion</td>\n <td>Boolean</td> \n <td>Indicates if the entity can be automatically expanded.</td>\n</tr>\n</table>\n<style></style>" } [/block] ### Sample Mapping Entity Object { "id": "1de251bf-46a6-4056-af9c-96b6ca89dfd0", "name": "appliances", "entries": [ { "value": "coffee maker", "synonyms": [ "coffee maker", "coffee" ] }, { "value": "thermostat", "synonyms": [ "thermostat", "heat", "air conditioning" ] }, { "value": "lights", "synonyms": [ "lights", "light", "lamps" ] }, { "value": "garage door", "synonyms": [ "garage door", "garage" ] } ], "isEnum": false, "automatedExpansion": false } ### Sample Enum Type Composite Entity Object { "id": "0f2c0b53-8681-4e76-9f26-04947bbc48d9", "name": "item", "entries": [ { "value": "@sys.color:color @size:size @clothes:clothes", "synonyms": [ "@sys.color:color @size:size @clothes:clothes" ] }, { "value": "@sys.color:color @clothes:clothes of @size:size", "synonyms": [ "@sys.color:color @clothes:clothes of @size:size" ] } ], "isEnum": true, "automatedExpansion": false } [block:api-header] { "type": "basic", "title": "Array of Entity Entry Objects" } [/block] Array of entity entry objects contains information about entity entries. Each object has the following fields: [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "value", "0-1": "String", "0-2": "- For <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\" target=\"_blank\">mapping entities</a>: a reference value.\n\n- For <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\" target=\"_blank\">enum type entities</a>: a string that can contain references to other entities (with or without aliases).", "1-0": "synonyms", "1-1": "Array of strings", "1-2": "- For <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-mapping-entities\" target=\"_blank\">mapping entities</a>: an array of synonyms.\n\n- For <a href=\"https://docs.api.ai/docs/concept-entities#section-developer-enum-type-entities\" target=\"_blank\">enum type entities</a>: a string that is identical to the value string." }, "cols": 3, "rows": 2 } [/block] ### Sample Array of Mapping Entity Entry Objects [{ "value": "dog", "synonyms": [ "dog", "dogs" ] }, { "value": "cat", "synonyms": [ "cat", "cats", "kitten", "kittens" ] }]