diff --git a/hindsight-docs/docs-integrations/paperclip.md b/hindsight-docs/docs-integrations/paperclip.md index 9aa0f09f7..566b1ec16 100644 --- a/hindsight-docs/docs-integrations/paperclip.md +++ b/hindsight-docs/docs-integrations/paperclip.md @@ -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 | diff --git a/hindsight-docs/guides/2026-04-16-guide-paperclip-memory-with-hindsight.md b/hindsight-docs/guides/2026-04-16-guide-paperclip-memory-with-hindsight.md index 8ef9329d3..d00f3f37b 100644 --- a/hindsight-docs/guides/2026-04-16-guide-paperclip-memory-with-hindsight.md +++ b/hindsight-docs/guides/2026-04-16-guide-paperclip-memory-with-hindsight.md @@ -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. diff --git a/hindsight-integrations/paperclip/README.md b/hindsight-integrations/paperclip/README.md index 1acb3f652..34c43894c 100644 --- a/hindsight-integrations/paperclip/README.md +++ b/hindsight-integrations/paperclip/README.md @@ -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 diff --git a/hindsight-integrations/paperclip/src/manifest.ts b/hindsight-integrations/paperclip/src/manifest.ts index e7e195903..223467fb8 100644 --- a/hindsight-integrations/paperclip/src/manifest.ts +++ b/hindsight-integrations/paperclip/src/manifest.ts @@ -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",