Long-term memory scripting reference
Complete API reference for ConvaiRestClient.Memory and ConvaiRestClient.EndUsers — all method signatures, parameters, return types, identity interfaces, and data models.
ConvaiRestClient entry points
ConvaiRestClient entry pointsnamespace Convai.RestAPI
public sealed class ConvaiRestClient : IDisposable// Initialize with API key string (uses default options)
public ConvaiRestClient(string apiKey)
// Initialize with full options (custom timeout, transport)
public ConvaiRestClient(ConvaiRestClientOptions options)Property
Type
Description
MemoryService
MemoryServiceAddAsync
AddAsyncParameter
Type
Description
ListAsync
ListAsyncParameter
Type
Default
Description
GetAsync
GetAsyncDeleteAsync
DeleteAsyncDeleteAllAsync
DeleteAllAsyncEndUsersService
EndUsersServiceGetAsync
GetAsyncListAsync
ListAsyncParameter
Type
Default
Description
UpdateMetadataAsync
UpdateMetadataAsyncDeleteAsync
DeleteAsyncCharacterService — memory methods
CharacterService — memory methodsGetMemoryEnabledAsync
GetMemoryEnabledAsyncSetMemoryEnabledAsync
SetMemoryEnabledAsyncIdentity interfaces
IEndUserIdentityProvider
IEndUserIdentityProviderIEndUserMetadataProvider
IEndUserMetadataProviderIEndUserIdProvider
IEndUserIdProviderDeviceEndUserIdProvider
DeviceEndUserIdProviderContext
Behavior
Data models
MemoryRecord
MemoryRecordProperty
JSON key
Type
Description
AddMemoriesResponse
AddMemoriesResponseProperty
JSON key
Type
Description
MemoryAddResult
MemoryAddResultProperty
JSON key
Type
Description
MemoryListResponse
MemoryListResponseProperty
JSON key
Type
Description
MemoryDeleteResponse
MemoryDeleteResponseProperty
JSON key
Type
Description
MemoryDeleteAllResponse
MemoryDeleteAllResponseProperty
JSON key
Type
Description
EndUserDetails
EndUserDetailsProperty
JSON key
Type
Notes
EndUsersListResponse
EndUsersListResponseProperty
JSON key
Type
Description
EndUserUpdateResponse
EndUserUpdateResponseProperty
JSON key
Type
Description
EndUserDeleteResponse
EndUserDeleteResponseProperty
JSON key
Type
Description
MemorySettings
MemorySettingsProperty
JSON key
Type
Default
Description
Error handling
Next steps
Long-term memory usage examplesTroubleshoot long-term memoryLast updated
Was this helpful?