> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maximem.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Maximem Synap is a managed memory layer for AI agents: it ingests conversations and documents, extracts structured memory, and returns scoped context to the agent at retrieval time.
> The Python and JavaScript/TypeScript SDKs are the supported way to use Synap. Write integration code with SDK calls, not raw HTTP requests.
> Start with the Quickstart: https://docs.maximem.ai/getting-started/quickstart.md. Every SDK method is documented in the SDK reference: https://docs.maximem.ai/sdk-reference/overview.md.

# Instances

> How Synap instances separate memory designs, environments, keys, and readiness.

An instance is one memory design for one agent or use case, together with its API keys, people, and memories. Create separate instances for staging and production. Agents that serve the same users and do the same job can share an instance; otherwise, use separate instances.

The use-case file defines the instance's memory architecture. You cannot swap that design between unrelated use cases by reusing an instance.

## Status and readiness

The Dashboard and CLI show these lifecycle statuses:

| Status | Meaning |
| - | - |
| `initializing` | The instance is being provisioned. The stored service state is `provisioning`. |
| `active` | The instance exists and can be managed. It may still be building its memory architecture. |
| `inactive` | The instance is not serving runtime traffic. |
| `suspended` | Synap has suspended the instance. |
| `deleting` | Deletion is in progress. |

Status is not readiness. A newly active instance can still be building its memory architecture. Wait until its build is ready before runtime reads or writes:

```bash theme={null}
maximem-synap instances wait <instance-id>
```

The default wait is 20 minutes. It exits 0 when ready, 7 on timeout, and 1 if the build fails. Builds usually take 15 to 20 minutes; Synap retries a failed attempt up to three times. After a final failure, you can run `instances rebuild <instance-id>` from the stored use case. Rebuilds are limited to three per instance in 24 hours and only work after a failure.

## CLI list columns

`maximem-synap instances list` includes:

* **AGENT**: the `agent_type` selected at creation: `external_facing`, `intra_org`, or `special_purpose`. Choose it according to who uses the agent.
* **CONFIG**: the state of the memory architecture configuration.
* **BUILD**: whether that configuration is still being built, ready, or failed.

Use `--json` when another program needs the full status and identifiers.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.