API Reference opencode_sdk v#0.1.59

Copy Markdown View Source

Modules

Unofficial OpenCode SDK for Elixir.

HTTP client used by generated operations.

Provides struct and type for a APIError

Provides struct and type for a APIErrorData

Provides struct and type for a Agent

Provides struct and type for a AgentConfig

Provides struct and type for a AgentModel

Provides struct and type for a AgentPart

Provides struct and type for a AgentPartInput

Provides struct and type for a AgentPartInputSource

Provides struct and type for a AgentPartSource

Provides struct and type for a ApiAuth

Provides struct and type for a AssistantMessage

Provides struct and type for a AssistantMessagePath

Provides struct and type for a AssistantMessageTime

Provides struct and type for a AssistantMessageTokens

Provides struct and type for a AssistantMessageTokensCache

Provides struct and type for a BadRequestError

Provides struct and type for a Command

Provides struct and type for a CompactionPart

Provides API endpoints related to config

Provides struct and type for a ConfigAgent

Provides struct and type for a ConfigCompaction

Provides struct and type for a ConfigEnterprise

Provides struct and type for a ConfigExperimental

Provides struct and type for a ConfigMode

Provides struct and type for a ConfigSkills

Provides struct and type for a ConfigToolOutput

Provides struct and type for a ConfigTui

Provides struct and type for a ConfigTuiScrollAcceleration

Provides struct and type for a ConfigWatcher

Provides struct and type for a ConsoleState

Provides struct and type for a ContextOverflowError

Provides struct and type for a ContextOverflowErrorData

Provides API endpoints related to control

Provides struct and type for a EffectHttpApiErrorForbidden

Provides struct and type for a EffectHttpApiErrorInternalServerError

Provides API endpoint related to event

Provides struct and type for a EventCommandExecuted

Provides struct and type for a EventCommandExecutedProperties

Provides struct and type for a EventFileEdited

Provides struct and type for a EventFileEditedProperties

Provides struct and type for a EventFileWatcherUpdated

Provides struct and type for a EventFileWatcherUpdatedProperties

Provides struct and type for a EventGlobalDisposed

Provides struct and type for a EventInstallationUpdateAvailable

Provides struct and type for a EventInstallationUpdateAvailableProperties

Provides struct and type for a EventInstallationUpdated

Provides struct and type for a EventInstallationUpdatedProperties

Provides struct and type for a EventLspClientDiagnostics

Provides struct and type for a EventLspClientDiagnosticsProperties

Provides struct and type for a EventLspUpdated

Provides struct and type for a EventMcpBrowserOpenFailed

Provides struct and type for a EventMcpBrowserOpenFailedProperties

Provides struct and type for a EventMcpToolsChanged

Provides struct and type for a EventMcpToolsChangedProperties

Provides struct and type for a EventMessagePartDelta

Provides struct and type for a EventMessagePartDeltaProperties

Provides struct and type for a EventMessagePartRemoved

Provides struct and type for a EventMessagePartRemovedProperties

Provides struct and type for a EventMessagePartUpdated

Provides struct and type for a EventMessagePartUpdatedProperties

Provides struct and type for a EventMessageRemoved

Provides struct and type for a EventMessageRemovedProperties

Provides struct and type for a EventMessageUpdated

Provides struct and type for a EventMessageUpdatedProperties

Provides struct and type for a EventPermissionAsked

Provides struct and type for a EventPermissionReplied

Provides struct and type for a EventPermissionRepliedProperties

Provides struct and type for a EventProjectUpdated

Provides struct and type for a EventPtyCreated

Provides struct and type for a EventPtyCreatedProperties

Provides struct and type for a EventPtyDeleted

Provides struct and type for a EventPtyDeletedProperties

Provides struct and type for a EventPtyExited

Provides struct and type for a EventPtyExitedProperties

Provides struct and type for a EventPtyUpdated

Provides struct and type for a EventPtyUpdatedProperties

Provides struct and type for a EventQuestionAsked

Provides struct and type for a EventQuestionRejected

Provides struct and type for a EventQuestionRejectedProperties

Provides struct and type for a EventQuestionReplied

Provides struct and type for a EventQuestionRepliedProperties

