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(**params) -> EventListResponse

Path

Types:

from opencode_ai.types import Path

Methods:

• client.path.get(**params) -> Path

App

Types:

from opencode_ai.types import Model, Provider, AppLogResponse, AppProvidersResponse

Methods:

• client.app.log(**params) -> AppLogResponse
• client.app.providers(**params) -> AppProvidersResponse

Agent

Types:

from opencode_ai.types import Agent, AgentListResponse

Methods:

• client.agent.list(**params) -> AgentListResponse

Find

Types:

from opencode_ai.types import 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, FileNode, FileListResponse, FileReadResponse, FileStatusResponse

Methods:

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

Config

Types:

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

Methods:

• client.config.get(**params) -> Config

Command

Types:

from opencode_ai.types import Command, CommandListResponse

Methods:

• client.command.list(**params) -> CommandListResponse

Project

Types:

from opencode_ai.types import Project, ProjectListResponse

Methods:

• client.project.list(**params) -> ProjectListResponse
• client.project.current(**params) -> Project

Session

Types:

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

Methods:

• client.session.create(**params) -> Session
• client.session.update(id, **params) -> Session
• client.session.list(**params) -> SessionListResponse
• client.session.delete(id, **params) -> SessionDeleteResponse
• client.session.abort(id, **params) -> SessionAbortResponse
• client.session.children(id, **params) -> SessionChildrenResponse
• client.session.command(id, **params) -> SessionCommandResponse
• client.session.get(id, **params) -> Session
• client.session.init(id, **params) -> SessionInitResponse
• client.session.message(message_id, *, id, **params) -> SessionMessageResponse
• client.session.messages(id, **params) -> SessionMessagesResponse
• client.session.prompt(id, **params) -> SessionPromptResponse
• client.session.revert(id, **params) -> Session
• client.session.share(id, **params) -> Session
• client.session.shell(id, **params) -> AssistantMessage
• client.session.summarize(id, **params) -> SessionSummarizeResponse
• client.session.unrevert(id, **params) -> Session
• client.session.unshare(id, **params) -> Session

Permissions

Types:

from opencode_ai.types.session import Permission, PermissionRespondResponse

Methods:

• client.session.permissions.respond(permission_id, *, id, **params) -> PermissionRespondResponse

Tui

Types:

from opencode_ai.types import (
    TuiAppendPromptResponse,
    TuiClearPromptResponse,
    TuiExecuteCommandResponse,
    TuiOpenHelpResponse,
    TuiOpenModelsResponse,
    TuiOpenSessionsResponse,
    TuiOpenThemesResponse,
    TuiShowToastResponse,
    TuiSubmitPromptResponse,
)

Methods:

• client.tui.append_prompt(**params) -> TuiAppendPromptResponse
• client.tui.clear_prompt(**params) -> TuiClearPromptResponse
• client.tui.execute_command(**params) -> TuiExecuteCommandResponse
• client.tui.open_help(**params) -> TuiOpenHelpResponse
• client.tui.open_models(**params) -> TuiOpenModelsResponse
• client.tui.open_sessions(**params) -> TuiOpenSessionsResponse
• client.tui.open_themes(**params) -> TuiOpenThemesResponse
• client.tui.show_toast(**params) -> TuiShowToastResponse
• client.tui.submit_prompt(**params) -> TuiSubmitPromptResponse