For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configure memory for a character

Enable long-term memory for an Unreal character, verify the dashboard setting, and reset the local conversation link when needed.

Configure a Convai character so it can remember returning players. Enable the character-level LTM setting, verify it is active, and reset the local conversation link when you need a fresh thread.

Prerequisites

  • The Convai Unreal Engine plugin is installed and the API key is configured.

  • The character Actor has a UConvaiChatbotComponent with a valid CharacterID.

  • Player identity is configured. See End-user identity.

Enable LTM for the character

LTM is disabled by default on new characters in the Convai dashboard. Enable it for every character that should build persistent memory.

1

Check the current status

Add Convai Get LTM Status from the Convai|LTM category.

Set Character ID to the character ID from the Convai dashboard. The On Success delegate returns Status as a bool.

2

Enable memory if needed

If Status is false, call Convai Set LTM Status with the same Character ID and B Enable set to true.

Bind On Success to a visible confirmation such as Print String while testing.

3

Verify the setting

Call Convai Get LTM Status again. Continue only when Status returns true.

Use ResetConversation() when the player starts a new playthrough, switches profiles, or needs a fresh conversation session without deleting long-term memory.

Call Reset Conversation on the Convai Chatbot component.

ResetConversation() sets the local SessionID property to "-1". It does not delete the player's Speaker ID or individual memory records from Convai. The same EndUserID continues to scope long-term memory for that player.

UConvaiChatbotComponent.SessionID defaults to "-1" and is cleared by ResetConversation(). The WebRTC connection does not send this property. Use it for local reset tracking or HTTP Bot Query flows.

Verify the configuration

Before StartSession, confirm:

  • Convai Get LTM Status returns true.

  • UConvaiChatbotComponent.EndUserID is set to a non-empty, stable value.

  • SessionID is "-1" after ResetConversation(), or unchanged when you are continuing with the same identity.

For identity assignment steps, see End-user identity.

Next steps

Long-term memory usage examplesLTM Blueprint referenceTroubleshoot long-term memory

Last updated

Was this helpful?