Overview
This API is used to mark a specified experience as obsolete or unmark it from being obsolete. It is implemented by setting the deprecated field in the request body to true or false.
API details
Constraints
- The caller must have an API Key. For more information, see Manage AI API Keys.
Request path
PATCH {BASE_URL}/api/v1/memory/spaces/{spaceId}/experiences/{experienceId}/obsolescence
Request headers
Name |
Required |
Example Value |
Description |
|---|---|---|---|
| Authorization | Yes | Bearer {token} | Authentication Information |
| Content-Type | No | application/json | Request Body Format |
| X-OB-Project-ID | Yes | {projectId} | Project ID |
Request parameters
Path parameters
Name |
Type |
Whether required |
Example Value |
Description |
|---|---|---|---|---|
| spaceId | string | Yes | space-123 | Memory space ID. |
| experienceId | integer | Yes | 12345 | Experience ID. |
Body parameters
Name |
Type |
Whether required |
Example Value |
Description |
|---|---|---|---|---|
| deprecated | boolean | Yes | true | true indicates deprecated, and false indicates not deprecated. |
Response parameters
Response parameters
Name |
Type |
Description |
|---|---|---|
| success | boolean | Whether the request was successful |
| code | string | Response Code |
| message | string | Response parameters |
| data | object | Business response data |
Request example
curl --request PATCH '{BASE_URL}/api/v1/memory/spaces/{spaceId}/experiences/{experienceId}/obsolescence' \
--header 'Authorization: Bearer {token}' \
--header 'X-OB-Project-ID: {projectId}' \
--header 'Content-Type: application/json' \
--data '{
"deprecated": true
}'
Response example
{
"success": true,
"code": "200",
"message": "successful",
"data": {}
}