Quick Start

Enable memory on a character and verify cross-session recall using the Convai dashboard and the Unity Editor.

Your First Cross-Session Memory

Long-Term Memory requires two things to work: memory must be enabled for the character on the Convai Dashboard, and the SDK must send a stable user identifier with each session. The second part is handled automatically by DeviceEndUserIdProvider. This guide covers the minimal steps to get from zero to a character that remembers you.

Prerequisites

  • Your Convai API key is configured in Tools → Convai → Configuration.

  • A Unity scene with a ConvaiCharacter component already set up and working (the character should respond to speech).

Steps

1

Enable memory on your character

Open the Convai dashboard and select your character. Navigate to Memory → Memory Settings and enable the Long-Term Memory toggle.

This is an opt-in setting — memory is off by default. The character will not accumulate or use memories until you enable it here. For a full walkthrough of the dashboard UI, see the Memory Settings documentation.

2

Enter Play Mode and start a conversation

Press Play in the Unity Editor. Start a conversation with the character and share a few facts it can remember — your name, your role, or a preference. For example:

"My name is Alex. I'm a safety officer on the night shift."

Let the character respond, then stop Play Mode.

3

Re-enter Play Mode and verify recall

Press Play again and start a new conversation with the same character. Ask it to recall what it knows:

"Do you remember who I am?"

If Long-Term Memory is working, the character will reference facts from the previous session without being told again.

What Just Happened

Behind this seamless experience, four things occurred automatically:

  1. Identity: The SDK called DeviceEndUserIdProvider, which read a stable GUID from PlayerPrefs (key: "convai.end_user_id"). In the Editor, the same GUID is used every Play Mode session on this machine.

  2. Connect: That GUID was sent to the Convai server as end_user_id when the session started.

  3. Memory recall: The server resolved the GUID to an internal speaker record, loaded memories for the speaker_id:character_id pair, and injected them into the AI's context before the first response.

  4. Memory storage: At the end of the first session, the backend extracted facts from the conversation (your name, your role) and stored them as MemoryRecord entries in the partition.

Next Steps

Conclusion

With memory enabled on the dashboard and the default identity provider in place, your character will accumulate and recall user-specific facts across every session — entirely automatically. When your project requires user accounts, custom identity, or direct control over memory content, the rest of this section provides the tools to do that.

Last updated

Was this helpful?