> ## Documentation Index
> Fetch the complete documentation index at: https://memos-api.openmem.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Search memories

> Search memories for a specific user.

This endpoint uses the class-based SearchHandler for better code organization.



## OpenAPI

````yaml mintdocs/openapi.json post /product/search
openapi: 3.1.0
info:
  title: MemOS API
  version: 1.0.0
servers: []
security: []
paths:
  /product/search:
    post:
      tags:
        - Server API
      summary: Search memories
      description: >-
        Search memories for a specific user.


        This endpoint uses the class-based SearchHandler for better code
        organization.
      operationId: search_memories_product_search_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APISearchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    APISearchRequest:
      properties:
        query:
          type: string
          title: Query
          description: User search query
        user_id:
          type: string
          title: User Id
          description: User ID
        readable_cube_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Readable Cube Ids
          description: >-
            List of cube IDs that are readable for this request. Required for
            algorithm-facing API; optional for developer-facing API.
        mode:
          $ref: '#/components/schemas/SearchMode'
          description: 'Search mode: fast, fine, or mixture.'
          default: fast
        session_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Id
          description: >-
            Session ID used as a soft signal to prioritize more relevant
            memories. Only used for weighting, not as a hard filter.
        top_k:
          type: integer
          minimum: 1
          title: Top K
          description: 'Number of textual memories to retrieve (top-K). Default: 10.'
          default: 10
        pref_top_k:
          type: integer
          minimum: 0
          title: Pref Top K
          description: 'Number of preference memories to retrieve (top-K). Default: 6.'
          default: 6
        include_preference:
          type: boolean
          title: Include Preference
          description: >-
            Whether to retrieve preference memories along with general memories.
            If enabled, the system will automatically recall user preferences
            relevant to the query. Default: True.
          default: true
        search_tool_memory:
          type: boolean
          title: Search Tool Memory
          description: >-
            Whether to retrieve tool memories along with general memories. If
            enabled, the system will automatically recall tool memories relevant
            to the query. Default: True.
          default: true
        tool_mem_top_k:
          type: integer
          minimum: 0
          title: Tool Mem Top K
          description: 'Number of tool memories to retrieve (top-K). Default: 6.'
          default: 6
        filter:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Filter
          description: |2-

                    Filter for the memory, example:
                    {
                        "`and` or `or`": [
                            {"id": "uuid-xxx"},
                            {"created_at": {"gt": "2024-01-01"}},
                        ]
                    }
                    
        internet_search:
          type: boolean
          title: Internet Search
          description: >-
            Whether to enable internet search in addition to memory search.
            Primarily used by internal algorithms. Default: False.
          default: false
        threshold:
          anyOf:
            - type: number
            - type: 'null'
          title: Threshold
          description: >-
            Internal similarity threshold for searching plaintext memories. If
            None, default thresholds will be applied.
        search_memory_type:
          type: string
          title: Search Memory Type
          description: >-
            Type of memory to search: All, WorkingMemory, LongTermMemory,
            UserMemory, OuterMemory, ToolSchemaMemory, ToolTrajectoryMemory
          default: All
        chat_history:
          anyOf:
            - items:
                anyOf:
                  - $ref: '#/components/schemas/ChatCompletionSystemMessageParam'
                  - $ref: '#/components/schemas/ChatCompletionUserMessageParam'
                  - $ref: '#/components/schemas/ChatCompletionAssistantMessageParam'
                  - $ref: '#/components/schemas/ChatCompletionToolMessageParam'
              type: array
            - type: 'null'
          title: Chat History
          description: >-
            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.
        mem_cube_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Mem Cube Id
          description: >-
            (Deprecated) Single cube ID to search in. Prefer `readable_cube_ids`
            for multi-cube search.
        moscube:
          type: boolean
          title: Moscube
          description: (Deprecated / internal) Whether to use legacy MemOSCube path.
          default: false
        operation:
          anyOf:
            - items:
                $ref: '#/components/schemas/PermissionDict'
              type: array
            - type: 'null'
          title: Operation
          description: (Internal) Operation definitions for multi-cube read permissions.
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: Source of the search query [plugin will router diff search]
      type: object
      required:
        - query
        - user_id
      title: APISearchRequest
      description: Request model for searching memories.
    SearchResponse:
      properties:
        code:
          type: integer
          title: Code
          description: Response status code
          default: 200
        message:
          type: string
          title: Message
          description: Response message
        data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Data
          description: Response data
      type: object
      required:
        - message
      title: SearchResponse
      description: Response model for search operations.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SearchMode:
      type: string
      enum:
        - fast
        - fine
        - mixture
      title: SearchMode
      description: Enumeration for search modes.
    ChatCompletionSystemMessageParam:
      properties:
        content:
          anyOf:
            - type: string
            - items:
                $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
              type: array
            - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
          title: Content
        role:
          type: string
          const: system
          title: Role
        name:
          type: string
          title: Name
        chat_time:
          anyOf:
            - type: string
            - type: 'null'
          title: Chat Time
        message_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Message Id
      type: object
      required:
        - content
        - role
      title: ChatCompletionSystemMessageParam
    ChatCompletionUserMessageParam:
      properties:
        content:
          anyOf:
            - type: string
            - items:
                anyOf:
                  - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
                  - $ref: '#/components/schemas/ChatCompletionContentPartImageParam'
                  - $ref: >-
                      #/components/schemas/ChatCompletionContentPartInputAudioParam
                  - $ref: '#/components/schemas/File'
              type: array
            - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
            - $ref: '#/components/schemas/ChatCompletionContentPartImageParam'
            - $ref: '#/components/schemas/ChatCompletionContentPartInputAudioParam'
            - $ref: '#/components/schemas/File'
          title: Content
        role:
          type: string
          const: user
          title: Role
        name:
          type: string
          title: Name
        chat_time:
          anyOf:
            - type: string
            - type: 'null'
          title: Chat Time
        message_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Message Id
      type: object
      required:
        - content
        - role
      title: ChatCompletionUserMessageParam
    ChatCompletionAssistantMessageParam:
      properties:
        role:
          type: string
          const: assistant
          title: Role
        audio:
          anyOf:
            - $ref: '#/components/schemas/Audio'
            - type: 'null'
        content:
          anyOf:
            - type: string
            - items:
                anyOf:
                  - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
                  - $ref: '#/components/schemas/ChatCompletionContentPartRefusalParam'
              type: array
            - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
            - $ref: '#/components/schemas/ChatCompletionContentPartRefusalParam'
            - type: 'null'
          title: Content
        refusal:
          anyOf:
            - type: string
            - type: 'null'
          title: Refusal
        tool_calls:
          anyOf:
            - items:
                anyOf:
                  - $ref: >-
                      #/components/schemas/ChatCompletionMessageFunctionToolCallParam
                  - $ref: >-
                      #/components/schemas/ChatCompletionMessageCustomToolCallParam
              type: array
            - $ref: '#/components/schemas/ChatCompletionMessageFunctionToolCallParam'
            - $ref: '#/components/schemas/ChatCompletionMessageCustomToolCallParam'
          title: Tool Calls
        chat_time:
          anyOf:
            - type: string
            - type: 'null'
          title: Chat Time
        message_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Message Id
      type: object
      required:
        - role
      title: ChatCompletionAssistantMessageParam
    ChatCompletionToolMessageParam:
      properties:
        content:
          anyOf:
            - type: string
            - items:
                anyOf:
                  - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
                  - $ref: '#/components/schemas/ChatCompletionContentPartImageParam'
                  - $ref: >-
                      #/components/schemas/ChatCompletionContentPartInputAudioParam
                  - $ref: '#/components/schemas/File'
              type: array
            - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
            - $ref: '#/components/schemas/ChatCompletionContentPartImageParam'
            - $ref: '#/components/schemas/ChatCompletionContentPartInputAudioParam'
            - $ref: '#/components/schemas/File'
          title: Content
        role:
          type: string
          const: tool
          title: Role
        tool_call_id:
          type: string
          title: Tool Call Id
        chat_time:
          anyOf:
            - type: string
            - type: 'null'
          title: Chat Time
        message_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Message Id
      type: object
      required:
        - content
        - role
        - tool_call_id
      title: ChatCompletionToolMessageParam
    PermissionDict:
      properties:
        permissions:
          items:
            type: string
            enum:
              - read
              - write
              - delete
              - execute
          type: array
          title: Permissions
        mem_cube_id:
          type: string
          title: Mem Cube Id
      type: object
      title: PermissionDict
      description: Typed dictionary for chat message dictionaries.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ChatCompletionContentPartTextParam:
      properties:
        text:
          type: string
          title: Text
        type:
          type: string
          const: text
          title: Type
      type: object
      required:
        - text
        - type
      title: ChatCompletionContentPartTextParam
    ChatCompletionContentPartImageParam:
      properties:
        image_url:
          $ref: '#/components/schemas/ImageURL'
        type:
          type: string
          const: image_url
          title: Type
      type: object
      required:
        - image_url
        - type
      title: ChatCompletionContentPartImageParam
    ChatCompletionContentPartInputAudioParam:
      properties:
        input_audio:
          $ref: '#/components/schemas/InputAudio'
        type:
          type: string
          const: input_audio
          title: Type
      type: object
      required:
        - input_audio
        - type
      title: ChatCompletionContentPartInputAudioParam
    File:
      properties:
        file:
          $ref: '#/components/schemas/FileFile'
        type:
          type: string
          const: file
          title: Type
      type: object
      required:
        - file
        - type
      title: File
    Audio:
      properties:
        id:
          type: string
          title: Id
      type: object
      required:
        - id
      title: Audio
    ChatCompletionContentPartRefusalParam:
      properties:
        refusal:
          type: string
          title: Refusal
        type:
          type: string
          const: refusal
          title: Type
      type: object
      required:
        - refusal
        - type
      title: ChatCompletionContentPartRefusalParam
    ChatCompletionMessageFunctionToolCallParam:
      properties:
        id:
          type: string
          title: Id
        function:
          $ref: '#/components/schemas/Function'
        type:
          type: string
          const: function
          title: Type
      type: object
      required:
        - id
        - function
        - type
      title: ChatCompletionMessageFunctionToolCallParam
    ChatCompletionMessageCustomToolCallParam:
      properties:
        id:
          type: string
          title: Id
        custom:
          $ref: '#/components/schemas/Custom'
        type:
          type: string
          const: custom
          title: Type
      type: object
      required:
        - id
        - custom
        - type
      title: ChatCompletionMessageCustomToolCallParam
    ImageURL:
      properties:
        url:
          type: string
          title: Url
        detail:
          type: string
          enum:
            - auto
            - low
            - high
          title: Detail
      type: object
      required:
        - url
      title: ImageURL
    InputAudio:
      properties:
        data:
          type: string
          title: Data
        format:
          type: string
          enum:
            - wav
            - mp3
          title: Format
      type: object
      required:
        - data
        - format
      title: InputAudio
    FileFile:
      properties:
        file_data:
          type: string
          title: File Data
        file_id:
          type: string
          title: File Id
        filename:
          type: string
          title: Filename
      type: object
      title: FileFile
    Function:
      properties:
        arguments:
          type: string
          title: Arguments
        name:
          type: string
          title: Name
      type: object
      required:
        - arguments
        - name
      title: Function
    Custom:
      properties:
        input:
          type: string
          title: Input
        name:
          type: string
          title: Name
      type: object
      required:
        - input
        - name
      title: Custom

````