1Update AI Space
Overview
This API updates the specified AI Space.
Method: PUT
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 |
|---|---|---|---|
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 updated. | – |
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 Space 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 (Required) | String | JSON containing details of the AI Space object to be updated, To update the AI Space’s name using this API, you must provide the AI Space’s ID in the path parameter. If name is provided instead of the ID, the name will not be updated. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated space: Product Space"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Required parameter missing. |
500 | Internal Server Error |
Resources
JSON Example for request body parameter.