@xfloor-memory-sdk
  1. Get Started
@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
  1. Get Started

Overview

FloorMemory APIs — At a Glance (Simple Version)#

FloorMemory APIs help you build AI assistants that remember things.
You organize knowledge into Floors, structure that knowledge using Blocks, and then let users chat with it — with memory that persists over time.

The Simple Mental Model#

User talks → AI answers → Memory is saved → Next question feels smarter
That’s it.

What Is a Floor?#

A Floor is a knowledge space.
Think of it as:
One assistant
One domain
One memory boundary
Examples:
A college assistant
A product support bot
A course tutor
A personal AI assistant
Each Floor has its own content, conversations, and memory.
When a Floor is created, xFloor automatically:
creates the Floor
creates a default Block inside it
You can start adding content immediately.

What Is a Block?#

A Block is a content category inside a Floor.
Blocks help organize what kind of content lives in a Floor — not who uses it.
Think of it like this:
Floor = the knowledge space
Block = a section inside that space
Examples of Blocks inside a single Floor:
Posts
FAQs
Announcements
Discussions
Resources

Default Block (Important for First-Time Users)#

Every Floor comes with a default Block.
That means:
You do not need to create a Block manually
You can start using Create Event right away
All content can go into the default Block initially
👉 Blocks are optional structure, not mandatory setup.

❓ Do I Need Blocks?#

Short answer:
👉 No. Not at the beginning.
You can build a fully working AI assistant without thinking about Blocks at all.
Memory still works
Conversations still flow
Follow-up questions still feel natural
Blocks only become useful when your content grows and you want better organization.

Floor + Block Together (Mental Model)#

Floor (Knowledge Space)
 ├── Default Block (auto-created)
 ├── Optional Block: FAQs
 ├── Optional Block: Posts
 └── Optional Block: Resources
Memory is scoped at the Floor level
Content is organized at the Block level
Users never see this unless you choose to expose it.

What FloorMemory Does (In Plain English)#

FloorMemory takes care of:
Remembering past conversations
Fetching the right content from the right Blocks
Making follow-up questions work naturally
Keeping memory scoped to the correct Floor
So your AI doesn’t start from scratch every time.

What FloorMemory Does Not Do#

No UI opinions
No forced AI model
No user authentication logic
You stay in control.

The Only APIs Most Developers Need#

Most apps start with just these:
1.
Query API
→ Ask a question, get an answer (with memory)
2.
Create Event API
→ Add knowledge to a Floor (goes into the default Block unless specified)
3.
Conversations API
→ Resume or view past chats (optional)
Everything else is optional.

How a Conversation Works (Simplified)#

1.
User sends a message
2.
You call the Query API
3.
FloorMemory:
Uses prior conversation history
Retrieves relevant content from the Floor (across Blocks)
4.
AI responds
5.
Memory is saved automatically
No extra work for you.

User Identity (One Rule)#

FloorMemory needs a stable user ID.
That’s it.
Use your own login system → pass user_id
Or use xFloor’s signup APIs → get xfloor_user_id
👉 Identity is required. Registration is optional.

One-Line Summary#

FloorMemory is the memory layer for AI assistants.
Floors define where memory lives.
Blocks organize what memory contains — starting with a default Block.
You bring the UI, users, and model.
FloorMemory makes the conversation remember.
Modified at 2026-01-29 09:43:21
Next
Quick Start
Built with