Context Memories

Get a memory by fully qualified name

Get a context memory by fully qualified name.

get/v1/contextCenter/memories/name/{fqn}

Request

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

Path parameters

fqnstring required

Fully qualified name of the context memory

Query parameters

fieldsstring

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include deleted memories

Response

The context 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.