GoodMemSystem
Server info and initialization.
Methods on this page are called through client.system.
client.system.info
client.system.info(requestOptions?: RequestOptions): Promise<SystemInfoResponseShape>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.
HTTP: GET /v1/system/info
Parameters
| Parameter | Type | Description |
|---|---|---|
requestOptions | RequestOptions optional | Per-call signal, timeout, or headers. |
Returns: Promise<SystemInfoResponseShape>
Example
const info = await client.system.info();
console.log(info.version);client.system.init
client.system.init(requestOptions?: RequestOptions): Promise<SystemInitResponseShape>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.
HTTP: POST /v1/system/init
Parameters
| Parameter | Type | Description |
|---|---|---|
requestOptions | RequestOptions optional | Per-call signal, timeout, or headers. |
Returns: Promise<SystemInitResponseShape>
Example
const init = await client.system.init();
console.log(init.rootApiKey);Data Models
Interfaces
SystemInfoResponse
| Field | Type | Required | Description |
|---|---|---|---|
version | string | yes | Semantic version string advertised by the running server. |
major | number | yes | Major version component parsed from the advertised semantic version. |
minor | number | yes | Minor version component parsed from the advertised semantic version. |
patch | number | yes | Patch version component parsed from the advertised semantic version. |
dirty | boolean | yes | Whether the running build reports uncommitted workspace changes. |
gitCommit | string | no | Git commit SHA baked into the build, when available. |
gitDescribe | string | no | Git describe output baked into the build, when available. |
buildTime | string | no | Build timestamp recorded for this server binary, when available. |
capabilities | Record<string, string> | no | Optional capability flags or metadata advertised by the running server. |
SystemInitResponse
Response from the system initialization endpoint.
| Field | Type | Required | Description |
|---|---|---|---|
alreadyInitialized | boolean | yes | Indicates whether the system was already initialized before this request. |
message | string | yes | A human-readable message about the initialization status. |
rootApiKey | string | null | no | The API key for the root user. Only present if system was just initialized (not previously initialized). |
userId | string | null | no | The user ID of the root user. Only present if system was just initialized (not previously initialized). |
Response Shapes
Response shape types model values returned by the SDK after forward-compatible unknown enum strings are coerced to null.
SystemInfoResponseShape
| Field | Type | Required | Description |
|---|---|---|---|
version | string | yes | Semantic version string advertised by the running server. |
major | number | yes | Major version component parsed from the advertised semantic version. |
minor | number | yes | Minor version component parsed from the advertised semantic version. |
patch | number | yes | Patch version component parsed from the advertised semantic version. |
dirty | boolean | yes | Whether the running build reports uncommitted workspace changes. |
gitCommit | string | no | Git commit SHA baked into the build, when available. |
gitDescribe | string | no | Git describe output baked into the build, when available. |
buildTime | string | no | Build timestamp recorded for this server binary, when available. |
capabilities | Record<string, string> | no | Optional capability flags or metadata advertised by the running server. |
SystemInitResponseShape
| Field | Type | Required | Description |
|---|---|---|---|
alreadyInitialized | boolean | yes | Indicates whether the system was already initialized before this request. |
message | string | yes | A human-readable message about the initialization status. |
rootApiKey | string | null | no | The API key for the root user. Only present if system was just initialized (not previously initialized). |
userId | string | null | no | The user ID of the root user. Only present if system was just initialized (not previously initialized). |