Skip to main content
This page documents all 6 public types in the Agents family in source order. Use the table of contents to jump to a type.

AgentContract

Represents an agent’s contract.yaml, which says how to install and run the agent and which parameters it accepts. Use from_directory() to load and check one before publishing, and validate_kwargs() to check a run’s -k values. Tracker checks the published contract again when a run starts. Agents model · 12 fields Fields
required · str
required · str
optional · Path | None · default:
optional · list[str | OutputArtifact] · default:
optional · list[str] · default:
optional · Union[Literal[’*’], list[str], NoneType] · default:
optional · dict[str, str] · default:
optional · str | None · default:
optional · dict[str, Parameter] · default:
optional · dict[str, Parameter] · default:
required · str
optional · AgentTurns | None · default:

AgentContractRequest

Agent definition submitted when starting a run. Agents model · 12 fields Fields
required · str
optional · str | None · default:
optional · str · default:
optional · str · default:
optional · AgentTurns | None · default:
optional · str | None · default:
optional · list[str | OutputArtifact] · default:
optional · list[str] · default:
optional · Union[Literal[’*’], list[str], NoneType] · default:
optional · dict[str, str] · default:
optional · dict[str, str] · default:
optional · bool · default:

AgentDownloadURLResponse

Temporary URL for downloading an uploaded agent archive. Agents model · 3 fields Fields
required · str
required · str
required · int

AgentEntry

One uploaded agent visible to the configured tenant. Agents model · 2 fields Fields
required · str
optional · str | None · default:

AgentsResponse

Uploaded agents visible to the configured tenant. Agents model · 1 field Fields
required · list[AgentEntry]

Parameter

Represents one parameter an agent accepts, declared under defaults or kwargs in its contract. Agents model · 5 fields Fields
required · Literal[‘float’, ‘bool’, ‘dict’, ‘int’, ‘str’]
required · bool
optional · float | bool | dict[str, Any] | int | str | None · default:
optional · list[str] | None · default:
optional · str | None · default: