Overview
Sets or removes the obsolete status of a specified experience by setting the deprecated field in the request body to true or false.
API details
Constraints
- You 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 |
Required |
Example value |
Description |
|---|---|---|---|---|
| spaceId | string | Yes | space-123 | Memory space ID. |
| experienceId | integer | Yes | 12345 | Experience ID. |
Body parameters
Name |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| deprecated | boolean | Yes | true | Set the value to true to mark the experience as obsolete, or false to remove its obsolete status. |
Response
Response parameters
Name |
Type |
Description |
|---|---|---|
| success | boolean | Whether the request was successful |
| code | string | Response code. |
| message | string | Response message. |
| data | object | 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": {}
}