Skip to content

Miscellaneous

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

AbsolutePath module-attribute 

AbsolutePath: TypeAlias = str

CommandInfo

name instance-attribute 

name: str

description class-attribute instance-attribute 

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

CommandListResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: list[CommandInfo]

ExperimentalPersistentPtyCreateSize

cols instance-attribute 

cols: int

rows instance-attribute 

rows: int

ExperimentalPersistentPtyHandoffResponse

handoff instance-attribute 

handoff: PersistentPtyHandoff | None

ExperimentalPersistentPtyUpdateSize

cols instance-attribute 

cols: int

rows instance-attribute 

rows: int

FilesystemChangedEventData

file instance-attribute 

file: str

event instance-attribute 

event: OpenEnum[Literal['add', 'change', 'unlink']]

GenerateTextResponse

data instance-attribute 

data: GenerateTextResponseData

GenerateTextResponseData

text instance-attribute 

text: str

InstallationUpdateAvailableEventData

version instance-attribute 

version: str

InstallationUpdatedEventData

version instance-attribute 

version: str

MoneyUSD module-attribute 

MoneyUSD: TypeAlias = float

MoneyUSDPerMillionTokens module-attribute 

MoneyUSDPerMillionTokens: TypeAlias = float

PairingCode

code instance-attribute 

code: str

expires_in instance-attribute 

expires_in: int

PairingSession

token instance-attribute 

token: str

RelativePath module-attribute 

RelativePath: TypeAlias = str

RpcOutput

output class-attribute instance-attribute 

output: Any = Field(default=None, exclude_if=is_none)

ServerInfo

version instance-attribute 

version: str

pid instance-attribute 

pid: int

urls instance-attribute 

urls: list[str]

paths instance-attribute 

paths: ServerInfoPaths

capabilities class-attribute instance-attribute 

capabilities: ServerInfoCapabilities | None = None

ServerInfoCapabilities

persistent_pty class-attribute instance-attribute 

persistent_pty: bool | None = Field(
    default=None,
    validation_alias="persistentPty",
    serialization_alias="persistentPty",
)

ServerInfoPaths

tmp instance-attribute 

tmp: str

SnapshotID module-attribute 

SnapshotID: TypeAlias = str

TokenUsageInfo

input instance-attribute 

input: float

output instance-attribute 

output: float

reasoning instance-attribute 

reasoning: float

cache instance-attribute 

cache: TokenUsageInfoCache

TokenUsageInfoCache

read instance-attribute 

read: float

write instance-attribute 

write: float

ToolContent module-attribute 

ToolContent: TypeAlias = Annotated[
    Annotated[ToolTextContent, Tag("text")]
    | Annotated[ToolFileContent, Tag("file")]
    | Annotated[UnknownToolContent, Tag("__unknown__")],
    Discriminator(
        discriminator("type", "type", ["text", "file"])
    ),
]

ToolFileContent

type class-attribute instance-attribute 

type: Literal['file'] = 'file'

uri instance-attribute 

uri: str

mime instance-attribute 

mime: str

name class-attribute instance-attribute 

name: str | None = None

ToolTextContent

type class-attribute instance-attribute 

type: Literal['text'] = 'text'

text instance-attribute 

text: str

WebsearchProvidersResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: list[WebSearchProvider]

WebsearchQueryResponse

location instance-attribute 

location: LocationPublicRef

data instance-attribute 

data: WebSearchResponse

WorkspaceID module-attribute 

WorkspaceID: TypeAlias = str