supermemory/apps/docs/v5/api-reference/profiles.mdx
sohamd22 8452a00434 docs(api): keep the default preferences bucket and drop v4 profile labels in v5 docs (#1809)
Fixes v5 profile and bucket docs.

- **The default `preferences` bucket can't be replaced.** It's always part of the effective set. Custom buckets are added alongside it, `deleteBuckets` can't remove it, and defining a bucket named `preferences` only overrides its description.
- **No `[Summary]`/`[Recent]` labels in v5.** Only v4 adds them. Summaries are now told apart by an `aggregated_` id, and individual `dynamic` entries keep their `[YYYY-MM-DD]` date. Example responses are updated, and the migration snippet calls out the change.
- **Name clashes.** A namespace bucket with an org bucket's name returns `409`; the docs said the org's definition silently wins.
- **Smaller fixes:**
  - `filterPrompt` → `organizationalContext`.
  - An invalid `organization.update` example (stray `},`).
  - OAuth redirect URIs now use `/v3/connections/auth/callback/{provider}`.
  - The v4 `include` example in the migration snippet.
  - Broken anchors and links.

Checked against the current API and the published SDKs (TS 5.0.1, Python 5.0.0). Legacy v3/v4 docs are unchanged apart from factual fixes.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2026-10-15 18:52:40 +00:00

39 lines
1.5 KiB
Text

---
title: "Profiles"
sidebarTitle: "Overview"
description: "Turn accumulated memory into a ready-to-use understanding of a user"
icon: "/icons/hugeicons/id.svg"
---
| Operation | Purpose |
| --- | --- |
| `POST /ns/{namespace}/profile` | Retrieve durable facts, recent context, and custom insights |
| `GET /ns/{namespace}/profile/buckets` | See the profile categories available here |
| `PUT /ns/{namespace}/profile/buckets` | Shape the profile with namespace-specific categories |
| `DELETE /ns/{namespace}/profile/buckets` | Remove namespace-specific categories |
<CodeGroup>
```ts TypeScript
const { profile } = await supermemory.profile("user_1")
await supermemory.profiles.setBuckets("user_1", {
buckets: { work: "Professional preferences and ongoing work" },
})
```
```bash curl
curl -X POST "https://api.supermemory.ai/ns/user_1/profile" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
curl -X PUT "https://api.supermemory.ai/ns/user_1/profile/buckets" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"buckets":{"work":"Professional preferences and ongoing work"}}'
```
</CodeGroup>
Profiles always contain static and dynamic sections, giving applications both durable knowledge and fresh context without composing them manually. Organization-owned buckets may be inherited but cannot be changed through namespace bucket endpoints.
See [profile migration](/migration/api-v5-profiles).