Provides struct and type for a EventServerConnected

Provides struct and type for a EventServerInstanceDisposed

Provides struct and type for a EventServerInstanceDisposedProperties

Provides struct and type for a EventSessionCompacted

Provides struct and type for a EventSessionCompactedProperties

Provides struct and type for a EventSessionCreated

Provides struct and type for a EventSessionCreatedProperties

Provides struct and type for a EventSessionDeleted

Provides struct and type for a EventSessionDeletedProperties

Provides struct and type for a EventSessionDiff

Provides struct and type for a EventSessionDiffProperties

Provides struct and type for a EventSessionError

Provides struct and type for a EventSessionErrorProperties

Provides struct and type for a EventSessionIdle

Provides struct and type for a EventSessionIdleProperties

Provides struct and type for a EventSessionNextAgentSwitched

Provides struct and type for a EventSessionNextAgentSwitchedProperties

Provides struct and type for a EventSessionNextCompactionDelta

Provides struct and type for a EventSessionNextCompactionDeltaProperties

Provides struct and type for a EventSessionNextCompactionEnded

Provides struct and type for a EventSessionNextCompactionEndedProperties

Provides struct and type for a EventSessionNextCompactionStarted

Provides struct and type for a EventSessionNextCompactionStartedProperties

Provides struct and type for a EventSessionNextModelSwitched

Provides struct and type for a EventSessionNextModelSwitchedProperties

Provides struct and type for a EventSessionNextModelSwitchedPropertiesModel

Provides struct and type for a EventSessionNextPrompted

Provides struct and type for a EventSessionNextPromptedProperties

Provides struct and type for a EventSessionNextReasoningDelta

Provides struct and type for a EventSessionNextReasoningDeltaProperties

Provides struct and type for a EventSessionNextReasoningEnded

Provides struct and type for a EventSessionNextReasoningEndedProperties

Provides struct and type for a EventSessionNextReasoningStarted

Provides struct and type for a EventSessionNextReasoningStartedProperties

Provides struct and type for a EventSessionNextRetried

Provides struct and type for a EventSessionNextRetriedProperties

Provides struct and type for a EventSessionNextShellEnded

Provides struct and type for a EventSessionNextShellEndedProperties

Provides struct and type for a EventSessionNextShellStarted

Provides struct and type for a EventSessionNextShellStartedProperties

Provides struct and type for a EventSessionNextStepEnded

Provides struct and type for a EventSessionNextStepEndedProperties

Provides struct and type for a EventSessionNextStepEndedPropertiesTokens

Provides struct and type for a EventSessionNextStepEndedPropertiesTokensCache

Provides struct and type for a EventSessionNextStepFailed

Provides struct and type for a EventSessionNextStepFailedProperties

Provides struct and type for a EventSessionNextStepFailedPropertiesError

Provides struct and type for a EventSessionNextStepStarted

Provides struct and type for a EventSessionNextStepStartedProperties

Provides struct and type for a EventSessionNextStepStartedPropertiesModel

Provides struct and type for a EventSessionNextSynthetic

Provides struct and type for a EventSessionNextSyntheticProperties

Provides struct and type for a EventSessionNextTextDelta

Provides struct and type for a EventSessionNextTextDeltaProperties

Provides struct and type for a EventSessionNextTextEnded

Provides struct and type for a EventSessionNextTextEndedProperties

Provides struct and type for a EventSessionNextTextStarted

Provides struct and type for a EventSessionNextTextStartedProperties

Provides struct and type for a EventSessionNextToolCalled

Provides struct and type for a EventSessionNextToolCalledProperties

Provides struct and type for a EventSessionNextToolCalledPropertiesProvider

Provides struct and type for a EventSessionNextToolError

Provides struct and type for a EventSessionNextToolErrorProperties

Provides struct and type for a EventSessionNextToolErrorPropertiesError

Provides struct and type for a EventSessionNextToolErrorPropertiesProvider

Provides struct and type for a EventSessionNextToolFailed

Provides struct and type for a EventSessionNextToolFailedProperties

Provides struct and type for a EventSessionNextToolFailedPropertiesError

Provides struct and type for a EventSessionNextToolFailedPropertiesProvider

