@nimble-way/nimble-js 1.0.0 → 1.1.0

package/resources/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,4BAAyB;AACzB,OAAO,EACL,MAAM,EACN,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB,2BAAwB;AACzB,OAAO,EAAE,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,qBAAkB;AACvF,OAAO,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,cAAc,GACpB,mBAAgB;AACjB,OAAO,EACL,eAAe,EACf,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,GACpC,8BAA2B;AAC5B,OAAO,EACL,OAAO,EACP,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB,6BAA0B;AAC3B,OAAO,EAAE,QAAQ,EAAE,KAAK,mBAAmB,EAAE,KAAK,iBAAiB,EAAE,uBAAoB;AACzF,OAAO,EACL,IAAI,EACJ,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,uBAAoB;AACrB,OAAO,EACL,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB,mBAAgB;AACjB,OAAO,EACL,IAAI,EACJ,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,kBAAe;AAChB,OAAO,EACL,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,cAAc,GACpB,mBAAgB;AACjB,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,KAAK,YAAY,EAAE,uBAAoB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,4BAAyB;AACzB,OAAO,EACL,MAAM,EACN,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,cAAc,GACpB,2BAAwB;AACzB,OAAO,EAAE,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,qBAAkB;AACvF,OAAO,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,cAAc,GACpB,mBAAgB;AACjB,OAAO,EACL,eAAe,EACf,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,GACpC,8BAA2B;AAC5B,OAAO,EACL,OAAO,EACP,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB,6BAA0B;AAC3B,OAAO,EAAE,QAAQ,EAAE,KAAK,mBAAmB,EAAE,KAAK,iBAAiB,EAAE,uBAAoB;AACzF,OAAO,EACL,IAAI,EACJ,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,uBAAoB;AACrB,OAAO,EACL,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB,mBAAgB;AACjB,OAAO,EACL,IAAI,EACJ,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,kBAAe;AAChB,OAAO,EACL,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,cAAc,GACpB,mBAAgB;AACjB,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,KAAK,YAAY,EAAE,uBAAoB"}

package/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,6CASyB;AARvB,gGAAA,MAAM,OAAA;AASR,wCAAuF;AAA9E,kGAAA,OAAO,OAAA;AAChB,oCAQiB;AAPf,8FAAA,KAAK,OAAA;AAQP,0DAI4B;AAH1B,mHAAA,eAAe,OAAA;AAIjB,gDAQ2B;AAPzB,kGAAA,OAAO,OAAA;AAQT,4CAAyF;AAAhF,qGAAA,QAAQ,OAAA;AACjB,uCASqB;AARnB,4FAAA,IAAI,OAAA;AASN,oCAMiB;AALf,8FAAA,KAAK,OAAA;AAMP,kCAQgB;AAPd,4FAAA,IAAI,OAAA;AAQN,oCAMiB;AALf,8FAAA,KAAK,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,6CAWyB;AAVvB,gGAAA,MAAM,OAAA;AAWR,wCAAuF;AAA9E,kGAAA,OAAO,OAAA;AAChB,oCAQiB;AAPf,8FAAA,KAAK,OAAA;AAQP,0DAI4B;AAH1B,mHAAA,eAAe,OAAA;AAIjB,gDAQ2B;AAPzB,kGAAA,OAAO,OAAA;AAQT,4CAAyF;AAAhF,qGAAA,QAAQ,OAAA;AACjB,uCASqB;AARnB,4FAAA,IAAI,OAAA;AASN,oCAMiB;AALf,8FAAA,KAAK,OAAA;AAMP,kCAQgB;AAPd,4FAAA,IAAI,OAAA;AAQN,oCAMiB;AALf,8FAAA,KAAK,OAAA"}

