Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.recallrai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The User class represents a user in your RecallrAI project. It provides methods for managing sessions, memories, messages, and merge conflicts.

​
Properties

​
userId
string
Unique identifier for the user.
​
metadata
object
User metadata as an object.
​
createdAt
datetime
UTC timestamp when the user was created.
​
lastActiveAt
datetime
UTC timestamp of the user’s last activity.

​
User Management Methods

​
update()

import { UserAlreadyExistsError } from "recallrai";

try {
  const user = await client.getUser("user123");
  await user.update({
    newMetadata: { name: "John Doe", role: "admin" },
    newUserId: "john_doe",
  });
  console.log(`Updated user ID: ${user.userId}`);
} catch (error) {
  if (error instanceof UserAlreadyExistsError) {
    console.log(`New user ID already exists: ${error.message}`);
  }
}
​
newMetadata
object
New metadata to replace the existing metadata.
​
newUserId
string
Optional new user ID. Must be unique within your project.
Returns: void Raises: UserNotFoundError, UserAlreadyExistsError

​
refresh()

const user = await client.getUser("john_doe");
await user.refresh();
console.log(`Latest metadata:`, user.metadata);
Returns: void Raises: UserNotFoundError

​
delete()

const user = await client.getUser("john_doe");
await user.delete();
This permanently deletes the user and all associated sessions, memories, and messages.
Returns: void Raises: UserNotFoundError

​
Session Management Methods

​
createSession()

const user = await client.getUser("user123");
const session = await user.createSession({
  autoProcessAfterSeconds: 600,
  metadata: { type: "chat", channel: "web" },
});

console.log(`Created session: ${session.sessionId}`);
​
autoProcessAfterSeconds
number
Seconds of inactivity before auto-processing. Default: 600.
​
metadata
object
Optional metadata for the session.