Provides struct and type for a EventSessionNextToolInputDelta

Provides struct and type for a EventSessionNextToolInputDeltaProperties

Provides struct and type for a EventSessionNextToolInputEnded

Provides struct and type for a EventSessionNextToolInputEndedProperties

Provides struct and type for a EventSessionNextToolInputStarted

Provides struct and type for a EventSessionNextToolInputStartedProperties

Provides struct and type for a EventSessionNextToolProgress

Provides struct and type for a EventSessionNextToolProgressProperties

Provides struct and type for a EventSessionNextToolSuccess

Provides struct and type for a EventSessionNextToolSuccessProperties

Provides struct and type for a EventSessionNextToolSuccessPropertiesProvider

Provides struct and type for a EventSessionStatus

Provides struct and type for a EventSessionStatusProperties

Provides struct and types for a EventSessionStatusPropertiesStatus

Provides struct and type for a EventSessionStatusPropertiesStatusAction

Provides struct and type for a EventSessionUpdated

Provides struct and type for a EventSessionUpdatedProperties

Provides struct and type for a EventTodoUpdated

Provides struct and type for a EventTodoUpdatedProperties

Provides struct and types for a EventTuiCommandExecute

Provides struct and types for a EventTuiCommandExecuteProperties

Provides struct and types for a EventTuiPromptAppend

Provides struct and types for a EventTuiPromptAppendProperties

Provides struct and types for a EventTuiSessionSelect

Provides struct and types for a EventTuiSessionSelectProperties

Provides struct and types for a EventTuiToastShow

Provides struct and type for a EventTuiToastShow1

Provides struct and type for a EventTuiToastShow1Properties

Provides struct and types for a EventTuiToastShowProperties

Provides struct and type for a EventVcsBranchUpdated

Provides struct and type for a EventVcsBranchUpdatedProperties

Provides struct and type for a EventWorkspaceFailed

Provides struct and type for a EventWorkspaceFailedProperties

Provides struct and type for a EventWorkspaceReady

Provides struct and type for a EventWorkspaceReadyProperties

Provides struct and type for a EventWorkspaceRestore

Provides struct and type for a EventWorkspaceRestoreProperties

Provides struct and type for a EventWorkspaceStatus

Provides struct and type for a EventWorkspaceStatusProperties

Provides struct and type for a EventWorktreeFailed

Provides struct and type for a EventWorktreeFailedProperties

Provides struct and type for a EventWorktreeReady

Provides struct and type for a EventWorktreeReadyProperties

Provides API endpoints related to experimental

Provides API endpoints related to file

Provides struct and type for a FileContent

Provides struct and type for a FileContentPatch

Provides struct and type for a FileContentPatchHunks

Provides struct and type for a FileDiff

Provides struct and type for a FileNode

Provides struct and type for a FilePart

Provides struct and type for a FilePartInput

Provides struct and type for a FilePartSourceText

Provides struct and type for a FileSource

Provides struct and type for a FormatterStatus

Provides API endpoints related to global

Provides struct and type for a GlobalEvent

Provides struct and type for a GlobalSession

Provides struct and type for a GlobalSessionModel

Provides struct and type for a GlobalSessionRevert

Provides struct and type for a GlobalSessionShare

Provides struct and type for a GlobalSessionSummary

Provides struct and type for a GlobalSessionTime

Provides API endpoints related to instance

Provides struct and type for a KeybindsConfig

Provides struct and type for a LSPStatus

Provides struct and type for a MCPStatusConnected

Provides struct and type for a MCPStatusDisabled

Provides struct and type for a MCPStatusFailed

Provides struct and type for a MCPStatusNeedsAuth

Provides struct and type for a MCPStatusNeedsClientRegistration

Provides API endpoints related to mcp

Provides struct and type for a McpLocalConfig

Provides struct and type for a McpOAuthConfig

Provides struct and type for a McpRemoteConfig

Provides struct and type for a McpUnsupportedOAuthError

Provides struct and type for a MessageAbortedError

Provides struct and type for a MessageAbortedErrorData

Provides struct and type for a MessageOutputLengthError

Provides struct and type for a MessageRequest