package/resources/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,6BAAyB;AACzB,OAAO,EACL,MAAM,GAQP,4BAAwB;AACzB,OAAO,EAAE,OAAO,EAAqD,sBAAkB;AACvF,OAAO,EACL,KAAK,GAON,oBAAgB;AACjB,OAAO,EACL,eAAe,GAGhB,+BAA2B;AAC5B,OAAO,EACL,OAAO,GAOR,8BAA0B;AAC3B,OAAO,EAAE,QAAQ,EAAoD,wBAAoB;AACzF,OAAO,EACL,IAAI,GAQL,wBAAoB;AACrB,OAAO,EACL,KAAK,GAKN,oBAAgB;AACjB,OAAO,EACL,IAAI,GAOL,mBAAe;AAChB,OAAO,EACL,KAAK,GAKN,oBAAgB"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,6BAAyB;AACzB,OAAO,EACL,MAAM,GAUP,4BAAwB;AACzB,OAAO,EAAE,OAAO,EAAqD,sBAAkB;AACvF,OAAO,EACL,KAAK,GAON,oBAAgB;AACjB,OAAO,EACL,eAAe,GAGhB,+BAA2B;AAC5B,OAAO,EACL,OAAO,GAOR,8BAA0B;AAC3B,OAAO,EAAE,QAAQ,EAAoD,wBAAoB;AACzF,OAAO,EACL,IAAI,GAQL,wBAAoB;AACrB,OAAO,EACL,KAAK,GAKN,oBAAgB;AACjB,OAAO,EACL,IAAI,GAOL,mBAAe;AAChB,OAAO,EACL,KAAK,GAKN,oBAAgB"}

package/src/client.ts

