Search memories

POST

product

Search memories

curl --request POST \
  --url https://api.example.com/product/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "user_id": "<string>",
  "readable_cube_ids": [
    "<string>"
  ],
  "mode": "fast",
  "session_id": "<string>",
  "top_k": 10,
  "pref_top_k": 6,
  "include_preference": true,
  "search_tool_memory": true,
  "tool_mem_top_k": 6,
  "filter": {},
  "internet_search": false,
  "threshold": 123,
  "search_memory_type": "All",
  "chat_history": [
    {
      "content": "<string>",
      "role": "<string>",
      "name": "<string>",
      "chat_time": "<string>",
      "message_id": "<string>"
    }
  ],
  "mem_cube_id": "<string>",
  "moscube": false,
  "operation": [
    {
      "permissions": [],
      "mem_cube_id": "<string>"
    }
  ],
  "source": "<string>"
}
'

import requests

url = "https://api.example.com/product/search"

payload = {
    "query": "<string>",
    "user_id": "<string>",
    "readable_cube_ids": ["<string>"],
    "mode": "fast",
    "session_id": "<string>",
    "top_k": 10,
    "pref_top_k": 6,
    "include_preference": True,
    "search_tool_memory": True,
    "tool_mem_top_k": 6,
    "filter": {},
    "internet_search": False,
    "threshold": 123,
    "search_memory_type": "All",
    "chat_history": [
        {
            "content": "<string>",
            "role": "<string>",
            "name": "<string>",
            "chat_time": "<string>",
            "message_id": "<string>"
        }
    ],
    "mem_cube_id": "<string>",
    "moscube": False,
    "operation": [
        {
            "permissions": [],
            "mem_cube_id": "<string>"
        }
    ],
    "source": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    user_id: '<string>',
    readable_cube_ids: ['<string>'],
    mode: 'fast',
    session_id: '<string>',
    top_k: 10,
    pref_top_k: 6,
    include_preference: true,
    search_tool_memory: true,
    tool_mem_top_k: 6,
    filter: {},
    internet_search: false,
    threshold: 123,
    search_memory_type: 'All',
    chat_history: [
      {
        content: '<string>',
        role: '<string>',
        name: '<string>',
        chat_time: '<string>',
        message_id: '<string>'
      }
    ],
    mem_cube_id: '<string>',
    moscube: false,
    operation: [{permissions: [], mem_cube_id: '<string>'}],
    source: '<string>'
  })
};

