1Get AI Spaces From Folder
Overview
This API retrieves a list of AI Space objects from a specific folder.
Method: GET
Request URL: {kyvos-url}/rest/v2/ai-spaces/folders/{foldername-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 |
|---|---|---|---|
foldername-or-id (Required) | String | Name or ID of the folder from which you want to retrieve the list of AI Space objects. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the foldername-or-id parameter should be interpreted as an AI Space folder name or folder ID. If by=name, provide the folder name in the foldername-or-id parameter. If by=id, provide the folder ID in the foldername-or-id parameter. The default value is name. | – |
owner | String | Filters AI Spaces based on the owner name. | – |
tags | String | Filters AI Spaces by tags. This filter applies only to AI Spaces that contain at least one tag. | – |
searchText | String | Filters AI Spaces by name. All AI Spaces whose names contain the specified text are included in the response, irrespective of case. | – |
modifiedAfter | String | Filters AI Spaces to include only those modified after the specified Unix timestamp. | – |
modifiedBefore | String | Filters AI Spaces to include only those modified before the specified Unix timestamp. | – |
count | Number | Specifies the maximum number of records returned in the response. Note: The If the value is negative, all available records are returned. Default: | – |
lastEntityName | String | Returns only the entities occurring after the specified entity name. All preceding entities are skipped. | – |
lastEntityId | String | Returns only the entities occurring after the specified entity ID. All preceding entities are skipped. | – |
Responses
200 Success
{
"spaces": [
{
"owner": "admin",
"name": "Sales space",
"id": "17785888109387127044023166383764",
"lastModified": "05/19/2026 13:22:07 IST",
"accessRights": "1",
"ownerId": "397039469",
"lastModifiedTimestamp": "1779177127382"
},
{
"owner": "admin",
"name": "Product space",
"id": "17785104411806127093050179966831",
"lastModified": "05/16/2026 14:23:48 IST",
"accessRights": "1",
"ownerId": "397039469",
"lastModifiedTimestamp": "1778921628709"
}
]
}Status Code | Description |
|---|
Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |