Taxonomy – Mira AI

Overview

In Everything Platform, concepts, classes and categories must be predefined along with their relationships within the taxonomy, where each node (i.e., the concept) can be enriched with additional attributes.

Attributes are inherited along the taxonomy tree. Child nodes automatically inherit all attribute keys from their parent nodes, while also having the ability to introduce new attributes specific to themselves.

GET Taxonomy

GET api/taxonomy/v1/taxonomy?limit=100&offset=0

Request

This request retrieves a list of taxonomy nodes based on the provided limit and offset parameters. The response will contain an array of taxonomy nodes, each with an ID, name, description, parent node (except the root node) and an array of children nodes.

Method: GET
Endpoint: api/taxonomy/v1/taxonomy
Query Parameters:
- limit (number, optional): The maximum number of taxonomy nodes to retrieve.
- offset (number, optional): The offset for paginating through taxonomy nodes.

Request Headers
accessToken	<Acces Token>

Query Params
limit	100
offset	0

Example

curl --location 'api/taxonomy/v1/taxonomy?limit=100&offset=0' \
--header 'accessToken: '

{
    "tenant_id": "b61b449-ec3f-4645-9bb8-d0af9cc0897a",
    "project_id": "e6aabf5b-8c78-4956-a55e-2c3b0f978469",
    "workspace_id": "6d2072d7-7ff8-42d7-a635-875fcda24248",
	"nodes": [
		{
			"taxonomy_node_id": "55a08cdc-da34-45d7-a44b-bf934def1072",
			"label": "Retail",
			"taxonomy_node_details": {
				"node_details": {
					"elements": [
						{
							"element_id": "6f48664e-7226-4a6b-b666-aeb8f6a00f4d",
							"thumbnail_url": "http://cndscnsdcnlsdccds.jpg"
						}
					],
					"attributes": []
				}
			},
			"taxonomy_nodes": [
				{
					"taxonomy_node_id": "1da18c52-16bf-4c50-8f58-9a9721b4e979",
					"parent_node_id": "55a08cdc-da34-45d7-a44b-bf934def1072",
					"label": "Sku",
					"taxonomy_node_details": {
						"node_details": {
							"elements": [
								{
									"element_id": "6f48664e-7226-4a6b-b666-aeb8f6a00f4d",
									"thumbnail_url": "http://cndscnsdcnlsdccds.jpg"
								}
							],
							"attributes": []
						}
					},
					"taxonomy_nodes": [
						{
							"taxonomy_node_id": "67ced9cf-fe2e-4a47-942f-c00de30bb70e",
							"parent_node_id": "1da18c52-16bf-4c50-8f58-9a9721b4e979",
							"label": "Sku_1",
							"taxonomy_node_details": {
								"node_details": {
									"elements": [
										{
											"element_id": "6f48664e-7226-4a6b-b666-aeb8f6a00f4d",
											"thumbnail_url": "http://cndscnsdcnlsdccds.jpg"
										}
									],
									"attributes": []
								}
							},
							"taxonomy_nodes": []
						},
						{
							"taxonomy_node_id": "59ae1867-5c0a-4034-a71c-c46e3535a4bf",
							"parent_node_id": "1da18c52-16bf-4c50-8f58-9a9721b4e979",
							"label": "Sku_2",
							"taxonomy_node_details": {
								"node_details": {
									"elements": [
										{
											"element_id": "6f48664e-7226-4a6b-b666-aeb8f6a00f4d",
											"thumbnail_url": "http://cndscnsdcnlsdccds.jpg"
										}
									],
									"attributes": []
								}
							},
							"taxonomy_nodes": []
						},
						{
							"taxonomy_node_id": "23cc248d-8c17-4799-b850-b7c8d995d881",
							"parent_node_id": "1da18c52-16bf-4c50-8f58-9a9721b4e979",
							"label": "Sku_3",
							"taxonomy_node_details": {
								"node_details": {
									"elements": [
										{
											"element_id": "6f48664e-7226-4a6b-b666-aeb8f6a00f4d",
											"thumbnail_url": "http://cndscnsdcnlsdccds.jpg"
										}
									],
									"attributes": []
								}
							},
							"taxonomy_nodes": []
						}
					]
				},
				{
					"taxonomy_node_id": "a47d4a3d-bd2c-4c47-9591-95d006d61750",
					"parent_node_id": "55a08cdc-da34-45d7-a44b-bf934def1072",
					"label": "Shelves",
					"taxonomy_nodes": []
				}
			]
		},
		{
			"taxonomy_node_id": "55a08cdc-da34-45d7-a44b-bf934def1075",
			"label": "Objects",
			"taxonomy_nodes": []
		}
	]
}

POST Insert taxonomy node

POST api/taxonomy/v1/taxonomy

This endpoint allows you to create a new taxonomy node.

Request Body

parent_node_id (string, optional): The ID of the parent node.
taxonomy_node_details (object):
- node_details (object):
  - attributes (array):
  - attribute_id (string): The ID of the attribute.
  - attribute_key (string): The key of the attribute.
  - mandatory (boolean): Indicates whether the attribute is mandatory.
  - value (string): The value of the attribute.
  - value_type (string): The type of the attribute value.
elements (array): An array of elements.

Response
The response will contain the details of the newly created taxonomy node.

Request Headers
accessToken	<Acces Token>

Body

{
    "parent_node_id": "bc579a0f-0fe5-411d-aa66-e543af4a83d8",
    "taxonomy_node_details": {
        "node_details": {
            "attributes": [
                {
                    "attribute_id": "39f49733-1705-43f0-b4b3-321560bee014",
                    "attribute_key": "Label",
                    "mandatory": true,
                    "value": "Tabasco red pepper spicy sauce",
                    "value_type": "text"
                },
                {
                    "attribute_id": "39f49733-1705-43f0-b4b3-321560bee014",
                    "attribute_key": "EAN Code",
                    "mandatory": false,
                    "value": "401234567890",
                    "value_type": "text"
                }
            ],
            "elements": []
        }
    }
}