fetch('https://api.example.com/product/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/product/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'user_id' => '<string>',
    'readable_cube_ids' => [
        '<string>'
    ],
    'mode' => 'fast',
    'session_id' => '<string>',
    'top_k' => 10,
    'pref_top_k' => 6,
    'include_preference' => true,
    'search_tool_memory' => true,
    'tool_mem_top_k' => 6,
    'filter' => [
        
    ],
    'internet_search' => false,
    'threshold' => 123,
    'search_memory_type' => 'All',
    'chat_history' => [
        [
                'content' => '<string>',
                'role' => '<string>',
                'name' => '<string>',
                'chat_time' => '<string>',
                'message_id' => '<string>'
        ]
    ],
    'mem_cube_id' => '<string>',
    'moscube' => false,
    'operation' => [
        [
                'permissions' => [
                                
                ],
                'mem_cube_id' => '<string>'
        ]
    ],
    'source' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/product/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"readable_cube_ids\": [\n    \"<string>\"\n  ],\n  \"mode\": \"fast\",\n  \"session_id\": \"<string>\",\n  \"top_k\": 10,\n  \"pref_top_k\": 6,\n  \"include_preference\": true,\n  \"search_tool_memory\": true,\n  \"tool_mem_top_k\": 6,\n  \"filter\": {},\n  \"internet_search\": false,\n  \"threshold\": 123,\n  \"search_memory_type\": \"All\",\n  \"chat_history\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"name\": \"<string>\",\n      \"chat_time\": \"<string>\",\n      \"message_id\": \"<string>\"\n    }\n  ],\n  \"mem_cube_id\": \"<string>\",\n  \"moscube\": false,\n  \"operation\": [\n    {\n      \"permissions\": [],\n      \"mem_cube_id\": \"<string>\"\n    }\n  ],\n  \"source\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/product/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"readable_cube_ids\": [\n    \"<string>\"\n  ],\n  \"mode\": \"fast\",\n  \"session_id\": \"<string>\",\n  \"top_k\": 10,\n  \"pref_top_k\": 6,\n  \"include_preference\": true,\n  \"search_tool_memory\": true,\n  \"tool_mem_top_k\": 6,\n  \"filter\": {},\n  \"internet_search\": false,\n  \"threshold\": 123,\n  \"search_memory_type\": \"All\",\n  \"chat_history\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"name\": \"<string>\",\n      \"chat_time\": \"<string>\",\n      \"message_id\": \"<string>\"\n    }\n  ],\n  \"mem_cube_id\": \"<string>\",\n  \"moscube\": false,\n  \"operation\": [\n    {\n      \"permissions\": [],\n      \"mem_cube_id\": \"<string>\"\n    }\n  ],\n  \"source\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/product/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"readable_cube_ids\": [\n    \"<string>\"\n  ],\n  \"mode\": \"fast\",\n  \"session_id\": \"<string>\",\n  \"top_k\": 10,\n  \"pref_top_k\": 6,\n  \"include_preference\": true,\n  \"search_tool_memory\": true,\n  \"tool_mem_top_k\": 6,\n  \"filter\": {},\n  \"internet_search\": false,\n  \"threshold\": 123,\n  \"search_memory_type\": \"All\",\n  \"chat_history\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"name\": \"<string>\",\n      \"chat_time\": \"<string>\",\n      \"message_id\": \"<string>\"\n    }\n  ],\n  \"mem_cube_id\": \"<string>\",\n  \"moscube\": false,\n  \"operation\": [\n    {\n      \"permissions\": [],\n      \"mem_cube_id\": \"<string>\"\n    }\n  ],\n  \"source\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "code": 200,
  "data": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Body

application/json

Request model for searching memories.

query

string

required

User search query

user_id

string

required

User ID

readable_cube_ids

string[] | null

List of cube IDs that are readable for this request. Required for algorithm-facing API; optional for developer-facing API.

mode

enum<string>

default:fast

Search mode: fast, fine, or mixture.

Available options:

fast,

fine,

mixture

session_id

string | null

Session ID used as a soft signal to prioritize more relevant memories. Only used for weighting, not as a hard filter.

top_k

integer

default:10

Number of textual memories to retrieve (top-K). Default: 10.

Required range: x >= 1

pref_top_k

integer

default:6

Number of preference memories to retrieve (top-K). Default: 6.

Required range: x >= 0

include_preference

boolean

default:true

Whether to retrieve preference memories along with general memories. If enabled, the system will automatically recall user preferences relevant to the query. Default: True.

search_tool_memory

boolean

default:true

Whether to retrieve tool memories along with general memories. If enabled, the system will automatically recall tool memories relevant to the query. Default: True.

tool_mem_top_k

integer

default:6

Number of tool memories to retrieve (top-K). Default: 6.

Required range: x >= 0

filter

Filter · object | null

Filter for the memory, example:
    {
        "`and` or `or`": [
            {"id": "uuid-xxx"},
            {"created_at": {"gt": "2024-01-01"}},
        ]
    }

internet_search

boolean

default:false

Whether to enable internet search in addition to memory search. Primarily used by internal algorithms. Default: False.

threshold

number | null

Internal similarity threshold for searching plaintext memories. If None, default thresholds will be applied.

search_memory_type

string

default:All

Type of memory to search: All, WorkingMemory, LongTermMemory, UserMemory, OuterMemory, ToolSchemaMemory, ToolTrajectoryMemory

chat_history

(ChatCompletionSystemMessageParam · object | ChatCompletionUserMessageParam · object | ChatCompletionAssistantMessageParam · object | ChatCompletionToolMessageParam · object)[] | null

Historical chat messages used internally by algorithms. If None, internal stored history may be used; if provided (even an empty list), this value will be used as-is.

ChatCompletionSystemMessageParam
ChatCompletionUserMessageParam
ChatCompletionAssistantMessageParam
ChatCompletionToolMessageParam

Show child attributes

mem_cube_id

string | null

(Deprecated) Single cube ID to search in. Prefer readable_cube_ids for multi-cube search.

moscube

boolean

default:false

(Deprecated / internal) Whether to use legacy MemOSCube path.

operation

PermissionDict · object[] | null

(Internal) Operation definitions for multi-cube read permissions.

Show child attributes

source

string | null

Source of the search query [plugin will router diff search]

Response

Successful Response

Response model for search operations.

message

string

required

Response message

code

integer

default:200

Response status code

data

Data · object | null

Response data

Search memories

curl --request POST \
  --url https://api.example.com/product/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "user_id": "<string>",
  "readable_cube_ids": [
    "<string>"
  ],
  "mode": "fast",
  "session_id": "<string>",
  "top_k": 10,
  "pref_top_k": 6,
  "include_preference": true,
  "search_tool_memory": true,
  "tool_mem_top_k": 6,
  "filter": {},
  "internet_search": false,
  "threshold": 123,
  "search_memory_type": "All",
  "chat_history": [
    {
      "content": "<string>",
      "role": "<string>",
      "name": "<string>",
      "chat_time": "<string>",
      "message_id": "<string>"
    }
  ],
  "mem_cube_id": "<string>",
  "moscube": false,
  "operation": [
    {
      "permissions": [],
      "mem_cube_id": "<string>"
    }
  ],
  "source": "<string>"
}
'

import requests

url = "https://api.example.com/product/search"

