api.md 17 KB
Shared Response Types
Event
Response Types:
Methods:
App
Response Types:
Methods:
client.App.Get(ctx context.Context) (opencode.App, error)client.App.Init(ctx context.Context) (bool, error)client.App.Log(ctx context.Context, body opencode.AppLogParams) (bool, error)
Find
Response Types:
Methods:
client.Find.Files(ctx context.Context, query opencode.FindFilesParams) ([]string, error)client.Find.Symbols(ctx context.Context, query opencode.FindSymbolsParams) ([]opencode.Symbol, error)client.Find.Text(ctx context.Context, query opencode.FindTextParams) ([]opencode.Match, error)
File
Response Types:
Methods:
client.File.Read(ctx context.Context, query opencode.FileReadParams) (opencode.FileReadResponse, error)client.File.Status(ctx context.Context) ([]opencode.File, error)
Config
Response Types:
- opencode.Config
- opencode.Keybinds
- opencode.McpLocal
- opencode.McpRemote
- opencode.Model
- opencode.Provider
- opencode.ConfigProvidersResponse
Methods:
client.Config.Get(ctx context.Context) (opencode.Config, error)client.Config.Providers(ctx context.Context) (opencode.ConfigProvidersResponse, error)
Session
Params Types:
Response Types:
- opencode.AssistantMessage
- opencode.AssistantMessagePart
- opencode.FilePart
- opencode.Message
- opencode.Session
- opencode.StepStartPart
- opencode.TextPart
- opencode.ToolPart
- opencode.ToolStateCompleted
- opencode.ToolStateError
- opencode.ToolStatePending
- opencode.ToolStateRunning
- opencode.UserMessage
- opencode.UserMessagePart
Methods:
client.Session.New(ctx context.Context) (opencode.Session, error)client.Session.List(ctx context.Context) ([]opencode.Session, error)client.Session.Delete(ctx context.Context, id string) (bool, error)client.Session.Abort(ctx context.Context, id string) (bool, error)client.Session.Chat(ctx context.Context, id string, body opencode.SessionChatParams) (opencode.AssistantMessage, error)client.Session.Init(ctx context.Context, id string, body opencode.SessionInitParams) (bool, error)client.Session.Messages(ctx context.Context, id string) ([]opencode.Message, error)client.Session.Share(ctx context.Context, id string) (opencode.Session, error)client.Session.Summarize(ctx context.Context, id string, body opencode.SessionSummarizeParams) (bool, error)client.Session.Unshare(ctx context.Context, id string) (opencode.Session, error)