v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Create a Memory.

post/v1/{+parent}/memories

Path parameters

parentstring required

Required. The resource name of the ReasoningEngine to create the Memory under. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Query parameters

memoryIdstring

Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are [a-z0-9-]. The first character must be a letter, and the last character must be a letter or number.

Request body

expireTimestring google-datetime

Optional. Represents the timestamp of when this resource is considered expired. This is always provided on output when expiration is set on input, regardless of whether expire_time or ttl was provided.

updateTimestring google-datetime

Output only. Represents the timestamp when this Memory was most recently updated.

ttlstring google-duration

Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.

metadataobject

Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.

disableMemoryRevisionsboolean

Optional. Input only. Indicates whether no revision will be created for this request.

createTimestring google-datetime

Output only. Represents the timestamp when this Memory was created.

factstring

Optional. Represents semantic knowledge extracted from the source content.

revisionLabelsobject

Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.

revisionExpireTimestring google-datetime

Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.

revisionTtlstring google-duration

Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.

displayNamestring

Optional. Represents the display name of the Memory.

scopeobject

Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.

namestring

Identifier. Represents the resource name of the Memory. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}

descriptionstring

Optional. Represents the description of the Memory.

Response

Successful response