cayu.runtime.manifest

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.

`AgentManifest`

from cayu.runtime import AgentManifest

Bases: _ManifestModel.

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
`name`	`str`	`required`
`model`	`str`	`required`
`has_system_prompt`	`bool`	`required`
`configured_provider`	`str \| None`	`required`
`resolved_provider`	`str \| None`	`required`
`provider_resolution`	`Literal['explicit', 'model_pattern', 'default', 'missing', 'ambiguous']`	`required`
`provider_candidates`	`tuple[str, ...]`	`()`
`workflow_tool_names`	`tuple[str, ...]`	`()`
`authoring_state`	`AgentAuthoringState \| None`	`None`
`execution_requirements`	`ExecutionRequirements`	`required`
`tools`	`tuple[ToolManifest, ...]`	`()`
`hosted_tools`	`tuple[HostedToolManifest, ...]`	`()`
`targeted_tool_mode`	`Literal['call_tool', 'openai_additional_tools', 'openai_additional_tools_or_call_tool'] \| None`	`None`
`tool_policy`	`str`	`required`
`context_policy`	`str`	`required`
`context_overflow_policy`	`str \| None`	`required`
`runtime_hooks`	`tuple[str, ...]`	`()`
`loop_policies`	`tuple[str, ...]`	`()`
`registration_provenance`	`RegistrationProvenance`	`required`
`implementation_provenance`	`RegistrationProvenance`	`required`

Release source · Runtime guarantees · Capability guides

`APP_MANIFEST_SCHEMA_VERSION`

from cayu.runtime import APP_MANIFEST_SCHEMA_VERSION

APP_MANIFEST_SCHEMA_VERSION = '17'

Release source · Runtime guarantees · Capability guides

`ApplicationDefaultsManifest`

from cayu.runtime import ApplicationDefaultsManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`provider`	`str \| None`	`required`
`environment`	`str \| None`	`required`

Release source · Runtime guarantees · Capability guides

`AppManifest`

