Validate AI Space
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API validates an AI Space and its related configurations to ensure correctness and consistency.
Method: POST
Request URL: {kyvos-url}/rest/v2/ai-spaces/{name-or-id}/validate
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 |
|---|---|---|---|
Content-Type (Required) | String | Specifies media type of request body. |
|
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 | Represents the name or ID of the AI Space that needs to be validated. 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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json | String | JSON of the AI Space that needs to be validated. Note: An example JSON is provided under the Resources section below for reference. | – |
folderName | String | Name of the folder that 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 that containing the AI Space. | – |
Responses
200 Success
{
"code": 0,
"message": "AI Space validated successfully.",
"validationStatus": "VALID"
}Resources
JSON Example for request body parameter.