@reminix/sdk 0.8.0

package/src/resources/agents.ts

@@ -0,0 +1,239 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Agents extends APIResource {
+  /**
+   * Have a conversational interaction with an agent. This endpoint maintains
+   * conversation context through the messages array, allowing for multi-turn
+   * conversations.
+   *
+   * **Timeout:** Chat requests have a 60-second timeout. If the agent takes longer
+   * to respond, you will receive a 504 Gateway Timeout error. For long-running
+   * conversations, consider using streaming mode which does not have the same
+   * timeout constraints.
+   *
+   * **Idempotency:** For non-streaming requests, send an `Idempotency-Key` header
+   * with a unique value (e.g., UUID) to ensure duplicate requests return the same
+   * response. Keys are valid for 24 hours. Streaming responses are not cached.
+   *
+   * **Use cases:**
+   *
+   * - Customer support chatbots
+   * - AI assistants with memory
+   * - Multi-step question answering
+   * - Conversational agents that need context
+   *
+   * **Message format:** Follows OpenAI-compliant message structure with support for:
+   *
+   * - `system`, `user`, `assistant`, and `tool` roles
+   * - Multimodal content (text + images)
+   * - Tool/function calling
+   *
+   * **Streaming:** Set `stream: true` in the request body to receive Server-Sent
+   * Events (SSE) stream with incremental chunks. Perfect for ChatGPT-like real-time
+   * chat interfaces.
+   *
+   * @example
+   * ```ts
+   * const response = await client.agents.chat('name', {
+   *   messages: [
+   *     { role: 'user', content: 'What is the weather today?' },
+   *   ],
+   * });
+   * ```
+   */
+  chat(name: string, body: AgentChatParams, options?: RequestOptions): APIPromise<AgentChatResponse> {
+    return this._client.post(path`/agents/${name}/chat`, { body, ...options });
+  }
+
+  /**
+   * Execute a one-shot task with an agent. This endpoint is designed for
+   * task-oriented operations where you provide input and receive a complete output.
+   *
+   * **Timeout:** Agent invocations have a 60-second timeout. If the agent takes
+   * longer to respond, you will receive a 504 Gateway Timeout error. For
+   * long-running tasks, consider using streaming mode which does not have the same
+   * timeout constraints.
+   *
+   * **Idempotency:** For non-streaming requests, send an `Idempotency-Key` header
+   * with a unique value (e.g., UUID) to ensure duplicate requests return the same
+   * response. Keys are valid for 24 hours. Streaming responses are not cached.
+   *
+   * **Use cases:**
+   *
+   * - Data analysis and processing
+   * - Content generation (with streaming for long outputs)
+   * - One-time operations that don't require conversation history
+   * - API-like operations
+   *
+   * **Streaming:** Set `stream: true` in the request body to receive Server-Sent
+   * Events (SSE) stream with incremental chunks. Useful for long-running tasks or
+   * real-time progress updates.
+   *
+   * @example
+   * ```ts
+   * const response = await client.agents.invoke('name', {
+   *   input: {
+   *     task: 'analyze this data',
+   *     data: { value: 123, items: ['a', 'b', 'c'] },
+   *   },
+   * });
+   * ```
+   */
+  invoke(name: string, body: AgentInvokeParams, options?: RequestOptions): APIPromise<AgentInvokeResponse> {
+    return this._client.post(path`/agents/${name}/invoke`, { body, ...options });
+  }
+}
+
+/**
+ * Optional request context passed to the agent handler.
+ */
+export interface Context {
+  /**
+   * ID to track multi-turn conversations
+   */
+  conversation_id?: string;
+
+  /**
+   * Additional custom context fields
+   */
+  custom?: { [key: string]: unknown };
+
+  /**
+   * ID of the user making the request
+   */
+  user_id?: string;
+}
+
+export interface AgentChatResponse {
+  /**
+   * Assistant message response
+   */
+  message: AgentChatResponse.Message;
+}
+
+export namespace AgentChatResponse {
+  /**
+   * Assistant message response
+   */
+  export interface Message {
+    content: string | Array<unknown> | null;
+
+    role: 'assistant';
+
+    tool_calls?: Array<Message.ToolCall>;
+  }
+
+  export namespace Message {
+    export interface ToolCall {
+      id: string;
+
+      function: ToolCall.Function;
+
+      type: 'function';
+    }
+
+    export namespace ToolCall {
+      export interface Function {
+        arguments: string;
+
+        name: string;
+      }
+    }
+  }
+}
+
+export interface AgentInvokeResponse {
+  /**
+   * Output from the agent. Structure depends on agent implementation.
+   */
+  output?: unknown;
+}
+
+export interface AgentChatParams {
+  /**
+   * Conversation history. Must include at least one message.
+   */
+  messages: Array<AgentChatParams.Message>;
+
+  /**
+   * Optional request context passed to the agent handler.
+   */
+  context?: Context;
+
+  /**
+   * Whether to stream the response as SSE.
+   */
+  stream?: boolean;
+}
+
+export namespace AgentChatParams {
+  export interface Message {
+    /**
+     * Message content. Can be string, array (multimodal), or object (tool).
+     */
+    content: string | Array<Message.UnionMember1> | { [key: string]: unknown };
+
+    /**
+     * Message role
+     */
+    role: 'system' | 'user' | 'assistant' | 'tool';
+
+    /**
+     * Tool name (required when role is "tool")
+     */
+    name?: string;
+
+    /**
+     * Tool call ID (for tool role)
+     */
+    tool_call_id?: string;
+  }
+
+  export namespace Message {
+    export interface UnionMember1 {
+      type: 'text' | 'image_url';
+
+      image_url?: UnionMember1.ImageURL;
+
+      text?: string;
+    }
+
+    export namespace UnionMember1 {
+      export interface ImageURL {
+        url: string;
+      }
+    }
+  }
+}
+
+export interface AgentInvokeParams {
+  /**
+   * Input data for the agent. Structure depends on agent implementation.
+   */
+  input: { [key: string]: unknown };
+
+  /**
+   * Optional request context passed to the agent handler.
+   */
+  context?: Context;
+
+  /**
+   * Whether to stream the response as SSE.
+   */
+  stream?: boolean;
+}
+
+export declare namespace Agents {
+  export {
+    type Context as Context,
+    type AgentChatResponse as AgentChatResponse,
+    type AgentInvokeResponse as AgentInvokeResponse,
+    type AgentChatParams as AgentChatParams,
+    type AgentInvokeParams as AgentInvokeParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Agents,
+  type Context,
+  type AgentChatResponse,
+  type AgentInvokeResponse,
+  type AgentChatParams,
+  type AgentInvokeParams,
+} from './agents';
+export { Project, type ProjectRetrieveResponse } from './project';

package/src/resources/project.ts

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Project extends APIResource {
+  /**
+   * Returns the project associated with the API key used for authentication.
+   *
+   * The project contains metadata about your organization's configuration,
+   * including:
+   *
+   * - Project ID and organization ID
+   * - Project name and slug
+   * - Creation and update timestamps
+   *
+   * This endpoint is useful for verifying your API key is valid and retrieving
+   * project details.
+   */
+  retrieve(options?: RequestOptions): APIPromise<ProjectRetrieveResponse> {
+    return this._client.get('/project', options);
+  }
+}
+
+export interface ProjectRetrieveResponse {
+  /**
+   * Unique identifier for the project
+   */
+  id: string;
+
+  /**
+   * ISO 8601 timestamp when the project was created
+   */
+  createdAt: string;
+
+  /**
+   * Human-readable name of the project
+   */
+  name: string;
+
+  /**
+   * ID of the organization that owns this project
+   */
+  organizationId: string;
+
+  /**
+   * URL-friendly identifier for the project
+   */
+  slug: string;
+
+  /**
+   * ISO 8601 timestamp when the project was last updated
+   */
+  updatedAt: string;
+}
+
+export declare namespace Project {
+  export { type ProjectRetrieveResponse as ProjectRetrieveResponse };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.8.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

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

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

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

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}