opencode-sdk-python/api.md

Shared Types

from opencode_ai.types import MessageAbortedError, ProviderAuthError, UnknownError

Event

Types:

from opencode_ai.types import EventListResponse

Methods:

• client.event.list() -> EventListResponse

App

Types:

from opencode_ai.types import (
    App,
    Mode,
    Model,
    Provider,
    AppInitResponse,
    AppLogResponse,
    AppModesResponse,
    AppProvidersResponse,
)

Methods:

• client.app.get() -> App
• client.app.init() -> AppInitResponse
• client.app.log(**params) -> AppLogResponse
• client.app.modes() -> AppModesResponse
• client.app.providers() -> AppProvidersResponse

Find

Types:

from opencode_ai.types import (
    Match,
    Symbol,
    FindFilesResponse,
    FindSymbolsResponse,
    FindTextResponse,
)

Methods:

• client.find.files(**params) -> FindFilesResponse
• client.find.symbols(**params) -> FindSymbolsResponse
• client.find.text(**params) -> FindTextResponse

File

Types:

from opencode_ai.types import File, FileReadResponse, FileStatusResponse

Methods:

• client.file.read(**params) -> FileReadResponse
• client.file.status() -> FileStatusResponse

Config

Types:

from opencode_ai.types import Config, KeybindsConfig, McpLocalConfig, McpRemoteConfig, ModeConfig

Methods:

• client.config.get() -> Config

Session

Types:

from opencode_ai.types import (
    AssistantMessage,
    FilePart,
    FilePartInput,
    FilePartSource,
    FilePartSourceText,
    FileSource,
    Message,
    Part,
    Session,
    SnapshotPart,
    StepFinishPart,
    StepStartPart,
    SymbolSource,
    TextPart,
    TextPartInput,
    ToolPart,
    ToolStateCompleted,
    ToolStateError,
    ToolStatePending,
    ToolStateRunning,
    UserMessage,
    SessionListResponse,
    SessionDeleteResponse,
    SessionAbortResponse,
    SessionInitResponse,
    SessionMessagesResponse,
    SessionSummarizeResponse,
)

Methods:

• client.session.create() -> Session
• client.session.list() -> SessionListResponse
• client.session.delete(id) -> SessionDeleteResponse
• client.session.abort(id) -> SessionAbortResponse
• client.session.chat(id, **params) -> AssistantMessage
• client.session.init(id, **params) -> SessionInitResponse
• client.session.messages(id) -> SessionMessagesResponse
• client.session.share(id) -> Session
• client.session.summarize(id, **params) -> SessionSummarizeResponse
• client.session.unshare(id) -> Session

Tui

Types:

from opencode_ai.types import TuiPromptResponse

Methods:

• client.tui.prompt(**params) -> TuiPromptResponse