@orq-ai/node 4.0.2 → 4.0.5

package/packages/orq-rc/docs/sdks/responses/README.md

@@ -5,15 +5,15 @@
 
 ### Available Operations
 
-* [create](#create) - Create an agent response
+* [create](#create) - Create response
 
 ## create
 
-Creates a new response representing an agent interaction. A response tracks the conversation from the initial message until the agent becomes inactive or errors. Supports both synchronous (waiting) and asynchronous (background) execution modes.
+Initiates an agent conversation and returns a complete response. This endpoint manages the full lifecycle of an agent interaction, from receiving the initial message through all processing steps until completion. Supports synchronous execution (waits for completion) and asynchronous execution (returns immediately with task ID). The response includes all messages exchanged, tool calls made, and token usage statistics. Ideal for request-response patterns where you need the complete interaction result.
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="CreateAgentResponse" method="post" path="/v2/agents/{agent_key}/responses" -->
+<!-- UsageSnippet language="typescript" operationID="CreateAgentResponseRequest" method="post" path="/v2/agents/{agent_key}/responses" -->
 ```typescript
 import { Orq } from "@orq-ai/node";
 
@@ -22,36 +22,33 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.agents.responses.create({
-    agentKey: "<value>",
-    requestBody: {
-      message: {
-        role: "user",
-        parts: [],
-      },
-      contact: {
-        id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
-        displayName: "Jane Doe",
-        email: "jane.doe@example.com",
-        metadata: [
-          {
-            "department": "Engineering",
-            "role": "Senior Developer",
-          },
-        ],
-        logoUrl: "https://example.com/avatars/jane-doe.jpg",
-        tags: [
-          "hr",
-          "engineering",
-        ],
-      },
-      thread: {
-        id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
-        tags: [
-          "customer-support",
-          "priority-high",
-        ],
-      },
+  const result = await orq.agents.responses.create("<value>", {
+    message: {
+      role: "tool",
+      parts: [],
+    },
+    contact: {
+      id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
+      displayName: "Jane Doe",
+      email: "jane.doe@example.com",
+      metadata: [
+        {
+          "department": "Engineering",
+          "role": "Senior Developer",
+        },
+      ],
+      logoUrl: "https://example.com/avatars/jane-doe.jpg",
+      tags: [
+        "hr",
+        "engineering",
+      ],
+    },
+    thread: {
+      id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
+      tags: [
+        "customer-support",
+        "priority-high",
+      ],
     },
   });
 
@@ -76,36 +73,33 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await agentsResponsesCreate(orq, {
-    agentKey: "<value>",
-    requestBody: {
-      message: {
-        role: "user",
-        parts: [],
-      },
-      contact: {
-        id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
-        displayName: "Jane Doe",
-        email: "jane.doe@example.com",
-        metadata: [
-          {
-            "department": "Engineering",
-            "role": "Senior Developer",
-          },
-        ],
-        logoUrl: "https://example.com/avatars/jane-doe.jpg",
-        tags: [
-          "hr",
-          "engineering",
-        ],
-      },
-      thread: {
-        id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
-        tags: [
-          "customer-support",
-          "priority-high",
-        ],
-      },
+  const res = await agentsResponsesCreate(orq, "<value>", {
+    message: {
+      role: "tool",
+      parts: [],
+    },
+    contact: {
+      id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
+      displayName: "Jane Doe",
+      email: "jane.doe@example.com",
+      metadata: [
+        {
+          "department": "Engineering",
+          "role": "Senior Developer",
+        },
+      ],
+      logoUrl: "https://example.com/avatars/jane-doe.jpg",
+      tags: [
+        "hr",
+        "engineering",
+      ],
+    },
+    thread: {
+      id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
+      tags: [
+        "customer-support",
+        "priority-high",
+      ],
     },
   });
   if (res.ok) {
@@ -123,14 +117,15 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateAgentResponseRequest](../../models/operations/createagentresponserequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `agentKey`                                                                                                                                                                     | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The unique key of identifier of the agent to invoke                                                                                                                            |
+| `requestBody`                                                                                                                                                                  | [operations.CreateAgentResponseRequestRequestBody](../../models/operations/createagentresponserequestrequestbody.md)                                                           | :heavy_minus_sign:                                                                                                                                                             | N/A                                                                                                                                                                            |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.CreateAgentResponseResponseBody](../../models/operations/createagentresponseresponsebody.md)\>**
+**Promise\<[operations.CreateAgentResponseRequestResponseBody](../../models/operations/createagentresponserequestresponsebody.md)\>**
 
 ### Errors
 

package/packages/orq-rc/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "@orq-ai/node",
-      "version": "4.0.0-rc.68",
+      "version": "4.1.0-rc.0",
       "dependencies": {
         "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
         "zod": "^3.25.0 || ^4.0.0"

package/packages/orq-rc/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@orq-ai/node",
-  "version": "4.0.0-rc.68",
+  "version": "4.1.0-rc.0",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/packages/orq-rc/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@orq-ai/node",
-  "version": "4.0.0-rc.68",
+  "version": "4.1.0-rc.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@orq-ai/node",
-      "version": "4.0.0-rc.68",
+      "version": "4.1.0-rc.0",
       "dependencies": {
         "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
         "zod": "^3.25.0 || ^4.0.0"

package/packages/orq-rc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orq-ai/node",
-  "version": "4.0.0-rc.68",
+  "version": "4.1.0-rc.0",
   "author": "Orq",
   "bin": {
     "mcp": "bin/mcp-server.js"

package/packages/orq-rc/src/funcs/agentsCreate.ts

@@ -26,19 +26,19 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a new agent
+ * Create agent
  *
  * @remarks
- * Creates a new AI agent with specified configuration. Agents can be configured with a primary model and an optional fallback model that will be used automatically if the primary model fails.
+ * Creates a new agent with the specified configuration, including model selection, instructions, tools, and knowledge bases. Agents are intelligent assistants that can execute tasks, interact with tools, and maintain context through memory stores. The agent can be configured with a primary model and optional fallback models for automatic failover, custom instructions for behavior control, and various settings to control execution limits and tool usage.
  */
 export function agentsCreate(
   client: OrqCore,
-  request?: operations.CreateAgentRequestBody | undefined,
+  request?: operations.CreateAgentRequestRequestBody | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateAgentResponseBody,
-    | errors.CreateAgentResponseBody
+    operations.CreateAgentRequestResponseBody,
+    | errors.CreateAgentRequestResponseBody
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -58,13 +58,13 @@ export function agentsCreate(
 
 async function $do(
   client: OrqCore,
-  request?: operations.CreateAgentRequestBody | undefined,
+  request?: operations.CreateAgentRequestRequestBody | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.CreateAgentResponseBody,
-      | errors.CreateAgentResponseBody
+      operations.CreateAgentRequestResponseBody,
+      | errors.CreateAgentRequestResponseBody
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -80,7 +80,9 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.CreateAgentRequestBody$outboundSchema.optional().parse(value),
+      operations.CreateAgentRequestRequestBody$outboundSchema.optional().parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -105,7 +107,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "CreateAgent",
+    operationID: "CreateAgentRequest",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -148,8 +150,8 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.CreateAgentResponseBody,
-    | errors.CreateAgentResponseBody
+    operations.CreateAgentRequestResponseBody,
+    | errors.CreateAgentRequestResponseBody
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -159,8 +161,8 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, operations.CreateAgentResponseBody$inboundSchema),
-    M.jsonErr(409, errors.CreateAgentResponseBody$inboundSchema),
+    M.json(201, operations.CreateAgentRequestResponseBody$inboundSchema),
+    M.jsonErr(409, errors.CreateAgentRequestResponseBody$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/packages/orq-rc/src/funcs/agentsDelete.ts

@@ -27,14 +27,14 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete an agent
+ * Delete agent
  *
  * @remarks
- * Permanently deletes an agent and all its configuration, including primary and fallback model settings.
+ * Permanently removes an agent from the workspace. This operation is irreversible and will delete all associated configuration including model assignments, tools, knowledge bases, memory stores, and cached data. Active agent sessions will be terminated, and the agent key will become available for reuse.
  */
 export function agentsDelete(
   client: OrqCore,
-  request: operations.DeleteAgentRequest,
+  agentKey: string,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -52,14 +52,14 @@ export function agentsDelete(
 > {
   return new APIPromise($do(
     client,
-    request,
+    agentKey,
     options,
   ));
 }
 
 async function $do(
   client: OrqCore,
-  request: operations.DeleteAgentRequest,
+  agentKey: string,
   options?: RequestOptions,
 ): Promise<
   [
@@ -78,8 +78,12 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.DeleteAgentRequest = {
+    agentKey: agentKey,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) => operations.DeleteAgentRequest$outboundSchema.parse(value),
     "Input validation failed",
   );

package/packages/orq-rc/src/funcs/agentsInvoke.ts

@@ -25,14 +25,17 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Invoke an agent
+ * Execute an agent task
  *
  * @remarks
- * Executes an existing agent with the provided input. The agent uses its pre-configured primary model and will automatically fall back to its configured fallback model if the primary model fails. Fallback models are configured at the agent level, not during execution.
+ * Invokes an agent to perform a task with the provided input message. The agent will process the request using its configured model and tools, maintaining context through memory stores if configured. Supports automatic model fallback on primary model failure, tool execution, knowledge base retrieval, and continuation of previous conversations. Returns a task response that can be used to track execution status and retrieve results.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function agentsInvoke(
   client: OrqCore,
-  request: operations.InvokeAgentRequest,
+  key: string,
+  requestBody?: operations.InvokeAgentRequestBody | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -49,14 +52,16 @@ export function agentsInvoke(
 > {
   return new APIPromise($do(
     client,
-    request,
+    key,
+    requestBody,
     options,
   ));
 }
 
 async function $do(
   client: OrqCore,
-  request: operations.InvokeAgentRequest,
+  key: string,
+  requestBody?: operations.InvokeAgentRequestBody | undefined,
   options?: RequestOptions,
 ): Promise<
   [
@@ -74,8 +79,13 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.InvokeAgentRequest = {
+    key: key,
+    requestBody: requestBody,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) => operations.InvokeAgentRequest$outboundSchema.parse(value),
     "Input validation failed",
   );

package/packages/orq-rc/src/funcs/agentsList.ts

@@ -25,14 +25,16 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List all agents
+ * List agents
  *
  * @remarks
- * Retrieves a list of all agents in your workspace. When no limit is provided, returns all agents without pagination. When a limit is specified, returns a paginated list. Each agent includes its configuration, primary model, and optional fallback model settings.
+ * Retrieves a comprehensive list of agents configured in your workspace. Supports pagination for large datasets and returns agents sorted by creation date (newest first). Each agent in the response includes its complete configuration: model settings with fallback options, instructions, tools, knowledge bases, memory stores, and execution parameters. Use pagination parameters to efficiently navigate through large collections of agents.
  */
 export function agentsList(
   client: OrqCore,
-  request?: operations.ListAgentsRequest | undefined,
+  limit?: number | undefined,
+  startingAfter?: string | undefined,
+  endingBefore?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -49,14 +51,18 @@ export function agentsList(
 > {
   return new APIPromise($do(
     client,
-    request,
+    limit,
+    startingAfter,
+    endingBefore,
     options,
   ));
 }
 
 async function $do(
   client: OrqCore,
-  request?: operations.ListAgentsRequest | undefined,
+  limit?: number | undefined,
+  startingAfter?: string | undefined,
+  endingBefore?: string | undefined,
   options?: RequestOptions,
 ): Promise<
   [
@@ -74,8 +80,14 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.ListAgentsRequest | undefined = {
+    limit: limit,
+    startingAfter: startingAfter,
+    endingBefore: endingBefore,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) =>
       operations.ListAgentsRequest$outboundSchema.optional().parse(value),
     "Input validation failed",

package/packages/orq-rc/src/funcs/agentsResponsesCreate.ts

@@ -25,18 +25,19 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create an agent response
+ * Create response
  *
  * @remarks
- * Creates a new response representing an agent interaction. A response tracks the conversation from the initial message until the agent becomes inactive or errors. Supports both synchronous (waiting) and asynchronous (background) execution modes.
+ * Initiates an agent conversation and returns a complete response. This endpoint manages the full lifecycle of an agent interaction, from receiving the initial message through all processing steps until completion. Supports synchronous execution (waits for completion) and asynchronous execution (returns immediately with task ID). The response includes all messages exchanged, tool calls made, and token usage statistics. Ideal for request-response patterns where you need the complete interaction result.
  */
 export function agentsResponsesCreate(
   client: OrqCore,
-  request: operations.CreateAgentResponseRequest,
+  agentKey: string,
+  requestBody?: operations.CreateAgentResponseRequestRequestBody | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateAgentResponseResponseBody,
+    operations.CreateAgentResponseRequestResponseBody,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -49,19 +50,21 @@ export function agentsResponsesCreate(
 > {
   return new APIPromise($do(
     client,
-    request,
+    agentKey,
+    requestBody,
     options,
   ));
 }
 
 async function $do(
   client: OrqCore,
-  request: operations.CreateAgentResponseRequest,
+  agentKey: string,
+  requestBody?: operations.CreateAgentResponseRequestRequestBody | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.CreateAgentResponseResponseBody,
+      operations.CreateAgentResponseRequestResponseBody,
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -74,10 +77,15 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.CreateAgentResponseRequestRequest = {
+    agentKey: agentKey,
+    requestBody: requestBody,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) =>
-      operations.CreateAgentResponseRequest$outboundSchema.parse(value),
+      operations.CreateAgentResponseRequestRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -107,7 +115,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "CreateAgentResponse",
+    operationID: "CreateAgentResponseRequest",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -146,7 +154,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateAgentResponseResponseBody,
+    operations.CreateAgentResponseRequestResponseBody,
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -156,7 +164,10 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.CreateAgentResponseResponseBody$inboundSchema),
+    M.json(
+      200,
+      operations.CreateAgentResponseRequestResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req);

package/packages/orq-rc/src/funcs/agentsRetrieve.ts

@@ -26,19 +26,19 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get an agent
+ * Retrieve agent
  *
  * @remarks
- * Retrieves a single agent by its unique key, including its full configuration with primary and fallback model settings.
+ * Retrieves detailed information about a specific agent identified by its unique key or identifier. Returns the complete agent manifest including configuration settings, model assignments (primary and fallback), tools, knowledge bases, memory stores, instructions, and execution parameters. Use this endpoint to fetch the current state and configuration of an individual agent.
  */
 export function agentsRetrieve(
   client: OrqCore,
-  request: operations.GetAgentRequest,
+  agentKey: string,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetAgentResponseBody,
-    | errors.GetAgentResponseBody
+    operations.RetrieveAgentRequestResponseBody,
+    | errors.RetrieveAgentRequestResponseBody
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -51,20 +51,20 @@ export function agentsRetrieve(
 > {
   return new APIPromise($do(
     client,
-    request,
+    agentKey,
     options,
   ));
 }
 
 async function $do(
   client: OrqCore,
-  request: operations.GetAgentRequest,
+  agentKey: string,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.GetAgentResponseBody,
-      | errors.GetAgentResponseBody
+      operations.RetrieveAgentRequestResponseBody,
+      | errors.RetrieveAgentRequestResponseBody
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -77,9 +77,14 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.RetrieveAgentRequestRequest = {
+    agentKey: agentKey,
+  };
+
   const parsed = safeParse(
-    request,
-    (value) => operations.GetAgentRequest$outboundSchema.parse(value),
+    input,
+    (value) =>
+      operations.RetrieveAgentRequestRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -108,7 +113,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "GetAgent",
+    operationID: "RetrieveAgentRequest",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -151,8 +156,8 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.GetAgentResponseBody,
-    | errors.GetAgentResponseBody
+    operations.RetrieveAgentRequestResponseBody,
+    | errors.RetrieveAgentRequestResponseBody
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -162,8 +167,8 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetAgentResponseBody$inboundSchema),
-    M.jsonErr(404, errors.GetAgentResponseBody$inboundSchema),
+    M.json(200, operations.RetrieveAgentRequestResponseBody$inboundSchema),
+    M.jsonErr(404, errors.RetrieveAgentRequestResponseBody$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });