Skip to content

cayu.sessions.Session

Part of cayu.sessions.base. Read the Python API overview and install the required extra.

from cayu.sessions import Session

Bases: BaseModel.

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
id str Field(default_factory=lambda: str(uuid4()))
instance_id str Field(default_factory=lambda: str(uuid4()), frozen=True)
agent_name str required
provider_name str required
model str required
parent_session_id str | None None
causal_budget_id str required
runtime_name str 'cayu'
runtime_version str | None None
environment_name str | None None
status SessionStatus SessionStatus.PENDING
created_at datetime Field(default_factory=lambda: datetime.now(UTC))
updated_at datetime Field(default_factory=lambda: datetime.now(UTC))
last_activity_at datetime Field(default_factory=lambda: datetime.now(UTC))
run_epoch StrictInt Field(default=0, ge=0, le=MAX_DURABLE_JSON_INTEGER)
invocation SessionInvocation Field(frozen=True)
labels dict[str, str] Field(default_factory=dict)
metadata dict[str, Any] Field(default_factory=dict)
Session.execution_deadline() -> ExecutionDeadline
Session.default_causal_budget_id(value: Any) -> Any
Session.copy_metadata(value: dict[str, Any]) -> dict[str, Any]
Session.copy_labels(value) -> dict[str, str]
Session.validate_nonblank_fields(value: str, info) -> str
Session.validate_id(value: str, info) -> str
Session.validate_instance_id(value: str) -> str

validate_optional_nonblank_fields (method)

Section titled “validate_optional_nonblank_fields (method)”
Session.validate_optional_nonblank_fields(value: str | None, info) -> str | None

validate_profile_build_provenance (method)

Section titled “validate_profile_build_provenance (method)”
Session.validate_profile_build_provenance() -> Session
Session.tool_capability_ceiling() -> ToolCapabilityCeiling

Return the session’s required durable application-tool authority.

Session.runtime_build_provenance() -> RuntimeBuildProvenance

Load exact build provenance without attributing legacy work to this process.

Session.runtime_build_fingerprint() -> str | None
Session.runtime_source_revision() -> str | None

Release source · Runtime guarantees · Capability guides