Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Get Started with the Agent Memory APIs

  • how-to
To get started with the Couchbase Capella APIs for Agent Memory, you must create an API key. An API key authenticates and authorizes you to access the APIs.

This page is for Agent Memory in Capella. It covers the Agent Memory features in the Management API, and the Agent Memory API. For more information about the Management API for Capella Operational features, see Get Started with the Capella Operational Management API.

This page describes how to manage:

Use the Management API to deploy and manage Agent Memory servers and Agent Memory API keys. Use the Agent Memory API to store and retrieve memory on your Agent Memory server.

Management API Keys

To create an initial bootstrap API key to access the Management API, you must use the Capella UI. Once you have created an initial bootstrap API key, you can use the Management API itself to create further API keys.

Understand Management API Keys

Each API key for the Management API has the following characteristics:

  • API keys are associated with Couchbase Capella roles and permissions.

  • Every API key has an expiration date.

  • Every API key is associated with an allowed IP address list.

Organization Roles and Project Access

Each API key is associated with 1 or more organization roles, which determine the privileges that the API key has within the organization. For more information about organization roles, see Organization Roles.

Each API key may have access to 1 or more projects, depending on the organization role. For each project, each API key is associated with 1 or more project roles, which determine the privileges that the API key has within each project. For more information about project roles, see Project Roles.

You can create an API key at the organization or a project level:

  • When you create an API key at the organization level, you may specify the organization roles for the API key, which projects the API key is associated with, and the project roles for the API key within each project.

  • When you create an API key at the project level, the API key has the Organization Member role for the organization containing the project, and has access to the project where you created it. You may specify project roles for the API key within that project.

An API key must have the appropriate Capella roles to access an endpoint. The Management API reference guide lists the roles that are needed for each endpoint.

Expiration

By default, each API key expires 180 days after creation. You can specify a different expiration, or specify that the API key does not expire. For security, create new API keys regularly and let old API keys expire after transitioning to the new keys.

IP Access

By default, when you first create an API key, you can use that API key to access the Management API from any IP address. For security, each API key should only be able to access the Management API from specific IP addresses.

For each API key, you can grant access from:

Display Management API Keys

You can display Management API keys within an organization or within a project. By default, there are no API keys for the Management API.

  • Organization Level

  • Project Level

To display Management API keys within an organization:

  1. In the Capella UI, click your initials.

  2. Click Organizations.

  3. Select the organization you want to create API keys for.

  4. Go to Settings  API Keys.

To display Management API keys within a project:

  1. In your organization, go to Projects.

  2. Select the project you want to create API keys for.

  3. Go to Settings  API Keys.

Generate Management API Keys

You can generate Management API keys within an organization or within a project.

  • Organization Level

  • Project Level

To generate a Management API key at the organization level:

  1. Display the list of Management API keys within the organization.

  2. Click Generate Key.

  3. In the Key Name field, enter a name for the API key.

  4. (Optional) In the Description field, enter a description of the API key.

  5. In Organization Roles, select 1 or more organization roles for the API key.

  6. If the API key has the Organization Member role, configure the projects that the API key can access:

    1. Click Configure Project Access.

    2. Enable the projects you want the API key to access, or click Select all.

    3. For each project which the API key can access, select 1 or more project roles for the API key.

    4. Click Save.

  7. In Key Expiration, accept the default expiration, change the expiration, or specify that the key should not expire.

  8. In Allowed IP Addresses, click Added Allowed IP Address to specify IP access for the API key.

  9. Select 1 of the following options:

    1. To allow a specific IP address or block, in the Add IP / CIDR Block field, enter the IP address or CIDR notation.

    2. To add your current IP address block, click Add Current IP Address.

  10. Click Add.

  11. When you’re ready, click Generate Key.

    The Capella UI shows the new API key ID and the new API key token. The API key token is hidden to prevent others reading it.

    You must copy or download the API key token now. When you leave this page, you will not be able to copy or download the API key token again.

  12. To download the API key token, click Download Key. The key is saved by your browser in a file called <name>-api-key-token.txt, where <name> is the name of the API key.

  13. To copy either the API key ID or the API key token to the clipboard, click the copy icon () next to the field.

To generate a Management API key at the project level:

  1. Display the list of Management API keys within the project.

  2. Click Generate Key.

  3. In the Key Name field, enter a name for the API key.

  4. (Optional) In the Description field, enter a description of the API key.

  5. In Roles, select 1 or more project roles for the API key.

  6. In the Key Expiration, accept the default expiration, change the expiration, or specify that the key should not expire.

  7. In Allowed IP Addresses, click Added Allowed IP Address to specify IP access for the API key.

  8. Select 1 of the following options:

    1. To allow a specific IP address or block, in the Add IP / CIDR Block field, enter the IP address or CIDR notation.

    2. To add your current IP address, click Add Current IP Address.

  9. Click Add.

  10. When you’re ready, click Generate Key.

    The Capella UI shows the new API key ID and the new API key token. The API key token is hidden to prevent others reading it.

    You must copy or download the API key token now. After leaving this page, you cannot copy or download the API key token.

  11. To download the API key token, click Download Key. The key is saved by your browser in a file called <name>-api-key-token.txt, where <name> is the name of the API key.

  12. To copy either the API key ID or the API key token to the clipboard, click the copy icon () next to the field.

View Management API Keys

