// This file is auto-generated by @hey-api/openapi-ts /** * Add an extension to an active session. */ export type AddExtensionRequest = { sessionId: string; /** * Extension configuration (see ExtensionConfig variants: Stdio, StreamableHttp, Builtin, Platform). */ config?: unknown; }; /** * Empty success response for operations that return no data. */ export type EmptyResponse = { [key: string]: unknown; }; /** * Remove an extension from an active session. */ export type RemoveExtensionRequest = { sessionId: string; name: string; }; /** * List all tools available in a session. */ export type GetToolsRequest = { sessionId: string; }; /** * Tools response. */ export type GetToolsResponse = { /** * Array of tool info objects with `name`, `description`, `parameters`, and optional `permission`. */ tools: Array; }; /** * Read a resource from an extension. */ export type ReadResourceRequest = { sessionId: string; uri: string; extensionName: string; }; /** * Resource read response. */ export type ReadResourceResponse = { /** * The resource result from the extension (MCP ReadResourceResult). */ result?: unknown; }; /** * Update the working directory for a session. */ export type UpdateWorkingDirRequest = { sessionId: string; workingDir: string; }; /** * Delete a session. */ export type DeleteSessionRequest = { sessionId: string; }; /** * List configured extensions and any warnings. */ export type GetExtensionsRequest = { [key: string]: unknown; }; /** * List configured extensions and any warnings. */ export type GetExtensionsResponse = { /** * Array of ExtensionEntry objects with `enabled` flag, `configKey`, and flattened config details. */ extensions: Array; warnings: Array; }; /** * Persist a new extension to the user's global goose config. */ export type AddConfigExtensionRequest = { name: string; /** * Extension configuration. Must be a JSON object matching one of the * `ExtensionConfig` variants (e.g. `stdio`, `streamable_http`, `builtin`). * `name` and `enabled` are injected server-side. */ extensionConfig?: unknown; enabled?: boolean; }; /** * Remove a persisted extension from the user's global goose config. */ export type RemoveConfigExtensionRequest = { configKey: string; }; /** * Toggle the `enabled` flag for a persisted extension in the user's global goose config. */ export type ToggleConfigExtensionRequest = { configKey: string; enabled: boolean; }; export type GetSessionExtensionsRequest = { sessionId: string; }; export type GetSessionExtensionsResponse = { extensions: Array; }; /** * List providers with setup metadata and the current model inventory snapshot. */ export type ListProvidersRequest = { /** * Only return entries for these providers. Empty means all. */ providerIds?: Array; }; /** * Provider list response. */ export type ListProvidersResponse = { entries: Array; }; /** * Provider inventory entry. */ export type ProviderInventoryEntryDto = { /** * Provider identifier. */ providerId: string; /** * Human-readable provider name. */ providerName: string; /** * Description of the provider's capabilities. */ description: string; /** * The default/recommended model for this provider. */ defaultModel: string; /** * Whether Goose has enough configuration to use this provider. */ configured: boolean; /** * Provider classification such as `Preferred`, `Builtin`, `Declarative`, or `Custom`. */ providerType: string; /** * Required configuration keys and setup metadata. */ configKeys: Array; /** * Step-by-step setup instructions, when present. */ setupSteps: Array; /** * Whether this provider supports background inventory refresh. */ supportsRefresh: boolean; /** * Whether a refresh is currently in flight. */ refreshing: boolean; /** * The list of available models. */ models: Array; /** * When this entry was last successfully refreshed (ISO 8601). */ lastUpdatedAt?: string | null; /** * When a refresh was most recently attempted (ISO 8601). */ lastRefreshAttemptAt?: string | null; /** * The last refresh failure message, if any. */ lastRefreshError?: string | null; /** * Whether we believe this data may be outdated. */ stale: boolean; /** * Guidance message shown when this provider manages its own model selection externally. */ modelSelectionHint?: string | null; }; export type ProviderConfigKey = { name: string; required: boolean; secret: boolean; default?: string | null; oauthFlow?: boolean; deviceCodeFlow?: boolean; primary?: boolean; }; /** * A single model in provider inventory. */ export type ProviderInventoryModelDto = { /** * Model identifier as the provider knows it. */ id: string; /** * Human-readable display name. */ name: string; /** * Model family for grouping in UI. */ family?: string | null; /** * Context window size in tokens. */ contextLimit?: number | null; /** * Whether the model supports reasoning/extended thinking. */ reasoning?: boolean | null; /** * Whether this model should appear in the compact recommended picker. */ recommended?: boolean; }; /** * Trigger a background refresh of provider inventories. */ export type RefreshProviderInventoryRequest = { /** * Which providers to refresh. Empty means all known providers. */ providerIds?: Array; }; /** * Refresh acknowledgement. */ export type RefreshProviderInventoryResponse = { /** * Which providers will be refreshed. */ started: Array; /** * Which providers were skipped and why. */ skipped?: Array; }; export type RefreshProviderInventorySkipDto = { providerId: string; reason: RefreshProviderInventorySkipReasonDto; }; export type RefreshProviderInventorySkipReasonDto = 'unknown_provider' | 'not_configured' | 'does_not_support_refresh' | 'already_refreshing'; /** * Read saved configuration field values for one provider. */ export type ProviderConfigReadRequest = { providerId: string; }; export type ProviderConfigReadResponse = { fields: Array; }; export type ProviderConfigFieldValueDto = { key: string; value?: string | null; isSet: boolean; isSecret: boolean; required: boolean; }; /** * Return provider configured statuses. Empty provider_ids means all providers. */ export type ProviderConfigStatusRequest = { providerIds?: Array; }; export type ProviderConfigStatusResponse = { statuses: Array; }; export type ProviderConfigStatusDto = { providerId: string; isConfigured: boolean; }; /** * Save provider configuration fields and start an inventory refresh when supported. */ export type ProviderConfigSaveRequest = { providerId: string; fields: Array; }; export type ProviderConfigFieldUpdate = { key: string; value: string; }; export type ProviderConfigChangeResponse = { status: ProviderConfigStatusDto; refresh: RefreshProviderInventoryResponse; }; /** * Delete provider configuration fields and start an inventory refresh when supported. */ export type ProviderConfigDeleteRequest = { providerId: string; }; /** * Read a single non-secret config value. */ export type ReadConfigRequest = { key: string; }; /** * Config read response. */ export type ReadConfigResponse = { value?: unknown; }; /** * Upsert a single non-secret config value. */ export type UpsertConfigRequest = { key: string; value: unknown; }; /** * Remove a single non-secret config value. */ export type RemoveConfigRequest = { key: string; }; /** * Check whether a secret exists. Never returns the actual value. */ export type CheckSecretRequest = { key: string; }; /** * Secret check response. */ export type CheckSecretResponse = { exists: boolean; }; /** * Set a secret value (write-only). */ export type UpsertSecretRequest = { key: string; value: unknown; }; /** * Remove a secret. */ export type RemoveSecretRequest = { key: string; }; /** * Export a session as a JSON string. */ export type ExportSessionRequest = { sessionId: string; }; /** * Export session response — raw JSON of the goose session with `conversation`. */ export type ExportSessionResponse = { data: string; }; /** * Import a session from a JSON string. */ export type ImportSessionRequest = { data: string; }; /** * Import session response — metadata about the newly created session. */ export type ImportSessionResponse = { sessionId: string; title?: string | null; updatedAt?: string | null; messageCount: number; }; /** * Update the project association for a session. */ export type UpdateSessionProjectRequest = { sessionId: string; projectId?: string | null; }; /** * Rename a session. */ export type RenameSessionRequest = { sessionId: string; title: string; }; /** * Archive a session (soft delete). */ export type ArchiveSessionRequest = { sessionId: string; }; /** * Unarchive a previously archived session. */ export type UnarchiveSessionRequest = { sessionId: string; }; /** * Create a new source in an explicit target scope (global or project-scoped). */ export type CreateSourceRequest = { type: SourceType; name: string; description: string; content: string; global: boolean; /** * Absolute path to the project root. Required when `global` is false. */ projectDir?: string | null; }; /** * The type of source entity. */ export type SourceType = 'skill' | 'builtinSkill' | 'recipe' | 'subrecipe' | 'agent'; export type CreateSourceResponse = { source: SourceEntry; }; /** * A source discovered by Goose and backed by an on-disk path. Sources may be * either `global` (shared across all projects) or project-specific. */ export type SourceEntry = { type: SourceType; name: string; description: string; content: string; /** * Absolute path to the source on disk. A directory for skills, a file for * recipes and agents. */ directory: string; /** * True when the source lives in the user's global sources directory; false * when it lives inside a specific project. */ global: boolean; /** * Paths (absolute) of additional files that live alongside the source. * Only skills currently populate this; empty for other source types. */ supportingFiles?: Array; }; /** * List discovered sources. * * Today this endpoint only returns skills. If `type` is omitted, it defaults * to listing skill sources. Both global and project-scoped skills are included * when `project_dir` is set. */ export type ListSourcesRequest = { type?: SourceType | null; projectDir?: string | null; }; export type ListSourcesResponse = { sources: Array; }; /** * Update an existing source's name, description, and content by absolute path. */ export type UpdateSourceRequest = { type: SourceType; path: string; name: string; description: string; content: string; }; export type UpdateSourceResponse = { source: SourceEntry; }; /** * Delete a source and its on-disk directory by absolute path. */ export type DeleteSourceRequest = { type: SourceType; path: string; }; /** * Export a source at an absolute path as a portable JSON payload. */ export type ExportSourceRequest = { type: SourceType; path: string; }; export type ExportSourceResponse = { json: string; filename: string; }; /** * Import a source from a JSON export payload produced by `_goose/sources/export`. * The imported source is written into the explicit target scope; on name * collisions a `-imported` suffix is appended. */ export type ImportSourcesRequest = { data: string; global: boolean; projectDir?: string | null; }; export type ImportSourcesResponse = { sources: Array; }; /** * Transcribe audio via a dictation provider. */ export type DictationTranscribeRequest = { /** * Base64-encoded audio data */ audio: string; /** * MIME type (e.g. "audio/wav", "audio/webm") */ mimeType: string; /** * Provider to use: "openai", "groq", "elevenlabs", or "local" */ provider: string; }; /** * Transcription result. */ export type DictationTranscribeResponse = { text: string; }; /** * Get the configuration status of all dictation providers. */ export type DictationConfigRequest = { [key: string]: unknown; }; /** * Dictation config response — map of provider name to status. */ export type DictationConfigResponse = { providers: { [key: string]: DictationProviderStatusEntry; }; }; /** * Per-provider configuration status. */ export type DictationProviderStatusEntry = { configured: boolean; host?: string | null; description: string; usesProviderConfig: boolean; settingsPath?: string | null; configKey?: string | null; modelConfigKey?: string | null; defaultModel?: string | null; selectedModel?: string | null; availableModels?: Array; }; export type DictationModelOption = { id: string; label: string; description: string; }; /** * List available local Whisper models with their download status. */ export type DictationModelsListRequest = { [key: string]: unknown; }; export type DictationModelsListResponse = { models: Array; }; export type DictationLocalModelStatus = { id: string; label: string; description: string; sizeMb: number; downloaded: boolean; downloadInProgress: boolean; }; /** * Kick off a background download of a local Whisper model. */ export type DictationModelDownloadRequest = { modelId: string; }; /** * Poll the progress of an in-flight download. */ export type DictationModelDownloadProgressRequest = { modelId: string; }; export type DictationModelDownloadProgressResponse = { /** * None when no download is active for this model id. */ progress?: DictationDownloadProgress | null; }; export type DictationDownloadProgress = { bytesDownloaded: number; totalBytes: number; progressPercent: number; /** * serde lowercase of DownloadStatus: "downloading" | "completed" | "failed" | "cancelled" */ status: string; error?: string | null; }; /** * Cancel an in-flight download. */ export type DictationModelCancelRequest = { modelId: string; }; /** * Delete a downloaded local Whisper model from disk. */ export type DictationModelDeleteRequest = { modelId: string; }; /** * Persist the user's model selection for a given provider. */ export type DictationModelSelectRequest = { provider: string; modelId: string; }; export type ExtRequest = { id: string; method: string; params?: AddExtensionRequest | RemoveExtensionRequest | GetToolsRequest | ReadResourceRequest | UpdateWorkingDirRequest | DeleteSessionRequest | GetExtensionsRequest | AddConfigExtensionRequest | RemoveConfigExtensionRequest | ToggleConfigExtensionRequest | GetSessionExtensionsRequest | ListProvidersRequest | RefreshProviderInventoryRequest | ProviderConfigReadRequest | ProviderConfigStatusRequest | ProviderConfigSaveRequest | ProviderConfigDeleteRequest | ReadConfigRequest | UpsertConfigRequest | RemoveConfigRequest | CheckSecretRequest | UpsertSecretRequest | RemoveSecretRequest | ExportSessionRequest | ImportSessionRequest | UpdateSessionProjectRequest | RenameSessionRequest | ArchiveSessionRequest | UnarchiveSessionRequest | CreateSourceRequest | ListSourcesRequest | UpdateSourceRequest | DeleteSourceRequest | ExportSourceRequest | ImportSourcesRequest | DictationTranscribeRequest | DictationConfigRequest | DictationModelsListRequest | DictationModelDownloadRequest | DictationModelDownloadProgressRequest | DictationModelCancelRequest | DictationModelDeleteRequest | DictationModelSelectRequest | { [key: string]: unknown; } | null; }; export type ExtResponse = { id: string; result?: EmptyResponse | GetToolsResponse | ReadResourceResponse | GetExtensionsResponse | GetSessionExtensionsResponse | ListProvidersResponse | RefreshProviderInventoryResponse | ProviderConfigReadResponse | ProviderConfigStatusResponse | ProviderConfigChangeResponse | ReadConfigResponse | CheckSecretResponse | ExportSessionResponse | ImportSessionResponse | CreateSourceResponse | ListSourcesResponse | UpdateSourceResponse | ExportSourceResponse | ImportSourcesResponse | DictationTranscribeResponse | DictationConfigResponse | DictationModelsListResponse | DictationModelDownloadProgressResponse | unknown; } | { error: { code: number; message: string; data?: unknown; }; id: string; };