System

Methods on this page are called as client.system.<method>(...) where client is either a synchronous Goodmem or asynchronous AsyncGoodmem instance initialized below:

from goodmem import Goodmem
client = Goodmem(base_url='http://localhost:8080', api_key='gm_...')

from goodmem import AsyncGoodmem
client = AsyncGoodmem(base_url='http://localhost:8080', api_key='gm_...')

Retrieve server build metadata

Returns the server's advertised semantic version, git metadata, build timestamp, and optional capability flags. The endpoint is intentionally unauthenticated so bootstrap tooling can call it before API keys exist.

info = client.system.info()
print(info.version)

Initialize the system

Initializes the system by creating a root user and API key. This endpoint should only be called once during first-time setup. If the system is already initialized, the endpoint will return a success response without creating new credentials.

result = client.system.init()
print(f"Already initialized: {result.already_initialized}")

Async usage: client.system exposes the same methods on AsyncGoodmem; use await / async for as needed.

Data Models

All data models are pydantic v2 models. Fields are shown with their Python attribute names; JSON responses use camelCase aliases (e.g., owner_id → ownerId).

SystemInfoResponse

SystemInfoResponse

• version (str) — Semantic version string advertised by the running server.
• major (int) — Major version component parsed from the advertised semantic version.
• minor (int) — Minor version component parsed from the advertised semantic version.
• patch (int) — Patch version component parsed from the advertised semantic version.
• dirty (bool) — Whether the running build reports uncommitted workspace changes.
• git_commit (str, optional) — Git commit SHA baked into the build, when available.
• git_describe (str, optional) — Git describe output baked into the build, when available.
• build_time (str, optional) — Build timestamp recorded for this server binary, when available.
• capabilities (dict[str, str], optional) — Optional capability flags or metadata advertised by the running server.

SystemInitResponse

Response from the system initialization endpoint.

• already_initialized (bool) — Indicates whether the system was already initialized before this request.
• message (str) — A human-readable message about the initialization status.
• root_api_key (str, optional) — The API key for the root user. Only present if system was just initialized (not previously initialized).
• user_id (str, optional) — The user ID of the root user. Only present if system was just initialized (not previously initialized).