COcouchbase
AI Agent Memory API Keys

List Organization Agent Memory API Keys

Changed on

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.

get/v4/organizations/{organizationId}/aiServices/agentMemoryApiKeys

Request

Query parameters

projectIdstring uuid
Example:ffffffff-aaaa-1414-eeee-000000000000

The GUID4 ID of the project.

clusterIdstring uuid

Filter to fetch appservices belonging to a particular cluster.

Filters by clusterId.

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: name, expiry, createdAt, lastUsedAt.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

Successfully listed the agent memory API keys for the organization.

Example response

{
  "data": [
    {
      "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
      "name": "support-bot-prod-key",
      "description": "Production key for the support bot agent",
      "agentMemoryServerId": "3fa1b2c3-a925-4e57-a1f9-90bc2dcfa091",
      "agentMemoryServerName": "support-bot-memory",
      "expiry": 180,
      "accessPolicy": {
        "roles": [
          "ams_rw"
        ]
      },
      "lastUsedAt": "2026-08-06T10:30:00Z",
      "audit": {
        "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "createdAt": "2021-09-01T12:34:56Z",
        "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "modifiedAt": "2021-09-01T12:34:56Z",
        "version": 1
      },
      "projectId": "a3b2c1d0-0000-4e57-b1f9-90bc2dcfa001",
      "clusterId": "13d745eb-9861-4e1d-88f5-eaacfef416a2",
      "clusterName": "my-cluster"
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}

Changes