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
4 changes: 3 additions & 1 deletion apps/docs/snippets/api-v5-content-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Pass `include` as a comma-separated list to return chunks, memories, or both. Ke
{"system":{"status":"done","createdAt":"...","updatedAt":"..."}}
```

`system.status` is one of `unknown`, `queued`, `extracting`, `chunking`, `embedding`, `indexing`, `done`, or `failed`.

### List documents, chunks, or memories

<CodeGroup>
Expand Down Expand Up @@ -51,7 +53,7 @@ DELETE /ns/{namespace}/document
```
</CodeGroup>

The v5 array accepts 1–100 Supermemory or caller-defined IDs. Inspect both `deletedCount` and per-ID `errors`; HTTP success can include partial failures.
The v5 array accepts 1–100 Supermemory or caller-defined IDs. Inspect both `count` and per-ID `errors`; HTTP success can include partial failures.

### Forget memories

Expand Down
8 changes: 4 additions & 4 deletions apps/docs/snippets/api-v5-document-ingestion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ POST /ns/user_1/document?dreaming=dynamic
```
</CodeGroup>

The response remains an acceptance result with `id` and `status`. Repeating the v5 request with `id: "conv_1"` adds or diffs the new content into that document; it does not silently replace the canonical source.
The response remains an acceptance result with `id` and `status`. Its `status` is the document's processing state after the request: `queued` when new work was queued, otherwise the document's current state (for example `done` for an unchanged duplicate, or `failed` for a metadata-only update to a failed document). Possible values: `unknown`, `queued`, `extracting`, `chunking`, `embedding`, `indexing`, `done`, `failed`. Repeating the v5 request with `id: "conv_1"` adds or diffs the new content into that document; it does not silently replace the canonical source.

### Batch ingestion

Expand All @@ -41,7 +41,7 @@ The response remains an acceptance result with `id` and `status`. Repeating the

Send the v5 body to `POST /ns/user_1/document/batch`. The array accepts 1–600 document objects. Namespace, `taskType`, and processing mode apply to the request; document content, ID, context, metadata, grouping, and date stay per item.

Batch results preserve input order. Inspect `success`, `failed`, and every item in `results`; a batch can contain successful and failed items together.
`results` lists accepted documents first, in request order, then failed ones; match each result by `id`, or by `url` for a failed item with no ID. Inspect `count` (accepted), `failed`, and every item in `results`; each item's `status` is a processing state as above, or `error` when that item failed, and a batch can contain successful and failed items together.

### File ingestion

Expand All @@ -54,7 +54,7 @@ Replace `POST /v3/documents/file` with `POST /ns/{namespace}/document/file`. Con
| `metadata`, `group` | JSON-encoded strings |
| `fileType`, `mimeType` | Query parameters when inference is insufficient |

The API acknowledges the file after durable acceptance. Extraction, indexing, and memory formation continue asynchronously; poll the document rather than assuming the first response means processing is complete.
The API acknowledges the file after durable acceptance, with `status` set as for a JSON add. Extraction, indexing, and memory formation continue asynchronously; poll the document rather than assuming the first response means processing is complete.

### Processing choices

Expand All @@ -66,5 +66,5 @@ The API acknowledges the file after durable acceptance. Extraction, indexing, an

- Ingest text, a public URL, and a file, then wait for each document to finish processing.
- Repeat a caller-defined ID and confirm append/diff behavior instead of replacement.
- Submit a mixed-success batch and verify result order and per-item errors.
- Submit a mixed-success batch and verify each result matches its document by ID, with per-item errors.
- Confirm metadata and grouping remain filterable after processing.
3 changes: 2 additions & 1 deletion apps/docs/snippets/api-v5-rollout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ Record each legacy request, v5 request, expected semantic result, and intentiona
### Compare writes

- Repeated POST appends or diffs; PATCH replaces canonical content.
- Batch outcomes preserve input order and surface partial failures.
- Batch outcomes list accepted documents first, then failures, and surface partial failures; match by ID, not position.
- Metadata-only updates leave source content unchanged.
- Accepted writes are polled until processing reaches a terminal state.

### Compare reads and recall

- Document includes are absent when omitted and empty arrays when requested without results.
- Unified list responses populate only the selected resource array.
- `metadata` is always an object, `{}` when empty; it is never `null`.
- Search parity uses explicit v4-equivalent mode and threshold before testing v5 defaults.
- Profiles always contain static, dynamic, and bucket sections.

Expand Down
3 changes: 2 additions & 1 deletion apps/docs/snippets/api-v5-search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,10 @@ Legacy `include.chunks` has no v5 equivalent. Choose `chunks` or `hybrid` instea
| --- | --- |
| Result array | `results` |
| Timing | `searchTime` |
| Source expansion | `result.included.document` |
| Source expansion | `result.included.document`, with timestamps under its `system` |
| Related context | `result.included.related.{parents,children,siblings}` |
| Lifecycle fields | `result.system` |
| Version and inference flags | `result.isLatest`, `result.isInference` |

Each primary result contains either `memory`, `chunk`, or both only if the contract allows it. Branch on field presence rather than assuming one result shape.

Expand Down
Loading