> ## Documentation Index
> Fetch the complete documentation index at: https://docs.memmachine.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Memories

> List memories within a project.

System returns a paginated list of memories stored in the project.
The page_size and page_num fields control pagination.

The filter field allows for filtering based on metadata key-value pairs.
The type field allows specifying which memory type to list.




## OpenAPI

````yaml /platform.openapi.json post /v2/memories/list
openapi: 3.0.4
info:
  description: >-
    Public REST API for the MemMachine memory system. Manages projects and
    memories.
  title: MemMachine Public API
  version: 0.1.0
servers:
  - url: https://api.memmachine.ai
security:
  - BearerAuth: []
tags:
  - name: Projects
  - name: Memories
  - name: Metrics
  - name: Health
paths:
  /v2/memories/list:
    post:
      tags:
        - Memories
      summary: List Memories
      description: |
        List memories within a project.

        System returns a paginated list of memories stored in the project.
        The page_size and page_num fields control pagination.

        The filter field allows for filtering based on metadata key-value pairs.
        The type field allows specifying which memory type to list.
      operationId: ListMemories
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListMemoriesSpec'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResult'
          description: Successful Response
        default:
          $ref: '#/components/responses/UnexpectedError'
components:
  schemas:
    ListMemoriesSpec:
      allOf:
        - $ref: '#/components/schemas/ProjectScope'
        - properties:
            filter:
              default: ''
              description: >
                An optional string filter applied to the memory metadata. This
                uses a

                simple query language (e.g., 'metadata.user_id=123') for exact
                matches.

                Multiple conditions can be combined using AND operators.  The
                metadata

                fields are prefixed with 'metadata.' to distinguish them from
                other fields.
              example: metadata.user_id=123 AND metadata.session_id=abc
              title: Filter
              type: string
            page_num:
              default: 0
              description: |
                The zero-based page number to retrieve. Use this for pagination.
              example: 0
              title: Page Num
              type: integer
            page_size:
              default: 100
              description: >
                The maximum number of memories to return per page. Use this for
                pagination.
              example: 50
              title: Page Size
              type: integer
            set_metadata:
              additionalProperties: true
              description: |
                Optional metadata key-value pairs used to filter or identify
                a specific semantic memory set. Applies only when listing
                semantic memories.
              nullable: true
              title: Set Metadata
              type: object
            type:
              $ref: '#/components/schemas/MemoryType'
          type: object
      description: Specification model for listing memories.
      title: ListMemoriesSpec
    ListResult:
      description: Response model for memory list results.
      properties:
        content:
          $ref: '#/components/schemas/ListResultContent'
        status:
          default: 0
          description: >
            The status code of the search operation. 0 typically indicates
            success.
          example: 0
          title: Status
          type: integer
      required:
        - content
      title: ListResult
      type: object
    ProjectScope:
      properties:
        project_id:
          default: ''
          description: >-
            The identifier of the project. If empty, the user's default project
            is used.
          maxLength: 255
          pattern: ^[\p{L}\p{N}_:-]*$
          title: Project Id
          type: string
          x-go-type-skip-optional-pointer: true
      type: object
    MemoryType:
      description: Memory type.
      enum:
        - semantic
        - episodic
      title: MemoryType
      type: string
    ListResultContent:
      additionalProperties: false
      description: Payload for ListResult.content returned by `/memories/list`.
      properties:
        episodic_memory:
          description: Listed episodic memory entries.
          items:
            $ref: '#/components/schemas/Episode'
          nullable: true
          title: Episodic Memory
          type: array
        semantic_memory:
          description: Listed semantic memory entries.
          items:
            $ref: '#/components/schemas/SemanticFeature'
          nullable: true
          title: Semantic Memory
          type: array
      title: ListResultContent
      type: object
    Error:
      properties:
        code:
          description: Error code.
          format: int32
          type: integer
        message:
          description: Error message.
          type: string
      required:
        - code
        - message
      type: object
    Episode:
      description: Episode data returned in list responses.
      properties:
        content:
          description: The content payload of the episode.
          title: Content
          type: string
        content_type:
          $ref: '#/components/schemas/ContentType'
        created_at:
          description: Timestamp when the episode was created.
          format: date-time
          title: Created At
          type: string
        episode_type:
          $ref: '#/components/schemas/EpisodeType'
        filterable_metadata:
          additionalProperties: true
          description: Metadata indexed for filtering.
          nullable: true
          title: Filterable Metadata
          type: object
        metadata:
          additionalProperties: true
          description: Optional metadata associated with the episode.
          nullable: true
          title: Metadata
          type: object
        produced_for_id:
          description: Identifier of the intended recipient of the episode.
          nullable: true
          title: Produced For Id
          type: string
        producer_id:
          description: Identifier of the episode producer.
          title: Producer Id
          type: string
        producer_role:
          description: Role of the producer (e.g., user/assistant/system).
          title: Producer Role
          type: string
        sequence_num:
          default: 0
          description: Sequence number within the session.
          title: Sequence Num
          type: integer
        session_key:
          description: Session key associated with the episode.
          title: Session Key
          type: string
        uid:
          description: Unique identifier for the episode.
          title: Uid
          type: string
      required:
        - uid
        - content
        - session_key
        - created_at
        - producer_id
        - producer_role
      title: Episode
      type: object
    SemanticFeature:
      description: Semantic memory entry returned in API responses.
      properties:
        category:
          description: Category of the semantic feature.
          title: Category
          type: string
        feature_name:
          description: Name of the semantic feature.
          title: Feature Name
          type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
        set_id:
          description: Identifier of the semantic set.
          nullable: true
          title: Set Id
          type: string
        tag:
          description: Tag associated with the semantic feature.
          title: Tag
          type: string
        value:
          description: Value of the semantic feature.
          title: Value
          type: string
      required:
        - category
        - tag
        - feature_name
        - value
      title: SemanticFeature
      type: object
    ContentType:
      default: string
      description: Enumeration for the type of content within an Episode.
      enum:
        - string
      title: ContentType
      type: string
    EpisodeType:
      default: message
      description: Episode type.
      enum:
        - message
      title: EpisodeType
      type: string
    Metadata:
      description: Storage metadata for a semantic feature, including id and citations.
      properties:
        citations:
          description: Episode IDs cited by this semantic feature.
          items:
            type: string
          nullable: true
          title: Citations
          type: array
        id:
          description: Identifier for the semantic feature.
          nullable: true
          title: Id
          type: string
        other:
          additionalProperties: true
          description: Additional storage metadata for the semantic feature.
          nullable: true
          title: Other
          type: object
      title: Metadata
      type: object
  responses:
    UnexpectedError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Unexpected error.
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http

````