Skip to main content

Console service

client.console exposes access-request decisions, private operations and notifications, and a platform resource-count snapshot. The method docstrings describe the individual operations and their authorization requirements.

Access requests and decisions​

MethodResult and meaning
request_access(payload: AccessRequestCreate)Returns OperationAccepted; records a request and notifies current grantors.
resolve_access_request(access_request_id, payload: AccessRequestResolve)Returns OperationAccepted; records the current grantor's approval or denial.

AccessRequestCreate requires resource_kind (dataset, model, or workroom), resource_id, and an idempotency_key. Optional capability and reason describe the requested access. Core owns deduplication and idempotency; reuse the key only for replaying the same intended request. AccessRequestResolve accepts decision="approved" or "denied".

The accepted result's id is an operation ID, not an access-request ID. Use it with get_operation. To resolve the request, use the request ID in its access_request resource reference; older Core versions expose this identifier only in grantor notifications. Do not pass an operation ID to resolve_access_request.

Approval records a decision and notifies the requester; it does not create an access grant. Resource permissions require the appropriate separate permission-management operation. Core verifies current grantor authority, accepts same-decision replay, and refuses conflicting decisions. The SDK propagates those authorization and conflict errors.

Private operations, notifications and tray​

MethodResult and meaning
get_operation(operation_id)ConsoleOperation owned by the caller.
list_operations(limit=100, include_dismissed=False)Caller-owned operations, newest first.
mark_operation_seen(operation_id)ConsoleStateChanged; marks seen without changing execution status.
dismiss_operation(operation_id)ConsoleStateChanged; hides a terminal operation and marks it seen.
list_notifications(limit=100, include_dismissed=False)Notifications addressed to the caller.
get_notification(notification_id)One caller-addressed ConsoleNotification.
mark_notification_seen(notification_id)ConsoleStateChanged; marks seen without resolving a request.
dismiss_notification(notification_id)ConsoleStateChanged; hides the notification and marks it seen.
get_tray()ConsoleTray with needs_attention, running, updates, and has_more.

Both list methods take keyword-only parameters. limit must be an integer from 1 through 200. These are bounded snapshots without cursor or offset pagination. Set include_dismissed=True to include dismissed history. Record-ID parameters accept UUID objects or UUID strings. Core enforces ownership/recipient isolation; SDK calls propagate refusals.

Seen and dismissed states affect presentation only: they do not cancel work, resolve access requests, grant permissions, or delete history. Core refuses dismissal of running or unresolved operations with HTTP 409. Agent-tool invocation requires approval for these writes and access-request decisions.

Core's tray currently selects at most eight records, prioritizing attention, then running, then updates. has_more describes additional eligible records within Core's bounded scan; use the feeds to inspect more history. It is not a count of every retained record. Response models preserve unknown fields and future status vocabulary.

Read configured-resource counts​

snapshot = client.console.get_platform_readiness()
print(snapshot.completeness)
for section in snapshot.sections:
print(section.key, section.count, section.status, section.error_code)

Any authenticated user can read this snapshot. Core reports compute, provider, model, data-source and deployed-app sections. Inspect each returned section.key rather than assuming a fixed key set. It marks a section ready when its count is positive and missing when zero; neither is a platform health verdict. For example, a disabled connector registration without a running workload still contributes to the connector count.

A failed count probe reports error, a nullable count and an error code; the snapshot then reports partial. The SDK preserves those server results, future fields and new vocabulary without retrying or inventing successful sections. A transport or authorization failure remains an SDK exception.

This call does not inspect service liveness, read logs, or establish telemetry delivery. Those require their own operational checks.