from cayu import AppManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal['17']`	`APP_MANIFEST_SCHEMA_VERSION`
`fingerprint`	`str`	`required`
`agents`	`tuple[AgentManifest, ...]`	`required`
`providers`	`tuple[ProviderManifest, ...]`	`required`
`environments`	`tuple[EnvironmentManifest, ...]`	`required`
`stores`	`StoreManifest`	`required`
`defaults`	`ApplicationDefaultsManifest`	`required`
`runtime`	`RuntimeManifest`	`required`
`capabilities`	`tuple[CapabilityManifest, ...]`	`required`

Release source · Runtime guarantees · Capability guides

`CapabilityManifest`

from cayu.runtime import CapabilityManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`name`	`str`	`required`
`declared`	`bool`	`required`
`resolved`	`bool`	`required`
`process_available`	`Literal['not_checked']`	`'not_checked'`
`live_verified`	`Literal['not_run']`	`'not_run'`

Release source · Runtime guarantees · Capability guides

`ConfigurationFieldProvenanceManifest`

from cayu.runtime import ConfigurationFieldProvenanceManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`path`	`str`	`required`
`owner`	`str`	`required`
`source`	`CayuConfigSource`	`required`

Release source · Runtime guarantees · Capability guides

`EnvironmentManifest`

from cayu.runtime import EnvironmentManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`name`	`str`	`required`
`is_default`	`bool`	`required`
`factory_backed`	`bool`	`required`
`workspace`	`str \| None`	`required`
`workspace_branch_capabilities`	`FrozenJsonObject`	`required`
`workspace_branch_lifecycle`	`FrozenJsonObject`	`required`
`runner`	`str \| None`	`required`
`artifact_store`	`str \| None`	`required`
`vault`	`str \| None`	`required`
`credential_proxy`	`str \| None`	`required`
`binding`	`str \| None`	`required`
`knowledge_store`	`str \| None`	`required`
`mcp_servers`	`tuple[str, ...]`	`required`
`workspace_checkpoint_policy`	`FrozenJsonObject \| None`	`None`
`lifecycle_policy`	`FrozenJsonObject \| None`	`required`
`registration_provenance`	`RegistrationProvenance`	`required`
`implementation_provenance`	`RegistrationProvenance`	`required`
`deferred`	`bool`	`False`

Release source · Runtime guarantees · Capability guides

`HostedToolManifest`

from cayu.runtime import HostedToolManifest

Typed provider-hosted authority declared by one agent registration.

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`type`	`Literal['openai_web_search']`	`required`
`search_context_size`	`Literal['low', 'medium', 'high']`	`required`
`external_web_access`	`bool`	`required`
`allowed_domains`	`tuple[str, ...]`	`required`
`blocked_domains`	`tuple[str, ...]`	`required`
`return_token_budget`	`Literal['default', 'unlimited']`	`required`
`include_sources`	`bool`	`required`

Release source · Runtime guarantees · Capability guides

`NamedCheckManifest`

from cayu.runtime import NamedCheckManifest

Bounded non-secret descriptor for one application-owned check.

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`name`	`str`	`required`
`description`	`str`	`required`
`timeout_s`	`int`	`Field(gt=0)`
`max_output_bytes`	`int`	`Field(gt=0)`
`required_executables`	`tuple[str, ...]`	`required`
`profile_fingerprint`	`str`	`Field(pattern='^sha256:[0-9a-f]{64}$')`

validate_bounded_text (method)

NamedCheckManifest.validate_bounded_text(value: str, info) -> str

validate_required_executables (method)

NamedCheckManifest.validate_required_executables(value: tuple[str, ...]) -> tuple[str, ...]

Release source · Runtime guarantees · Capability guides

`ProviderManifest`

from cayu.runtime import ProviderManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`name`	`str`	`required`
`model_patterns`	`tuple[str, ...]`	`required`
`is_default`	`bool`	`required`
`implementation`	`str`	`required`
`usage_dialect`	`str`	`required`
`supports_native_structured_output`	`bool`	`required`
`registration_provenance`	`RegistrationProvenance`	`required`
`implementation_provenance`	`RegistrationProvenance`	`required`

Release source · Runtime guarantees · Capability guides

`RecoveryCleanupPolicyManifest`

from cayu import RecoveryCleanupPolicyManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`step_timeout_seconds`	`float`	`required`
`overall_timeout_seconds`	`float`	`required`
`max_supervised_tasks`	`int`	`required`

Release source · Runtime guarantees · Capability guides

`RegistrationProvenance`

from cayu.runtime import RegistrationProvenance

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`kind`	`Literal['project', 'built_in', 'external', 'dynamic', 'unavailable']`	`required`
`symbol`	`str`	`required`
`location`	`str \| None`	`None`

Release source · Runtime guarantees · Capability guides

`RequestFootprintConfigManifest`

from cayu.runtime import RequestFootprintConfigManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`enabled`	`bool`	`required`
`fingerprint_key_id`	`str \| None`	`required`
`fingerprinting_enabled`	`bool`	`required`
`footprint_schema_version`	`int`	`required`
`canonicalization_version`	`int`	`required`

Release source · Runtime guarantees · Capability guides

`RuntimeConfigurationManifest`

from cayu.runtime import RuntimeConfigurationManifest

Redacted values and ownership for supported application tunables.

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`values`	`FrozenJsonObject`	`required`
`provenance`	`tuple[ConfigurationFieldProvenanceManifest, ...]`	`required`

Release source · Runtime guarantees · Capability guides

`RuntimeManifest`

from cayu.runtime import RuntimeManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`configuration`	`RuntimeConfigurationManifest`	`required`
`dispatcher`	`str`	`required`
`retry_policy`	`str \| None`	`required`
`budget_policy`	`str \| None`	`required`
`runtime_hooks`	`tuple[str, ...]`	`required`
`loop_policies`	`tuple[str, ...]`	`required`
`event_sinks`	`tuple[str, ...]`	`required`
`mcp_manifest_policy`	`str \| None`	`required`
`tool_result_projection_policy`	`ToolResultProjectionPolicyManifest \| None`	`required`
`context_counting`	`str`	`required`
`request_footprint`	`RequestFootprintConfigManifest`	`required`
`max_file_attachment_bytes`	`int`	`required`
`max_total_file_attachment_bytes`	`int`	`required`
`max_file_attachments_per_request`	`int`	`required`
`tool_timeout_seconds`	`float \| None`	`required`
`max_parallel_tool_calls`	`int`	`required`
`max_environment_lifecycle_owners`	`int`	`required`
`recovery_cleanup_policy`	`RecoveryCleanupPolicyManifest`	`required`

Release source · Runtime guarantees · Capability guides

`StoreManifest`

from cayu.runtime import StoreManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`session`	`str`	`required`
`task`	`str \| None`	`required`
`knowledge`	`str \| None`	`required`
`budget`	`str`	`required`
`budget_ledger`	`str`	`required`
`event_watcher`	`str`	`required`

Release source · Runtime guarantees · Capability guides

`ToolManifest`

from cayu.runtime import ToolManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`name`	`str`	`required`
`description`	`str`	`required`
`effect`	`str`	`required`
`parallel_safe`	`bool`	`required`
`workspace_mutation`	`bool`	`False`
`execution_boundary`	`Literal['in_process', 'posix_process']`	`'in_process'`
`timeout_strength`	`Literal['none', 'cooperative_in_process', 'hard_process_deadline']`	`'none'`
`sandboxed`	`bool`	`False`
`adapter_identity`	`FrozenJsonObject \| None`	`None`
`adapter_configuration_sha256`	`str \| None`	`Field(default=None, pattern='^sha256:[0-9a-f]{64}$')`
`hard_deadline_seconds`	`float \| None`	`Field(default=None, gt=0, le=24 * 60 * 60)`
`input_schema`	`FrozenJsonObject`	`Field(default_factory=lambda: MappingProxyType({}))`
`policy_coverage`	`Literal['allowed', 'denied', 'approval_required', 'conditional', 'unknown']`	`required`
`policy_environment_names`	`tuple[str, ...] \| None`	`None`
`parameter_policy_decision`	`Literal['deny', 'require_approval'] \| None`	`None`
`approval_validity_rules`	`tuple[str, ...]`	`Field(default=(), exclude_if=lambda value: not value)`
`command_policy`	`str \| None`	`None`
`named_checks`	`tuple[NamedCheckManifest, ...]`	`()`
`registration_provenance`	`RegistrationProvenance`	`required`
`implementation_provenance`	`RegistrationProvenance`	`required`

validate_adapter_identity (method)

ToolManifest.validate_adapter_identity(value: object) -> object

validate_execution_boundary (method)

ToolManifest.validate_execution_boundary() -> ToolManifest

Release source · Runtime guarantees · Capability guides

`ToolResultProjectionPolicyManifest`

from cayu.runtime import ToolResultProjectionPolicyManifest

Bases: _ManifestModel.

Fields and attributes

Name	Type	Default
`identity`	`str`	`required`
`max_inline_bytes`	`int \| None`	`None`
`max_inline_token_estimate`	`int \| None`	`None`
`preview_bytes`	`int \| None`	`None`
`token_estimation_method`	`str \| None`	`None`

Release source · Runtime guarantees · Capability guides