Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions hindsight-docs/docs-integrations/paperclip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down Expand Up @@ -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 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
21 changes: 10 additions & 11 deletions hindsight-integrations/paperclip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions hindsight-integrations/paperclip/src/manifest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down