Provides struct and type for a MessageResponse

Provides struct and type for a NotFoundError

Provides struct and type for a NotFoundErrorData

Provides struct and type for a OAuth

Provides API endpoints related to operations

Provides struct and type for a OutputFormatJsonSchema

Provides struct and type for a OutputFormatText

Provides struct and type for a Part

Provides struct and type for a PatchPart

Provides struct and type for a Path

Provides API endpoints related to permission

Provides struct and type for a PermissionRequest

Provides struct and type for a PermissionRequestTool

Provides struct and type for a PermissionRule

Provides API endpoints related to project

Provides struct and type for a ProjectCommands

Provides struct and type for a ProjectIcon

Provides struct and type for a ProjectSummary

Provides struct and type for a ProjectTime

Provides struct and type for a Prompt

Provides struct and type for a PromptAgentAttachment

Provides struct and type for a PromptFileAttachment

Provides struct and type for a PromptSource

Provides API endpoints related to provider

Provides struct and type for a ProviderAuthAuthorization

Provides struct and type for a ProviderAuthError

Provides struct and type for a ProviderAuthErrorData

Provides API endpoints related to pty

Provides API endpoints related to question

Provides struct and type for a QuestionInfo

Provides struct and type for a QuestionOption

Provides struct and type for a QuestionRejected

Provides struct and type for a QuestionReplied

Provides struct and type for a QuestionRequest

Provides struct and type for a QuestionRequestTool

Provides struct and type for a QuestionTool

Provides struct and type for a Range

Provides struct and type for a RangeEnd

Provides struct and type for a RangeStart

Provides struct and type for a ReasoningPart

Provides struct and type for a ReasoningPartTime

Provides struct and type for a ResourceSource

Provides struct and type for a RetryPart

Provides struct and type for a RetryPartTime

Provides struct and type for a ServerConfig

Provides API endpoints related to session

Provides struct and type for a SessionErrorUnknown

Provides struct and type for a SessionInfo

Provides struct and type for a SessionInfoModel

Provides struct and type for a SessionInfoTime

Provides struct and type for a SessionMessageAgentSwitched

Provides struct and type for a SessionMessageAgentSwitchedTime

Provides struct and type for a SessionMessageAssistant

Provides struct and type for a SessionMessageAssistantError

Provides struct and type for a SessionMessageAssistantModel

Provides struct and type for a SessionMessageAssistantReasoning

Provides struct and type for a SessionMessageAssistantSnapshot

Provides struct and type for a SessionMessageAssistantText

Provides struct and type for a SessionMessageAssistantTime

Provides struct and type for a SessionMessageAssistantTokens

Provides struct and type for a SessionMessageAssistantTokensCache

Provides struct and type for a SessionMessageAssistantTool

Provides struct and type for a SessionMessageAssistantToolProvider

Provides struct and type for a SessionMessageAssistantToolTime

Provides struct and type for a SessionMessageCompaction

Provides struct and type for a SessionMessageCompactionTime

Provides struct and type for a SessionMessageModelSwitched

Provides struct and type for a SessionMessageModelSwitchedModel

Provides struct and type for a SessionMessageModelSwitchedTime

Provides struct and type for a SessionMessageShell

Provides struct and type for a SessionMessageShellTime

Provides struct and type for a SessionMessageSynthetic

Provides struct and type for a SessionMessageSyntheticTime

Provides struct and type for a SessionMessageToolStateCompleted

Provides struct and type for a SessionMessageToolStateError

Provides struct and type for a SessionMessageToolStateErrorError

Provides struct and type for a SessionMessageToolStatePending

Provides struct and type for a SessionMessageToolStateRunning

Provides struct and type for a SessionMessageUser

Provides struct and type for a SessionMessageUserTime

Provides struct and type for a SessionModel

Provides struct and type for a SessionNextRetryError

Provides struct and type for a SessionRevert

Provides struct and type for a SessionShare

Provides struct and type for a SessionSummary

Provides struct and type for a SessionTime

Provides struct and type for a SnapshotFileDiff

Provides struct and type for a SnapshotPart

Provides struct and type for a StepFinishPart

Provides struct and type for a StepFinishPartTokens

