Skip to main content

Overview

The RecallrAI client is the entry point for all SDK operations. It manages authentication and provides methods for user management.

Initialization

Methods

createUser()

string
required
Unique identifier for the user. Must be unique within your project.
object
Optional metadata to associate with the user.
Returns: User Raises: UserAlreadyExistsError

getUser()

string
required
The ID of the user to retrieve.
boolean
default:"true"
Whether to validate user existence via API before creating the instance. Set false only when userId is already trusted.
Returns: User Raises: UserNotFoundError
Set { validate: false } to skip the SDK lookup request (GET /api/v1/users/{userId}) when the user ID is already trusted by your system.
When { validate: false } is used, fields that require an API lookup (for example createdAt, lastActiveAt, and metadata) are set to UNAVAILABLE until you call refresh(). Import UNAVAILABLE from recallrai when checking these values.

listUsers()

number
Number of users to skip. Default: 0
number
Maximum number of users to return. Default: 10
object
Filter users by metadata fields.
Returns: UserList with users, total, and hasMore.