Get AI Space
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves details of the specified AI Space.
Method: GET
Request URL: {kyvos-url}/rest/v2/ai-spaces/{name-or-id}
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the AI Space for which object details are to be retrieved. Note: If the AI Space name is provided, then either folderName or folderId must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a AI Space name or AI Sapce ID. If by=name, provide the AI Space name in the name-or-id parameter. If by=id, provide the AI Space ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder containing the AI Space. If the AI Space is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the AI Space will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the AI Space. | – |
Responses
200 Success
{
"iro": {
"entityRepositDate": "1779177127382",
"ownerAppId": "397039469",
"linkedEntityId": "",
"modelType": "BASE",
"type": "SPACE",
"specific": {
"spaceEntities": {
"SMODEL_OBJECT_17778916825206127085047140225104": {
"name": "aCcount",
"id": "SMODEL_OBJECT_17778916825206127085047140225104",
"modelType": "BASE",
"folderName": "Sales",
"type": "ANALYTICAL",
"folderId": "folder_17778916258243127088097114950635"
},
"C63FEB26-DB0F-B78A-653D-C82EA6F8C500": {
"name": "dim_product",
"id": "C63FEB26-DB0F-B78A-653D-C82EA6F8C500",
"modelType": "BASE",
"folderName": "advantagesolutions",
"type": "ANALYTICAL",
"folderId": "folder_E51386E6-25EE-5297-9E8C-4FEF835B1BA4"
},
"EEE3EE4D-CB39-709E-CC62-647B77CDC48E": {
"name": "rls_team_client",
"id": "EEE3EE4D-CB39-709E-CC62-647B77CDC48E",
"modelType": "BASE",
"folderName": "advantagesolutions",
"type": "ANALYTICAL",
"folderId": "folder_E51386E6-25EE-5297-9E8C-4FEF835B1BA4"
},
"17781500900664127014089166121321": {
"name": "Account copy 11",
"id": "17781500900664127014089166121321",
"modelType": "BASE",
"folderName": "Test",
"type": "ANALYTICAL",
"folderId": "folder_17778916258243127088097114950635"
}
}
},
"folderId": "folder_17785104394259127085028190185304",
"designSource": "DESIGNER",
"ownerAppName": "admin",
"common": {
"compatibilityVersion": "1",
"desc": "",
"tags": ""
},
"entityState": "",
"name": "NEW-SPACE 12",
"isPublic": true,
"subType": "",
"repositDate": "06/03/2026 16:25:37 IST",
"id": "17785888109387127044023166383764",
"folderName": "Sales",
"accessRights": "1",
"categoryId": "folder_17785104394259127085028190185304"
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |