Quick Start — Your First FloorMemory API Call (SDK-First)

This guide shows how to make your first conversational, memory-aware query using FloorMemory APIs and SDKs.

You will:

Create an App

Generate an API token

Install an SDK

Ask a memory-grounded question in a Floor

⏱️ Time to first response: ~5 minutes

Step 1. Create an App

An App represents your AI assistant and owns its API credentials.

An App is not a mobile application.
It is a logical configuration for your web-based Personal AI Assistant.

👉 Create an App here:
https://xfloor.ai/account/settings/createapp

Fill in:

Title – Name of your assistant
Example: Personal Tutor, Research Assistant

Details – Short description
Example: AI assistant for algorithm revision

Image (Optional) – Dashboard identification only

Click Create App.

Once created:

The App becomes active

API access is enabled

A default Pod Floor is automatically created for the App

A default Block is automatically created inside that Floor

You can start adding content and querying immediately.

Step 2. Generate an API Token

All FloorMemory API requests require Bearer Token authentication.

👉 Generate a token here:
https://xfloor.ai/account/settings/developer

Steps:

Enter a Token Name
Example: local-dev, production-backend

Select Expiration Days

Click Generate Token

Copy the token immediately and store it securely

⚠️ The token is shown only once
🔒 Keep it server-side — never expose it in browser JavaScript

Set it as an environment variable:

Step 3. Install an SDK (Recommended)

While you can call the APIs directly via REST, using an SDK is strongly recommended for:

Authentication handling

Typed request/response models

Automatic serialization

Cleaner application code

For SDK internals and supported languages, see:
👉 SDK Overview

Python

TypeScript / JavaScript

SDKs for Python, TypeScript, JavaScript, and Java are generated from the same API contract and are functionally equivalent.

Step 4. Ask Your First Question (Query API)

FloorMemory SDKs do not expose a single high-level MemoryClient.

Instead, functionality is accessed through capability-based API classes, such as QueryApi.

The Query API is the primary way to interact with FloorMemory.

It automatically:

Loads relevant conversation context

Retrieves floor- and block-grounded knowledge

Returns a grounded response

Stores conversation memory for future turns

Python Example (SDK)

TypeScript Example (SDK)

import { Configuration, QueryApi } from "@xfloor/floor-memory-sdk-ts";

const config = new Configuration({
  accessToken: process.env.XFLOOR_API_KEY!,
  basePath: "https://appfloor.in",
});

const queryApi = new QueryApi(config);

const response = await queryApi.query({
  userId: "user_123",
  floorId: "floor_456",
  appId: "YOUR_APP_ID",
  query: "Help me revise binary search trees",
});

console.log(response.answer);

🎉 That’s it.
You’ve made your first memory-aware conversational API call.

What Happens Automatically

When you call the Query API, FloorMemory automatically:

Loads relevant conversation history

Retrieves knowledge scoped to the Floor

Stores the interaction as conversational memory

Maintains continuity across future queries

You do not need to manage:

Threads

Conversation state

Memory persistence

Notes on `user_id`, `floor_id`, and `app_id`

user_id
Identifies the end user
(from your auth system or xFloor-managed registration)

floor_id
Identifies the knowledge space being queried
(the default Pod Floor is created automatically with the App)

app_id
Identifies the calling application context
(required for all SDK-based API calls)

All three are required for conversational APIs.

Next Steps

Once your first query works, you can:

Add content using Create Event

Resume conversations using Get Conversations

Display activity using Get Feed

Secure flows using Signup / Login / Password APIs

Plug in your preferred AI model

Summary

FloorMemory APIs provide the memory layer for AI assistants.

Bring your UI.
Bring your users (or use ours).
Bring your model.
FloorMemory handles the memory.

Quick Start

Quick Start — Your First FloorMemory API Call (SDK-First)#

Step 1. Create an App#

Step 2. Generate an API Token#

Step 3. Install an SDK (Recommended)#

Python#

TypeScript / JavaScript#

Step 4. Ask Your First Question (Query API)#

Python Example (SDK)#

TypeScript Example (SDK)#

What Happens Automatically#

Notes on user_id, floor_id, and app_id#

Next Steps#

Summary#