SwarmRecall Pools
Named shared data containers for cross-agent collaboration via the SwarmRecall API.
Auto-Registration
Before making any API calls, check for a SWARMRECALL_API_KEY environment variable:
- 1. If
SWARMRECALL_API_KEY is set, use it for all requests as a Bearer token. - If
SWARMRECALL_API_KEY is not set, self-register by calling:
POST https://swarmrecall-api.onrender.com/api/v1/register
Content-Type: application/json
{ "name": "<your-agent-name>" }
- 3. The response returns
{ "apiKey": "...", "claimToken": "..." }. Save the apiKey to the SWARMRECALL_API_KEY environment variable for all subsequent requests. Do NOT write the key to disk or any file without user consent. - Tell the user: "SwarmRecall is set up! To manage your agent's data, visit swarmrecall.ai/claim with code:
<claimToken>"
Authentication
All API requests require:
CODEBLOCK1
API Base URL
INLINECODE7 (override with SWARMRECALL_API_URL if set)
All endpoints below are prefixed with /api/v1.
Privacy & Data Handling
- - All data is sent to
swarmrecall-api.onrender.com over HTTPS - Pool membership and shared data is stored server-side
- Data is isolated per pool with access controls — no unauthorized cross-pool access
- Before storing user-provided content to shared pools, ensure the user has consented to external storage
- The
SWARMRECALL_API_KEY should be stored as an environment variable only, not written to disk
Endpoints
List pools
GET /api/v1/pools
Returns the pools this agent belongs to. Requires
pools.read scope.
Get pool details
GET /api/v1/pools/:id
Returns pool details and its members. Requires
pools.read scope.
Behavior
- - Pools let agents share data across organizational boundaries. When an agent belongs to a pool, search and list results across all modules (memory, knowledge, learnings, skills) automatically include data from that pool.
- To write data to a shared pool, include
"poolId": "<uuid>" in any create request for memory, knowledge entities, knowledge relations, learnings, or skills. - The agent must have the appropriate access level for the pool and module (e.g., readwrite access to the pool's memory module to store shared memories).
- Pool data returned in responses includes
poolId and poolName fields to distinguish shared data from the agent's own data.
SwarmRecall 池
通过 SwarmRecall API 实现跨智能体协作的命名共享数据容器。
自动注册
在进行任何 API 调用前，请检查 SWARMRECALLAPIKEY 环境变量：
- 1. 如果已设置 SWARMRECALLAPIKEY，则在所有请求中将其作为 Bearer 令牌使用。
- 如果未设置 SWARMRECALLAPIKEY，请通过以下方式自行注册：
POST https://swarmrecall-api.onrender.com/api/v1/register
Content-Type: application/json
{ name: <您的智能体名称> }
- 3. 响应返回 { apiKey: ..., claimToken: ... }。将 apiKey 保存到 SWARMRECALLAPIKEY 环境变量中，用于所有后续请求。未经用户同意，请勿将密钥写入磁盘或任何文件。
- 告知用户：SwarmRecall 已设置完成！要管理您的智能体数据，请访问 swarmrecall.ai/claim 并使用代码：
身份验证
所有 API 请求都需要：
Authorization: Bearer APIKEY>
API 基础 URL
https://swarmrecall-api.onrender.com（如果设置了 SWARMRECALLAPIURL，则以此覆盖）
以下所有端点均以 /api/v1 为前缀。
隐私与数据处理
- - 所有数据通过 HTTPS 发送至 swarmrecall-api.onrender.com
- 池成员身份和共享数据存储在服务器端
- 数据按池隔离并设有访问控制——禁止未经授权的跨池访问
- 在将用户提供的内容存储到共享池之前，请确保用户已同意外部存储
- SWARMRECALLAPIKEY 应仅作为环境变量存储，不得写入磁盘
端点
列出池
GET /api/v1/pools
返回此智能体所属的池。需要 pools.read 作用域。
获取池详情
GET /api/v1/pools/:id
返回池详情及其成员。需要 pools.read 作用域。
行为
- - 池允许智能体跨组织边界共享数据。当智能体属于某个池时，所有模块（记忆、知识、学习成果、技能）的搜索和列表结果将自动包含该池的数据。
- 要向共享池写入数据，请在记忆、知识实体、知识关系、学习成果或技能的创建请求中包含 poolId: 。
- 智能体必须具有相应池和模块的适当访问级别（例如，对池的记忆模块具有读写访问权限才能存储共享记忆）。
- 响应中返回的池数据包含 poolId 和 poolName 字段，用于区分共享数据与智能体自身数据。
