COcouchbase
AI Agent Memory Servers

List Organization Agent Memory Servers

Changed on

Lists every agent memory server in the organization that the caller has access to.

Use the projectId query parameter to narrow the results to a single project, and the search query parameter to match against the name and description.

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/agentMemoryServers

Request

Query parameters

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

The GUID4 ID of the project.

searchstring

Filters the results to agent memory servers whose name or description contains the given substring. By default, no search filter is applied.

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, status, createdAt, modifiedAt.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

status'pending' | 'deploying' | 'healthy' | 'unhealthy' | 'deploymentFailed' | 'destroying' | 'destroyFailed'

Filters the results by the deployment status of the agent memory server. By default, agent memory servers in all states are returned.

Response

Successfully listed the agent memory servers for the organization.

Example response

{
  "data": [
    {
      "id": "3fa1b2c3-a925-4e57-a1f9-90bc2dcfa091",
      "name": "support-bot-memory",
      "description": "Agent memory store for the support bot",
      "tenantId": "f59e8a62-0000-4e57-b1f9-90bc2dcfa000",
      "projectId": "a3b2c1d0-0000-4e57-b1f9-90bc2dcfa001",
      "clusterId": "13d745eb-9861-4e1d-88f5-eaacfef416a2",
      "config": {
        "nodeConfig": {
          "instanceType": "small",
          "nodeCount": 3,
          "provider": "aws",
          "region": "us-east-1"
        },
        "bucket": "agent-memory",
        "memoryBlockTTL": 604800,
        "embedding": {
          "integrationId": "provider1-ffffffff-aaaa-1414-eeee-000000000000",
          "model": "text-embedding-3-small"
        },
        "llm": {
          "integrationId": "provider1-ffffffff-aaaa-1414-eeee-000000000000",
          "model": "gpt-4o-mini"
        },
        "semanticExtraction": {
          "enabled": true
        },
        "advancedConfig": {
          "summaryTokenLimit": 700,
          "processingBatchSize": 5,
          "maxRequestsPerMinute": 1500,
          "maxTokensPerMinute": 125000,
          "maxConcurrentTasks": 100,
          "perRequestTokenLimit": 4096,
          "idleSleepSeconds": 0.5,
          "queueMaxSize": 10000,
          "maxFailCount": 3,
          "taskTimeoutSeconds": 90
        }
      },
      "network": {
        "endpoint": "https://ams-3fa1b2c3.example.com"
      },
      "status": "healthy",
      "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
      }
    }
  ],
  "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