Skip to content

Agent

5 types. Import any of them from opencode.types.

AgentColor module-attribute 

AgentColor: TypeAlias = str

AgentGetResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: AgentInfo

AgentID module-attribute 

AgentID: TypeAlias = str

AgentInfo

id instance-attribute 

id: AgentID

name instance-attribute 

name: str

model class-attribute instance-attribute 

model: ModelRef | None = Field(
    default=None, exclude_if=is_none
)

request instance-attribute 

request: ProviderRequest

system class-attribute instance-attribute 

system: str | None = Field(default=None, exclude_if=is_none)

description class-attribute instance-attribute 

description: str | None = Field(
    default=None, exclude_if=is_none
)

mode instance-attribute 

mode: OpenEnum[Literal['subagent', 'primary', 'all']]

hidden instance-attribute 

hidden: bool

color class-attribute instance-attribute 

color: AgentColor | None = Field(
    default=None, exclude_if=is_none
)

steps class-attribute instance-attribute 

steps: int | None = Field(default=None, exclude_if=is_none)

permissions instance-attribute 

permissions: PermissionRuleset

AgentListResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: list[AgentInfo]