Dashboard Overview

The Synap Dashboard is a web-based management interface for your Synap deployment. From a single interface at synap.maximem.ai, you can create and manage instances and configure memory architecture.

Key sections

Managing Instances

Create instances, upload use-case files, generate API keys, and monitor instance lifecycle states.

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
Upload / update use-case files	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 use-case uploads.
• Admin can create and manage instances and update use-case files.
• Member has read-only access to currently available dashboard resources.

Getting started

1. 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.

2. 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.

3. 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.

4. Configure and deploy

   Initialize the Memory Architecture Configuration for each instance, generate an API key, and use it to connect your application via the Synap SDK.

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

The dashboard manages the control plane (what exists and how it is configured), while the SDK operates the data plane (what goes in and comes out of memory).

Next steps

Create Your First Instance

Walk through creating an instance and generating an API key.

Writing a Use-Case Markdown File

The use-case file is how Synap configures memory 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.