Instance

Methods on this page are called as client.instance.<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_...')

Get the GoodMem instance

instance.get() → GoodMemInstance

Returns singleton instance identity, ownership, and audit metadata after requiring effective READ_INSTANCE authority. The built-in ADMIN role supplies this authority; instance ownership alone does not. A scoped API key must also retain READ_INSTANCE in its immutable ceiling. This operation does not expose credentials or mutate instance state.

Returns:

Raises:

• APIError — Any other non-2xx HTTP response (base class; exposes status_code and body).

Example

instance = client.instance.get()
print(instance.instance_id, instance.owner_id)

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