Provides struct and type for a StepFinishPartTokensCache

Provides struct and type for a StepStartPart

Provides struct and type for a StructuredOutputError

Provides struct and type for a StructuredOutputErrorData

Provides struct and type for a SubtaskPart

Provides struct and type for a SubtaskPartInput

Provides struct and type for a SubtaskPartInputModel

Provides struct and type for a SubtaskPartModel

Provides struct and type for a Symbol

Provides struct and type for a SymbolLocation

Provides struct and type for a SymbolSource

Provides API endpoints related to sync

Provides struct and type for a SyncEvent

Provides struct and type for a SyncEventMessagePartRemoved

Provides struct and type for a SyncEventMessagePartRemovedData

Provides struct and type for a SyncEventMessagePartUpdated

Provides struct and type for a SyncEventMessagePartUpdatedData

Provides struct and type for a SyncEventMessageRemoved

Provides struct and type for a SyncEventMessageRemovedData

Provides struct and type for a SyncEventMessageUpdated

Provides struct and type for a SyncEventMessageUpdatedData

Provides struct and type for a SyncEventSessionCreated

Provides struct and type for a SyncEventSessionCreatedData

Provides struct and type for a SyncEventSessionDeleted

Provides struct and type for a SyncEventSessionDeletedData

Provides struct and type for a SyncEventSessionNextAgentSwitched

Provides struct and type for a SyncEventSessionNextAgentSwitchedData

Provides struct and type for a SyncEventSessionNextCompactionDelta

Provides struct and type for a SyncEventSessionNextCompactionDeltaData

Provides struct and type for a SyncEventSessionNextCompactionEnded

Provides struct and type for a SyncEventSessionNextCompactionEndedData

Provides struct and type for a SyncEventSessionNextCompactionStarted

Provides struct and type for a SyncEventSessionNextCompactionStartedData

Provides struct and type for a SyncEventSessionNextModelSwitched

Provides struct and type for a SyncEventSessionNextModelSwitchedData

Provides struct and type for a SyncEventSessionNextModelSwitchedDataModel

Provides struct and type for a SyncEventSessionNextPrompted

Provides struct and type for a SyncEventSessionNextPromptedData

Provides struct and type for a SyncEventSessionNextReasoningDelta

Provides struct and type for a SyncEventSessionNextReasoningDeltaData

Provides struct and type for a SyncEventSessionNextReasoningEnded

Provides struct and type for a SyncEventSessionNextReasoningEndedData

Provides struct and type for a SyncEventSessionNextReasoningStarted

Provides struct and type for a SyncEventSessionNextReasoningStartedData

Provides struct and type for a SyncEventSessionNextRetried

Provides struct and type for a SyncEventSessionNextRetriedData

Provides struct and type for a SyncEventSessionNextShellEnded

Provides struct and type for a SyncEventSessionNextShellEndedData

Provides struct and type for a SyncEventSessionNextShellStarted

Provides struct and type for a SyncEventSessionNextShellStartedData

Provides struct and type for a SyncEventSessionNextStepEnded

Provides struct and type for a SyncEventSessionNextStepEndedData

Provides struct and type for a SyncEventSessionNextStepEndedDataTokens

Provides struct and type for a SyncEventSessionNextStepEndedDataTokensCache

Provides struct and type for a SyncEventSessionNextStepFailed

Provides struct and type for a SyncEventSessionNextStepFailedData

Provides struct and type for a SyncEventSessionNextStepFailedDataError

Provides struct and type for a SyncEventSessionNextStepStarted

Provides struct and type for a SyncEventSessionNextStepStartedData

Provides struct and type for a SyncEventSessionNextStepStartedDataModel

Provides struct and type for a SyncEventSessionNextSynthetic

Provides struct and type for a SyncEventSessionNextSyntheticData

Provides struct and type for a SyncEventSessionNextTextDelta

Provides struct and type for a SyncEventSessionNextTextDeltaData

Provides struct and type for a SyncEventSessionNextTextEnded

Provides struct and type for a SyncEventSessionNextTextEndedData

Provides struct and type for a SyncEventSessionNextTextStarted

Provides struct and type for a SyncEventSessionNextTextStartedData

