// This file is auto-generated by @hey-api/openapi-ts export type ClientOptions = { baseUrl: `${string}://${string}` | (string & {}); }; export type ActionRequired = { data: ActionRequiredData; }; export type ActionRequiredData = { actionType: 'toolConfirmation'; arguments: JsonObject; id: string; prompt?: string | null; toolName: string; } | { actionType: 'elicitation'; id: string; message: string; requested_schema: unknown; } | { actionType: 'elicitationResponse'; id: string; user_data: unknown; }; export type AddExtensionRequest = { config: ExtensionConfig; session_id: string; }; export type Annotations = { audience?: Array; lastModified?: string; priority?: number; }; export type Author = { contact?: string | null; metadata?: string | null; }; export type AuthorRequest = { contact?: string | null; metadata?: string | null; }; export type CallToolRequest = { arguments: unknown; name: string; session_id: string; }; export type CallToolResponse = { _meta?: unknown; content: Array; isError: boolean; structuredContent?: unknown; }; export type CancelRequest = { request_id: string; }; export type ChatRequest = { /** * Override the server's conversation history. Only use this when you need absolute control * over the conversation state (e.g., administrative tools). For normal operations, the server * is the source of truth - use truncate/fork endpoints to modify conversation history instead. */ override_conversation?: Array | null; recipe_name?: string | null; recipe_version?: string | null; session_id: string; user_message: Message; }; export type CheckProviderRequest = { provider: string; }; export type CommandType = 'Builtin' | 'Recipe' | 'Skill' | 'Agent'; /** * Configuration key metadata for provider setup */ export type ConfigKey = { /** * Optional default value for the key */ default?: string | null; /** * Whether this OAuth flow uses the device code grant (RFC 8628) * When true, the user must enter a verification code in the browser */ device_code_flow?: boolean; /** * The name of the configuration key (e.g., "API_KEY") */ name: string; /** * Whether this key should be configured using an OAuth flow * When true, the provider's configure_oauth() method will be called instead of prompting for manual input */ oauth_flow: boolean; /** * Whether this key should be shown prominently during provider setup * (onboarding, settings modal, CLI configure) */ primary?: boolean; /** * Whether this key is required for the provider to function */ required: boolean; /** * Whether this key should be stored securely (e.g., in keychain) */ secret: boolean; }; export type ConfigKeyQuery = { is_secret: boolean; key: string; }; export type ConfigResponse = { config: { [key: string]: unknown; }; }; export type ConfirmToolActionRequest = { action: Permission; id: string; principalType?: PrincipalType; sessionId: string; }; export type Content = ({ type: 'text'; } & RawTextContent) | ({ type: 'image'; } & RawImageContent) | ({ type: 'resource'; } & RawEmbeddedResource) | ({ type: 'audio'; } & RawAudioContent) | ({ type: 'resource_link'; } & RawResource); export type ContentBlock = ({ type: 'text'; } & RawTextContent) | ({ type: 'image'; } & RawImageContent) | ({ type: 'resource'; } & RawEmbeddedResource) | ({ type: 'audio'; } & RawAudioContent) | ({ type: 'resource_link'; } & RawResource); export type Conversation = Array; export type CreateCustomProviderResponse = { provider_name: string; }; export type CreateRecipeRequest = { author?: AuthorRequest | null; session_id: string; }; export type CreateRecipeResponse = { error?: string | null; recipe?: Recipe | null; }; export type CreateScheduleRequest = { cron: string; id: string; recipe: Recipe; }; /** * Content Security Policy metadata for MCP Apps * Specifies allowed domains for network connections and resource loading */ export type CspMetadata = { /** * Domains allowed for base-uri */ baseUriDomains?: Array | null; /** * Domains allowed for connect-src (fetch, XHR, WebSocket) */ connectDomains?: Array | null; /** * Domains allowed for frame-src (nested iframes) */ frameDomains?: Array | null; /** * Domains allowed for resource loading (scripts, styles, images, fonts, media) */ resourceDomains?: Array | null; }; export type DeclarativeProviderConfig = { api_key_env?: string; base_path?: string | null; base_url: string; catalog_provider_id?: string | null; description?: string | null; display_name: string; dynamic_models?: boolean | null; engine: ProviderEngine; env_vars?: Array | null; fast_model?: string | null; headers?: { [key: string]: string; } | null; model_doc_link?: string | null; models: Array; name: string; requires_auth?: boolean; setup_steps?: Array; skip_canonical_filtering?: boolean; supports_streaming?: boolean | null; timeout_seconds?: number | null; }; export type DecodeRecipeRequest = { deeplink: string; }; export type DecodeRecipeResponse = { recipe: Recipe; }; export type DeleteRecipeRequest = { id: string; }; export type DictationProvider = 'openai' | 'elevenlabs' | 'groq' | 'local'; export type DictationProviderStatus = { /** * Config key name if uses_provider_config is false */ config_key?: string | null; /** * Whether the provider is fully configured and ready to use */ configured: boolean; /** * Description of what this provider does */ description: string; /** * Custom host URL if configured (only for providers that support it) */ host?: string | null; /** * Path to settings if uses_provider_config is true */ settings_path?: string | null; /** * Whether this provider uses the main provider config (true) or has its own key (false) */ uses_provider_config: boolean; }; export type DownloadModelRequest = { /** * Model spec like "bartowski/Llama-3.2-3B-Instruct-GGUF:Q4_K_M" */ spec: string; }; export type DownloadProgress = { /** * Bytes downloaded so far */ bytes_downloaded: number; /** * Error message if failed */ error?: string | null; /** * Estimated time remaining in seconds */ eta_seconds?: number | null; /** * Model ID being downloaded */ model_id: string; /** * Download progress percentage (0-100) */ progress_percent: number; /** * Download speed in bytes per second */ speed_bps?: number | null; status: DownloadStatus; /** * Total bytes to download */ total_bytes: number; }; export type DownloadStatus = 'downloading' | 'completed' | 'failed' | 'cancelled'; export type EmbeddedResource = { _meta?: { [key: string]: unknown; }; annotations?: Annotations | { [key: string]: unknown; }; resource: ResourceContents; }; export type EncodeRecipeRequest = { recipe: Recipe; }; export type EncodeRecipeResponse = { deeplink: string; }; export type EnvVarConfig = { default?: string | null; description?: string | null; name: string; /** * When true, the field is shown prominently in the UI (not collapsed). * Defaults to the value of `required` if not specified. */ primary?: boolean | null; required?: boolean; secret?: boolean; }; export type Envs = { [key: string]: string; }; export type ErrorResponse = { message: string; }; /** * Represents the different types of MCP extensions that can be added to the manager */ export type ExtensionConfig = { description: string; name: string; type: 'sse'; uri?: string | null; } | { args: Array; available_tools?: Array; bundled?: boolean | null; cmd: string; description: string; env_keys?: Array; envs?: Envs; /** * The name used to identify this extension */ name: string; timeout?: number | null; type: 'stdio'; } | { available_tools?: Array; bundled?: boolean | null; description: string; display_name?: string | null; /** * The name used to identify this extension */ name: string; timeout?: number | null; type: 'builtin'; } | { available_tools?: Array; bundled?: boolean | null; description: string; display_name?: string | null; /** * The name used to identify this extension */ name: string; type: 'platform'; } | { available_tools?: Array; bundled?: boolean | null; description: string; env_keys?: Array; envs?: Envs; headers?: { [key: string]: string; }; /** * The name used to identify this extension */ name: string; /** * Optional Unix domain socket path for HTTP-over-UDS transport. * When set, the HTTP connection is routed through this socket while * `uri` is used for the Host header and path. * Use `@name` for Linux abstract sockets. */ socket?: string | null; timeout?: number | null; type: 'streamable_http'; uri: string; } | { available_tools?: Array; bundled?: boolean | null; description: string; /** * Instructions for how to use these tools */ instructions?: string | null; /** * The name used to identify this extension */ name: string; /** * The tools provided by the frontend */ tools: Array; type: 'frontend'; } | { available_tools?: Array; /** * The Python code to execute */ code: string; /** * Python package dependencies required by this extension */ dependencies?: Array | null; description: string; /** * The name used to identify this extension */ name: string; /** * Timeout in seconds */ timeout?: number | null; type: 'inline_python'; }; /** * Extension data containing all extension states * Keys are in format "extension_name.version" (e.g., "todo.v0") */ export type ExtensionData = { [key: string]: unknown; }; export type ExtensionEntry = ExtensionConfig & { enabled: boolean; }; export type ExtensionLoadResult = { error?: string | null; name: string; success: boolean; }; export type ExtensionQuery = { config: ExtensionConfig; enabled: boolean; name: string; }; export type ExtensionResponse = { extensions: Array; warnings?: Array; }; export type FeaturesResponse = { /** * Map of feature name to enabled status */ features: { [key: string]: boolean; }; }; export type ForkRequest = { copy: boolean; timestamp?: number | null; truncate: boolean; }; export type ForkResponse = { sessionId: string; }; export type FrontendToolRequest = { id: string; toolCall: { [key: string]: unknown; }; }; export type GetToolsQuery = { extension_name?: string | null; session_id: string; }; export type GooseApp = McpAppResource & (WindowProps | null) & { mcpServers?: Array; prd?: string | null; }; export type GooseMode = 'auto' | 'approve' | 'smart_approve' | 'chat'; /** * A single downloadable GGUF file (used internally and for downloads). */ export type HfGgufFile = { download_url: string; filename: string; quantization: string; size_bytes: number; }; export type HfModelInfo = { author: string; downloads: number; gguf_files: Array; model_name: string; repo_id: string; }; /** * A quantization variant — groups sharded files into one logical entry. */ export type HfQuantVariant = { description: string; download_url: string; filename: string; quality_rank: number; quantization: string; sharded?: boolean; size_bytes: number; }; export type Icon = { mimeType?: string; sizes?: Array; src: string; theme?: IconTheme | { [key: string]: unknown; }; }; export type IconTheme = 'light' | 'dark'; export type ImageContent = { _meta?: { [key: string]: unknown; }; annotations?: Annotations | { [key: string]: unknown; }; data: string; mimeType: string; }; export type ImportAppRequest = { html: string; }; export type ImportAppResponse = { message: string; name: string; }; export type ImportSessionRequest = { json: string; }; export type InspectJobResponse = { processStartTime?: string | null; runningDurationSeconds?: number | null; sessionId?: string | null; }; export type JsonObject = { [key: string]: unknown; }; export type KillJobResponse = { message: string; }; export type ListAppsRequest = { session_id?: string | null; }; export type ListAppsResponse = { apps: Array; }; export type ListRecipeResponse = { manifests: Array; }; export type ListSchedulesResponse = { jobs: Array; }; export type LoadedProvider = { config: DeclarativeProviderConfig; is_editable: boolean; }; export type LocalModelResponse = { filename: string; id: string; mmproj_status?: ModelDownloadStatus | null; quantization: string; recommended: boolean; repo_id: string; settings: ModelSettings; size_bytes: number; status: ModelDownloadStatus; vision_capable: boolean; }; /** * MCP App Resource * Represents a UI resource that can be rendered in an MCP App */ export type McpAppResource = { _meta?: ResourceMetadata | null; /** * Base64-encoded binary content (alternative to text) */ blob?: string | null; /** * Optional description of what this resource does */ description?: string | null; /** * MIME type (should be "text/html;profile=mcp-app" for MCP Apps) */ mimeType: string; /** * Human-readable name of the resource */ name: string; /** * Text content of the resource (HTML for MCP Apps) */ text?: string | null; /** * URI of the resource (must use ui:// scheme) */ uri: string; }; /** * A message to or from an LLM */ export type Message = { content: Array; created: number; id?: string | null; metadata: MessageMetadata; role: Role; }; /** * Content passed inside a message, which can be both simple content and tool content */ export type MessageContent = (TextContent & { type: 'text'; }) | (ImageContent & { type: 'image'; }) | (ToolRequest & { type: 'toolRequest'; }) | (ToolResponse & { type: 'toolResponse'; }) | (ToolConfirmationRequest & { type: 'toolConfirmationRequest'; }) | (ActionRequired & { type: 'actionRequired'; }) | (FrontendToolRequest & { type: 'frontendToolRequest'; }) | (ThinkingContent & { type: 'thinking'; }) | (RedactedThinkingContent & { type: 'redactedThinking'; }) | (SystemNotificationContent & { type: 'systemNotification'; }); export type MessageEvent = { message: Message; token_state: TokenState; type: 'Message'; } | { error: string; type: 'Error'; } | { reason: string; token_state: TokenState; type: 'Finish'; } | { message: { [key: string]: unknown; }; request_id: string; type: 'Notification'; } | { conversation: Conversation; type: 'UpdateConversation'; } | { request_ids: Array; type: 'ActiveRequests'; } | { type: 'Ping'; }; /** * Metadata for message visibility */ export type MessageMetadata = { /** * Whether the message should be included in the agent's context window */ agentVisible: boolean; /** * Whether the message should be visible to the user in the UI */ userVisible: boolean; }; export type ModelCapabilities = { attachment: boolean; reasoning: boolean; temperature: boolean; tool_call: boolean; }; export type ModelConfig = { context_limit?: number | null; max_tokens?: number | null; model_name: string; reasoning?: boolean | null; /** * Provider-specific request parameters (e.g., anthropic_beta headers) */ request_params?: { [key: string]: unknown; } | null; temperature?: number | null; toolshim: boolean; toolshim_model?: string | null; }; export type ModelDownloadStatus = { state: 'NotDownloaded'; } | { bytes_downloaded: number; progress_percent: number; speed_bps?: number | null; state: 'Downloading'; total_bytes: number; } | { state: 'Downloaded'; }; /** * Information about a model's capabilities */ export type ModelInfo = { /** * The maximum context length this model supports */ context_limit: number; /** * Currency for the costs (default: "$") */ currency?: string | null; /** * Cost per token for input in USD (optional) */ input_token_cost?: number | null; /** * The name of the model */ name: string; /** * Cost per token for output in USD (optional) */ output_token_cost?: number | null; /** * Whether this model supports cache control */ supports_cache_control?: boolean | null; }; export type ModelInfoData = { cache_read_token_cost?: number | null; cache_write_token_cost?: number | null; context_limit: number; currency: string; input_token_cost?: number | null; max_output_tokens?: number | null; model: string; output_token_cost?: number | null; provider: string; }; export type ModelInfoQuery = { model: string; provider: string; }; export type ModelInfoResponse = { model_info?: ModelInfoData | null; source: string; }; export type ModelSettings = { context_size?: number | null; enable_thinking?: boolean; flash_attention?: boolean | null; frequency_penalty?: number; /** * Estimated tokens per image for budget planning before mtmd tokenization. * The actual count is determined after tokenization via `chunks.total_tokens()`. */ image_token_estimate?: number; max_output_tokens?: number | null; /** * Size of the mmproj file in bytes, used for memory accounting. */ mmproj_size_bytes?: number; n_batch?: number | null; n_gpu_layers?: number | null; n_threads?: number | null; native_tool_calling?: boolean; presence_penalty?: number; repeat_last_n?: number; repeat_penalty?: number; sampling?: SamplingConfig; use_jinja?: boolean; use_mlock?: boolean; /** * Whether this model architecture supports vision input. * Derived from the featured model table, not user-configurable. */ vision_capable?: boolean; }; export type ModelTemplate = { capabilities: ModelCapabilities; context_limit: number; deprecated: boolean; id: string; name: string; }; export type ParseRecipeRequest = { content: string; }; export type ParseRecipeResponse = { recipe: Recipe; }; export type Permission = 'always_allow' | 'allow_once' | 'cancel' | 'deny_once' | 'always_deny'; /** * Enum representing the possible permission levels for a tool. */ export type PermissionLevel = 'always_allow' | 'ask_before' | 'never_allow'; /** * Sandbox permissions for MCP Apps * Specifies which browser capabilities the UI needs access to. * Maps to the iframe Permission Policy `allow` attribute. */ export type PermissionsMetadata = { /** * Request camera access (maps to Permission Policy `camera` feature) */ camera?: boolean; /** * Request clipboard write access (maps to Permission Policy `clipboard-write` feature) */ clipboardWrite?: boolean; /** * Request geolocation access (maps to Permission Policy `geolocation` feature) */ geolocation?: boolean; /** * Request microphone access (maps to Permission Policy `microphone` feature) */ microphone?: boolean; }; export type PrincipalType = 'Extension' | 'Tool'; export type PromptContentResponse = { content: string; default_content: string; is_customized: boolean; name: string; }; export type PromptsListResponse = { prompts: Array