Compare commits

...
Author SHA1 Message Date
Ben 73bbe5f736 Merge branch 'main' into docs-chat-cloud-first 2026-05-22 09:53:48 -04:00
Ben 806fbcd41c docs(nemoclaw): add Cloud API URL to quickstart and config default (#1700)
* docs(nemoclaw): prioritize Hindsight Cloud with callout banners

* feat(nemoclaw): default --api-url to Hindsight Cloud, make it optional
2026-05-22 09:52:58 -04:00
Ben a75c3c85ad docs(paperclip): add Cloud API URL to quickstart and config default (#1699)
* docs(paperclip): prioritize Hindsight Cloud in setup docs and config default

* style(paperclip): align table columns after linter reformat
2026-05-22 09:37:02 -04:00
Ben 0db9f3da19 docs(dify): add Cloud Recommended callout (#1698)
dify already led with Cloud signup — adds the explicit  Recommended
banner for visual consistency.
2026-05-22 09:36:15 -04:00
Ben 8940710c72 docs(n8n): add Cloud Recommended callout (#1697)
n8n already led with Cloud signup — adds the explicit  Recommended
banner to README and docs page Setup sections for visual consistency
with the other cloud-first integrations.
2026-05-22 09:35:29 -04:00
Ben 6252643de0 docs(agno): prioritize Hindsight Cloud in quickstart (#1696)
Lead README + docs Quick Start with Cloud sign-up + Cloud API URL.
Bulk-replace localhost:8888 examples with Cloud URL. Demote
self-hosted to a 'Self-hosting (local development)' section below.
Update docstring examples in __init__.py and tools.py.
2026-05-22 09:33:44 -04:00
Ben 3fce309c0d docs(agentcore): add Cloud Recommended callout in quickstart (#1694)
Adds  Recommended Hindsight Cloud callout to README + docs + guide
Quick Start sections. agentcore already led with Cloud URL in code
examples — this just makes the recommendation explicit.
2026-05-22 09:32:33 -04:00
Ben 6bdb1a08f5 docs(chat): add Hindsight Cloud setup callout to README and docs 2026-05-21 14:36:48 -04:00
20 changed files with 108 additions and 50 deletions
@@ -40,6 +40,10 @@ pip install hindsight-agentcore
## Quick Start
:::tip Recommended: Hindsight Cloud
[Sign up free](https://ui.hindsight.vectorize.io/signup) and grab an API key — no self-hosting required.
:::
```python
import os
from hindsight_agentcore import HindsightRuntimeAdapter, TurnContext, configure
+17 -8
View File
@@ -24,6 +24,10 @@ pip install hindsight-agno
## Quick Start
:::tip Recommended: Hindsight Cloud
[Sign up free](https://ui.hindsight.vectorize.io/signup) and grab an API key — no self-hosting required.
:::
```python
from agno.agent import Agent
from agno.models.openai import OpenAIChat
@@ -33,7 +37,8 @@ agent = Agent(
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
api_key="hsk_...", # or set HINDSIGHT_API_KEY env var
)],
)
@@ -41,6 +46,10 @@ agent.print_response("Remember that I prefer dark mode")
agent.print_response("What are my preferences?")
```
### Self-hosting (local development)
If you're running Hindsight locally with `./scripts/dev/start-api.sh`, swap the URL to `http://localhost:8888`. See the [installation guide](/developer/installation) for setup.
The agent now has three tools it can call:
- **`retain_memory`** — Store information to long-term memory
@@ -58,11 +67,11 @@ agent = Agent(
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
)],
instructions=[memory_instructions(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
)],
)
```
@@ -74,7 +83,7 @@ Include only the tools you need:
```python
tools = [HindsightTools(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
enable_retain=True,
enable_recall=True,
enable_reflect=False, # Omit reflect
@@ -93,7 +102,7 @@ The bank ID is resolved in order:
# Per-user banks from RunContext
agent = Agent(
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(hindsight_api_url="http://localhost:8888")],
tools=[HindsightTools(hindsight_api_url="https://api.hindsight.vectorize.io")],
user_id="user-123", # Used as bank_id
)
@@ -105,7 +114,7 @@ agent = Agent(
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(
bank_resolver=resolve_bank,
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
)],
)
```
@@ -118,7 +127,7 @@ Instead of passing connection details to every toolkit, configure once:
from hindsight_agno import configure, HindsightTools
configure(
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
api_key="your-api-key", # Or set HINDSIGHT_API_KEY env var
budget="mid", # Recall budget: low/mid/high
max_tokens=4096, # Max tokens for recall results
@@ -171,7 +180,7 @@ tools = [HindsightTools(bank_id="user-123")]
| Parameter | Default | Description |
|---|---|---|
| `hindsight_api_url` | Production API | Hindsight API URL |
| `hindsight_api_url` | Hindsight Cloud (`https://api.hindsight.vectorize.io`) | Hindsight API URL |
| `api_key` | `HINDSIGHT_API_KEY` env | API key for authentication |
| `budget` | `"mid"` | Default recall budget level |
| `max_tokens` | `4096` | Default max tokens for recall |
+6
View File
@@ -10,6 +10,12 @@ We built `@vectorize-io/hindsight-chat` to give [Vercel Chat SDK](https://github
[View Changelog →](/changelog/integrations/chat)
## Setup
:::tip Hindsight Cloud (recommended)
[Sign up free](https://ui.hindsight.vectorize.io/signup) — get an API key instantly, no infrastructure to run. Self-hosting? See the [installation guide](/developer/installation).
:::
## Installation
```bash
+4
View File
@@ -28,6 +28,10 @@ After install, the **Hindsight** plugin appears under **Tools** in the workflow
## Setup
:::tip Recommended: Hindsight Cloud
[Sign up free](https://ui.hindsight.vectorize.io/signup) and grab an API key — no self-hosting required.
:::
1. **Sign up** at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) (free tier) or [self-host](/developer/installation)
2. **Get an API key** from the Hindsight dashboard
3. **In Dify**, open the Hindsight plugin and add credentials:
+4
View File
@@ -35,6 +35,10 @@ Restart n8n; the **Hindsight** node appears in the node panel.
## Setup
:::tip Recommended: Hindsight Cloud
[Sign up free](https://ui.hindsight.vectorize.io/signup) and grab an API key — no self-hosting required.
:::
1. **Sign up** at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) (free tier) or [self-host](/developer/installation)
2. **Get an API key** from the Hindsight dashboard
3. **In n8n**, create a new **Hindsight API** credential with your API URL (defaults to Hindsight Cloud) and the `hsk_...` key
+5 -4
View File
@@ -14,16 +14,17 @@ NemoClaw runs [OpenClaw](https://openclaw.ai) inside an OpenShell sandbox with c
## Quick Start
:::tip Hindsight Cloud (recommended)
[Sign up free](https://ui.hindsight.vectorize.io/signup) — get an API key instantly, no infrastructure to run.
:::
```bash
npx @vectorize-io/hindsight-nemoclaw setup \
--sandbox my-assistant \
--api-url https://api.hindsight.vectorize.io \
--api-token <your-api-key> \
--bank-prefix my-sandbox
```
Get an API key at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup).
You'll see output like:
```
@@ -79,8 +80,8 @@ hindsight-nemoclaw setup [options]
Options:
--sandbox <name> NemoClaw sandbox name (required)
--api-url <url> Hindsight API URL (required)
--api-token <token> Hindsight API token (required)
--api-url <url> Hindsight API URL (default: https://api.hindsight.vectorize.io)
--bank-prefix <prefix> Memory bank prefix (default: "nemoclaw")
--skip-policy Skip sandbox network policy update
--skip-plugin-install Skip openclaw plugin installation
@@ -20,17 +20,18 @@ Then configure in **Settings → Plugins → Hindsight Memory**.
## Prerequisites
Either:
:::tip Hindsight Cloud (recommended)
[Sign up free](https://ui.hindsight.vectorize.io/signup) — no infrastructure to run. Skip straight to Configuration below.
:::
**Self-hosting alternative** — run Hindsight locally:
```bash
# Self-hosted
pip install hindsight-all
export HINDSIGHT_API_LLM_API_KEY=your-openai-key
hindsight-api
```
Or [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — no self-hosting required.
## How It Works
```
@@ -58,7 +59,7 @@ Memory is keyed to `companyId` + `agentId` — never to the run ID — so it acc
| Field | Default | Description |
|-------|---------|-------------|
| `hindsightApiUrl` | `http://localhost:8888` | Hindsight server URL |
| `hindsightApiUrl` | `https://api.hindsight.vectorize.io` | Hindsight server URL (Cloud default; use `http://localhost:8888` for self-hosted) |
| `hindsightApiKeyRef` | — | Paperclip secret name holding Hindsight Cloud API key |
| `bankGranularity` | `["company", "agent"]` | Memory isolation: per company+agent, per company, or per agent |
| `recallBudget` | `mid` | `low` = fastest, `mid` = balanced, `high` = most thorough |
@@ -31,7 +31,7 @@ This guide covers the quick-start path, the HTTP and process adapter patterns, b
Before you start, make sure you have:
- A Paperclip agent already running through the heartbeat model
- A reachable Hindsight backend, either self-hosted or [Hindsight Cloud](https://hindsight.vectorize.io)
- A Hindsight backend: [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) (recommended — free tier, no infrastructure to run) or [self-hosted](https://hindsight.vectorize.io/developer/installation)
- Stable identifiers for `companyId` and `agentId`
The identifier design matters. Paperclip's default isolation pattern works well because it maps cleanly to a multi-tenant setup.
@@ -44,6 +44,8 @@ pip install hindsight-agentcore
## Step 2: Connect AgentCore Runtime to Hindsight
> ✨ **Recommended:** [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — free tier, no self-hosting required.
```python
import os
from hindsight_agentcore import configure
@@ -54,6 +56,8 @@ configure(
)
```
If you'd rather self-host on AWS (ECS/EKS with RDS PostgreSQL + pgvector), set `hindsight_api_url` to your in-VPC Hindsight endpoint.
## Step 3: Wire memory into your runtime
```python
@@ -34,6 +34,8 @@ pip install hindsight-agentcore
## Quick Start
> ✨ **Recommended: [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup)** — free tier, no self-hosting required. Sign up and grab an API key in under a minute.
```python
import os
from hindsight_agentcore import HindsightRuntimeAdapter, TurnContext, configure
+24 -8
View File
@@ -18,6 +18,8 @@ pip install hindsight-agno
## Quick Start
> ✨ **Recommended: [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup)** — free tier, no self-hosting required. Sign up and grab an API key in under a minute.
```python
from agno.agent import Agent
from agno.models.openai import OpenAIChat
@@ -27,7 +29,8 @@ agent = Agent(
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
api_key="hsk_...", # or set HINDSIGHT_API_KEY env var
)],
)
@@ -41,6 +44,19 @@ The agent now has three tools it can call:
- **`recall_memory`** — Search long-term memory for relevant facts
- **`reflect_on_memory`** — Synthesize a reasoned answer from memories
### Self-hosting (local development)
If you're running Hindsight locally with `./scripts/dev/start-api.sh`, point at your local server instead:
```python
tools=[HindsightTools(
bank_id="user-123",
hindsight_api_url="https://api.hindsight.vectorize.io",
)]
```
See the [Hindsight installation guide](https://hindsight.vectorize.io/developer/installation) for self-hosting setup.
## With Memory Instructions
Pre-recall relevant memories and inject them into the system prompt:
@@ -52,11 +68,11 @@ agent = Agent(
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
)],
instructions=[memory_instructions(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
)],
)
```
@@ -68,7 +84,7 @@ Include only the tools you need:
```python
tools = [HindsightTools(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
enable_retain=True,
enable_recall=True,
enable_reflect=False, # Omit reflect
@@ -87,7 +103,7 @@ The bank ID is resolved in order:
# Per-user banks from RunContext
agent = Agent(
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(hindsight_api_url="http://localhost:8888")],
tools=[HindsightTools(hindsight_api_url="https://api.hindsight.vectorize.io")],
user_id="user-123", # Used as bank_id
)
@@ -99,7 +115,7 @@ agent = Agent(
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(
bank_resolver=resolve_bank,
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
)],
)
```
@@ -112,7 +128,7 @@ Instead of passing connection details to every toolkit, configure once:
from hindsight_agno import configure, HindsightTools
configure(
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
api_key="your-api-key", # Or set HINDSIGHT_API_KEY env var
budget="mid", # Recall budget: low/mid/high
max_tokens=4096, # Max tokens for recall results
@@ -165,7 +181,7 @@ tools = [HindsightTools(bank_id="user-123")]
| Parameter | Default | Description |
|---|---|---|
| `hindsight_api_url` | Production API | Hindsight API URL |
| `hindsight_api_url` | Hindsight Cloud (`https://api.hindsight.vectorize.io`) | Hindsight API URL |
| `api_key` | `HINDSIGHT_API_KEY` env | API key for authentication |
| `budget` | `"mid"` | Default recall budget level |
| `max_tokens` | `4096` | Default max tokens for recall |
@@ -13,11 +13,11 @@ Basic usage::
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
)],
instructions=[memory_instructions(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
)],
)
@@ -96,7 +96,8 @@ class HindsightTools(Toolkit):
model=OpenAIChat(id="gpt-4o-mini"),
tools=[HindsightTools(
bank_id="user-123",
hindsight_api_url="http://localhost:8888",
hindsight_api_url="https://api.hindsight.vectorize.io",
api_key="hsk_...",
)],
)
agent.print_response("Remember that I prefer dark mode")
+6
View File
@@ -2,6 +2,12 @@
Give your [Vercel Chat SDK](https://github.com/vercel/chat) bots persistent, per-user memory with a single handler wrapper. Works with Slack, Discord, Teams, Google Chat, GitHub, and Linear.
## Setup
> ✨ **Recommended:** [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — sign up free, get an API key, and you're ready. No infrastructure to run.
>
> Self-hosting alternative: [installation guide](https://hindsight.vectorize.io/developer/installation).
## Quick Start
```bash
+2
View File
@@ -10,6 +10,8 @@ Three tools — **Retain**, **Recall**, **Reflect** — drop into any Dify workf
## Setup
> ✨ **Recommended: [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup)** — free tier, no self-hosting required. Sign up and grab an API key in under a minute.
1. **Sign up** at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) (free tier) or [self-host](https://hindsight.vectorize.io/developer/installation).
2. **Get an API key** from the Hindsight dashboard.
3. **In Dify**, install this plugin (Marketplace or upload `.difypkg`), then add credentials:
+2
View File
@@ -27,6 +27,8 @@ Restart n8n and the **Hindsight** node appears in the node panel.
## Setup
> ✨ **Recommended: [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup)** — free tier, no self-hosting required. Sign up and grab an API key in under a minute.
1. **Create a Hindsight account** at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) (free tier available) — or self-host with the [Hindsight installer](https://hindsight.vectorize.io/developer/installation)
2. **Get an API key** from the Hindsight dashboard
3. **In n8n**, create a new **Hindsight API** credential:
+3 -4
View File
@@ -6,16 +6,15 @@ NemoClaw runs [OpenClaw](https://openclaw.ai) inside an OpenShell sandbox with s
## Quick Start
> ✨ **Recommended:** Use [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — sign up free and get an API key instantly. No infrastructure to run.
```bash
npx @vectorize-io/hindsight-nemoclaw setup \
--sandbox my-assistant \
--api-url https://api.hindsight.vectorize.io \
--api-token <your-api-key> \
--bank-prefix my-sandbox
```
Get an API key at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup).
## Documentation
Full setup guide, pitfalls, and troubleshooting:
@@ -31,8 +30,8 @@ hindsight-nemoclaw setup [options]
Options:
--sandbox <name> NemoClaw sandbox name (required)
--api-url <url> Hindsight API URL (required)
--api-token <token> Hindsight API token (required)
--api-url <url> Hindsight API URL (default: https://api.hindsight.vectorize.io)
--bank-prefix <prefix> Memory bank prefix (default: "nemoclaw")
--skip-policy Skip sandbox network policy update
--skip-plugin-install Skip openclaw plugin installation
+2 -4
View File
@@ -10,11 +10,11 @@ Usage:
Required options:
--sandbox <name> NemoClaw sandbox name (e.g. my-assistant)
--api-url <url> Hindsight Cloud API URL (https://api.hindsight.vectorize.io)
--api-token <token> Hindsight API key from https://ui.hindsight.vectorize.io
--bank-prefix <prefix> Bank ID prefix (memories go to <prefix>-openclaw)
Optional options:
--api-url <url> Hindsight API URL (default: https://api.hindsight.vectorize.io)
--skip-policy Skip the openshell policy update
--skip-plugin-install Skip openclaw plugins install
--dry-run Print what would be changed without executing
@@ -23,7 +23,6 @@ Optional options:
Example:
hindsight-nemoclaw setup \\
--sandbox my-assistant \\
--api-url https://api.hindsight.vectorize.io \\
--api-token hsk_abc123 \\
--bank-prefix my-sandbox
`);
@@ -49,13 +48,12 @@ function parseArgs(argv: string[]): CliArgs | null {
};
const sandbox = get("--sandbox");
const apiUrl = get("--api-url");
const apiUrl = get("--api-url") ?? "https://api.hindsight.vectorize.io";
const apiToken = get("--api-token");
const bankPrefix = get("--bank-prefix");
const missing: string[] = [];
if (!sandbox) missing.push("--sandbox");
if (!apiUrl) missing.push("--api-url");
if (!apiToken) missing.push("--api-token");
if (!bankPrefix) missing.push("--bank-prefix");
+10 -11
View File
@@ -20,26 +20,25 @@ Then configure in **Settings → Plugins → Hindsight Memory**.
## Prerequisites
Either:
> ✨ **Recommended:** [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — sign up free, get an API key, and skip the self-hosting setup entirely.
**Self-hosting alternative** — run Hindsight locally:
```bash
# Self-hosted (runs locally)
pip install hindsight-all
export HINDSIGHT_API_LLM_API_KEY=your-openai-key
hindsight-api
```
Or [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — no self-hosting required.
## Configuration
| Field | Default | Description |
| -------------------- | ----------------------- | -------------------------------------------------------------- |
| `hindsightApiUrl` | `http://localhost:8888` | Hindsight server URL |
| `hindsightApiKeyRef` | — | Paperclip secret name holding Hindsight Cloud API key |
| `bankGranularity` | `["company", "agent"]` | Memory isolation: per company+agent, per company, or per agent |
| `recallBudget` | `mid` | `low` = fastest, `mid` = balanced, `high` = most thorough |
| `autoRetain` | `true` | Automatically retain run output after every run |
| Field | Default | Description |
| -------------------- | ------------------------------------ | --------------------------------------------------------------------------------- |
| `hindsightApiUrl` | `https://api.hindsight.vectorize.io` | Hindsight server URL (Cloud default; use `http://localhost:8888` for self-hosted) |
| `hindsightApiKeyRef` | — | Paperclip secret name holding Hindsight Cloud API key |
| `bankGranularity` | `["company", "agent"]` | Memory isolation: per company+agent, per company, or per agent |
| `recallBudget` | `mid` | `low` = fastest, `mid` = balanced, `high` = most thorough |
| `autoRetain` | `true` | Automatically retain run output after every run |
## Bank ID Format
@@ -31,8 +31,8 @@ const manifest: PaperclipPluginManifestV1 = {
type: "string",
title: "Hindsight API URL",
description:
"Base URL of your Hindsight instance. Use http://localhost:8888 for self-hosted.",
default: "http://localhost:8888",
"Base URL of your Hindsight instance. Defaults to Hindsight Cloud. Use http://localhost:8888 for self-hosted.",
default: "https://api.hindsight.vectorize.io",
},
hindsightApiKeyRef: {
type: "string",