MODULE REFERENCE

client

anomx.integrations.platform.client

Authenticated JSON transport without dataset, run, or workspace operations.

PlatformClient

PlatformClient(url: str, token: str, timeout: float = 30.0, health_path: str = '/system/health')

An authenticated API connection, independent of any resource class.

A site origin such as https://host becomes https://host/api. Explicit API prefixes (including /api/v1 and reverse-proxy paths) are preserved. Paths passed to HTTP methods are relative to that API prefix, starting with /. Responses are decoded JSON; empty responses are None.

Credentials come only from arguments or from_env(). Requests have a bounded timeout, are never retried, and do not follow redirects.

Signature parameters
Parameter	Type	Default
`url`	`str`	`required`
`token`	`str`	`required`
`timeout`	`float`	`30.0`
`health_path`	`str`	`'/system/health'`

Members

urlattribute

# PlatformClient.url Source ↗

url: str

tokenattribute

# PlatformClient.token Source ↗

token: str = field(repr=False)

timeoutattribute

# PlatformClient.timeout Source ↗

timeout: float = 30.0

health_pathattribute

# PlatformClient.health_path Source ↗

health_path: str = '/system/health'

from_envclassmethod

# PlatformClient.from_env Source ↗

from_env() -> PlatformClient

Read ANOMX_URL and ANOMX_TOKEN for a standalone connection.

Returns PlatformClient

requestmethod

# PlatformClient.request Source ↗

request(path: str, payload: JSONValue = None, *, method: str = 'POST', params: QueryParams | None = None) -> JSONValue

Send a JSON request and decode JSON of any shape, or an empty response.

params URL-encodes query values and repeats keys for list values. HTTP errors expose status_code, method, and url. Error messages omit query values, credentials, and response bodies.

Signature parameters
Parameter	Type	Default
`path`	`str`	`required`
`payload`	`JSONValue`	`None`
`method`keyword only	`str`	`'POST'`
`params`keyword only	`QueryParams \| None`	`None`

Returns JSONValue

getmethod

# PlatformClient.get Source ↗

get(path: str, *, params: QueryParams | None = None) -> JSONValue

Read a resource, optionally passing query parameters.

Signature parameters
Parameter	Type	Default
`path`	`str`	`required`
`params`keyword only	`QueryParams \| None`	`None`

Returns JSONValue

postmethod

# PlatformClient.post Source ↗

post(path: str, payload: JSONValue = None, *, params: QueryParams | None = None) -> JSONValue

Submit JSON to a resource.

Signature parameters
Parameter	Type	Default
`path`	`str`	`required`
`payload`	`JSONValue`	`None`
`params`keyword only	`QueryParams \| None`	`None`

Returns JSONValue

putmethod

# PlatformClient.put Source ↗

put(path: str, payload: JSONValue = None, *, params: QueryParams | None = None) -> JSONValue

Replace a resource with JSON.

Signature parameters
Parameter	Type	Default
`path`	`str`	`required`
`payload`	`JSONValue`	`None`
`params`keyword only	`QueryParams \| None`	`None`

Returns JSONValue

patchmethod

# PlatformClient.patch Source ↗

patch(path: str, payload: JSONValue = None, *, params: QueryParams | None = None) -> JSONValue

Partially update a resource with JSON.

Signature parameters
Parameter	Type	Default
`path`	`str`	`required`
`payload`	`JSONValue`	`None`
`params`keyword only	`QueryParams \| None`	`None`

Returns JSONValue

deletemethod

# PlatformClient.delete Source ↗

delete(path: str, *, params: QueryParams | None = None) -> JSONValue

Delete a resource; an empty success response returns None.

Signature parameters
Parameter	Type	Default
`path`	`str`	`required`
`params`keyword only	`QueryParams \| None`	`None`

Returns JSONValue

headmethod

# PlatformClient.head Source ↗

head(path: str, *, params: QueryParams | None = None) -> None

Check a resource's HTTP status without decoding a body.

Signature parameters
Parameter	Type	Default
`path`	`str`	`required`
`params`keyword only	`QueryParams \| None`	`None`

Returns None

is_alivemethod

# PlatformClient.is_alive Source ↗

is_alive() -> bool

Check the configured health resource for status: ok.

Return False for HTTP, connection, timeout, or invalid-response errors. This checks API liveness, not access to a particular dataset or resource.

Returns bool

classView source ↗

PlatformError

PlatformError(message: str, *, status_code: int | None = None, method: str | None = None, url: str | None = None)

Bases: RuntimeError

A failed API request, with HTTP status and request location when available.

Signature parameters
Parameter	Type	Default
`message`	`str`	`required`
`status_code`keyword only	`int \| None`	`None`
`method`keyword only	`str \| None`	`None`
`url`keyword only	`str \| None`	`None`

classView source ↗

PlatformTimeoutError

PlatformTimeoutError(message: str, *, status_code: int | None = None, method: str | None = None, url: str | None = None)

Bases: PlatformError

The request exceeded the configured socket timeout.

Signature parameters
Parameter	Type	Default
`message`	`str`	`required`
`status_code`keyword only	`int \| None`	`None`
`method`keyword only	`str \| None`	`None`
`url`keyword only	`str \| None`	`None`