Overview
This API is used to update the name and description of a specified memory space. Only the spaceName and description fields can be updated; other fields (such as dims and provider) cannot be changed.
API details
Constraints
- The caller must have an API key. For more information, see Manage AI API keys.
Request path
PUT {BASE_URL}/api/v1/memory/spaces/{spaceId}
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 | {project-id} | Project ID |
Request parameters
Path parameters
Name |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| spaceId | string | Yes | space-123 | Memory space ID. |
Body parameters
Name |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| spaceName | string | Yes | my-space | The name of the space, which must not exceed 128 characters in length. |
| description | string | No | A space for storing memories. | The maximum length of the space description is 512 characters. |
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. |
Data fields
Name |
Type |
Description |
|---|---|---|
| id | string | Unique resource identifier. |
| name | string | Resource name. |
| status | string | Resource status. |
| createTime | string | Creation time. |
Request example
curl --request PUT '{BASE_URL}/api/v1/memory/spaces/spc-123456' \
--header 'Authorization: Bearer {token}' \
--header 'X-OB-Project-ID: {project-id}' \
--header 'Content-Type: application/json' \
--data '{
"spaceName": "my-space",
"description": "This is a memory space for testing."
}'
Response example
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "spc-123456",
"name": "my-space",
"status": "RUNNING",
"createTime": "2026-04-10T10:00:00Z"
}
}