Skip to content

Commit d02affd

Browse files
authored
docs: expand external API configuration section for OpenClaw (#294)
- Add plugin configuration example with hindsightApiUrl and hindsightApiToken - Document behavior differences when using external API mode - Add verification steps and log messages to expect - Explain use cases (shared memory, production, team environments)
1 parent 6b34692 commit d02affd

1 file changed

Lines changed: 58 additions & 4 deletions

File tree

hindsight-docs/docs/sdks/integrations/openclaw.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,16 +125,70 @@ export HINDSIGHT_API_LLM_BASE_URL=https://openrouter.ai/api/v1
125125

126126
### External API (Advanced)
127127

128-
To use an existing Hindsight API server instead of the local daemon:
128+
Connect to a remote Hindsight API server instead of running a local daemon. This is useful for:
129+
130+
- **Shared memory** across multiple OpenClaw instances
131+
- **Production deployments** with centralized memory storage
132+
- **Team environments** where agents share knowledge
133+
134+
#### Plugin Configuration
135+
136+
Configure in `~/.openclaw/openclaw.json`:
137+
138+
```json
139+
{
140+
"plugins": {
141+
"entries": {
142+
"hindsight-openclaw": {
143+
"enabled": true,
144+
"config": {
145+
"hindsightApiUrl": "https://your-hindsight-server.com",
146+
"hindsightApiToken": "your-api-token"
147+
}
148+
}
149+
}
150+
}
151+
}
152+
```
153+
154+
**Options:**
155+
- `hindsightApiUrl` - Full URL to external Hindsight API (e.g., `https://mcp.hindsight.example.com`)
156+
- `hindsightApiToken` - API token for authentication (optional, only if API requires auth)
157+
158+
#### Environment Variables (Alternative)
159+
160+
You can also configure via environment variables:
129161

130162
```bash
131-
export HINDSIGHT_EMBED_API_URL=http://your-server:8000
132-
export HINDSIGHT_EMBED_API_TOKEN=your-api-token # Optional, if API requires auth
163+
export HINDSIGHT_EMBED_API_URL=https://your-hindsight-server.com
164+
export HINDSIGHT_EMBED_API_TOKEN=your-api-token # Optional
133165

134166
openclaw gateway
135167
```
136168

137-
Useful for shared memory across multiple OpenClaw instances or production deployments.
169+
**Note:** Plugin config takes precedence over environment variables.
170+
171+
#### Behavior
172+
173+
When external API mode is enabled:
174+
- **No local daemon** is started (no hindsight-embed process)
175+
- **Health check** runs on startup to verify API connectivity
176+
- **All memory operations** (retain, recall, reflect) go to the external API
177+
- **Faster startup** since no local PostgreSQL or embedding models are needed
178+
179+
#### Verification
180+
181+
Check OpenClaw logs for external API mode:
182+
183+
```bash
184+
tail -f /tmp/openclaw/openclaw-*.log | grep Hindsight
185+
186+
# Should see on startup:
187+
# [Hindsight] External API mode enabled: https://your-hindsight-server.com
188+
# [Hindsight] External API health check passed
189+
```
190+
191+
If you see daemon startup messages instead, verify your configuration is correct.
138192

139193
## Inspecting Memories
140194

0 commit comments

Comments
 (0)