Context Memories

Create or update a memory

Create a new context memory, or update an existing one if it already exists.

put/v1/contextCenter/memories

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/contextCenter/memories
  • Auth: HTTP bearer

Request body

namestring required
displayNamestring
descriptionstring
titlestring
summarystring
questionstring required
answerstring required
memoryType'Preference' | 'UseCase' | 'Note' | 'Runbook' | 'Faq'
memoryScope'UserGlobal' | 'EntityScoped'
status'Draft' | 'Active' | 'Archived'
sourceType'Manual' | 'ChatPromotion' | 'RememberRequest' | 'FileExtraction' | 'PageExtraction'
sourceConversationstring uuid
sourceHumanMessagestring uuid
sourceAssistantMessagestring uuid
domainsstring[]
extensionobject
dataProductsstring[]

Response

The updated memory

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
titlestring
summarystring
questionstring
answerstring
memoryType'Preference' | 'UseCase' | 'Note' | 'Runbook' | 'Faq'
memoryScope'UserGlobal' | 'EntityScoped'
status'Draft' | 'Active' | 'Archived'
pinnedboolean
sourceType'Manual' | 'ChatPromotion' | 'RememberRequest' | 'FileExtraction' | 'PageExtraction'
sourceConversationstring uuid
sourceHumanMessagestring uuid
sourceAssistantMessagestring uuid
usageCountinteger
lastUsedAtinteger
versionnumber double
updatedAtinteger
updatedBystring
hrefstring uri
deletedboolean
provider'system' | 'user' | 'automation'
extensionobject
impersonatedBystring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.