Skip to main content

types.types

Pydantic models for chat functionality and agent specifications.

EnvvarSpec Objects​

class EnvvarSpec(BaseModel)

Specification for an environment variable.

SkillSpec Objects​

class SkillSpec(BaseModel)

Specification for a skill.

Supports three variants:
  • Variant 1 (name-based): Uses module to discover and load a skill from a Python module path (e.g. agent_skills.events).
  • Variant 2 (package-based): Uses package and method to reference a callable in an installable Python package. Attributes such as license, compatibility, allowed_tools, and metadata are discovered at runtime from the SKILL.md packaged inside the Python package — they should NOT be duplicated in the YAML spec.
    • Variant 3 (path-based): Uses path to load a local skill directory containing SKILL.md (relative to the configured skills folder).

ToolRuntimeSpec Objects​

class ToolRuntimeSpec(BaseModel)

Runtime binding for resolving a tool implementation.

ToolSpec Objects​

class ToolSpec(BaseModel)

Specification for a runtime tool.

FrontendToolSpec Objects​

class FrontendToolSpec(BaseModel)

Specification for a frontend tool set.

AIModel Objects​

class AIModel(BaseModel)

Specification for an AI model.

AIModels Objects​

class AIModels(str, Enum)

Enumeration of all available AI model IDs.

Note: Enum members are generated by make specs. This base class is kept here as the canonical type; the generated agent_runtimes.specs.models module re-populates members at import time.

EvalSpec Objects​

class EvalSpec(BaseModel)

Evaluation benchmark specification.

GuardrailPermissions Objects​

class GuardrailPermissions(BaseModel)

Permission toggles for a guardrail profile.

TokenLimitsSpec Objects​

class TokenLimitsSpec(BaseModel)

Token budget limits.

DataScopeSpec Objects​

class DataScopeSpec(BaseModel)

Data-access scoping rules.

DataHandlingSpec Objects​

class DataHandlingSpec(BaseModel)

Data output and PII handling policy.

ApprovalPolicySpec Objects​

class ApprovalPolicySpec(BaseModel)

Manual/automatic approval policy.

ToolLimitsSpec Objects​

class ToolLimitsSpec(BaseModel)

Tool-call limits for a run.

AuditSpec Objects​

class AuditSpec(BaseModel)

Audit/logging policy.

ContentSafetySpec Objects​

class ContentSafetySpec(BaseModel)

Prompt-injection and untrusted-content policy.

GuardrailSpec Objects​

class GuardrailSpec(BaseModel)

Guardrail specification.

MemorySpec Objects​

class MemorySpec(BaseModel)

Specification for a memory backend.

Memories Objects​

class Memories(str, Enum)

Enumeration of available memory backends.

Note: Enum members are generated by make specs. This base class is kept here as the canonical type; the generated agent_runtimes.specs.memory module re-populates members at import time.

NotificationField Objects​

class NotificationField(BaseModel)

Dynamic field definition for a notification channel.

NotificationChannelSpec Objects​

class NotificationChannelSpec(BaseModel)

Notification channel specification.

OutputSpec Objects​

class OutputSpec(BaseModel)

Output format specification.

EventField Objects​

class EventField(BaseModel)

Dynamic field definition for an event type specification.

EventSpec Objects​

class EventSpec(BaseModel)

Event type specification for agent lifecycle and guardrail events.

TriggerField Objects​

class TriggerField(BaseModel)

Dynamic field definition for a trigger type.

TriggerSpec Objects​

class TriggerSpec(BaseModel)

Trigger type specification.

AgentSkillSpec Objects​

class AgentSkillSpec(BaseModel)

Specification for an agent skill.

Simplified version of the full Skill type from agent-skills, containing only the fields needed for agent specification.

AgentStatus Objects​

class AgentStatus(str, Enum)

Status of an agent runtime.

ChatRequest Objects​

class ChatRequest(BaseModel)

Chat request from frontend.

AIModelRuntime Objects​

class AIModelRuntime(BaseModel)

Runtime configuration for an AI model.

BuiltinTool Objects​

class BuiltinTool(BaseModel)

Configuration for a builtin tool.

MCPServerTool Objects​

class MCPServerTool(BaseModel)

A tool provided by an MCP server.

MCPServer Objects​

class MCPServer(BaseModel)

Configuration for an MCP server.

FrontendConfig Objects​

class FrontendConfig(BaseModel)

Configuration returned to frontend.

AgentSpec Objects​

class AgentSpec(BaseModel)

Specification for an AI agent.

Defines the configuration for a reusable agent template that can be instantiated as an agent runtime.

TeamAgentSpec Objects​

class TeamAgentSpec(BaseModel)

Specification for an agent within a team.

TeamSupervisorSpec Objects​

class TeamSupervisorSpec(BaseModel)

Specification for a team supervisor agent.

TeamValidationSpec Objects​

class TeamValidationSpec(BaseModel)

Validation settings for a team.

TeamReactionRule Objects​

class TeamReactionRule(BaseModel)

A reaction rule for automated team responses.

TeamHealthMonitoring Objects​

class TeamHealthMonitoring(BaseModel)

Health monitoring configuration for a team.

TeamOutputSpec Objects​

class TeamOutputSpec(BaseModel)

Output configuration for a team.

TeamSpec Objects​

class TeamSpec(BaseModel)

Specification for a multi-agent team.