FloorMemory Java SDK

The FloorMemory Java SDK enables JVM-based applications to integrate with FloorMemory (xfloor’s conversational memory platform).

It is suitable for:

Backend services

Enterprise systems

Spring Boot, Quarkus, Micronaut applications

Desktop or Android clients interacting directly with FloorMemory APIs

You can use it to:

Query memory-aware conversations

Add content and events to Floors

Retrieve recent activity feeds

Fetch floor metadata

Manage floor visibility and settings (owner-only)

The SDK mirrors the FloorMemory API contract closely and follows a capability-based structure (Query, Event, Floors, Auth).

Source Code

Official Java SDK

👉 https://github.com/xFloorllm/floor-memory-sdk-client/tree/main/java

Production Examples (Highly Recommended)

👉 https://github.com/xFloorllm/floor-memory-sdk-examples/tree/main/java

The examples repository includes:

Spring Boot integration samples

Clean service-layer usage

Multi-turn conversational flows

Event ingestion examples

Production-safe configuration patterns

If you're building a real backend system, start there.

Installation

Maven

<dependency>
  <groupId>ai.xfloor.memory</groupId>
  <artifactId>floor-memory-sdk</artifactId>
  <version>1.x.x</version>
</dependency>

Gradle

Authentication & Client Setup (Required)

All FloorMemory APIs require:

Bearer access token

App ID

User ID (for conversational continuity)

Configure ApiClient

Critical Notes

Token is sent as:
Authorization: Bearer <XFLOOR_API_KEY>

Create the ApiClient once and reuse it

app_id is mandatory on every API call

Do not embed tokens in source code

Safe to reuse across threads

Common Parameter Glossary

Parameter	Meaning
`userId`	Unique xfloor user identifier. Enables personalization and conversation continuity.
`appId`	Required application context identifier.
`floorId` / `floorIds`	Floor(s) to read from or write to.
`blockId`	Optional block container inside a floor.
`blockType`	Category (`post`, `forum`).
Async ingestion	Create Event returns when queued; poll feed for confirmation.

Querying a Floor (Primary API)

API: QueryApi.query()

Endpoint: POST /agent/memory/query

QueryRequest Parameters

Field	Type	Required	Description
`userId`	`String`	✅	Maintains conversational continuity
`query`	`String`	✅	Natural language question
`floorIds`	`List<String>`	✅	Floors to search
`k`	`Integer`	Optional	Top-K retrieval
`includeMetadata`	`"0"` / `"1"`	Optional	Include metadata
`summaryNeeded`	`"0"` / `"1"`	Optional	Generate summarized answer
`appId`	`String`	✅	Application context

Example

What This Does

Loads prior conversation context

Retrieves floor-grounded knowledge

Returns contextual answer

Stores interaction for follow-up queries

Adding Content to a Floor (Create Event)

API: EventApi.event(inputInfo, files, appId)

Endpoint: POST /api/memory/events

Content-Type: multipart/form-data

Ingestion model: Asynchronous

`inputInfo` JSON Fields

Field	Type	Required	Description
`floor_id`	String	✅	Target floor
`block_id`	String	Optional	Block container
`block_type`	String	Optional	Category (`0 for post`, `1 for forum`)
`user_id`	String	✅	Author
`title`	String	Optional	Title
`description`	String	✅	Main content

Example

Ingestion Behavior

200 OK = accepted and queued

Background embedding and indexing

Not immediately searchable

Poll Recent Events if deterministic confirmation is required

Retrieve Recent Activity (Feed)

API: GetRecentEventsApi.getRecentEvents(floorId, userId, appId)

Fetch Floor Metadata

API: GetFloorInformationApi.getFloorInformation(...)

Edit Floor (Owner Only)

Manage Floor Visibility

Thread Safety & Performance

ApiClient is thread-safe

Use one ApiClient per application

Reuse API instances

Safe for concurrent service requests

Suitable for high-throughput backend systems

Using the Official Java Examples

If you are building:

A Spring Boot microservice

A memory-enabled AI backend

An ingestion pipeline

A JVM-based enterprise system

A structured conversational platform

Start here:

👉 https://github.com/xFloorllm/floor-memory-sdk-examples/tree/main/java

The examples repository demonstrates:

Proper client initialization

Clean separation of config and service logic

Multi-floor conversational patterns

Deterministic ingestion flows

Production-safe environment configuration

Summary

Java SDK mirrors FloorMemory APIs closely

Capability-based APIs (Query, Event, Floor, Auth)

app_id is mandatory for every call

No hidden abstractions

Designed for enterprise backend systems

Where to Go Next

👉 JavaScript SDK

👉 TypeScript SDK

👉 Python SDK

👉 Core FloorMemory APIs

Java SDK

FloorMemory Java SDK#

Source Code#

Official Java SDK#

Production Examples (Highly Recommended)#

Installation#

Maven#

Gradle#

Authentication & Client Setup (Required)#

Configure ApiClient#

Critical Notes#

Common Parameter Glossary#

Querying a Floor (Primary API)#

QueryRequest Parameters#

Example#

What This Does#

Adding Content to a Floor (Create Event)#

inputInfo JSON Fields#

Example#

Ingestion Behavior#

Retrieve Recent Activity (Feed)#

Fetch Floor Metadata#

Edit Floor (Owner Only)#

Manage Floor Visibility#

Thread Safety & Performance#

Using the Official Java Examples#

Summary#

Where to Go Next#

FloorMemory Java SDK

Source Code

Official Java SDK

Production Examples (Highly Recommended)

Installation

Maven

Gradle

Authentication & Client Setup (Required)

Configure ApiClient

Critical Notes

Common Parameter Glossary

Querying a Floor (Primary API)

QueryRequest Parameters

Example

What This Does

Adding Content to a Floor (Create Event)

`inputInfo` JSON Fields

Example

Ingestion Behavior

Retrieve Recent Activity (Feed)

Fetch Floor Metadata

Edit Floor (Owner Only)

Manage Floor Visibility

Thread Safety & Performance

Using the Official Java Examples

Summary

Where to Go Next