Mpalo API documentation
The API provides a versioned contract for persistent memory operations. The current runtime implements deterministic text persistence, lexical retrieval, stored-text context, usage, and operational paths. Learned Palo Bloom capabilities remain in development, and the capability registry identifies what each route can do.
What is available today
The hosted v1 customer path currently runs a deterministic text-memory runtime. It accepts text, persists submitted text when the required storage and consent conditions are met, retrieves related records with tenant-scoped lexical ranking, renders selected stored text as context, and exposes request, usage, billing, export, deletion, health, and anomaly surfaces.
Inspectable runtime
See provider, execution mode, capability status, verification state, and operational history.
Versioned API
Use the same request and response contract from HTTP, the SDK, or the Palo CLI.
Clear boundaries
Separate control-plane configuration, memory operations, observability, and research direction.
Data and model boundary
The current hosted environment uses a deterministic reference implementation for testing the API path. It does not execute a learned Palo Bloom model, create customer-facing embeddings, perform semantic vector search, train a shared model, or perform aggregate learning. It substitutes only model-dependent computation. Its request, storage, usage, charge, and operational records still use the backend path and report their billing environment explicitly.
What a current memory request means
A write may store the submitted text in the managed reference path after authentication, storage attachment, consent, and policy checks. A recall ranks stored records lexically and may return selected stored text as context. The response identifies the provider, execution mode, model version, capability status, retention state, and usage state. The backend receipt also identifies model-only substitution separately from storage, metering, billing, and observability. An unspecified model variant means that no model was invoked for that operation, such as deletion or an explicit offline fixture.
See Infrastructure for the current capability matrix and Mpalo's trust materials for policy and legal terms. Claims about encryption, retention, ownership, provider execution, or universal erasure must be read from the applicable policy and contract, not inferred from this preview.
Start with a real contract
The quickest route is to read the current state, install an interface, authenticate, attach an active storage connection, and run the reference example with its provenance and usage receipt visible.
Capability status
A route can exist before the intended learned capability behind it is deployed. The documentation uses explicit statuses so a contract fixture is never presented as Palo Bloom execution.
| Area | Current status | Meaning |
|---|---|---|
| Text persistence | available_mock | Current managed reference behavior, subject to storage and consent checks. |
| Lexical retrieval | available_mock | Deterministic tenant-scoped ranking over retained text. |
| Embeddings and vector search | not_deployed | No customer-facing vector index is attached to the current path. |
| Traversal and mapping | contract_stage | Response and attribution shapes exist for testing, not learned behavior. |
| BYO storage execution | control_plane_only | Connections can be configured, but v1 memory requests do not dispatch to them. |
| Palo Bloom execution | not_deployed | The model adapter is in development and is not used by the hosted customer path. |
Developer hub
Follow the path that matches your work. The public pages stay focused on current behavior and documented contracts. The unresolved infrastructure roadmap remains an internal engineering record.
Production integration
Plan authentication, idempotency, deletion, error handling, and environment separation.
Agents and automation
Keep machine output stable, preserve provenance, and avoid scraping terminal presentation.
Errors and retries
Use error envelopes, request IDs, retryable flags, and idempotency keys correctly.
System status
Check public service availability separately from tenant-scoped infrastructure telemetry.
Was this page helpful?
Your feedback helps us improve our documentation.