User Profile

​

In plain terms

The analogy: the contact card in your phone. Structured slots (name, number, company), not free-form notes.

​

When to use it

• You have a fixed set of attributes you always want to know: name, role, timezone, plan tier, department.
• You want clean structured values you can render in a UI or use in logic (for example, display profile.custom.department after validating its type).
• Timezone-aware behavior — the agent can schedule or phrase things in the user’s local time.

memory: { storage, userProfile: true }   // tracks name, role, timezone, language

​

When NOT to use it

• For open-ended preferences (“likes dark mode,” “into sci-fi”) — those are unpredictable, so use User Facts instead.
• For transient data — see the same guidance as User Facts.

​

Configuration

// Built-ins only
memory: { storage, userProfile: true }

// Add product-specific fields
memory: {
  storage,
  userProfile: { customFields: ["department", "preferredUnits"] },
}

​

What gets stored

{
  "name": "Akash Sengar",
  "role": "Senior Engineer",
  "company": "Apex Bank",
  "timezone": "Asia/Kolkata",
  "language": "en",
  "custom": { "department": "engineering" }
}

About this user:
- Name: Akash Sengar
- Role: Senior Engineer
- Company: Apex Bank
- Timezone: Asia/Kolkata

​

Direct access

const profile = await agent.memory!.getUserProfile()!.getProfile("user-123");
console.log(profile?.timezone);

​

Cross-references

• User Facts — free-form facts for unpredictable attributes
• Multi-User Isolation — profiles are strictly per user
• Memory Overview — the full picture