This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here.

{
    "iro":{
        "entityRepositDate":"1779177127382",
        "ownerAppId":"397039469",
        "linkedEntityId":"",
        "type":"SPACE",
        "specific":{
            "spaceEntities":{
                "SMODEL_OBJECT_17778916825206127085047140225104":{
                    "name":"aCcount",
                    "id":"SMODEL_OBJECT_17778916825206127085047140225104",
                    "type":"ANALYTICAL",
                    "categoryName":"Admin",
                    "categoryId":"folder_17778916258243127088097114950635"
                },
                "C63FEB26-DB0F-B78A-653D-C82EA6F8C500":{
                    "name":"dim_product",
                    "id":"C63FEB26-DB0F-B78A-653D-C82EA6F8C500",
                    "type":"ANALYTICAL",
                    "categoryName":"advantagesolutions",
                    "categoryId":"folder_E51386E6-25EE-5297-9E8C-4FEF835B1BA4"
                },
                "EEE3EE4D-CB39-709E-CC62-647B77CDC48E":{
                    "name":"rls_team_client",
                    "id":"EEE3EE4D-CB39-709E-CC62-647B77CDC48E",
                    "type":"ANALYTICAL",
                    "categoryName":"advantagesolutions",
                    "categoryId":"folder_E51386E6-25EE-5297-9E8C-4FEF835B1BA4"
                },
                "17781500900664127014089166121321":{
                    "name":"Account copy 11",
                    "id":"17781500900664127014089166121321",
                    "type":"ANALYTICAL",
                    "categoryName":"Amit",
                    "categoryId":"folder_17778916258243127088097114950635"
                }
            }
        },
        "folderId":"folder_17785104394259127085028190185304",
        "designSource":"DESIGNER",
        "ownerAppName":"admin",
        "common":{
            "compatibilityVersion":"1",
            "desc":"",
            "tags":""
        },
        "entityState":"",
        "name":"NEW-SPACE 121",
        "isPublic":true,
        "subType":"",
        "repositDate":"05/19/2026 13:22:07 IST",
        "folderName":"Admin",
        "accessRights":"1",
        "categoryId":"folder_17785104394259127085028190185304"
    }
}

JSON Field Definitions

Field	Type	Description	Possible Values	Example
iro	Object	Wrapper object containing the complete AI Space entity data	JSON Object	{"iro": {...}}
iro.id	String	System-generated unique identifier for the AI Space	Alphanumeric ID	"space_17768558564508127068"
iro.name	String	Display name of the AI Space used for identification in the UI and Kyvos Dialogs	Any valid string	"Sales Analytics Space"
iro.type	String	Entity type indicating this is an AI Space	SPACE	"SPACE"
iro.subType	String	Subtype of the entity (reserved for future use)	Empty string or specific subtype	""
iro.folderId	String	Unique identifier of the folder where the AI Space is stored	Folder ID or empty	"folder_123456789"
iro.folderName	String	Name of the folder where the AI Space is stored	Folder name or root folder name	"AI Spaces"
iro.categoryId	String	Category identifier (same as folderId for organizational purposes)	Category ID	"folder_123456789"
iro.accessRights	String	Access permissions for the current user on this AI Space	0,1	"0"
iro.isPublic	Boolean	Indicates whether the AI Space is publicly accessible to all users	true,false	FALSE
iro.entityState	String	Current state of the AI Space entity	ACTIVE,INACTIVE	"ACTIVE"
iro.designSource	String	Source from which the AI Space was created	UI,API	"UI"
iro.ownerAppId	String	Application ID of the owner	Application ID or empty	""
iro.ownerAppName	String	Application name of the owner	Application name or empty	""
iro.repositDate	String	Date when the AI Space was stored in the repository	Date string	"2026-06-10"
iro.entityRepositDate	String	Entity-specific repository date	Date string	"2026-06-10"
iro.linkedEntityId	String	ID of any linked entity if applicable	Entity ID or empty	""
iro.sourceEntityId	String	ID of the source entity if this AI Space was copied	Entity ID or empty	""
iro.sourceEntityName	String	Name of the source entity if this AI Space was copied	Entity name or empty	""
iro.sourceFolderId	String	Folder ID of the source entity if this AI Space was copied	Folder ID or empty	""
iro.common	Object	Common metadata including description, tags, and compatibility version	JSON Object	{"desc": "", "tags": ""}
iro.common.desc	String	Notes or description providing additional information about the AI Space	Free text	"AI Space for sales analytics"
iro.common.tags	String	Comma-separated tags for categorizing and searching the AI Space	Comma-separated values	"sales,analytics,quarterly"
iro.common.compatibilityVersion	String	Version number for backward compatibility	Version string	"3"
iro.common.entityRefs	Array	References to related entities	Array of entity references	[]
iro.specific	Object	AI Space-specific data including space entities and AI context settings	JSON Object	{"spaceEntities": {...}}
iro.specific.spaceEntities	Object	Map of entities (Semantic Models) added to this AI Space where each key is an entity ID	JSON Object with entity IDs as keys	{"entity_id_1": {...}}
iro.specific.spaceEntities.{entityId}	Object	Individual entity object containing details of a Semantic Model added to the AI Space	JSON Object	{"id": "...", "name": "..."}
iro.specific.spaceEntities.{entityId}.id	String	Unique identifier of the entity (Semantic Model) added to the AI Space	Entity ID	"cube_123456789"
iro.specific.spaceEntities.{entityId}.name	String	Display name of the entity (Semantic Model)	Entity name	"Sales_Model"
iro.specific.spaceEntities.{entityId}.type	String	Type of the entity added to the AI Space	CUBE	"CUBE"
iro.specific.spaceEntities.{entityId}.categoryId	String	Folder ID where the entity is stored	Folder ID	"folder_789"
iro.specific.spaceEntities.{entityId}.categoryName	String	Folder name where the entity is stored	Folder name	"Semantic Models"
iro.specific.spaceEntities.{entityId}.businessContext	String	Entity-level business context describing the semantic model's purpose and domain	Free text	"Contains sales transaction data"
iro.specific.spaceEntities.{entityId}.queryingContext	String	Entity-level querying instructions for this specific semantic model	Free text	"Use SUM for revenue calculations"
iro.specific.spaceEntities.{entityId}.summaryContext	String	Entity-level summary instructions for this specific semantic model	Free text	"Highlight top performers"
iro.specific.queryingInstructions	String	Space-level context instructions included with user input for generating queries. Helps guide query generation, refine results, and improve response accuracy in Kyvos Dialogs	Free text with optional XML tags	"Always use fiscal year for date calculations"
iro.specific.summaryInstructions	String	Space-level context instructions for generating natural language summaries. Can include FOLLOW_UP_QUES_RULES tags for follow-up question generation rules	Free text with optional XML tags	"<FOLLOW_UP_QUES_RULES>Generate 3 follow-up questions</FOLLOW_UP_QUES_RULES>"
iro.specific.businessContext	String	Space-level business context that helps the AI identify relevant semantic models and produce more accurate responses. Provides insight into the purpose and domain of the AI Space	Free text	"This space contains sales data for North America region including revenue, profit, and customer metrics"

Create and Update AI Space JSON Examples

Table of Contents

Complete JSON Example

JSON Body

JSON Field Definitions