payload = {
    "query": "<string>",
    "user_id": "<string>",
    "readable_cube_ids": ["<string>"],
    "mode": "fast",
    "session_id": "<string>",
    "top_k": 10,
    "pref_top_k": 6,
    "include_preference": True,
    "search_tool_memory": True,
    "tool_mem_top_k": 6,
    "filter": {},
    "internet_search": False,
    "threshold": 123,
    "search_memory_type": "All",
    "chat_history": [
        {
            "content": "<string>",
            "role": "<string>",
            "name": "<string>",
            "chat_time": "<string>",
            "message_id": "<string>"
        }
    ],
    "mem_cube_id": "<string>",
    "moscube": False,
    "operation": [
        {
            "permissions": [],
            "mem_cube_id": "<string>"
        }
    ],
    "source": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    user_id: '<string>',
    readable_cube_ids: ['<string>'],
    mode: 'fast',
    session_id: '<string>',
    top_k: 10,
    pref_top_k: 6,
    include_preference: true,
    search_tool_memory: true,
    tool_mem_top_k: 6,
    filter: {},
    internet_search: false,
    threshold: 123,
    search_memory_type: 'All',
    chat_history: [
      {
        content: '<string>',
        role: '<string>',
        name: '<string>',
        chat_time: '<string>',
        message_id: '<string>'
      }
    ],
    mem_cube_id: '<string>',
    moscube: false,
    operation: [{permissions: [], mem_cube_id: '<string>'}],
    source: '<string>'
  })
};

fetch('https://api.example.com/product/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/product/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'user_id' => '<string>',
    'readable_cube_ids' => [
        '<string>'
    ],
    'mode' => 'fast',
    'session_id' => '<string>',
    'top_k' => 10,
    'pref_top_k' => 6,
    'include_preference' => true,
    'search_tool_memory' => true,
    'tool_mem_top_k' => 6,
    'filter' => [
        
    ],
    'internet_search' => false,
    'threshold' => 123,
    'search_memory_type' => 'All',
    'chat_history' => [
        [
                'content' => '<string>',
                'role' => '<string>',
                'name' => '<string>',
                'chat_time' => '<string>',
                'message_id' => '<string>'
        ]
    ],
    'mem_cube_id' => '<string>',
    'moscube' => false,
    'operation' => [
        [
                'permissions' => [
                                
                ],
                'mem_cube_id' => '<string>'
        ]
    ],
    'source' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/product/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"readable_cube_ids\": [\n    \"<string>\"\n  ],\n  \"mode\": \"fast\",\n  \"session_id\": \"<string>\",\n  \"top_k\": 10,\n  \"pref_top_k\": 6,\n  \"include_preference\": true,\n  \"search_tool_memory\": true,\n  \"tool_mem_top_k\": 6,\n  \"filter\": {},\n  \"internet_search\": false,\n  \"threshold\": 123,\n  \"search_memory_type\": \"All\",\n  \"chat_history\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"name\": \"<string>\",\n      \"chat_time\": \"<string>\",\n      \"message_id\": \"<string>\"\n    }\n  ],\n  \"mem_cube_id\": \"<string>\",\n  \"moscube\": false,\n  \"operation\": [\n    {\n      \"permissions\": [],\n      \"mem_cube_id\": \"<string>\"\n    }\n  ],\n  \"source\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/product/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"readable_cube_ids\": [\n    \"<string>\"\n  ],\n  \"mode\": \"fast\",\n  \"session_id\": \"<string>\",\n  \"top_k\": 10,\n  \"pref_top_k\": 6,\n  \"include_preference\": true,\n  \"search_tool_memory\": true,\n  \"tool_mem_top_k\": 6,\n  \"filter\": {},\n  \"internet_search\": false,\n  \"threshold\": 123,\n  \"search_memory_type\": \"All\",\n  \"chat_history\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"name\": \"<string>\",\n      \"chat_time\": \"<string>\",\n      \"message_id\": \"<string>\"\n    }\n  ],\n  \"mem_cube_id\": \"<string>\",\n  \"moscube\": false,\n  \"operation\": [\n    {\n      \"permissions\": [],\n      \"mem_cube_id\": \"<string>\"\n    }\n  ],\n  \"source\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/product/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"readable_cube_ids\": [\n    \"<string>\"\n  ],\n  \"mode\": \"fast\",\n  \"session_id\": \"<string>\",\n  \"top_k\": 10,\n  \"pref_top_k\": 6,\n  \"include_preference\": true,\n  \"search_tool_memory\": true,\n  \"tool_mem_top_k\": 6,\n  \"filter\": {},\n  \"internet_search\": false,\n  \"threshold\": 123,\n  \"search_memory_type\": \"All\",\n  \"chat_history\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"name\": \"<string>\",\n      \"chat_time\": \"<string>\",\n      \"message_id\": \"<string>\"\n    }\n  ],\n  \"mem_cube_id\": \"<string>\",\n  \"moscube\": false,\n  \"operation\": [\n    {\n      \"permissions\": [],\n      \"mem_cube_id\": \"<string>\"\n    }\n  ],\n  \"source\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "code": 200,
  "data": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

product

users

mem_cubes

memories

others

Body

Response