@@ -64,6 +64,8 @@ import {
   AgentGetResponse,
   AgentListParams,
   AgentListResponse,
+  AgentRunParams,
+  AgentRunResponse,
   AgentUpdateParams,
   AgentUpdateResponse,
   Agents,
@@ -898,9 +900,11 @@ export declare namespace Nimble {
     type AgentUpdateResponse as AgentUpdateResponse,
     type AgentListResponse as AgentListResponse,
     type AgentGetResponse as AgentGetResponse,
+    type AgentRunResponse as AgentRunResponse,
     type AgentCreateParams as AgentCreateParams,
     type AgentUpdateParams as AgentUpdateParams,
     type AgentListParams as AgentListParams,
+    type AgentRunParams as AgentRunParams,
   };
 
   export {

package/src/resources/agents/agents.ts

@@ -80,6 +80,14 @@ export class Agents extends APIResource {
   get(agentID: string, options?: RequestOptions): APIPromise<AgentGetResponse> {
     return this._client.get(path`/v2/agents/${agentID}`, options);
   }
+
+  /**
+   * Creates a minimal persistent Web Search Agent and starts a run for it. The
+   * response includes `web_search_agent_id` for later agent and run queries.
+   */
+  run(body: AgentRunParams, options?: RequestOptions): APIPromise<AgentRunResponse> {
+    return this._client.post('/v2/agents/runs', { body, ...options });
+  }
 }
 
 export interface AgentCreateResponse {
@@ -103,11 +111,6 @@ export interface AgentCreateResponse {
    */
   display_name: string;
 
-  /**
-   * Domain expertise or operating context for the agent.
-   */
-  domain_expertise: string;
-
   /**
    * Default effort level for this agent's runs.
    */
@@ -133,6 +136,11 @@ export interface AgentCreateResponse {
    */
   output_schema: { [key: string]: unknown } | null;
 
+  /**
+   * Skill or operating context for the agent.
+   */
+  skill: string;
+
   /**
    * Source guidance for the agent.
    */
@@ -287,11 +295,6 @@ export interface AgentUpdateResponse {
    */
   display_name: string;
 
-  /**
-   * Domain expertise or operating context for the agent.
-   */
-  domain_expertise: string;
-
   /**
    * Default effort level for this agent's runs.
    */
@@ -317,6 +320,11 @@ export interface AgentUpdateResponse {
    */
   output_schema: { [key: string]: unknown } | null;
 
+  /**
+   * Skill or operating context for the agent.
+   */
+  skill: string;
+
   /**
    * Source guidance for the agent.
    */
@@ -494,11 +502,6 @@ export namespace AgentListResponse {
      */
     display_name: string;
 
-    /**
-     * Domain expertise or operating context for the agent.
-     */
-    domain_expertise: string;
-
     /**
      * Default effort level for this agent's runs.
      */
@@ -524,6 +527,11 @@ export namespace AgentListResponse {
      */
     output_schema: { [key: string]: unknown } | null;
 
+    /**
+     * Skill or operating context for the agent.
+     */
+    skill: string;
+
     /**
      * Source guidance for the agent.
      */
@@ -679,11 +687,6 @@ export interface AgentGetResponse {
    */
   display_name: string;
 
-  /**
-   * Domain expertise or operating context for the agent.
-   */
-  domain_expertise: string;
-
   /**
    * Default effort level for this agent's runs.
    */
@@ -709,6 +712,11 @@ export interface AgentGetResponse {
    */
   output_schema: { [key: string]: unknown } | null;
 
+  /**
+   * Skill or operating context for the agent.
+   */
+  skill: string;
+
   /**
    * Source guidance for the agent.
    */
@@ -842,6 +850,80 @@ export namespace AgentGetResponse {
   }
 }
 
+export interface AgentRunResponse {
+  /**
+   * Run identifier, format "task*run*{uuid}".
+   */
+  id: string;
+
+  /**
+   * When the run was created.
+   */
+  created_at: string;
+
+  /**
+   * Effort level used for the run.
+   */
+  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
+
+  /**
+   * Interaction ID.
+   */
+  interaction_id: string;
+
+  /**
+   * True while status is 'queued' or 'running'.
+   */
+  is_active: boolean;
+
+  /**
+   * Current run status.
+   */
+  status: 'queued' | 'running' | 'completed' | 'failed' | 'cancelled';
+
+  /**
+   * Web Search Agent instance this run belongs to.
+   */
+  web_search_agent_id: string;
+
+  /**
+   * When the run completed.
+   */
+  completed_at?: string | null;
+
+  /**
+   * Error details when the run failed.
+   */
+  error?: AgentRunResponse.Error | null;
+
+  /**
+   * Prompt submitted for the run.
+   */
+  prompt?: string | null;
+
+  /**
+   * When the run started executing.
+   */
+  started_at?: string | null;
+}
+
+export namespace AgentRunResponse {
+  /**
+   * Error details when the run failed.
+   */
+  export interface Error {
+    /**
+     * Human-readable error description.
+     */
+    message: string;
+
+    /**
+     * Reference ID (equals the run id).
+     */
+    ref_id: string;
+  }
+}
+
 export interface AgentCreateParams {
   /**
    * Stable agent name.
@@ -858,11 +940,6 @@ export interface AgentCreateParams {
    */
   display_name?: string | null;
 
-  /**
-   * Domain expertise or operating context for the agent.
-   */
-  domain_expertise?: string | null;
-
   /**
    * Default effort level for this agent's runs.
    */
@@ -888,6 +965,11 @@ export interface AgentCreateParams {
    */
   output_schema?: { [key: string]: unknown } | null;
 
+  /**
+   * Skill or operating context for the agent.
+   */
+  skill?: string | null;
+
   /**
    * Source guidance for the agent.
    */
@@ -1003,6 +1085,107 @@ export interface AgentListParams {
   workspace_id?: string | null;
 }
 
+export interface AgentRunParams {
+  /**
+   * User prompt or task instructions for the run.
+   */
+  input: string;
+
+  /**
+   * Canonical effort tier names for the research graph.
+   */
+  effort?: 'low' | 'medium' | 'high' | 'x-high' | 'max' | null;
+
+  /**
+   * Whether to stream run events when supported.
+   */
+  enable_events?: boolean;
+
+  /**
+   * Existing records to ENRICH: a list of partial rows, or a single object,
+   * mirroring output_schema's shape.
+   */
+  input_data?: Array<{ [key: string]: unknown }> | { [key: string]: unknown } | null;
+
+  /**
+   * JSON schema overriding the agent's default structured output for this run.
+   */
+  output_schema?: { [key: string]: unknown } | null;
+
+  /**
+   * Previous interaction identifier used to continue a conversation.
+   */
+  previous_interaction_id?: string | null;
+
+  /**
+   * Source guidance overriding the agent default.
+   */
+  sources?: AgentRunParams.Sources | null;
+}
+
+export namespace AgentRunParams {
+  /**
+   * Source guidance overriding the agent default.
+   */
+  export interface Sources {
+    /**
+     * Source groups the agent is allowed to use.
+     */
+    allow?: Array<Sources.Allow>;
+
+    /**
+     * Free-text guidance describing sources or domains to avoid.
+     */
+    avoid?: string | null;
+
+    /**
+     * Source groups the agent should not use.
+     */
+    block?: Array<Sources.Block>;
+
+    /**
+     * Free-text guidance describing sources or domains to prioritize.
+     */
+    prioritize?: string | null;
+  }
+
+  export namespace Sources {
+    export interface Allow {
+      /**
+       * Domains included in this source group.
+       */
+      domains: Array<string>;
+
+      /**
+       * Source group title.
+       */
+      title: string;
+
+      /**
+       * Zero-based source group position.
+       */
+      order?: number;
+    }
+
+    export interface Block {
+      /**
+       * Domains included in this source group.
+       */
+      domains: Array<string>;
+
+      /**
+       * Source group title.
+       */
+      title: string;
+
+      /**
+       * Zero-based source group position.
+       */
+      order?: number;
+    }
+  }
+}
+
 Agents.Templates = Templates;
 Agents.Runs = Runs;
 
@@ -1012,9 +1195,11 @@ export declare namespace Agents {
     type AgentUpdateResponse as AgentUpdateResponse,
     type AgentListResponse as AgentListResponse,
     type AgentGetResponse as AgentGetResponse,
+    type AgentRunResponse as AgentRunResponse,
     type AgentCreateParams as AgentCreateParams,
     type AgentUpdateParams as AgentUpdateParams,
     type AgentListParams as AgentListParams,
+    type AgentRunParams as AgentRunParams,
   };
 
   export {

package/src/resources/agents/index.ts

@@ -6,9 +6,11 @@ export {
   type AgentUpdateResponse,
   type AgentListResponse,
   type AgentGetResponse,
+  type AgentRunResponse,
   type AgentCreateParams,
   type AgentUpdateParams,
   type AgentListParams,
+  type AgentRunParams,
 } from './agents';
 export {
   Runs,

package/src/resources/agents/templates.ts

@@ -69,11 +69,6 @@ export namespace TemplateListResponse {
      */
     display_name: string;
 
-    /**
-     * Domain expertise or operating context for the template.
-     */
-    domain_expertise: string;
-
     /**
      * Default effort level for runs created from this template.
      */
@@ -94,6 +89,11 @@ export namespace TemplateListResponse {
      */
     output_schema: { [key: string]: unknown } | null;
 
+    /**
+     * Skill or operating context for the template.
+     */
+    skill: string;
+
     /**
      * Ordered source groups for the template.
      */
@@ -200,11 +200,6 @@ export interface TemplateGetResponse {
    */
   display_name: string;
 
-  /**
-   * Domain expertise or operating context for the template.
-   */
-  domain_expertise: string;
-
   /**
    * Default effort level for runs created from this template.
    */
@@ -225,6 +220,11 @@ export interface TemplateGetResponse {
    */
   output_schema: { [key: string]: unknown } | null;
 
+  /**
+   * Skill or operating context for the template.
+   */
+  skill: string;
+
   /**
    * Ordered source groups for the template.
    */

package/src/resources/index.ts

@@ -7,9 +7,11 @@ export {
   type AgentUpdateResponse,
   type AgentListResponse,
   type AgentGetResponse,
+  type AgentRunResponse,
   type AgentCreateParams,
   type AgentUpdateParams,
   type AgentListParams,
+  type AgentRunParams,
 } from './agents/agents';
 export { Batches, type BatchGetResponse, type BatchProgressResponse } from './batches';
 export {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.0.0'; // x-release-please-version
+export const VERSION = '1.1.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.0.0";
+export declare const VERSION = "1.1.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.0.0";
+export declare const VERSION = "1.1.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.0.0'; // x-release-please-version
+exports.VERSION = '1.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.0.0'; // x-release-please-version
+export const VERSION = '1.1.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map