@xfloor-memory-sdk
    @xfloor-memory-sdk
    • Get Started
      • Overview
      • Quick Start
      • Authentication and Identification
      • Core Concepts (5-Minute Read)
      • What to Use First (API Map)
    • SDK
      • Overview
      • SDK Installation & Setup
      • Python SDK
      • JavaScript SDK
      • Typescript SDK
      • Java SDK
      • FAQ & Troubleshooting
      • Copy-Paste Debug Checklists
    • Core FloorMemory
      • Query (Primary API)
        POST
      • Create Event (Post Content)
        POST
      • Recent Events
        GET
      • Basic information of a floor
        GET
    • Floor Management
      • Edit floor
        POST
      • Make floor Private
        POST
      • Make floor public
        POST
      • Rename floor
        POST
    • Registration
      • Sign Up
        POST
      • Sign In with email ID
        POST
      • Sign In with Mobile number
        POST
      • Validation
        POST
      • Change Password
        POST
      • Reset Password
        POST
      • Change email ID
        POST
      • Change Mobile number
        POST
      • Send Validation code
        POST
      • External User Registration
        POST
    • SDKs
    • Schemas
      • PostAdd
      • QueryResponse
      • Media
      • UserDetails
      • SignUpResponse
      • BlockDetails
      • FloorInfo
      • Threads
      • EventResponse
      • 400ErrorCode
      • Remaining

    Core FloorMemory APIs (Commonly Used / Minimal Set)

    Floor Memory APIs provide developers with direct, structured access to floor-scoped data, events, and configuration within the xFloor platform.
    These APIs focus on floor-level memory and lifecycle operations, enabling developers to:
    Read and manage recent activity (events)
    Access conversational threads tied to a floor
    Fetch floor metadata and pod information
    Modify floor settings and visibility
    Manage ownership-restricted floor operations
    Integrate external user identity where required
    Floor Memory APIs are typically used alongside Conversational Memory APIs, but can also be consumed independently to build dashboards, feeds, admin panels, or custom applications.

    Scope of Floor Memory APIs#

    The APIs under this category operate at the floor level, not at the raw model or token level.
    They answer questions such as:
    What activity is happening in this floor?
    What conversations exist for this floor?
    What is the configuration and visibility of this floor?
    Who owns the floor and what can be edited?

    API Groups Covered in This Category#

    1. Events & Activity Memory#

    These APIs expose recent activity and events generated inside a floor.
    Typical usage:
    Rendering activity feeds
    Showing latest posts or updates
    Building timeline or notification views
    Includes:
    Get recent Events
    Events API
    Events may originate from:
    Content creation
    User interactions
    Block-level updates

    2. Conversational Threads#

    These APIs provide access to conversation threads associated with a floor and a user.
    They allow developers to:
    List existing conversation threads
    Resume prior conversations
    Build chat history and thread navigation
    Includes:
    Get Conversations
    These APIs do not generate responses themselves; they expose stored conversational memory.

    3. Floor Metadata & Pod Information#

    These APIs return descriptive and structural information about a floor.
    Used to:
    Render floor landing pages
    Display titles, avatars, and descriptions
    Identify pod-based floors and app associations
    Includes:
    Basic information of a floor
    Get the Floor Pod App information
    This data is read-only and safe for frequent access.

    4. Floor Configuration & Management#

    These APIs allow authorized users (typically owners) to modify floor configuration.
    They control:
    Floor visibility
    Floor identity
    Floor presentation metadata
    Includes:
    Edit floor
    Make floor Private
    Make floor Public
    Rename floor
    ⚠️ All floor-modifying APIs are ownership-restricted.
    Non-owners cannot invoke these operations.

    5. External User Registration (Optional)#

    This API supports developer-managed authentication models.
    It allows developers to:
    Register external users into xFloor
    Map their own user identity system to xFloor memory
    Includes:
    External User Registration
    This API is optional and only required if:
    The developer does not already have users registered in xFloor
    The developer wants xFloor to manage user identity creation

    Authorization & Ownership Rules#

    Read APIs (events, conversations, floor info) may be accessed based on floor visibility and access rules.
    Write / modify APIs (edit, rename, visibility changes) require:
    Valid user context
    User must be the floor owner
    Ownership is always validated server-side.

    How Floor Memory APIs Fit in the Bigger Picture#

    Floor Memory APIs handle floor-scoped state and memory, while:
    Conversational APIs handle message exchange
    Content ingestion APIs handle knowledge upload
    Authentication APIs handle identity creation
    Together, they enable developers to build:
    AI assistants
    Activity-driven UIs
    Floor-specific applications
    Pod-based integrations

    Typical Use Cases#

    Floor activity feeds
    Admin dashboards
    Conversation history panels
    Floor settings pages
    Pod-driven applications
    Custom AI experiences built on xFloor

    Design Philosophy#

    Floor Memory APIs are:
    Model-agnostic
    UI-independent
    Identity-aware but not identity-enforcing
    Safe to compose with external systems
    They provide structure and memory, not opinions or UI behavior.

    One-Line Summary#

    Floor Memory APIs give developers full programmatic access to floor activity, conversations, and configuration—securely and at scale.
    Modified at 2026-01-09 14:42:30
    Previous
    Copy-Paste Debug Checklists
    Next
    Query (Primary API)
    Built with