--- title: "List Organization Agent Memory API Keys" method: GET path: "/v4/organizations/{organizationId}/aiServices/agentMemoryApiKeys" tags: ["AI Agent Memory API Keys"] --- # List Organization Agent Memory API Keys `GET /v4/organizations/{organizationId}/aiServices/agentMemoryApiKeys` ## Request - Base URL: `https://cloudapi.cloud.couchbase.com` - URL: `https://cloudapi.cloud.couchbase.com/v4/organizations/{organizationId}/aiServices/agentMemoryApiKeys` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Lists every agent memory API key in the organization that the caller has access to. Use the `projectId` and `clusterId` query parameters to narrow the results to a single project or to the agent memory server of a single cluster. Each entry carries the project and cluster the agent memory server belongs to. The API key secret is never returned by this endpoint. In order to access this endpoint, the provided API key must have at least one of the following roles: - Organization Owner - Project Creator - Project Owner - Project Manager - Project Viewer - Database Data Reader/Writer - Database Data Reader - Cluster Owner - Cluster Data Writer - Cluster Data Viewer To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html). ## Query parameters - `projectId` string, uuid - `clusterId` string, uuid: Filter to fetch appservices belonging to a particular cluster. - `page` integer - `perPage` integer - `sortBy` string[] - `sortDirection` 'asc' | 'desc' ## Response `200` Successfully listed the agent memory API keys for the organization. - ListOrganizationAgentMemoryApiKeysResponse - `data` object[], required: The agent memory API keys in the organization that the caller has access to. Empty if the query matched no API key. The API key secret is never returned. - `id` string, uuid, required: The GUID4 ID of the agent memory API key. - `name` string, required: The name of the agent memory API key. - `description` string: A short description of the agent memory API key. - `agentMemoryServerId` string, uuid, required: The GUID4 ID of the agent memory server this API key authenticates against. - `agentMemoryServerName` string: The name of the agent memory server this API key authenticates against. - `expiry` number, double, required: Expiry of the API key in number of days. Must be between 0.01 and 36500 days, or -1 for a key that never expires. - `accessPolicy` AgentMemoryApiKeyAccessPolicy: The access policy sealed into the API key at creation time. - `roles` string[]: The roles granted to this API key on the agent memory server deployment. These are the roles the deployment itself enforces, and are distinct from the Capella organization and project roles required to call this API. - `ams_admin` - full access to the deployment, including administrative operations. - `ams_rw` - read and write agent memory. - `ams_ro` - read agent memory only. - `lastUsedAt` string, date-time, nullable: The RFC3339 timestamp at which the API key was last used against the agent memory server. Returns `null` when the API key has never been used, or when the agent memory server has not yet reported usage. - `audit` CouchbaseAuditData, required - `createdBy` string, required: The user who created the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users. - `createdAt` string, date-time, required: The RFC3339 timestamp associated with when the resource was initially created. - `modifiedBy` string, required: The user who last modified the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users. - `modifiedAt` string, date-time, required: The RFC3339 timestamp associated with when the resource was last modified. - `version` integer, required: The version of the document. This value is incremented each time the resource is modified. - `projectId` string, uuid: The GUID4 ID of the project the agent memory server belongs to. - `clusterId` string, uuid: The GUID4 ID of the cluster the agent memory server is deployed against. - `clusterName` string: The name of the cluster the agent memory server is deployed against. - `cursor` Cursor, required - `pages` Pages, required - `page` integer, required: Current page of results, starting from page 1. - `next` integer: Number of the next page of results. Not set on the last page. - `previous` integer: Number of the previous page of results. Not set on the first page. - `last` integer, required: Number of the last page of results. - `perPage` integer, required: Number of items displayed in each page. - `totalItems` integer, required: Total items found by the given query. - `hrefs` Hrefs, required - `first` string, uri, required: The base URL, endpoint, and path parameters required to fetch the first page of results. - `last` string, uri, required: The base URL, endpoint, and path parameters required to fetch the last page of results. - `previous` string, uri, required: The base URL, endpoint, and path parameters required to fetch the previous page of results. Empty if there is no previous page. - `next` string, uri, required: The base URL, endpoint, and path parameters required to fetch the next page of results. Empty if there is no next page. ## Other responses - `400`: Returned when we are unable to decode the recevied payload. - `401`: The client does not have the valid credentials to access this resource. - `403`: The client does not have the necessary permissions to access this resource. - `404`: The requested resource was not found. - `429`: Returned when the client exceeds the rate limit for the given APIKey. - `500`: An unexpected error occurred in the server while processing this request. ## Changes - **2026-10-19** `a5e88bcf71cb`: 1 info - endpoint added [Operation history](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/changes/v4/organizations/:organizationId/aiServices/agentMemoryApiKeys/get.md) --- [API](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api.md) - [All operations](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/revisions/a5e88bcf71cb?raw)