@bike4mind/sdk 1.1.2 → 1.3.0

package/dist/index.d.cts

@@ -119,7 +119,7 @@ interface paths {
     put?: never;
     /**
      * Execute a server-side tool
-     * @description Runs one of the built-in server-side tools (`weather_info`, `web_search`, `web_fetch`) and returns its result as JSON. Authenticate with a JWT access token only - API keys are NOT accepted on this endpoint. Rate-limited to 100 requests/hour per user, counted separately from other endpoints. `request_id` echoes the X-Request-ID response header.
+     * @description Runs one of the built-in server-side tools (`weather_info`, `web_search`, `web_fetch`, `decide`) and returns its result as JSON. Authenticate with a JWT access token only - API keys are NOT accepted on this endpoint. Rate-limited to 100 requests/hour per user, counted separately from other endpoints. `request_id` echoes the X-Request-ID response header.
      */
     post: operations['executeTool'];
     delete?: never;
@@ -332,7 +332,7 @@ interface paths {
     put?: never;
     /**
      * Start a file upload
-     * @description Registers a file and returns a presigned `upload_url`. Uploading is three steps: (1) call this endpoint with the file name, MIME type, and size in bytes; (2) `PUT` the raw bytes to `upload_url` before `upload_url_expires_at` - send no `Authorization` header, the URL signature is the credential, and do send a `Content-Type` matching `mime_type`; (3) poll `GET /api/v1/files/{id}` until `moderation_status` is `clean` (usually a few seconds after the PUT), then pass `id` wherever an endpoint takes a file id (for example `fabFileIds` and `referenceImageFabFileIds` on `POST /api/v1/image-edits`). Unsupported types, a size over the upload limit, or a size that would exceed your storage quota are rejected with 400 before any URL is issued. Authenticate with an API key (`b4m_live_`) carrying `files:write`, or a JWT.
+     * @description Registers a file and returns a presigned `upload_url`. Uploading is three steps: (1) call this endpoint with the file name, MIME type, and size in bytes; (2) `PUT` the raw bytes to `upload_url` before `upload_url_expires_at` - send no `Authorization` header, the URL signature is the credential, and do send a `Content-Type` matching `mime_type`; the URL is bound to `file_size`, so the body must be exactly that many bytes or storage refuses it with 403; (3) poll `GET /api/v1/files/{id}` until `moderation_status` is `clean` (usually a few seconds after the PUT), then pass `id` wherever an endpoint takes a file id (for example `fabFileIds` and `referenceImageFabFileIds` on `POST /api/v1/image-edits`). Unsupported types, a size over the upload limit, or a size that would exceed your storage quota are rejected with 400 before any URL is issued. Authenticate with an API key (`b4m_live_`) carrying `files:write`, or a JWT.
      */
     post: operations['createFileUpload'];
     delete?: never;
@@ -1335,6 +1335,21 @@ interface components {
         poll_url: string;
       };
     };
+    startAgentExecutionResponse403: {
+      error: string;
+      request_id?: string;
+      /**
+       * @deprecated
+       * @description Deprecated, sunset 2026-12-01. The `name` of whatever the server threw - usually one of our own error classes (`NotFoundError`, `UnprocessableEntityError`, ...), but on an unhandled 500 it can be a library or driver class name instead. Unstable by nature: these are internal names we rename at will, and the set is open. Documented only so the wire and this spec agree for the deprecation window; it is removed on the sunset date. Branch on the HTTP status, not on this.
+       */
+      name?: string;
+      /** @description API key scopes this route accepts. Holding any one of them satisfies it. */
+      required_scopes?: string[];
+      /** @description API key scopes this route also requires. Every one must be held, on top of `required_scopes`. */
+      also_required_scopes?: string[];
+      /** @enum {string} */
+      errorCode?: 'billing_organization_mismatch';
+    };
     /**
      * @example {
      *       "session_id": "<sessionId>",
@@ -1346,6 +1361,7 @@ interface components {
       message: string;
       model?: string;
       agent_id?: string;
+      /** @description The organization whose credit pool pays for this run. You must belong to it; a non-member gets 404. Omit it to bill your personal credits. An organization-billed API key always bills its own organization: omit this or set it to the key's; any other value is a 403 (`errorCode: billing_organization_mismatch`). */
       organization_id?: string;
       tools?: string[];
       max_iterations?: number;
@@ -1525,7 +1541,7 @@ interface components {
      */
     executeToolRequest: {
       /** @enum {string} */
-      toolName: 'weather_info' | 'web_search' | 'web_fetch';
+      toolName: 'weather_info' | 'web_search' | 'web_fetch' | 'decide';
       input: {
         [key: string]: unknown;
       };
@@ -1603,7 +1619,7 @@ interface components {
        */
       name?: string;
       /** @enum {string} */
-      errorCode?: 'unknown_model' | 'tool_search_unsupported' | 'all_tools_deferred' | 'deferred_tool_cache_control' | 'unknown_tool_reference';
+      errorCode?: 'unknown_model' | 'tool_search_unsupported' | 'all_tools_deferred' | 'deferred_tool_cache_control' | 'unknown_tool_reference' | 'tool_changes_unsupported' | 'invalid_tool_change';
     };
     createCompletionResponse422: {
       error: string;
@@ -1644,6 +1660,7 @@ interface components {
       messages: {
         /** @enum {string} */
         role: 'user' | 'assistant' | 'system';
+        /** @description A string, or an array of content blocks. A `system` message may instead hold only `tool_addition` / `tool_removal` blocks (`{ type, tool: { type: "tool_reference", name } }`) to load or unload a tool named in `tools` mid-conversation without invalidating the prompt cache. It must follow a user turn or an assistant turn ending in a tool search result, and be the last message or precede an assistant turn. Only on models whose `supports_tool_changes` is true and that are served by the direct Anthropic API; otherwise refused with `errorCode: "tool_changes_unsupported"` (or `invalid_tool_change` / `unknown_tool_reference` when malformed). */
         content: string | unknown[];
         cache?: boolean;
       }[];
@@ -2421,7 +2438,7 @@ interface components {
       /** @default [] */
       fabFileIds?: string[];
       referenceImageFabFileIds?: string[];
-      tools?: (('dice_roll' | 'image_generation' | 'edit_image' | 'music_generation' | 'audio_generation' | 'video_generation' | 'weather_info' | 'web_search' | 'web_fetch' | 'wolfram_alpha' | 'math_evaluate' | 'mermaid_chart' | 'current_datetime' | 'deep_research' | 'prompt_enhancement' | 'recharts' | 'edit_file' | 'blog_publish' | 'blog_edit' | 'blog_draft' | 'wikipedia_on_this_day' | 'moon_phase' | 'sunrise_sunset' | 'iss_tracker' | 'planet_visibility' | 'search_knowledge_base' | 'chess_engine' | 'retrieve_knowledge_content' | 'count_knowledge_base' | 'describe_knowledge_base' | 'list_my_data_lakes' | 'create_data_lake' | 'save_content_to_data_lake' | 'delegate_to_agent' | 'optihashi_schedule' | 'optihashi_formulate' | 'optihashi_edit_problem' | 'navigate_view' | 'generate_jupyter_notebook' | 'excel_generation' | 'fmp_financial_data' | 'bob_panel_read' | 'skill') | string)[];
+      tools?: (('dice_roll' | 'image_generation' | 'edit_image' | 'music_generation' | 'audio_generation' | 'video_generation' | 'weather_info' | 'web_search' | 'web_fetch' | 'wolfram_alpha' | 'math_evaluate' | 'mermaid_chart' | 'current_datetime' | 'deep_research' | 'prompt_enhancement' | 'recharts' | 'edit_file' | 'blog_publish' | 'blog_edit' | 'blog_draft' | 'wikipedia_on_this_day' | 'moon_phase' | 'sunrise_sunset' | 'iss_tracker' | 'planet_visibility' | 'search_knowledge_base' | 'chess_engine' | 'retrieve_knowledge_content' | 'count_knowledge_base' | 'describe_knowledge_base' | 'decide' | 'list_my_data_lakes' | 'create_data_lake' | 'save_content_to_data_lake' | 'delegate_to_agent' | 'optihashi_schedule' | 'optihashi_formulate' | 'optihashi_edit_problem' | 'navigate_view' | 'generate_jupyter_notebook' | 'excel_generation' | 'fmp_financial_data' | 'bob_panel_read' | 'skill') | string)[];
       /** @default 2 */
       safety_tolerance?: number;
       prompt_upsampling?: boolean;
@@ -4985,7 +5002,7 @@ interface operations {
           'application/json': components['schemas']['startAgentExecutionResponse202'];
         };
       };
-      /** @description No usable default chat model is configured and none was supplied. */
+      /** @description No usable default chat model is configured and none was supplied. An organization-billed API key bills an organization that no longer exists, or one its owner is no longer a member of; re-mint the key. */
       400: {
         headers: {
           /** @description Correlation id for this request; safe to log and quote in support requests. */
@@ -5019,15 +5036,27 @@ interface operations {
           'application/json': components['schemas']['ErrorResponse'];
         };
       };
-      /** @description The API key does not hold any of the required scopes. */
+      /** @description The API key holds neither the `ai:chat` nor the `ai:generate` scope, or an organization-billed API key names any organization but its own (`errorCode: billing_organization_mismatch`). */
       403: {
         headers: {
           /** @description Correlation id for this request; safe to log and quote in support requests. */
           'X-Request-ID'?: string;
+          /** @description Request quota per minute. */
+          'X-RateLimit-Limit-Minute'?: number;
+          /** @description Requests remaining in the current minute. */
+          'X-RateLimit-Remaining-Minute'?: number;
+          /** @description Unix epoch (seconds) when the minute window resets. */
+          'X-RateLimit-Reset-Minute'?: number;
+          /** @description Request quota per day. */
+          'X-RateLimit-Limit-Day'?: number;
+          /** @description Requests remaining in the current day. */
+          'X-RateLimit-Remaining-Day'?: number;
+          /** @description Unix epoch (seconds) when the day window resets. */
+          'X-RateLimit-Reset-Day'?: number;
           [name: string]: unknown;
         };
         content: {
-          'application/json': components['schemas']['ScopeForbiddenResponse'];
+          'application/json': components['schemas']['startAgentExecutionResponse403'];
         };
       };
       /** @description No session with the given `session_id` is owned by the caller, or `organization_id` names an organization the caller does not belong to. "Exists but is not yours" is reported as 404 too, so neither session ids nor org membership can be probed through this endpoint. */
@@ -6034,7 +6063,7 @@ interface operations {
           'text/event-stream': components['schemas']['createCompletionResponse200'];
         };
       };
-      /** @description Malformed or otherwise invalid request (no `errorCode`), or a `model` the caller cannot use (`errorCode: "unknown_model"`): not in the catalog or not available to the caller. List valid ids with `GET /api/v1/models`. Tool search requests are refused with: `tool_search_unsupported` (a server tool, `tool_reference` or echoed tool search block on a model that cannot serve tool search here), `all_tools_deferred` (every tool deferred and no server tool), `deferred_tool_cache_control` (`cache_control` on a deferred tool), `unknown_tool_reference` (a `tool_reference` naming a tool not in `tools`, or carrying no string `tool_name`). */
+      /** @description Malformed or otherwise invalid request (no `errorCode`), or a `model` the caller cannot use (`errorCode: "unknown_model"`): not in the catalog or not available to the caller. List valid ids with `GET /api/v1/models`. Tool search requests are refused with: `tool_search_unsupported` (a server tool, `tool_reference` or echoed tool search block on a model that cannot serve tool search here), `all_tools_deferred` (every tool deferred and no server tool), `deferred_tool_cache_control` (`cache_control` on a deferred tool), `unknown_tool_reference` (a `tool_reference` naming a tool not in `tools`, or carrying no string `tool_name`). Mid-conversation tool changes are refused with: `tool_changes_unsupported` (a `tool_addition` / `tool_removal` system message on a model that cannot serve it here), `invalid_tool_change` (a malformed block, or one placed where the provider does not accept it), and `unknown_tool_reference` (a changed tool not in `tools`). */
       400: {
         headers: {
           /** @description Correlation id for this request; safe to log and quote in support requests. */

package/dist/index.d.mts

@@ -119,7 +119,7 @@ interface paths {
     put?: never;
     /**
      * Execute a server-side tool
-     * @description Runs one of the built-in server-side tools (`weather_info`, `web_search`, `web_fetch`) and returns its result as JSON. Authenticate with a JWT access token only - API keys are NOT accepted on this endpoint. Rate-limited to 100 requests/hour per user, counted separately from other endpoints. `request_id` echoes the X-Request-ID response header.
+     * @description Runs one of the built-in server-side tools (`weather_info`, `web_search`, `web_fetch`, `decide`) and returns its result as JSON. Authenticate with a JWT access token only - API keys are NOT accepted on this endpoint. Rate-limited to 100 requests/hour per user, counted separately from other endpoints. `request_id` echoes the X-Request-ID response header.
      */
     post: operations['executeTool'];
     delete?: never;
@@ -332,7 +332,7 @@ interface paths {
     put?: never;
     /**
      * Start a file upload
-     * @description Registers a file and returns a presigned `upload_url`. Uploading is three steps: (1) call this endpoint with the file name, MIME type, and size in bytes; (2) `PUT` the raw bytes to `upload_url` before `upload_url_expires_at` - send no `Authorization` header, the URL signature is the credential, and do send a `Content-Type` matching `mime_type`; (3) poll `GET /api/v1/files/{id}` until `moderation_status` is `clean` (usually a few seconds after the PUT), then pass `id` wherever an endpoint takes a file id (for example `fabFileIds` and `referenceImageFabFileIds` on `POST /api/v1/image-edits`). Unsupported types, a size over the upload limit, or a size that would exceed your storage quota are rejected with 400 before any URL is issued. Authenticate with an API key (`b4m_live_`) carrying `files:write`, or a JWT.
+     * @description Registers a file and returns a presigned `upload_url`. Uploading is three steps: (1) call this endpoint with the file name, MIME type, and size in bytes; (2) `PUT` the raw bytes to `upload_url` before `upload_url_expires_at` - send no `Authorization` header, the URL signature is the credential, and do send a `Content-Type` matching `mime_type`; the URL is bound to `file_size`, so the body must be exactly that many bytes or storage refuses it with 403; (3) poll `GET /api/v1/files/{id}` until `moderation_status` is `clean` (usually a few seconds after the PUT), then pass `id` wherever an endpoint takes a file id (for example `fabFileIds` and `referenceImageFabFileIds` on `POST /api/v1/image-edits`). Unsupported types, a size over the upload limit, or a size that would exceed your storage quota are rejected with 400 before any URL is issued. Authenticate with an API key (`b4m_live_`) carrying `files:write`, or a JWT.
      */
     post: operations['createFileUpload'];
     delete?: never;
@@ -1335,6 +1335,21 @@ interface components {
         poll_url: string;
       };
     };
+    startAgentExecutionResponse403: {
+      error: string;
+      request_id?: string;
+      /**
+       * @deprecated
+       * @description Deprecated, sunset 2026-12-01. The `name` of whatever the server threw - usually one of our own error classes (`NotFoundError`, `UnprocessableEntityError`, ...), but on an unhandled 500 it can be a library or driver class name instead. Unstable by nature: these are internal names we rename at will, and the set is open. Documented only so the wire and this spec agree for the deprecation window; it is removed on the sunset date. Branch on the HTTP status, not on this.
+       */
+      name?: string;
+      /** @description API key scopes this route accepts. Holding any one of them satisfies it. */
+      required_scopes?: string[];
+      /** @description API key scopes this route also requires. Every one must be held, on top of `required_scopes`. */
+      also_required_scopes?: string[];
+      /** @enum {string} */
+      errorCode?: 'billing_organization_mismatch';
+    };
     /**
      * @example {
      *       "session_id": "<sessionId>",
@@ -1346,6 +1361,7 @@ interface components {
       message: string;
       model?: string;
       agent_id?: string;
+      /** @description The organization whose credit pool pays for this run. You must belong to it; a non-member gets 404. Omit it to bill your personal credits. An organization-billed API key always bills its own organization: omit this or set it to the key's; any other value is a 403 (`errorCode: billing_organization_mismatch`). */
       organization_id?: string;
       tools?: string[];
       max_iterations?: number;
@@ -1525,7 +1541,7 @@ interface components {
      */
     executeToolRequest: {
       /** @enum {string} */
-      toolName: 'weather_info' | 'web_search' | 'web_fetch';
+      toolName: 'weather_info' | 'web_search' | 'web_fetch' | 'decide';
       input: {
         [key: string]: unknown;
       };
@@ -1603,7 +1619,7 @@ interface components {
        */
       name?: string;
       /** @enum {string} */
-      errorCode?: 'unknown_model' | 'tool_search_unsupported' | 'all_tools_deferred' | 'deferred_tool_cache_control' | 'unknown_tool_reference';
+      errorCode?: 'unknown_model' | 'tool_search_unsupported' | 'all_tools_deferred' | 'deferred_tool_cache_control' | 'unknown_tool_reference' | 'tool_changes_unsupported' | 'invalid_tool_change';
     };
     createCompletionResponse422: {
       error: string;
@@ -1644,6 +1660,7 @@ interface components {
       messages: {
         /** @enum {string} */
         role: 'user' | 'assistant' | 'system';
+        /** @description A string, or an array of content blocks. A `system` message may instead hold only `tool_addition` / `tool_removal` blocks (`{ type, tool: { type: "tool_reference", name } }`) to load or unload a tool named in `tools` mid-conversation without invalidating the prompt cache. It must follow a user turn or an assistant turn ending in a tool search result, and be the last message or precede an assistant turn. Only on models whose `supports_tool_changes` is true and that are served by the direct Anthropic API; otherwise refused with `errorCode: "tool_changes_unsupported"` (or `invalid_tool_change` / `unknown_tool_reference` when malformed). */
         content: string | unknown[];
         cache?: boolean;
       }[];
@@ -2421,7 +2438,7 @@ interface components {
       /** @default [] */
       fabFileIds?: string[];
       referenceImageFabFileIds?: string[];
-      tools?: (('dice_roll' | 'image_generation' | 'edit_image' | 'music_generation' | 'audio_generation' | 'video_generation' | 'weather_info' | 'web_search' | 'web_fetch' | 'wolfram_alpha' | 'math_evaluate' | 'mermaid_chart' | 'current_datetime' | 'deep_research' | 'prompt_enhancement' | 'recharts' | 'edit_file' | 'blog_publish' | 'blog_edit' | 'blog_draft' | 'wikipedia_on_this_day' | 'moon_phase' | 'sunrise_sunset' | 'iss_tracker' | 'planet_visibility' | 'search_knowledge_base' | 'chess_engine' | 'retrieve_knowledge_content' | 'count_knowledge_base' | 'describe_knowledge_base' | 'list_my_data_lakes' | 'create_data_lake' | 'save_content_to_data_lake' | 'delegate_to_agent' | 'optihashi_schedule' | 'optihashi_formulate' | 'optihashi_edit_problem' | 'navigate_view' | 'generate_jupyter_notebook' | 'excel_generation' | 'fmp_financial_data' | 'bob_panel_read' | 'skill') | string)[];
+      tools?: (('dice_roll' | 'image_generation' | 'edit_image' | 'music_generation' | 'audio_generation' | 'video_generation' | 'weather_info' | 'web_search' | 'web_fetch' | 'wolfram_alpha' | 'math_evaluate' | 'mermaid_chart' | 'current_datetime' | 'deep_research' | 'prompt_enhancement' | 'recharts' | 'edit_file' | 'blog_publish' | 'blog_edit' | 'blog_draft' | 'wikipedia_on_this_day' | 'moon_phase' | 'sunrise_sunset' | 'iss_tracker' | 'planet_visibility' | 'search_knowledge_base' | 'chess_engine' | 'retrieve_knowledge_content' | 'count_knowledge_base' | 'describe_knowledge_base' | 'decide' | 'list_my_data_lakes' | 'create_data_lake' | 'save_content_to_data_lake' | 'delegate_to_agent' | 'optihashi_schedule' | 'optihashi_formulate' | 'optihashi_edit_problem' | 'navigate_view' | 'generate_jupyter_notebook' | 'excel_generation' | 'fmp_financial_data' | 'bob_panel_read' | 'skill') | string)[];
       /** @default 2 */
       safety_tolerance?: number;
       prompt_upsampling?: boolean;
@@ -4985,7 +5002,7 @@ interface operations {
           'application/json': components['schemas']['startAgentExecutionResponse202'];
         };
       };
-      /** @description No usable default chat model is configured and none was supplied. */
+      /** @description No usable default chat model is configured and none was supplied. An organization-billed API key bills an organization that no longer exists, or one its owner is no longer a member of; re-mint the key. */
       400: {
         headers: {
           /** @description Correlation id for this request; safe to log and quote in support requests. */
@@ -5019,15 +5036,27 @@ interface operations {
           'application/json': components['schemas']['ErrorResponse'];
         };
       };
-      /** @description The API key does not hold any of the required scopes. */
+      /** @description The API key holds neither the `ai:chat` nor the `ai:generate` scope, or an organization-billed API key names any organization but its own (`errorCode: billing_organization_mismatch`). */
       403: {
         headers: {
           /** @description Correlation id for this request; safe to log and quote in support requests. */
           'X-Request-ID'?: string;
+          /** @description Request quota per minute. */
+          'X-RateLimit-Limit-Minute'?: number;
+          /** @description Requests remaining in the current minute. */
+          'X-RateLimit-Remaining-Minute'?: number;
+          /** @description Unix epoch (seconds) when the minute window resets. */
+          'X-RateLimit-Reset-Minute'?: number;
+          /** @description Request quota per day. */
+          'X-RateLimit-Limit-Day'?: number;
+          /** @description Requests remaining in the current day. */
+          'X-RateLimit-Remaining-Day'?: number;
+          /** @description Unix epoch (seconds) when the day window resets. */
+          'X-RateLimit-Reset-Day'?: number;
           [name: string]: unknown;
         };
         content: {
-          'application/json': components['schemas']['ScopeForbiddenResponse'];
+          'application/json': components['schemas']['startAgentExecutionResponse403'];
         };
       };
       /** @description No session with the given `session_id` is owned by the caller, or `organization_id` names an organization the caller does not belong to. "Exists but is not yours" is reported as 404 too, so neither session ids nor org membership can be probed through this endpoint. */
@@ -6034,7 +6063,7 @@ interface operations {
           'text/event-stream': components['schemas']['createCompletionResponse200'];
         };
       };
-      /** @description Malformed or otherwise invalid request (no `errorCode`), or a `model` the caller cannot use (`errorCode: "unknown_model"`): not in the catalog or not available to the caller. List valid ids with `GET /api/v1/models`. Tool search requests are refused with: `tool_search_unsupported` (a server tool, `tool_reference` or echoed tool search block on a model that cannot serve tool search here), `all_tools_deferred` (every tool deferred and no server tool), `deferred_tool_cache_control` (`cache_control` on a deferred tool), `unknown_tool_reference` (a `tool_reference` naming a tool not in `tools`, or carrying no string `tool_name`). */
+      /** @description Malformed or otherwise invalid request (no `errorCode`), or a `model` the caller cannot use (`errorCode: "unknown_model"`): not in the catalog or not available to the caller. List valid ids with `GET /api/v1/models`. Tool search requests are refused with: `tool_search_unsupported` (a server tool, `tool_reference` or echoed tool search block on a model that cannot serve tool search here), `all_tools_deferred` (every tool deferred and no server tool), `deferred_tool_cache_control` (`cache_control` on a deferred tool), `unknown_tool_reference` (a `tool_reference` naming a tool not in `tools`, or carrying no string `tool_name`). Mid-conversation tool changes are refused with: `tool_changes_unsupported` (a `tool_addition` / `tool_removal` system message on a model that cannot serve it here), `invalid_tool_change` (a malformed block, or one placed where the provider does not accept it), and `unknown_tool_reference` (a changed tool not in `tools`). */
       400: {
         headers: {
           /** @description Correlation id for this request; safe to log and quote in support requests. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bike4mind/sdk",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "description": "Typed client for the Bike4Mind HTTP API, generated from its OpenAPI spec",
   "license": "BUSL-1.1",
   "author": "Bike4Mind",