Memory Store

View as Markdown

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

Get a memory store by resource nameGET /api/2.0/agents/{name=memory-stores/*}List memory storesGET /api/2.0/agents/memory-storesCreate a memory storePOST /api/2.0/agents/memory-storesUpdate a memory storePATCH /api/2.0/agents/{name=memory-stores/*}Delete a memory store by resource nameDELETE /api/2.0/agents/{name=memory-stores/*}Grant memory store permissionPOST /api/2.0/agents/{name=memory-stores/*}/permissions:grantGet memory store permissionGET /api/2.0/agents/{name=memory-stores/*}/permissions/selfList memory store permissionsGET /api/2.0/agents/{parent=memory-stores/*}/permissionsRevoke memory store permissionPOST /api/2.0/agents/{name=memory-stores/*}/permissions:revoke

ManagedMemoryStore object

A workspace-scoped 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 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_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.

View as Markdown

The ManagedMemoryStore object

{
  "name": "string",
  "display_name": "string",
  "workspace_id": 0,
  "storage_backend": {
    "backend_type": "STORAGE_BACKEND_TYPE_LAKEBASE",
    "backend_id": "string"
  },
  "owner_user_id": "string",
  "creator_user_id": "string",
  "description": "string",
  "create_time": "string",
  "update_time": "string"
}

Get a memory store by resource name Beta

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

Retrieves a 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.

View as Markdown

Response

{
  "name": "string",
  "display_name": "string",
  "workspace_id": 0,
  "storage_backend": {
    "backend_type": "STORAGE_BACKEND_TYPE_LAKEBASE",
    "backend_id": "string"
  },
  "owner_user_id": "string",
  "creator_user_id": "string",
  "description": "string",
  "create_time": "string",
  "update_time": "string"
}

List memory stores Beta

GET /api/2.0/agents/memory-stores

Lists 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.

View as Markdown

Response

{
  "managed_memory_stores": [
    {
      "name": "string",
      "display_name": "string",
      "workspace_id": 0,
      "storage_backend": {},
      "owner_user_id": "string",
      "creator_user_id": "string",
      "description": "string",
      "create_time": "string",
      "update_time": "string"
    }
  ],
  "next_page_token": "string"
}

Create a memory store Beta

POST /api/2.0/agents/memory-stores

Creates a 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 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 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 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.

View as Markdown

Request

{
  "display_name": "string",
  "description": "string"
}

Response

{
  "name": "string",
  "display_name": "string",
  "workspace_id": 0,
  "storage_backend": {
    "backend_type": "STORAGE_BACKEND_TYPE_LAKEBASE",
    "backend_id": "string"
  },
  "owner_user_id": "string",
  "creator_user_id": "string",
  "description": "string",
  "create_time": "string",
  "update_time": "string"
}

Update a memory store Beta

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

Updates a 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 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 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.

View as Markdown

Request

{
  "display_name": "string",
  "description": "string"
}

Response

{
  "name": "string",
  "display_name": "string",
  "workspace_id": 0,
  "storage_backend": {
    "backend_type": "STORAGE_BACKEND_TYPE_LAKEBASE",
    "backend_id": "string"
  },
  "owner_user_id": "string",
  "creator_user_id": "string",
  "description": "string",
  "create_time": "string",
  "update_time": "string"
}

Delete a memory store by resource name Beta

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

Deletes a 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}.

View as Markdown

Response

{}

Grant memory store permission Beta

POST /api/2.0/agents/{name=memory-stores/*}/permissions:grant

1 more path

POST /api/agents/v1/{name=memory-stores/*}/permissions:grant

Grants a READ or WRITE permission on a memory store to a principal. Only the owner or a workspace admin may grant permissions.

API scopes: agent-kit

Parameters

namestringRequiredpath

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

Request body

principalobjectRequired

Principal to grant the permission to.

Show child attributesHide child attributes

namestringRequired

principal_typestring

The kind of principal. Required unless the deprecated type alias is supplied.

Values:

• USER
• SERVICE_PRINCIPAL

permissionstringRequired

Permission level to grant.

Values:

• READ
• WRITE

View as Markdown

Request

{
  "principal": {
    "name": "string",
    "principal_type": "USER"
  },
  "permission": "READ"
}

Response

{}

Get memory store permission Beta

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

1 more path

GET /api/agents/v1/{name=memory-stores/*}/permissions/self

Retrieves the current caller's effective memory store permission. Returns PERMISSION_LEVEL_UNSPECIFIED when the caller has no access.

API scopes: agent-kit

Parameters

namestringRequiredpath

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

Response

principalobjectOutput only

The principal whose permission is reported.

Show child attributesHide child attributes

namestringRequired

principal_typestring

The kind of principal. Required unless the deprecated type alias is supplied.

Values:

• USER
• SERVICE_PRINCIPAL

permissionstringOutput only

The permission level. WRITE includes READ; PERMISSION_LEVEL_UNSPECIFIED means neither is available.

Values:

• READ
• WRITE

View as Markdown

Response

{
  "principal": {
    "name": "string",
    "principal_type": "USER"
  },
  "permission": "READ"
}

List memory store permissions Beta

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

1 more path

GET /api/agents/v1/{parent=memory-stores/*}/permissions

Lists explicit memory store grants. Only the owner or a workspace admin may list permissions.

API scopes: agent-kit

Parameters

parentstringRequiredpath

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

page_sizeint32query

Maximum number of permissions to return. Defaults to 100; maximum is 1000.

page_tokenstringquery

Continuation token from a previous response.

Response

memory_store_permissionsarray of objectOutput only

Explicit READ or WRITE grants. Implicit owner/admin access and inherited grants are excluded.

Show child attributesHide child attributes

principalobjectOutput only

The principal whose permission is reported.

Show child attributesHide child attributes

namestringRequired

principal_typestring

The kind of principal. Required unless the deprecated type alias is supplied.

Values:

• USER
• SERVICE_PRINCIPAL

permissionstringOutput only

The permission level. WRITE includes READ; PERMISSION_LEVEL_UNSPECIFIED means neither is available.

Values:

• READ
• WRITE

next_page_tokenstringOutput only

Token for the next page, omitted when all permissions have been returned.

View as Markdown

Response

{
  "memory_store_permissions": [
    {
      "principal": {},
      "permission": "READ"
    }
  ],
  "next_page_token": "string"
}

Revoke memory store permission Beta

POST /api/2.0/agents/{name=memory-stores/*}/permissions:revoke

1 more path

POST /api/agents/v1/{name=memory-stores/*}/permissions:revoke

Removes a principal's explicit READ and WRITE grants on a memory store. Only the owner or a workspace admin may revoke permissions. Ownership and inherited access are unaffected.

API scopes: agent-kit

Parameters

namestringRequiredpath

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

Request body

principalobjectRequired

Principal whose READ and WRITE grants will be removed.

Show child attributesHide child attributes

namestringRequired

principal_typestring

The kind of principal. Required unless the deprecated type alias is supplied.

Values:

• USER
• SERVICE_PRINCIPAL

View as Markdown

Request

{
  "principal": {
    "name": "string",
    "principal_type": "USER"
  }
}

Response

{}