Overview
Submit a multi-turn dialogue to the server. The model automatically extracts valuable memories (such as characters, events, and preferences) and writes them to the specified memory space. The API returns statistics on add, update, and skip operations performed this time.
API details
Constraints
- You must have an API Key. For more information, see Manage AI API Keys.
Request path
POST {BASE_URL}/api/v1/memory/spaces/{spaceId}/memories/extract
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 | your-project-id | Project ID |
Request parameters
Path parameters
Name |
Type |
Whether required |
Example Value |
Description |
|---|---|---|---|---|
| spaceId | string | Yes | space-123 | Memory space ID. |
Body parameters
Name |
Type |
Whether required |
Example Value |
Description |
|---|---|---|---|---|
| userId | string | Yes | user-001 | Business user ID. |
| agentId | string | Yes | agent-001 | Business agent ID. |
| sessionId | string | Yes | session-abc123 | Business session ID. |
| messages | array |
Yes | [{"role":"user","content":"Hello"}] | List of conversation messages. |
| messages[].role | string | Yes | user | Message role. Valid values: user, assistant, and system. |
| messages[].content | string | Yes | Hello | The content of the message. |
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 |
Data fields
Name |
Type |
Description |
|---|---|---|
| add | integer | Number of Newly Added Memories |
| update | integer | Number of Updated Memories |
| skip | integer | Number of Skipped Memories |
Request example
curl --request POST '{BASE_URL}/api/v1/memory/spaces/space-123/memories/extract' \
--header 'Authorization: Bearer {token}' \
--header 'X-OB-Project-ID: your-project-id' \
--header 'Content-Type: application/json' \
--data '{
"userId": "user-001",
"agentId": "agent-001",
"sessionId": "session-abc123",
"messages": [
{"role": "user", "content": "I like spicy hot pot."},
{"role": "assistant", "content": "Okay, your taste preference has been recorded."}
]
}'
Response example
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"add": 2,
"update": 1,
"skip": 0
}
}