Provides struct and type for a SyncEventSessionNextToolCalled

Provides struct and type for a SyncEventSessionNextToolCalledData

Provides struct and type for a SyncEventSessionNextToolCalledDataProvider

Provides struct and type for a SyncEventSessionNextToolError

Provides struct and type for a SyncEventSessionNextToolErrorData

Provides struct and type for a SyncEventSessionNextToolErrorDataError

Provides struct and type for a SyncEventSessionNextToolErrorDataProvider

Provides struct and type for a SyncEventSessionNextToolFailed

Provides struct and type for a SyncEventSessionNextToolFailedData

Provides struct and type for a SyncEventSessionNextToolFailedDataError

Provides struct and type for a SyncEventSessionNextToolFailedDataProvider

Provides struct and type for a SyncEventSessionNextToolInputDelta

Provides struct and type for a SyncEventSessionNextToolInputDeltaData

Provides struct and type for a SyncEventSessionNextToolInputEnded

Provides struct and type for a SyncEventSessionNextToolInputEndedData

Provides struct and type for a SyncEventSessionNextToolInputStarted

Provides struct and type for a SyncEventSessionNextToolInputStartedData

Provides struct and type for a SyncEventSessionNextToolProgress

Provides struct and type for a SyncEventSessionNextToolProgressData

Provides struct and type for a SyncEventSessionNextToolSuccess

Provides struct and type for a SyncEventSessionNextToolSuccessData

Provides struct and type for a SyncEventSessionNextToolSuccessDataProvider

Provides struct and type for a SyncEventSessionUpdated

Provides struct and type for a SyncEventSessionUpdatedData

Provides struct and type for a SyncEventSessionUpdatedDataInfo

Provides struct and type for a SyncEventSessionUpdatedDataInfoModel

Provides struct and type for a SyncEventSessionUpdatedDataInfoRevert

Provides struct and type for a SyncEventSessionUpdatedDataInfoShare

Provides struct and type for a SyncEventSessionUpdatedDataInfoSummary

Provides struct and type for a SyncEventSessionUpdatedDataInfoTime

Provides struct and type for a TextPart

Provides struct and type for a TextPartInput

Provides struct and type for a TextPartInputTime

Provides struct and type for a TextPartTime

Provides struct and type for a Todo

Provides struct and type for a ToolFileContent

Provides struct and type for a ToolListItem

Provides struct and type for a ToolPart

Provides struct and type for a ToolStateCompleted

Provides struct and type for a ToolStateCompletedTime

Provides struct and type for a ToolStateError

Provides struct and type for a ToolStateErrorTime

Provides struct and type for a ToolStatePending

Provides struct and type for a ToolStateRunning

Provides struct and type for a ToolStateRunningTime

Provides struct and type for a ToolTextContent

Provides API endpoints related to tui

Provides struct and type for a UnknownError

Provides struct and type for a UnknownErrorData

Provides struct and type for a UserMessage

Provides struct and type for a UserMessageModel

Provides struct and type for a UserMessageSummary

Provides struct and type for a UserMessageTime

Provides API endpoints related to v2

Provides API endpoint related to v2 messages

Provides struct and type for a V2SessionMessagesResponse

Provides struct and type for a V2SessionMessagesResponseCursor

Provides struct and type for a V2SessionsResponse

Provides struct and type for a V2SessionsResponseCursor

Provides struct and type for a VcsApplyError

Provides struct and type for a VcsApplyErrorData

Provides struct and type for a VcsFileDiff

Provides struct and type for a VcsFileStatus

Provides struct and type for a VcsInfo

Provides struct and type for a WellKnownAuth

Provides API endpoints related to workspace

Provides struct and type for a WorkspaceConfig

Provides struct and type for a WorkspaceWarpError

Provides struct and type for a WorkspaceWarpErrorData

Provides struct and type for a Worktree

Provides struct and type for a WorktreeCreateInput

Provides struct and type for a WorktreeRemoveInput

Provides struct and type for a WorktreeResetInput

OpenCode server process management.

OpenCode TUI process management.

Mix Tasks

Generates Elixir client code from OpenCode CLI OpenAPI specification.