initialize

await sdk.initialize()

Performs the one-time setup that must run before any other SDK call. initialize() resolves the Synap API key (from the api_key= constructor kwarg first, then the SYNAP_API_KEY environment variable), establishes the authenticated client identity, sets up the optional local cache, and starts the telemetry collector. Calling it a second time on the same SDK instance is a safe no-op.

Parameters

This method takes no parameters.

Returns

Returns None.

Example

import os
from maximem_synap import MaximemSynapSDK

sdk = MaximemSynapSDK(api_key=os.environ["SYNAP_API_KEY"])
await sdk.initialize()

# SDK is now ready for context operations.
ctx = await sdk.fetch(user_id="user-456")

Raises

AuthenticationError: when no API key is supplied (neither api_key= nor SYNAP_API_KEY), the key is rejected by the platform, or credential loading otherwise fails.

See Error Codes for the full SDK exception hierarchy.

Introduction

Lifecycle

Memory ingestion

Memory management

Conversation

Conversation context

Scoped context

User profile

Real-time streaming

Cache management

Credits & billing

Reference

Limits & Pricing

Parameters

Returns

Example

Raises

See also

​Parameters

​Returns

​Example

​Raises

​See also

Parameters

Returns

Example

Raises

See also