Skip to main content

Managed Memory Store

View as Markdown

A workspace-scoped managed memory store backed by service-managed storage.

ManagedMemoryStore object​

A workspace-scoped managed memory store backed by service-managed storage.

namestringBetaOutput onlyIDImmutable

Resource name in the form memory-stores/{managed_memory_store_id}.

display_namestring^[a-z0-9]([a-z0-9-]*[a-z0-9])?$[ 3 .. 56 ] charactersDeprecatedBetaImmutable

Deprecated compatibility alias for the caller-provided managed memory store ID. Canonical clients provide the ID through CreateMemoryStoreRequest.managed_memory_store_id and use name as the resource identifier.

workspace_idint64BetaOutput only

Workspace that owns the memory store.

storage_backendobjectBetaOutput only

Service-managed storage backing this memory store.

Show child attributesHide child attributes
backend_typestringBetaOutput only

Type of the storage backend.

Values:

  • STORAGE_BACKEND_TYPE_UNSPECIFIED
  • STORAGE_BACKEND_TYPE_LAKEBASE
backend_idstringBetaOutput only

Backend-specific identifier. For Lakebase, this is the project ID.

owner_user_idstringDeprecatedBetaOutput only

Deprecated alias for creator_user_id. This identifies the original creator, not a transferable owner. Use creator_user_id instead.

creator_user_idstringBetaOutput only

Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context.

descriptionstringBeta

Human-readable description of the memory store.

create_timestringBetaOutput only

Time when the store was created.

update_timestringBetaOutput only

Time when the store was last updated.

Get a managed memory store by resource name Beta​

GET /api/2.0/agents/{name=memory-stores/*}

Retrieves a managed memory store by resource name. Returns NOT_FOUND when the store does not exist in the caller's workspace.

API scopes: agent-kit

Parameters​

namestringRequiredpath

Resource name in the form memory-stores/{managed_memory_store_id}.

Response​

Returns the ManagedMemoryStore object.

List managed memory stores Beta​

GET /api/2.0/agents/memory-stores

Lists managed memory stores in the caller's workspace.

API scopes: agent-kit

Parameters​

page_sizeint32query

Maximum number of stores to return. The service may return fewer stores than requested. Defaults to 10; must be between 1 and 100.

page_tokenstringquery

Opaque pagination token from a previous ListManagedMemoryStores response.

Response​

Returns a list of ManagedMemoryStore objects.

Create a managed memory store Beta​

POST /api/2.0/agents/memory-stores

Creates a managed memory store in the caller's workspace.

API scopes: agent-kit

Parameters​

managed_memory_store_idstring^[a-z]([a-z0-9-]{0,54}[a-z0-9])?$[ 3 .. 56 ] charactersRequiredquery

Caller-provided, workspace-unique managed memory store ID. It must be 3-56 characters, begin with a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a letter or digit.

Request body​

The managed memory store to create.

display_namestring^[a-z0-9]([a-z0-9-]*[a-z0-9])?$[ 3 .. 56 ] charactersDeprecatedImmutable

Deprecated compatibility alias for the caller-provided managed memory store ID. Canonical clients provide the ID through CreateMemoryStoreRequest.managed_memory_store_id and use name as the resource identifier.

descriptionstring

Human-readable description of the memory store.

Response​

Returns the ManagedMemoryStore object.

Update a managed memory store Beta​

PATCH /api/2.0/agents/{name=memory-stores/*}

Updates a managed memory store's description and metadata.

API scopes: agent-kit

Parameters​

namestringRequiredIDImmutablepath

Resource name in the form memory-stores/{managed_memory_store_id}.

update_maskstringRequiredquery

Only description and metadata may be updated. Selecting metadata replaces the entire map.

Request body​

The managed memory store to update. name is taken from the URL.

display_namestring^[a-z0-9]([a-z0-9-]*[a-z0-9])?$[ 3 .. 56 ] charactersDeprecatedImmutable

Deprecated compatibility alias for the caller-provided managed memory store ID. Canonical clients provide the ID through CreateMemoryStoreRequest.managed_memory_store_id and use name as the resource identifier.

descriptionstring

Human-readable description of the memory store.

Response​

Returns the ManagedMemoryStore object.

Delete a managed memory store by resource name Beta​

DELETE /api/2.0/agents/{name=memory-stores/*}

Deletes a managed memory store by resource name. Returns NOT_FOUND when the store does not exist in the caller's workspace.

API scopes: agent-kit

Parameters​

namestringRequiredpath

Resource name in the form memory-stores/{managed_memory_store_id}.