# opensearch-memory

Part of **OPENSEARCH**

# OpenSearch Memory Management Console Guide

## Operations Overview

| Operation | Console Entry | Prerequisites | Description |
|----------|---------------|---------------|-------------|
| Retrieve Agentic Memory API Credentials | AI Search Open Platform Console > Intelligent Q&A > API Key Management | AI Search Open Platform console access, OpenClaw environment ready | Obtain baseUrl, workspaceName, and apiKey required to configure Agentic Memory in OpenClaw |

## Step-by-Step Instructions

### Retrieve Agentic Memory API Credentials

**Navigation**: AI Search Open Platform Console > Intelligent Q&A > API Key Management

**Prerequisites**:
- AI Search Open Platform console access
- Workspace already created in the console
- Basic understanding of OpenClaw Gateway and plugins

1. Log in to the AI Search Open Platform console  
   - Element: **Log in** (link) — top-right corner  
   - Notes: Use your Alibaba Cloud account credentials

2. Navigate to the API Key Management page  
   - Element: **Intelligent Q&A > API Key Management** (menu) — left navigation pane  
   - Notes: Ensure you are in the correct region (e.g., China (Shanghai))

3. Locate and copy the API service address (baseUrl)  
   - Element: **API service address (baseUrl)** (text_input) — on the API Key Management page  
   - Notes: The baseUrl follows the format `http://<workspace-id>.platform-cn-shanghai.opensearch.aliyuncs.com`. The workspace ID is embedded in this URL.

4. Copy the displayed **API Key** value  
   - Element: **API Key** (text_input) — same page as baseUrl  
   - Notes: This key is used for authentication when calling the Agentic Memory API

5. Note your **Workspace Name**  
   - Element: **Workspace Name** (text_input) — typically shown alongside baseUrl or in workspace settings  
   - Notes: Required during OpenClaw plugin configuration

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| baseUrl | text_input | Yes | — | The base URL for the Agentic Memory API, obtained from the AI Search Open Platform console. Format: `http://<workspace-id>.platform-cn-shanghai.opensearch.aliyuncs.com` |
| workspaceName | text_input | Yes | — | The name of the workspace created in the console |
| apiKey | text_input | Yes | — | The API key used for authenticating requests to the Agentic Memory service |
| serviceId | text_input | No | — | The service ID of the memory service. Default: `agentic-memory` |
| userId | text_input | No | — | User identifier to isolate memories per user. If not set, a UUID is auto-generated |
| agentId | text_input | No | — | Agent identifier to associate memories and skills with a specific agent |
| autoRecallMemory | checkbox | No | true, false | Enables automatic recall of relevant memories before agent execution. Default: false |
| autoCaptureMemory | checkbox | No | true, false | Enables automatic capture of conversations as memories after agent execution. Default: false |
| autoRecallSkill | checkbox | No | true, false | Includes skill retrieval during Auto-Recall. Default: false |
| autoCaptureSkill | checkbox | No | true, false | Enables automatic skill capture from conversations (coming soon). Default: false |
| recallLimit | number_input | No | — | Maximum number of memories retrieved per Auto-Recall. Default: 5 |

## FAQ

Q: Where can I find the baseUrl and API key for Agentic Memory?
A: Both are available on the **API Key Management** page under **Intelligent Q&A** in the AI Search Open Platform console.

Q: Is the workspace ID separate from the workspace name?
A: Yes. The workspace ID is embedded in the baseUrl (e.g., in `http://abc123.platform-cn-shanghai...`, `abc123` is the workspace ID), while the workspace name is a human-readable label shown in the console.

Q: Can I reuse the same API key across multiple agents?
A: Yes, but to isolate memories per user or agent, provide unique **userId** or **agentId** values during configuration.

Q: What happens if I don’t set userId or agentId?
A: If **userId** is omitted, a random UUID is generated automatically. If **agentId** is omitted, memories won’t be explicitly tied to a specific agent.

Q: Do I need to install anything in the console to enable Agentic Memory?
A: No. Agentic Memory is an API service. Configuration happens in your OpenClaw application using credentials obtained from the console.

## Pricing & Billing

### Billing Model
Billing is based on the number of API requests. Both input and output are billed per 1,000 requests.

### Price Reference

| Tier | Input Price | Output Price | Other Price |
|------|-------------|--------------|-------------|
| Agentic Memory API | 0.002 / | 0.002 / | — |

### Free Tier
No free tier is available.

### Billing Notes
- Asynchronous tasks are billed upon completion.
- Minimum billing duration for async tasks is 1 hour.
- Each request is subject to a maximum of 8K tokens.