enterprise_ai.core.system

Source: sdks/python/src/enterprise_ai/_core/system.py. Back to the Python SDK reference index.

note

This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.

Class SystemClient

Platform level read endpoints (no tenant data).

Resource

SystemClient.brick

brick(brick_id: str) -> Any

Get one platform brick. One brick of the catalog, matched on its id without regard to case. Answers 404 not_found when no brick has this id. No authentication required.

Route: /v1/catalog/bricks/{brick_id} (GET).

Name	Type	Default	Required	Description
brick_id	str		yes	Identifier of the brick in the catalog, case insensitive.

Returns: Any. Decoded JSON answer of the operation "Get one platform brick".

Raises: the typed errors of the transport (Errors).

SystemClient.bricks

bricks() -> Any

List the platform bricks. Catalog of the platform bricks read from bricks.yaml of the catalog folder, in one page (next_cursor is always null). The file is loaded as safe YAML (no anchors or aliases, 2 MB at most). No authentication required.

Route: /v1/catalog/bricks (GET).

This element takes no parameter.

Returns: Any. Decoded JSON answer of the operation "List the platform bricks".

Raises: the typed errors of the transport (Errors).

SystemClient.healthz

healthz() -> Any

Check that the process is alive. Liveness probe: always answers 200 with status: ok and the version of the Control Plane while the process serves requests. It checks no dependency. No authentication, no rate limit.

Route: /healthz (GET).

This element takes no parameter.

Returns: Any. Decoded JSON answer of the operation "Check that the process is alive".

Raises: the typed errors of the transport (Errors).

SystemClient.meta

meta() -> Any

Describe the Control Plane instance. Name, version and API version of the instance, supported locales and default locale, loaded domains, and the features enabled by the configuration: OIDC, API key, SPIFFE and development authentication, OpenBao, OpenFGA, OPA and LiteLLM (true when their address is set). No authentication required.

Route: /v1/meta (GET).

This element takes no parameter.

Returns: Any. Decoded JSON answer of the operation "Describe the Control Plane instance".

Raises: the typed errors of the transport (Errors).

SystemClient.metrics

metrics() -> Any

GET /metrics: Prometheus text format (a coroutine on the async client).

This element takes no parameter.

Returns: Any. Metrics as Prometheus exposition text (str, empty when the body is empty).

SystemClient.operation

operation(operation_id: str) -> Any

Follow a long operation. The operation (kind, state pending or accepted, method, path, HTTP status, idempotency key, tracked resource, creator and dates), its accepted answer and the live state of the tracked resource. The resource is read with the caller's credentials through the resource route, so the resource authorization applies: when that read fails, result stays null and result_error.http_status gives the status. status is pending while the request runs, then the status or state of the resource. Requires a tenant principal (403 tenant_required); an operation created by someone else answers 404 not_found unless the caller holds tenant_admin, platform_admin, auditor or security_officer.

Route: /v1/operations/{operation_id} (GET).

Name	Type	Default	Required	Description
operation_id	str		yes	Identifier of the operation, as returned in the Operation-Id header.

Returns: Any. Decoded JSON answer of the operation "Follow a long operation".

Raises: the typed errors of the transport (Errors).

SystemClient.readyz

readyz() -> Any

Check that the instance is ready. Readiness probe: checks that the database answers and that the schema migrations were applied. Answers 200 ready when every check passes, else 503 not_ready, with the result of each check and a message in the language of the request. The Redis cache state is reported but never makes the instance not ready. No authentication, no rate limit.

Route: /readyz (GET).

This element takes no parameter.

Returns: Any. Decoded JSON answer of the operation "Check that the instance is ready".

Raises: the typed errors of the transport (Errors).

SystemClient.roadmap

roadmap() -> Any

Read the product roadmap. Roadmap read from roadmap.yaml of the catalog folder, always with a phases list (empty when the file is missing). Loaded as safe YAML. No authentication required.

Route: /v1/roadmap (GET).

This element takes no parameter.

Returns: Any. Decoded JSON answer of the operation "Read the product roadmap".

Raises: the typed errors of the transport (Errors).