System Boundaries
Know which customer-visible behaviors are dependable, which responsibilities remain in your application, and how to handle uncertainty without relying on private architecture.
Build on contracts, not implementation
Safe to rely on
Documented requests, responses, and status codes.
- Created and skipped add outcomes.
- Per-item bulk outcomes.
- The
memoriesresponse array. - Documented fields, limits, and scope inputs.
Do not couple to
Private details can change without changing the API contract.
- Physical persistence technology.
- Search or ranking implementation.
- Background execution topology.
- Undocumented timing or identifier patterns.
Use customer-visible completion signals
The response tells you whether a memory exists.
A multi-status response can mix created, skipped, and rejected items.
An empty memories array is a completed query.
A created connected-source job is not complete until its public status says so.
Classify before retrying
What result did your application receive?
Created, skipped, empty, or another documented success
The operation completed with a business outcome.
Use: Continue; do not retry the same operation automatically.
Authentication, permission, validation, or not found
The request will not improve by waiting.
Use: Correct credentials, authorization, fields, or resource ID.
Rate limit, server error, or network failure
The failure may be temporary.
Use: Retry only with a bounded policy and a final recoverable state.
Connection ended after sending a write
Your application may not know whether the request arrived.
Use: Reconcile through visible records and avoid assuming either outcome.
Keep responsibilities explicit
Your application remains in control
MemorySync supplies scoped memory operations. It does not replace your product’s security, data ownership, or model-safety decisions.
- Authentication
- MemorySync API key
Keep it server-side and out of browser bundles, logs, and memory content.
- Authorization
- Your application
Verify organization, user, and object access before each call.
- Source of truth
- Your business systems
Keep authoritative profiles, documents, and transactions in their owning systems.
- Prompt safety
- Your model boundary
Treat imported and retrieved content as untrusted data.
Observe without collecting secrets
- 01
Correlate
beforeGenerate your own non-sensitive request or workflow identifier.
- 02
Measure
duringRecord operation name, status code, and duration.
- 03
Reference
afterKeep returned memory or sync job IDs when needed for support.
- 04
Redact
alwaysNever record API keys, tokens, hidden prompts, or full sensitive memory text.