To view details of a Management API key:

  1. Display the list of Management API keys within an organization or within a project.

  2. Click the name of the API key.

    The details of the API key are displayed: the name, description, organization roles, expiration, allowed IP addresses, and project access.

Delete Management API Keys

To delete a Management API key:

  1. Display the list of Management API keys within an organization or within a project.

  2. Next to the API key you want to delete, click the trash can icon ().

  3. In the confirmation dialogue, confirm that you want to delete the API key.

  4. Click Delete.

Agent Memory API Keys

To create an initial bootstrap API key to access the Agent Memory API, you can use the Capella UI or the Management API.

Prerequisites

To view, create, and delete Agent Memory API keys, you must have 1 of the following roles:

To view Agent Memory API keys, you can also have the Cluster Manager or Cluster Viewer project role. These roles cannot create or delete API keys.

View Agent Memory API Keys

To display your Agent Memory API keys:

  1. In the Capella UI, go to AI Data Plane  Access Control.

  2. Select the Agent Memory tab.

By default, there are no Agent Memory API keys.

Generate Agent Memory API Keys

You can only generate an API key for an Agent Memory server that has finished deploying.

To generate an Agent Memory API key:

  1. In the Capella UI, choose 1 of the following options:

    • Go to AI Data Plane  Access Control.

    • Go to AI Data Plane  Agent Memory.

    • Access Control

    • Agent Memory

    1. Select the Agent Memory tab.

    2. Click Generate API Key.

    3. In the Agent Memory list, select the Agent Memory server for this API key.

    1. Next to your Agent Memory server, click More Options (⋮)  Generate API Key.

  2. In the API Key Name field, enter a name for the API key.

  3. In the Expiry list, accept the default expiration, change the expiration, or specify that the key should not expire.

  4. (Optional) In the Description field, enter a description of the API key.

  5. Under Access, select the access level for the API key. For more information, see Access Levels.

  6. Click Generate API Key.

    The Capella UI shows the new API key ID and the new API key token.

    You must copy or download the API key token now. When you leave this page, you cannot copy or download the API key token again.

  7. To download the API key token, click Download Key.

  8. To copy either the API key ID or the API key token to the clipboard, click next to the field.

Delete Agent Memory API Keys

To delete an Agent Memory API key:

  1. In the Capella UI, go to AI Data Plane  Access Control.

  2. Select the Agent Memory tab.

  3. Next to the API key you want to delete, click .

  4. Confirm that you want to delete the API key and click Delete API Key.

Agent Memory Server Endpoint

The Agent Memory API uses your Agent Memory server’s endpoint as its base URL. The endpoint is unique to every Agent Memory server you deploy.

To copy your Agent Memory server endpoint, you can use the Capella UI or the Management API.

Prerequisites

To copy the endpoint, you must have a project role on the project that contains the operational cluster your Agent Memory server connects to.

Copy Your Agent Memory Server Endpoint

To copy your Agent Memory server endpoint:

  1. Go to AI Data Plane  Agent Memory.

  2. Click the name of your Agent Memory server.

  3. Under Connect, copy the Endpoint.

Allowed IP Addresses for Agent Memory

For security, your Agent Memory server only accepts requests from IP addresses in its allowed IP address list. A new Agent Memory server has no allowed IP addresses, so it blocks all requests until you add at least 1. Allowed IP addresses apply to an Agent Memory server, not to an individual API key.

To add an allowed IP address, you can use the Capella UI or the Management API.

For each Agent Memory server, you can grant access from:

You can add up to 50 allowed IP addresses to each Agent Memory server.

Prerequisites

To view, add, and delete allowed IP addresses for an Agent Memory server, you must have 1 of the following roles:

To view allowed IP addresses, you can also have the Cluster Viewer project role.

View Allowed IP Addresses

To display the allowed IP addresses for your Agent Memory servers:

  1. In the Capella UI, go to AI Data Plane  Allowed IP Addresses.

  2. Select the Agent Memory tab.

By default, there are no allowed IP addresses.

Add Allowed IP Addresses

To add an allowed IP address:

  1. In the Capella UI, choose 1 of the following options:

    • Go to AI Data Plane  Allowed IP Addresses.

    • Go to AI Data Plane  Agent Memory.

    • Allowed IP Addresses

    • Agent Memory

    1. Select the Agent Memory tab.

    2. Click Add Allowed IP Address.

    3. In the Agent Memory list, select the Agent Memory server.

      You can only add allowed IP addresses to an Agent Memory server with a Healthy status.

    1. Next to your Agent Memory server, click More Options (⋮)  Add Allowed IP.

  2. In the Select Allowed IP list, select 1 of the following options:

    Add IP Address Manually

    Allow a specific IP address or CIDR block. Enter the IP address or CIDR block in the Allowed IP / CIDR Block field.

    Add Current IP Address

    Allow your current IP address.

    Allow Access from Anywhere

    Allow any IP address to access your Agent Memory server. In the confirmation dialog, enter Yes and click Allow Access from Anywhere.

  3. Click Add Allowed IP Address.

Delete Allowed IP Addresses

To delete an allowed IP address:

  1. In the Capella UI, go to AI Data Plane  Allowed IP Addresses.

  2. Select the Agent Memory tab.

  3. Next to the allowed IP address you want to delete, click .

  4. Confirm that you want to delete the allowed IP address and click Delete Allowed IP.

Next Steps