Skip to content

cayu.tools.web_access

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

WebAccessCircuitPolicy

Section titled “WebAccessCircuitPolicy”
from cayu.tools import WebAccessCircuitPolicy

Decorators: @dataclass(frozen=True, slots=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
threshold int 3
open_seconds int 300
max_entries int 64

Release source · Runtime guarantees · Capability guides

WebAccessEvidence

Section titled “WebAccessEvidence”
from cayu.tools import WebAccessEvidence

Content-free, bounded evidence for one classified access barrier.

Bases: BaseModel.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
schema_version Literal[1] 1
outcome WebAccessOutcome required
source WebAccessEvidenceSource required
signal WebAccessSignal required
destination_fingerprint str Field(min_length=64, max_length=64)
status_code StrictInt | None Field(default=None, ge=100, le=599)
retry_after_seconds StrictInt | None Field(default=None, ge=0, le=MAX_WEB_ACCESS_RETRY_AFTER_SECONDS)
retry_after_unrepresentable StrictBool False

validate_evidence (method)

Section titled “validate_evidence (method)”
WebAccessEvidence.validate_evidence() -> WebAccessEvidence

Release source · Runtime guarantees · Capability guides

WebAccessEvidenceSource

Section titled “WebAccessEvidenceSource”
from cayu.tools import WebAccessEvidenceSource

Bases: StrEnum.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
HTTP_RESPONSE class attribute 'http_response'
BROWSER_RESPONSE class attribute 'browser_response'
EGRESS_POLICY class attribute 'egress_policy'
HOSTED_PROVIDER class attribute 'hosted_provider'
TRANSPORT class attribute 'transport'

Release source · Runtime guarantees · Capability guides

WebAccessOutcome

Section titled “WebAccessOutcome”
from cayu.tools import WebAccessOutcome

Stable access barriers derived from trusted transport observations.

Bases: StrEnum.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
AUTHENTICATION_REQUIRED class attribute 'authentication_required'
CONSENT_REQUIRED class attribute 'consent_required'
RATE_LIMITED class attribute 'rate_limited'
BOT_CHALLENGE class attribute 'bot_challenge'
DESTINATION_DENIED class attribute 'destination_denied'
CONTENT_UNAVAILABLE class attribute 'content_unavailable'
TRANSIENT_TRANSPORT_FAILURE class attribute 'transient_transport_failure'

Release source · Runtime guarantees · Capability guides

WebAccessRouteAction

Section titled “WebAccessRouteAction”
from cayu.tools import WebAccessRouteAction

One application-owned action for one classified route outcome.

Decorators: @dataclass(frozen=True, slots=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
kind WebAccessRouteActionKind required
target_route_id str | None None
wait_seconds int | None None
guidance str | None None

fallback_to (method)

Section titled “fallback_to (method)”
WebAccessRouteAction.fallback_to(route_id: str) -> WebAccessRouteAction

wait (method)

Section titled “wait (method)”
WebAccessRouteAction.wait(seconds: int, *, guidance: str | None=None) -> WebAccessRouteAction

operator_action (method)

Section titled “operator_action (method)”
WebAccessRouteAction.operator_action(guidance: str) -> WebAccessRouteAction

stop (method)

Section titled “stop (method)”
WebAccessRouteAction.stop(*, guidance: str | None=None) -> WebAccessRouteAction

Release source · Runtime guarantees · Capability guides

WebAccessRouteActionKind

Section titled “WebAccessRouteActionKind”
from cayu.tools import WebAccessRouteActionKind

Bases: StrEnum.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
FALLBACK class attribute 'fallback'
WAIT class attribute 'wait'
OPERATOR_ACTION class attribute 'operator_action'
STOP class attribute 'stop'

Release source · Runtime guarantees · Capability guides

WebAccessRoutePolicy

Section titled “WebAccessRoutePolicy”
from cayu.tools import WebAccessRoutePolicy

Decorators: @dataclass(frozen=True, slots=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
entry_route_id str required
rules tuple[WebAccessRouteRule, ...] ()
circuit WebAccessCircuitPolicy WebAccessCircuitPolicy()

Release source · Runtime guarantees · Capability guides

WebAccessRouteRule

Section titled “WebAccessRouteRule”
from cayu.tools import WebAccessRouteRule

Decorators: @dataclass(frozen=True, slots=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
route_id str required
outcome WebAccessOutcome required
action WebAccessRouteAction required

Release source · Runtime guarantees · Capability guides

WebAccessRoutingTool

Section titled “WebAccessRoutingTool”
from cayu.tools import WebAccessRoutingTool

Execute only the finite application-owned WebBridge route graph.

Bases: Tool.

init (method)

Section titled “init (method)”
WebAccessRoutingTool.__init__(*, routes: Sequence[WebBridgeRoute], policy: WebAccessRoutePolicy) -> None

name (property)

Section titled “name (property)”
WebAccessRoutingTool.name() -> str

execution_profile_identity (property)

Section titled “execution_profile_identity (property)”
WebAccessRoutingTool.execution_profile_identity() -> ExecutionProfileBehaviorIdentity | None

Return the stable behavior declaration frozen with this tool’s spec.

retain_arguments_for_model (property)

Section titled “retain_arguments_for_model (property)”
WebAccessRoutingTool.retain_arguments_for_model() -> bool

Retain bounded redacted original inputs privately for the same profile.

Independent of audit publication; oversized and compacted-away inputs may be omitted. This does not grant knowledge read or activation rights.

description (property)

Section titled “description (property)”
WebAccessRoutingTool.description() -> str

schema (property)

Section titled “schema (property)”
WebAccessRoutingTool.schema() -> dict[str, Any]

run (method)

Section titled “run (method)”
async WebAccessRoutingTool.run(ctx: ToolContext, args: dict[str, Any]) -> ToolResult

Release source · Runtime guarantees · Capability guides

WebAccessSignal

Section titled “WebAccessSignal”
from cayu.tools import WebAccessSignal

Bases: StrEnum.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
STATUS_CODE class attribute 'status_code'
WWW_AUTHENTICATE class attribute 'www_authenticate'
RETRY_AFTER class attribute 'retry_after'
CHALLENGE_HEADER class attribute 'challenge_header'
CONSENT_HEADER class attribute 'consent_header'
EGRESS_DENIAL class attribute 'egress_denial'
TRANSPORT_ERROR class attribute 'transport_error'
PROVIDER_STATUS class attribute 'provider_status'

Release source · Runtime guarantees · Capability guides

WebBridgeRoute

Section titled “WebBridgeRoute”
from cayu.tools import WebBridgeRoute

One explicitly named already-validated WebBridge fetch route.

Decorators: @dataclass(frozen=True, slots=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
route_id str required
bridge WebBridge required

Release source · Runtime guarantees · Capability guides