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

Overview

FloorMemory SDKs#

FloorMemory SDKs provide a typed, language-native interface to the FloorMemory APIs.
They are designed to:
Simplify authentication handling
Enforce request/response schemas
Reduce boilerplate HTTP code
Remain thin wrappers over the APIs
SDKs do not introduce custom behavior and do not hide API semantics.
They map closely to the underlying REST endpoints.

Supported SDKs#

FloorMemory provides official SDKs for:
Python
JavaScript
TypeScript
Java
All SDKs are generated from the same OpenAPI specification and are functionally equivalent.
This ensures:
Contract consistency across languages
Identical request/response behavior
Uniform parameter semantics
Predictable version alignment

Source Code#

All SDK source code is open source and maintained on GitHub:
šŸ‘‰ https://github.com/xFloorllm/floor-memory-sdk-client
The repository contains:
Python SDK
JavaScript SDK
TypeScript SDK
Java SDK
SDK releases track API contract versions and are versioned in alignment with the FloorMemory API.

Official Examples (All Languages)#

Production-ready integration examples are available here:
šŸ‘‰ https://github.com/xFloorllm/floor-memory-sdk-examples
This repository includes examples for:
Python
JavaScript
TypeScript
Java
The examples demonstrate:
Proper authentication configuration
Correct app_id handling
Multi-turn conversational flows
Event ingestion patterns
Production-safe initialization
Clean service-layer integration
If you are building a real application, the examples repository should be your starting point.

When to Use an SDK vs REST#

Use an SDK if you want:#

Faster integration
Typed request/response models
Automatic serialization/deserialization
Consistent error handling
Reduced HTTP boilerplate

Use REST directly if:#

You need full HTTP-level control
Your environment does not support SDKs
You are building infrastructure-level tooling
Both approaches are fully supported and share the same API contract.

Versioning Policy#

SDK versions align with the FloorMemory API contract.
Patch releases → Documentation, tooling, or non-functional fixes
Minor releases → Backward-compatible API additions
Major releases → Breaking API changes
SDK updates are contract-driven. There is no SDK-specific behavior divergence.

Design Philosophy#

FloorMemory SDKs are intentionally:
Thin
Predictable
Contract-aligned
Explicit in parameter handling
There are no hidden abstractions, no implicit defaults, and no behavioral overrides beyond what the API specifies.
Modified atĀ 2026-02-19 05:07:58
Previous
What to Use First (API Map)
Next
SDK Installation & Setup
Built with