// This file is auto-generated by @hey-api/openapi-ts import { client } from "./client.gen.js" import { buildClientParams, type Client, type Options as Options2, type TDataShape } from "./client/index.js" import type { AgentPartInput, AppAgentsResponses, AppLogErrors, AppLogResponses, AppSkillsResponses, Auth as Auth3, AuthRemoveErrors, AuthRemoveResponses, AuthSetErrors, AuthSetResponses, CommandListResponses, Config as Config3, ConfigGetResponses, ConfigProvidersResponses, ConfigUpdateErrors, ConfigUpdateResponses, EventSubscribeResponses, EventTuiCommandExecute2, EventTuiPromptAppend2, EventTuiSessionSelect2, EventTuiToastShow2, ExperimentalConsoleGetResponses, ExperimentalConsoleListOrgsResponses, ExperimentalConsoleSwitchOrgResponses, ExperimentalResourceListResponses, ExperimentalSessionListResponses, ExperimentalWorkspaceAdapterListResponses, ExperimentalWorkspaceCreateErrors, ExperimentalWorkspaceCreateResponses, ExperimentalWorkspaceListResponses, ExperimentalWorkspaceRemoveErrors, ExperimentalWorkspaceRemoveResponses, ExperimentalWorkspaceSessionRestoreErrors, ExperimentalWorkspaceSessionRestoreResponses, ExperimentalWorkspaceStatusResponses, FileListResponses, FilePartInput, FilePartSource, FileReadResponses, FileStatusResponses, FindFilesResponses, FindSymbolsResponses, FindTextResponses, FormatterStatusResponses, GlobalConfigGetResponses, GlobalConfigUpdateErrors, GlobalConfigUpdateResponses, GlobalDisposeResponses, GlobalEventResponses, GlobalHealthResponses, GlobalUpgradeErrors, GlobalUpgradeResponses, InstanceDisposeResponses, LspStatusResponses, McpAddErrors, McpAddResponses, McpAuthAuthenticateErrors, McpAuthAuthenticateResponses, McpAuthCallbackErrors, McpAuthCallbackResponses, McpAuthRemoveErrors, McpAuthRemoveResponses, McpAuthStartErrors, McpAuthStartResponses, McpConnectResponses, McpDisconnectResponses, McpLocalConfig, McpRemoteConfig, McpStatusResponses, OutputFormat, Part as Part2, PartDeleteErrors, PartDeleteResponses, PartUpdateErrors, PartUpdateResponses, PathGetResponses, PermissionListResponses, PermissionReplyErrors, PermissionReplyResponses, PermissionRespondErrors, PermissionRespondResponses, PermissionRuleset, ProjectCurrentResponses, ProjectInitGitResponses, ProjectListResponses, ProjectUpdateErrors, ProjectUpdateResponses, Prompt, ProviderAuthResponses, ProviderListResponses, ProviderOauthAuthorizeErrors, ProviderOauthAuthorizeResponses, ProviderOauthCallbackErrors, ProviderOauthCallbackResponses, PtyConnectErrors, PtyConnectResponses, PtyConnectTokenErrors, PtyConnectTokenResponses, PtyCreateErrors, PtyCreateResponses, PtyGetErrors, PtyGetResponses, PtyListResponses, PtyRemoveErrors, PtyRemoveResponses, PtyShellsResponses, PtyUpdateErrors, PtyUpdateResponses, QuestionAnswer, QuestionListResponses, QuestionRejectErrors, QuestionRejectResponses, QuestionReplyErrors, QuestionReplyResponses, SessionAbortErrors, SessionAbortResponses, SessionChildrenErrors, SessionChildrenResponses, SessionCommandErrors, SessionCommandResponses, SessionCreateErrors, SessionCreateResponses, SessionDeleteErrors, SessionDeleteMessageErrors, SessionDeleteMessageResponses, SessionDeleteResponses, SessionDelivery, SessionDiffResponses, SessionForkResponses, SessionGetErrors, SessionGetResponses, SessionInitErrors, SessionInitResponses, SessionListResponses, SessionMessageErrors, SessionMessageResponses, SessionMessagesErrors, SessionMessagesResponses, SessionPromptAsyncErrors, SessionPromptAsyncResponses, SessionPromptErrors, SessionPromptResponses, SessionRevertErrors, SessionRevertResponses, SessionShareErrors, SessionShareResponses, SessionShellErrors, SessionShellResponses, SessionStatusErrors, SessionStatusResponses, SessionSummarizeErrors, SessionSummarizeResponses, SessionTodoErrors, SessionTodoResponses, SessionUnrevertErrors, SessionUnrevertResponses, SessionUnshareErrors, SessionUnshareResponses, SessionUpdateErrors, SessionUpdateResponses, SubtaskPartInput, SyncHistoryListErrors, SyncHistoryListResponses, SyncReplayErrors, SyncReplayResponses, SyncStartResponses, TextPartInput, ToolIdsErrors, ToolIdsResponses, ToolListErrors, ToolListResponses, TuiAppendPromptErrors, TuiAppendPromptResponses, TuiClearPromptResponses, TuiControlNextResponses, TuiControlResponseResponses, TuiExecuteCommandErrors, TuiExecuteCommandResponses, TuiOpenHelpResponses, TuiOpenModelsResponses, TuiOpenSessionsResponses, TuiOpenThemesResponses, TuiPublishErrors, TuiPublishResponses, TuiSelectSessionErrors, TuiSelectSessionResponses, TuiShowToastResponses, TuiSubmitPromptResponses, V2SessionCompactResponses, V2SessionContextResponses, V2SessionListErrors, V2SessionListResponses, V2SessionMessagesErrors, V2SessionMessagesResponses, V2SessionPromptResponses, V2SessionWaitResponses, VcsDiffResponses, VcsGetResponses, WorktreeCreateErrors, WorktreeCreateInput, WorktreeCreateResponses, WorktreeListResponses, WorktreeRemoveErrors, WorktreeRemoveInput, WorktreeRemoveResponses, WorktreeResetErrors, WorktreeResetInput, WorktreeResetResponses, } from "./types.gen.js" export type Options = Options2< TData, ThrowOnError > & { /** * You can provide a client instance returned by `createClient()` instead of * individual options. This might be also useful if you want to implement a * custom client. */ client?: Client /** * You can pass arbitrary values through the `meta` object. This can be * used to access values that aren't defined as part of the SDK function. */ meta?: Record } class HeyApiClient { protected client: Client constructor(args?: { client?: Client }) { this.client = args?.client ?? client } } class HeyApiRegistry { private readonly defaultKey = "default" private readonly instances: Map = new Map() get(key?: string): T { const instance = this.instances.get(key ?? this.defaultKey) if (!instance) { throw new Error(`No SDK client found. Create one with "new OpencodeClient()" to fix this error.`) } return instance } set(value: T, key?: string): void { this.instances.set(key ?? this.defaultKey, value) } } export class Auth extends HeyApiClient { /** * Remove auth credentials * * Remove authentication credentials */ public remove( parameters: { providerID: string }, options?: Options, ) { const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "providerID" }] }]) return (options?.client ?? this.client).delete({ url: "/auth/{providerID}", ...options, ...params, }) } /** * Set auth credentials * * Set authentication credentials */ public set( parameters: { providerID: string auth?: Auth3 }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "providerID" }, { key: "auth", map: "body" }, ], }, ], ) return (options?.client ?? this.client).put({ url: "/auth/{providerID}", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class App extends HeyApiClient { /** * Write log * * Write a log entry to the server logs with specified level and metadata. */ public log( parameters?: { directory?: string workspace?: string service?: string level?: "debug" | "info" | "error" | "warn" message?: string extra?: { [key: string]: unknown } }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "service" }, { in: "body", key: "level" }, { in: "body", key: "message" }, { in: "body", key: "extra" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/log", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * List agents * * Get a list of all available AI agents in the OpenCode system. */ public agents( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/agent", ...options, ...params, }) } /** * List skills * * Get a list of all available skills in the OpenCode system. */ public skills( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/skill", ...options, ...params, }) } } export class Config extends HeyApiClient { /** * Get global configuration * * Retrieve the current global OpenCode configuration settings and preferences. */ public get(options?: Options) { return (options?.client ?? this.client).get({ url: "/global/config", ...options, }) } /** * Update global configuration * * Update global OpenCode configuration settings and preferences. */ public update( parameters?: { config?: Config3 }, options?: Options, ) { const params = buildClientParams([parameters], [{ args: [{ key: "config", map: "body" }] }]) return (options?.client ?? this.client).patch({ url: "/global/config", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class Global extends HeyApiClient { /** * Get health * * Get health information about the OpenCode server. */ public health(options?: Options) { return (options?.client ?? this.client).get({ url: "/global/health", ...options, }) } /** * Get global events * * Subscribe to global events from the OpenCode system using server-sent events. */ public event(options?: Options) { return (options?.client ?? this.client).sse.get({ url: "/global/event", ...options, }) } /** * Dispose instance * * Clean up and dispose all OpenCode instances, releasing all resources. */ public dispose(options?: Options) { return (options?.client ?? this.client).post({ url: "/global/dispose", ...options, }) } /** * Upgrade opencode * * Upgrade opencode to the specified version or latest if not specified. */ public upgrade( parameters?: { target?: string }, options?: Options, ) { const params = buildClientParams([parameters], [{ args: [{ in: "body", key: "target" }] }]) return (options?.client ?? this.client).post({ url: "/global/upgrade", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } private _config?: Config get config(): Config { return (this._config ??= new Config({ client: this.client })) } } export class Event extends HeyApiClient { /** * Subscribe to events * * Get events */ public subscribe( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).sse.get({ url: "/event", ...options, ...params, }) } } export class Config2 extends HeyApiClient { /** * Get configuration * * Retrieve the current OpenCode configuration settings and preferences. */ public get( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/config", ...options, ...params, }) } /** * Update configuration * * Update OpenCode configuration settings and preferences. */ public update( parameters?: { directory?: string workspace?: string config?: Config3 }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { key: "config", map: "body" }, ], }, ], ) return (options?.client ?? this.client).patch({ url: "/config", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * List config providers * * Get a list of all configured AI providers and their default models. */ public providers( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/config/providers", ...options, ...params, }) } } export class Console extends HeyApiClient { /** * Get active Console provider metadata * * Get the active Console org name and the set of provider IDs managed by that Console org. */ public get( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/console", ...options, ...params, }) } /** * List switchable Console orgs * * Get the available Console orgs across logged-in accounts, including the current active org. */ public listOrgs( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/console/orgs", ...options, ...params, }) } /** * Switch active Console org * * Persist a new active Console account/org selection for the current local OpenCode state. */ public switchOrg( parameters?: { directory?: string workspace?: string accountID?: string orgID?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "accountID" }, { in: "body", key: "orgID" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/experimental/console/switch", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class Session extends HeyApiClient { /** * List sessions * * Get a list of all OpenCode sessions across projects, sorted by most recently updated. Archived sessions are excluded by default. */ public list( parameters?: { directory?: string workspace?: string roots?: boolean | "true" | "false" start?: number cursor?: number search?: string limit?: number archived?: boolean | "true" | "false" }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "roots" }, { in: "query", key: "start" }, { in: "query", key: "cursor" }, { in: "query", key: "search" }, { in: "query", key: "limit" }, { in: "query", key: "archived" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/session", ...options, ...params, }) } } export class Resource extends HeyApiClient { /** * Get MCP resources * * Get all available MCP resources from connected servers. Optionally filter by name. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/resource", ...options, ...params, }) } } export class Adapter extends HeyApiClient { /** * List workspace adapters * * List all available workspace adapters for the current project. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/workspace/adapter", ...options, ...params, }) } } export class Workspace extends HeyApiClient { /** * List workspaces * * List all workspaces. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/workspace", ...options, ...params, }) } /** * Create workspace * * Create a workspace for the current project. */ public create( parameters?: { directory?: string workspace?: string id?: string type?: string branch?: string | null extra?: unknown | null }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "id" }, { in: "body", key: "type" }, { in: "body", key: "branch" }, { in: "body", key: "extra" }, ], }, ], ) return (options?.client ?? this.client).post< ExperimentalWorkspaceCreateResponses, ExperimentalWorkspaceCreateErrors, ThrowOnError >({ url: "/experimental/workspace", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Workspace status * * Get connection status for workspaces in the current project. */ public status( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/workspace/status", ...options, ...params, }) } /** * Remove workspace * * Remove an existing workspace. */ public remove( parameters: { id: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "id" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).delete< ExperimentalWorkspaceRemoveResponses, ExperimentalWorkspaceRemoveErrors, ThrowOnError >({ url: "/experimental/workspace/{id}", ...options, ...params, }) } /** * Restore session into workspace * * Replay a session's sync events into the target workspace in batches. */ public sessionRestore( parameters: { id: string directory?: string workspace?: string sessionID?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "id" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "sessionID" }, ], }, ], ) return (options?.client ?? this.client).post< ExperimentalWorkspaceSessionRestoreResponses, ExperimentalWorkspaceSessionRestoreErrors, ThrowOnError >({ url: "/experimental/workspace/{id}/session-restore", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } private _adapter?: Adapter get adapter(): Adapter { return (this._adapter ??= new Adapter({ client: this.client })) } } export class Experimental extends HeyApiClient { private _console?: Console get console(): Console { return (this._console ??= new Console({ client: this.client })) } private _session?: Session get session(): Session { return (this._session ??= new Session({ client: this.client })) } private _resource?: Resource get resource(): Resource { return (this._resource ??= new Resource({ client: this.client })) } private _workspace?: Workspace get workspace(): Workspace { return (this._workspace ??= new Workspace({ client: this.client })) } } export class Tool extends HeyApiClient { /** * List tools * * Get a list of available tools with their JSON schema parameters for a specific provider and model combination. */ public list( parameters: { directory?: string workspace?: string provider: string model: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "provider" }, { in: "query", key: "model" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/tool", ...options, ...params, }) } /** * List tool IDs * * Get a list of all available tool IDs, including both built-in tools and dynamically registered tools. */ public ids( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/tool/ids", ...options, ...params, }) } } export class Worktree extends HeyApiClient { /** * Remove worktree * * Remove a git worktree and delete its branch. */ public remove( parameters?: { directory?: string workspace?: string worktreeRemoveInput?: WorktreeRemoveInput }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { key: "worktreeRemoveInput", map: "body" }, ], }, ], ) return (options?.client ?? this.client).delete({ url: "/experimental/worktree", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * List worktrees * * List all sandbox worktrees for the current project. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/experimental/worktree", ...options, ...params, }) } /** * Create worktree * * Create a new git worktree for the current project and run any configured startup scripts. */ public create( parameters?: { directory?: string workspace?: string worktreeCreateInput?: WorktreeCreateInput }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { key: "worktreeCreateInput", map: "body" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/experimental/worktree", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Reset worktree * * Reset a worktree branch to the primary default branch. */ public reset( parameters?: { directory?: string workspace?: string worktreeResetInput?: WorktreeResetInput }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { key: "worktreeResetInput", map: "body" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/experimental/worktree/reset", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class Find extends HeyApiClient { /** * Find text * * Search for text patterns across files in the project using ripgrep. */ public text( parameters: { directory?: string workspace?: string pattern: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "pattern" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/find", ...options, ...params, }) } /** * Find files * * Search for files or directories by name or pattern in the project directory. */ public files( parameters: { directory?: string workspace?: string query: string dirs?: "true" | "false" type?: "file" | "directory" limit?: number }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "query" }, { in: "query", key: "dirs" }, { in: "query", key: "type" }, { in: "query", key: "limit" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/find/file", ...options, ...params, }) } /** * Find symbols * * Search for workspace symbols like functions, classes, and variables using LSP. */ public symbols( parameters: { directory?: string workspace?: string query: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "query" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/find/symbol", ...options, ...params, }) } } export class File extends HeyApiClient { /** * List files * * List files and directories in a specified path. */ public list( parameters: { directory?: string workspace?: string path: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "path" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/file", ...options, ...params, }) } /** * Read file * * Read the content of a specified file. */ public read( parameters: { directory?: string workspace?: string path: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "path" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/file/content", ...options, ...params, }) } /** * Get file status * * Get the git status of all files in the project. */ public status( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/file/status", ...options, ...params, }) } } export class Instance extends HeyApiClient { /** * Dispose instance * * Clean up and dispose the current OpenCode instance, releasing all resources. */ public dispose( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/instance/dispose", ...options, ...params, }) } } export class Path extends HeyApiClient { /** * Get paths * * Retrieve the current working directory and related path information for the OpenCode instance. */ public get( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/path", ...options, ...params, }) } } export class Vcs extends HeyApiClient { /** * Get VCS info * * Retrieve version control system (VCS) information for the current project, such as git branch. */ public get( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/vcs", ...options, ...params, }) } /** * Get VCS diff * * Retrieve the current git diff for the working tree or against the default branch. */ public diff( parameters: { directory?: string workspace?: string mode: "git" | "branch" }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "mode" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/vcs/diff", ...options, ...params, }) } } export class Command extends HeyApiClient { /** * List commands * * Get a list of all available commands in the OpenCode system. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/command", ...options, ...params, }) } } export class Lsp extends HeyApiClient { /** * Get LSP status * * Get LSP server status */ public status( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/lsp", ...options, ...params, }) } } export class Formatter extends HeyApiClient { /** * Get formatter status * * Get formatter status */ public status( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/formatter", ...options, ...params, }) } } export class Auth2 extends HeyApiClient { /** * Remove MCP OAuth * * Remove OAuth credentials for an MCP server. */ public remove( parameters: { name: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "name" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).delete({ url: "/mcp/{name}/auth", ...options, ...params, }) } /** * Start MCP OAuth * * Start OAuth authentication flow for a Model Context Protocol (MCP) server. */ public start( parameters: { name: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "name" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/mcp/{name}/auth", ...options, ...params, }) } /** * Complete MCP OAuth * * Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code. */ public callback( parameters: { name: string directory?: string workspace?: string code?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "name" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "code" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/mcp/{name}/auth/callback", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Authenticate MCP OAuth * * Start OAuth flow and wait for callback (opens browser). */ public authenticate( parameters: { name: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "name" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post( { url: "/mcp/{name}/auth/authenticate", ...options, ...params, }, ) } } export class Mcp extends HeyApiClient { /** * Get MCP status * * Get the status of all Model Context Protocol (MCP) servers. */ public status( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/mcp", ...options, ...params, }) } /** * Add MCP server * * Dynamically add a new Model Context Protocol (MCP) server to the system. */ public add( parameters?: { directory?: string workspace?: string name?: string config?: McpLocalConfig | McpRemoteConfig }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "name" }, { in: "body", key: "config" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/mcp", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Connect an MCP server. */ public connect( parameters: { name: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "name" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/mcp/{name}/connect", ...options, ...params, }) } /** * Disconnect an MCP server. */ public disconnect( parameters: { name: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "name" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/mcp/{name}/disconnect", ...options, ...params, }) } private _auth?: Auth2 get auth(): Auth2 { return (this._auth ??= new Auth2({ client: this.client })) } } export class Project extends HeyApiClient { /** * List all projects * * Get a list of projects that have been opened with OpenCode. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/project", ...options, ...params, }) } /** * Get current project * * Retrieve the currently active project that OpenCode is working with. */ public current( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/project/current", ...options, ...params, }) } /** * Initialize git repository * * Create a git repository for the current project and return the refreshed project info. */ public initGit( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/project/git/init", ...options, ...params, }) } /** * Update project * * Update project properties such as name, icon, and commands. */ public update( parameters: { projectID: string directory?: string workspace?: string name?: string icon?: { url?: string override?: string color?: string } commands?: { /** * Startup script to run when creating a new workspace (worktree) */ start?: string } }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "projectID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "name" }, { in: "body", key: "icon" }, { in: "body", key: "commands" }, ], }, ], ) return (options?.client ?? this.client).patch({ url: "/project/{projectID}", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class Pty extends HeyApiClient { /** * List available shells * * Get a list of available shells on the system. */ public shells( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/pty/shells", ...options, ...params, }) } /** * List PTY sessions * * Get a list of all active pseudo-terminal (PTY) sessions managed by OpenCode. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/pty", ...options, ...params, }) } /** * Create PTY session * * Create a new pseudo-terminal (PTY) session for running shell commands and processes. */ public create( parameters?: { directory?: string workspace?: string command?: string args?: Array cwd?: string title?: string env?: { [key: string]: string } }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "command" }, { in: "body", key: "args" }, { in: "body", key: "cwd" }, { in: "body", key: "title" }, { in: "body", key: "env" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/pty", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Remove PTY session * * Remove and terminate a specific pseudo-terminal (PTY) session. */ public remove( parameters: { ptyID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "ptyID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).delete({ url: "/pty/{ptyID}", ...options, ...params, }) } /** * Get PTY session * * Retrieve detailed information about a specific pseudo-terminal (PTY) session. */ public get( parameters: { ptyID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "ptyID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/pty/{ptyID}", ...options, ...params, }) } /** * Update PTY session * * Update properties of an existing pseudo-terminal (PTY) session. */ public update( parameters: { ptyID: string directory?: string workspace?: string title?: string size?: { rows: number cols: number } }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "ptyID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "title" }, { in: "body", key: "size" }, ], }, ], ) return (options?.client ?? this.client).put({ url: "/pty/{ptyID}", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Create PTY WebSocket token * * Create a short-lived ticket for opening a PTY WebSocket connection. */ public connectToken( parameters: { ptyID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "ptyID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/pty/{ptyID}/connect-token", ...options, ...params, }) } /** * Connect to PTY session * * Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time. */ public connect( parameters: { ptyID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "ptyID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/pty/{ptyID}/connect", ...options, ...params, }) } } export class Question extends HeyApiClient { /** * List pending questions * * Get all pending question requests across all sessions. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/question", ...options, ...params, }) } /** * Reply to question request * * Provide answers to a question request from the AI assistant. */ public reply( parameters: { requestID: string directory?: string workspace?: string answers?: Array }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "requestID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "answers" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/question/{requestID}/reply", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Reject question request * * Reject a question request from the AI assistant. */ public reject( parameters: { requestID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "requestID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/question/{requestID}/reject", ...options, ...params, }) } } export class Permission extends HeyApiClient { /** * List pending permissions * * Get all pending permission requests across all sessions. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/permission", ...options, ...params, }) } /** * Respond to permission request * * Approve or deny a permission request from the AI assistant. */ public reply( parameters: { requestID: string directory?: string workspace?: string reply?: "once" | "always" | "reject" message?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "requestID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "reply" }, { in: "body", key: "message" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/permission/{requestID}/reply", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Respond to permission * * Approve or deny a permission request from the AI assistant. * * @deprecated */ public respond( parameters: { sessionID: string permissionID: string directory?: string workspace?: string response?: "once" | "always" | "reject" }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "path", key: "permissionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "response" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/permissions/{permissionID}", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class Oauth extends HeyApiClient { /** * Start OAuth authorization * * Start the OAuth authorization flow for a provider. */ public authorize( parameters: { providerID: string directory?: string workspace?: string method?: number inputs?: { [key: string]: string } }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "providerID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "method" }, { in: "body", key: "inputs" }, ], }, ], ) return (options?.client ?? this.client).post< ProviderOauthAuthorizeResponses, ProviderOauthAuthorizeErrors, ThrowOnError >({ url: "/provider/{providerID}/oauth/authorize", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Handle OAuth callback * * Handle the OAuth callback from a provider after user authorization. */ public callback( parameters: { providerID: string directory?: string workspace?: string method?: number code?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "providerID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "method" }, { in: "body", key: "code" }, ], }, ], ) return (options?.client ?? this.client).post< ProviderOauthCallbackResponses, ProviderOauthCallbackErrors, ThrowOnError >({ url: "/provider/{providerID}/oauth/callback", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class Provider extends HeyApiClient { /** * List providers * * Get a list of all available AI providers, including both available and connected ones. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/provider", ...options, ...params, }) } /** * Get provider auth methods * * Retrieve available authentication methods for all AI providers. */ public auth( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/provider/auth", ...options, ...params, }) } private _oauth?: Oauth get oauth(): Oauth { return (this._oauth ??= new Oauth({ client: this.client })) } } export class Session2 extends HeyApiClient { /** * List sessions * * Get a list of all OpenCode sessions, sorted by most recently updated. */ public list( parameters?: { directory?: string workspace?: string scope?: "project" path?: string roots?: boolean | "true" | "false" start?: number search?: string limit?: number }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "scope" }, { in: "query", key: "path" }, { in: "query", key: "roots" }, { in: "query", key: "start" }, { in: "query", key: "search" }, { in: "query", key: "limit" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/session", ...options, ...params, }) } /** * Create session * * Create a new OpenCode session for interacting with AI assistants and managing conversations. */ public create( parameters?: { directory?: string workspace?: string parentID?: string title?: string agent?: string model?: { id: string providerID: string variant?: string } permission?: PermissionRuleset workspaceID?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "parentID" }, { in: "body", key: "title" }, { in: "body", key: "agent" }, { in: "body", key: "model" }, { in: "body", key: "permission" }, { in: "body", key: "workspaceID" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Get session status * * Retrieve the current status of all sessions, including active, idle, and completed states. */ public status( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/session/status", ...options, ...params, }) } /** * Delete session * * Delete a session and permanently remove all associated data, including messages and history. */ public delete( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).delete({ url: "/session/{sessionID}", ...options, ...params, }) } /** * Get session * * Retrieve detailed information about a specific OpenCode session. */ public get( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/session/{sessionID}", ...options, ...params, }) } /** * Update session * * Update properties of an existing session, such as title or other metadata. */ public update( parameters: { sessionID: string directory?: string workspace?: string title?: string permission?: PermissionRuleset time?: { archived?: number } }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "title" }, { in: "body", key: "permission" }, { in: "body", key: "time" }, ], }, ], ) return (options?.client ?? this.client).patch({ url: "/session/{sessionID}", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Get session children * * Retrieve all child sessions that were forked from the specified parent session. */ public children( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/session/{sessionID}/children", ...options, ...params, }) } /** * Get session todos * * Retrieve the todo list associated with a specific session, showing tasks and action items. */ public todo( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/session/{sessionID}/todo", ...options, ...params, }) } /** * Get message diff * * Get the file changes (diff) that resulted from a specific user message in the session. */ public diff( parameters: { sessionID: string directory?: string workspace?: string messageID?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "messageID" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/session/{sessionID}/diff", ...options, ...params, }) } /** * Get session messages * * Retrieve all messages in a session, including user prompts and AI responses. */ public messages( parameters: { sessionID: string directory?: string workspace?: string limit?: number before?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "query", key: "limit" }, { in: "query", key: "before" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/session/{sessionID}/message", ...options, ...params, }) } /** * Send message * * Create and send a new message to a session, streaming the AI response. */ public prompt( parameters: { sessionID: string directory?: string workspace?: string messageID?: string model?: { providerID: string modelID: string } agent?: string noReply?: boolean tools?: { [key: string]: boolean } format?: OutputFormat system?: string variant?: string parts?: Array }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "messageID" }, { in: "body", key: "model" }, { in: "body", key: "agent" }, { in: "body", key: "noReply" }, { in: "body", key: "tools" }, { in: "body", key: "format" }, { in: "body", key: "system" }, { in: "body", key: "variant" }, { in: "body", key: "parts" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/message", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Delete message * * Permanently delete a specific message and all of its parts from a session without reverting file changes. */ public deleteMessage( parameters: { sessionID: string messageID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "path", key: "messageID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).delete< SessionDeleteMessageResponses, SessionDeleteMessageErrors, ThrowOnError >({ url: "/session/{sessionID}/message/{messageID}", ...options, ...params, }) } /** * Get message * * Retrieve a specific message from a session by its message ID. */ public message( parameters: { sessionID: string messageID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "path", key: "messageID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/session/{sessionID}/message/{messageID}", ...options, ...params, }) } /** * Fork session * * Create a new session by forking an existing session at a specific message point. */ public fork( parameters: { sessionID: string directory?: string workspace?: string messageID?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "messageID" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/fork", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Abort session * * Abort an active session and stop any ongoing AI processing or command execution. */ public abort( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/abort", ...options, ...params, }) } /** * Initialize session * * Analyze the current application and create an AGENTS.md file with project-specific agent configurations. */ public init( parameters: { sessionID: string directory?: string workspace?: string modelID?: string providerID?: string messageID?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "modelID" }, { in: "body", key: "providerID" }, { in: "body", key: "messageID" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/init", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Unshare session * * Remove the shareable link for a session, making it private again. */ public unshare( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).delete({ url: "/session/{sessionID}/share", ...options, ...params, }) } /** * Share session * * Create a shareable link for a session, allowing others to view the conversation. */ public share( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/share", ...options, ...params, }) } /** * Summarize session * * Generate a concise summary of the session using AI compaction to preserve key information. */ public summarize( parameters: { sessionID: string directory?: string workspace?: string providerID?: string modelID?: string auto?: boolean }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "providerID" }, { in: "body", key: "modelID" }, { in: "body", key: "auto" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/summarize", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Send async message * * Create and send a new message to a session asynchronously, starting the session if needed and returning immediately. */ public promptAsync( parameters: { sessionID: string directory?: string workspace?: string messageID?: string model?: { providerID: string modelID: string } agent?: string noReply?: boolean tools?: { [key: string]: boolean } format?: OutputFormat system?: string variant?: string parts?: Array }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "messageID" }, { in: "body", key: "model" }, { in: "body", key: "agent" }, { in: "body", key: "noReply" }, { in: "body", key: "tools" }, { in: "body", key: "format" }, { in: "body", key: "system" }, { in: "body", key: "variant" }, { in: "body", key: "parts" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/prompt_async", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Send command * * Send a new command to a session for execution by the AI assistant. */ public command( parameters: { sessionID: string directory?: string workspace?: string messageID?: string agent?: string model?: string arguments?: string command?: string variant?: string parts?: Array<{ id?: string type: "file" mime: string filename?: string url: string source?: FilePartSource }> }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "messageID" }, { in: "body", key: "agent" }, { in: "body", key: "model" }, { in: "body", key: "arguments" }, { in: "body", key: "command" }, { in: "body", key: "variant" }, { in: "body", key: "parts" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/command", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Run shell command * * Execute a shell command within the session context and return the AI's response. */ public shell( parameters: { sessionID: string directory?: string workspace?: string messageID?: string agent?: string model?: { providerID: string modelID: string } command?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "messageID" }, { in: "body", key: "agent" }, { in: "body", key: "model" }, { in: "body", key: "command" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/shell", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Revert message * * Revert a specific message in a session, undoing its effects and restoring the previous state. */ public revert( parameters: { sessionID: string directory?: string workspace?: string messageID?: string partID?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "messageID" }, { in: "body", key: "partID" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/revert", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Restore reverted messages * * Restore all previously reverted messages in a session. */ public unrevert( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/session/{sessionID}/unrevert", ...options, ...params, }) } } export class Part extends HeyApiClient { /** * Delete a part from a message. */ public delete( parameters: { sessionID: string messageID: string partID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "path", key: "messageID" }, { in: "path", key: "partID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).delete({ url: "/session/{sessionID}/message/{messageID}/part/{partID}", ...options, ...params, }) } /** * Update a part in a message. */ public update( parameters: { sessionID: string messageID: string partID: string directory?: string workspace?: string part?: Part2 }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "path", key: "messageID" }, { in: "path", key: "partID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { key: "part", map: "body" }, ], }, ], ) return (options?.client ?? this.client).patch({ url: "/session/{sessionID}/message/{messageID}/part/{partID}", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class History extends HeyApiClient { /** * List sync events * * List sync events for all aggregates. Keys are aggregate IDs the client already knows about, values are the last known sequence ID. Events with seq > value are returned for those aggregates. Aggregates not listed in the input get their full history. */ public list( parameters?: { directory?: string workspace?: string body?: { [key: string]: number } }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { key: "body", map: "body" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/sync/history", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class Sync extends HeyApiClient { /** * Start workspace sync * * Start sync loops for workspaces in the current project that have active sessions. */ public start( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/sync/start", ...options, ...params, }) } /** * Replay sync events * * Validate and replay a complete sync event history. */ public replay( parameters?: { query_directory?: string workspace?: string body_directory?: string events?: Array<{ id: string aggregateID: string seq: number type: string data: { [key: string]: unknown } }> }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "query_directory", map: "directory", }, { in: "query", key: "workspace" }, { in: "body", key: "body_directory", map: "directory", }, { in: "body", key: "events" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/sync/replay", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } private _history?: History get history(): History { return (this._history ??= new History({ client: this.client })) } } export class Session3 extends HeyApiClient { /** * List v2 sessions * * Retrieve sessions in the requested order. Items keep that order across pages; use cursor.next or cursor.previous to move through the ordered list. */ public list( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/api/session", ...options, ...params, }) } /** * Send v2 message * * Create a v2 session message and queue it for the agent loop. */ public prompt( parameters: { sessionID: string directory?: string workspace?: string prompt?: Prompt delivery?: SessionDelivery }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "prompt" }, { in: "body", key: "delivery" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/api/session/{sessionID}/prompt", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Compact v2 session * * Compact a v2 session conversation. */ public compact( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/api/session/{sessionID}/compact", ...options, ...params, }) } /** * Wait for v2 session * * Wait for a v2 session agent loop to become idle. */ public wait( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/api/session/{sessionID}/wait", ...options, ...params, }) } /** * Get v2 session context * * Retrieve the active context messages for a v2 session (all messages after the last compaction). */ public context( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/api/session/{sessionID}/context", ...options, ...params, }) } /** * Get v2 session messages * * Retrieve projected v2 messages for a session. Items keep the requested order across pages; use cursor.next or cursor.previous to move through the ordered timeline. */ public messages( parameters: { sessionID: string directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "path", key: "sessionID" }, { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/api/session/{sessionID}/message", ...options, ...params, }) } } export class V2 extends HeyApiClient { private _session?: Session3 get session(): Session3 { return (this._session ??= new Session3({ client: this.client })) } } export class Control extends HeyApiClient { /** * Get next TUI request * * Retrieve the next TUI request from the queue for processing. */ public next( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).get({ url: "/tui/control/next", ...options, ...params, }) } /** * Submit TUI response * * Submit a response to the TUI request queue to complete a pending request. */ public response( parameters?: { directory?: string workspace?: string body?: unknown }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { key: "body", map: "body" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/control/response", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } } export class Tui extends HeyApiClient { /** * Append TUI prompt * * Append prompt to the TUI. */ public appendPrompt( parameters?: { directory?: string workspace?: string text?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "text" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/append-prompt", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Open help dialog * * Open the help dialog in the TUI to display user assistance information. */ public openHelp( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/open-help", ...options, ...params, }) } /** * Open sessions dialog * * Open the session dialog. */ public openSessions( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/open-sessions", ...options, ...params, }) } /** * Open themes dialog * * Open the theme dialog. */ public openThemes( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/open-themes", ...options, ...params, }) } /** * Open models dialog * * Open the model dialog. */ public openModels( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/open-models", ...options, ...params, }) } /** * Submit TUI prompt * * Submit the prompt. */ public submitPrompt( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/submit-prompt", ...options, ...params, }) } /** * Clear TUI prompt * * Clear the prompt. */ public clearPrompt( parameters?: { directory?: string workspace?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/clear-prompt", ...options, ...params, }) } /** * Execute TUI command * * Execute a TUI command. */ public executeCommand( parameters?: { directory?: string workspace?: string command?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "command" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/execute-command", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Show TUI toast * * Show a toast notification in the TUI. */ public showToast( parameters?: { directory?: string workspace?: string title?: string message?: string variant?: "info" | "success" | "warning" | "error" duration?: number }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "title" }, { in: "body", key: "message" }, { in: "body", key: "variant" }, { in: "body", key: "duration" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/show-toast", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Publish TUI event * * Publish a TUI event. */ public publish( parameters?: { directory?: string workspace?: string body?: EventTuiPromptAppend2 | EventTuiCommandExecute2 | EventTuiToastShow2 | EventTuiSessionSelect2 }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { key: "body", map: "body" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/publish", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } /** * Select session * * Navigate the TUI to display the specified session. */ public selectSession( parameters?: { directory?: string workspace?: string sessionID?: string }, options?: Options, ) { const params = buildClientParams( [parameters], [ { args: [ { in: "query", key: "directory" }, { in: "query", key: "workspace" }, { in: "body", key: "sessionID" }, ], }, ], ) return (options?.client ?? this.client).post({ url: "/tui/select-session", ...options, ...params, headers: { "Content-Type": "application/json", ...options?.headers, ...params.headers, }, }) } private _control?: Control get control(): Control { return (this._control ??= new Control({ client: this.client })) } } export class OpencodeClient extends HeyApiClient { public static readonly __registry = new HeyApiRegistry() constructor(args?: { client?: Client; key?: string }) { super(args) OpencodeClient.__registry.set(this, args?.key) } private _auth?: Auth get auth(): Auth { return (this._auth ??= new Auth({ client: this.client })) } private _app?: App get app(): App { return (this._app ??= new App({ client: this.client })) } private _global?: Global get global(): Global { return (this._global ??= new Global({ client: this.client })) } private _event?: Event get event(): Event { return (this._event ??= new Event({ client: this.client })) } private _config?: Config2 get config(): Config2 { return (this._config ??= new Config2({ client: this.client })) } private _experimental?: Experimental get experimental(): Experimental { return (this._experimental ??= new Experimental({ client: this.client })) } private _tool?: Tool get tool(): Tool { return (this._tool ??= new Tool({ client: this.client })) } private _worktree?: Worktree get worktree(): Worktree { return (this._worktree ??= new Worktree({ client: this.client })) } private _find?: Find get find(): Find { return (this._find ??= new Find({ client: this.client })) } private _file?: File get file(): File { return (this._file ??= new File({ client: this.client })) } private _instance?: Instance get instance(): Instance { return (this._instance ??= new Instance({ client: this.client })) } private _path?: Path get path(): Path { return (this._path ??= new Path({ client: this.client })) } private _vcs?: Vcs get vcs(): Vcs { return (this._vcs ??= new Vcs({ client: this.client })) } private _command?: Command get command(): Command { return (this._command ??= new Command({ client: this.client })) } private _lsp?: Lsp get lsp(): Lsp { return (this._lsp ??= new Lsp({ client: this.client })) } private _formatter?: Formatter get formatter(): Formatter { return (this._formatter ??= new Formatter({ client: this.client })) } private _mcp?: Mcp get mcp(): Mcp { return (this._mcp ??= new Mcp({ client: this.client })) } private _project?: Project get project(): Project { return (this._project ??= new Project({ client: this.client })) } private _pty?: Pty get pty(): Pty { return (this._pty ??= new Pty({ client: this.client })) } private _question?: Question get question(): Question { return (this._question ??= new Question({ client: this.client })) } private _permission?: Permission get permission(): Permission { return (this._permission ??= new Permission({ client: this.client })) } private _provider?: Provider get provider(): Provider { return (this._provider ??= new Provider({ client: this.client })) } private _session?: Session2 get session(): Session2 { return (this._session ??= new Session2({ client: this.client })) } private _part?: Part get part(): Part { return (this._part ??= new Part({ client: this.client })) } private _sync?: Sync get sync(): Sync { return (this._sync ??= new Sync({ client: this.client })) } private _v2?: V2 get v2(): V2 { return (this._v2 ??= new V2({ client: this.client })) } private _tui?: Tui get tui(): Tui { return (this._tui ??= new Tui({ client: this.client })) } }