Key sections
Managing Instances
Create, configure, and monitor your Synap instances. Create and manage API keys for SDK authentication and manage instance lifecycle states.
Memory Configuration
Configure how each instance stores, ingests, and retrieves memory using YAML-based Memory Architecture Configuration (MACA) with version control and approval workflows.
Roles and permissions
Access to dashboard features is governed by three roles. Each member of your client organization is assigned exactly one role.| Capability | Owner | Admin | Member |
|---|---|---|---|
| View instances | Yes | Yes | Yes |
| Create/edit instances | Yes | Yes | No |
| Generate API keys | Yes | Yes | No |
| Configure memory architecture | Yes | Yes | No |
| View analytics | Planned | Planned | Planned |
| Manage team | Planned | Planned | Planned |
| Manage webhooks | Planned | Planned | Planned |
- Owner has full control over currently available dashboard capabilities, including instance lifecycle and memory configuration.
- Admin can create and manage instances and memory architecture configuration.
- Member has read-only access to currently available dashboard resources.
Getting started
Sign up or get invited
Visit synap.maximem.ai to create an account, or accept an invitation from your organization’s Owner. Authentication is handled through Auth0 with support for email/password and SSO.
Access your client organization
Once signed in, you will see the instances associated with your client organization. If you are the Owner, you can begin creating instances immediately. If you were invited, your access level depends on the role assigned to you.
Create or view your instances
Owners and Admins can create new instances from the Instances page. Members can view existing instances and their configurations. Each instance represents an isolated memory environment for a specific agent or use case.
The dashboard is for management and monitoring. For integrating memory into your application, use the Synap SDK. The SDK provides the programmatic interface for ingesting memories, retrieving context, and managing the memory lifecycle from your application code.
Dashboard vs. SDK
It is important to understand the boundary between the dashboard and the SDK:| Concern | Dashboard | SDK |
|---|---|---|
| Creating instances | Yes | No |
| Configuring memory architecture | Yes | No |
| Generating API keys | Yes | No |
| Ingesting memories | No | Yes |
| Retrieving context | No | Yes |
| Streaming (gRPC) | No | Yes |
| Monitoring metrics | Yes | Read-only via API |
| Managing team | Yes | No |
Next steps
Create Your First Instance
Walk through creating an instance and generating an API key.
Configure Memory
Set up storage, ingestion, and retrieval behavior for your instance.
First Integration Guide
End-to-end guide connecting your application to Synap using the SDK and a dashboard-provisioned instance.
Production Checklist
Review everything you need before going live.