Overview
This API is used to retrieve detailed information about a single memory based on the specified memory space ID and memory ID.
API details
Constraints
- The caller must have an API Key. For more information, see Manage AI API Keys.
Request path
GET {BASE_URL}/api/v1/memory/spaces/{spaceId}/memories/{memoryId}
Request headers
Name |
Required |
Example Value |
Description |
|---|---|---|---|
| Authorization | Yes | Bearer {token} | Authentication Information |
| X-OB-Project-ID | Yes | your-project-id | Project ID |
| Content-Type | No | application/json | Request Body Format |
Request parameters
Path parameters
Name |
Type |
Whether required |
Example Value |
Description |
|---|---|---|---|---|
| spaceId | string | Yes | space-123 | Memory space ID. |
| memoryId | integer | Yes | 1234567890 | Memory ID (snowflake int64). |
Response
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 |
Data field description
The data field returned by the API contains the details of the specific memory. Its structure is defined by the upstream service and is an unknown object here.
Request example
curl --request GET '{BASE_URL}/api/v1/memory/spaces/space-123/memories/1234567890123456' \
--header 'Authorization: Bearer {token}' \
--header 'X-OB-Project-ID: your-project-id'
Response example
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": 1234567890123456,
"content": "This is an example of a piece of memory content.",
"metadata": {}
}
}