@tambo-ai/typescript-sdk 0.80.0 → 0.83.0

package/resources/threads/runs.d.ts

@@ -0,0 +1,277 @@
+import { APIResource } from "../../core/resource.js";
+import * as RunsAPI from "./runs.js";
+import * as ThreadsAPI from "./threads.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Runs extends APIResource {
+    /**
+     * Creates a new thread and immediately starts a streaming run. Returns an SSE
+     * stream of AG-UI events.
+     *
+     * @example
+     * ```ts
+     * await client.threads.runs.create({
+     *   message: {
+     *     content: [{ text: 'Hello, world!', type: 'text' }],
+     *     role: 'user',
+     *   },
+     * });
+     * ```
+     */
+    create(body: RunCreateParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Explicitly cancel a running run. Note: closing the SSE connection also cancels
+     * the run.
+     *
+     * @example
+     * ```ts
+     * const run = await client.threads.runs.delete(
+     *   'run_xyz789abc',
+     *   { threadId: 'thr_abc123xyz' },
+     * );
+     * ```
+     */
+    delete(runID: string, params: RunDeleteParams, options?: RequestOptions): APIPromise<RunDeleteResponse>;
+    /**
+     * Starts a streaming run on an existing thread. Returns an SSE stream of AG-UI
+     * events.
+     *
+     * @example
+     * ```ts
+     * await client.threads.runs.run('thr_abc123xyz', {
+     *   message: {
+     *     content: [{ text: 'Hello, world!', type: 'text' }],
+     *     role: 'user',
+     *   },
+     * });
+     * ```
+     */
+    run(threadID: string, body: RunRunParams, options?: RequestOptions): APIPromise<void>;
+}
+export interface InputMessage {
+    /**
+     * Content blocks (text, resource, or tool_result)
+     */
+    content: Array<ThreadsAPI.TextContent | ThreadsAPI.ResourceContent | ThreadsAPI.ToolResultContent>;
+    /**
+     * Message role - must be 'user' for input messages
+     */
+    role: 'user';
+    /**
+     * Additional metadata to attach to the message
+     */
+    metadata?: unknown;
+}
+export interface RunDeleteResponse {
+    /**
+     * The run ID that was cancelled
+     */
+    runId: string;
+    /**
+     * New status after cancellation (always 'cancelled')
+     */
+    status: 'cancelled';
+}
+export interface RunCreateParams {
+    /**
+     * The user's message
+     */
+    message: InputMessage;
+    /**
+     * Available UI components the model can render
+     */
+    availableComponents?: Array<RunCreateParams.AvailableComponent>;
+    /**
+     * Maximum tokens to generate
+     */
+    maxTokens?: number;
+    /**
+     * Override the default model
+     */
+    model?: string;
+    /**
+     * ID of the previous run. Required when continuing a thread that already has
+     * messages.
+     */
+    previousRunId?: string;
+    /**
+     * Metadata for the run
+     */
+    runMetadata?: unknown;
+    /**
+     * Temperature for generation (0-2)
+     */
+    temperature?: number;
+    /**
+     * Thread configuration
+     */
+    thread?: RunCreateParams.Thread;
+    /**
+     * Metadata for the thread
+     */
+    threadMetadata?: unknown;
+    /**
+     * How the model should use tools
+     */
+    toolChoice?: 'auto' | 'required' | 'none' | RunCreateParams.Name;
+    /**
+     * Client-side tools the model can call
+     */
+    tools?: Array<RunCreateParams.Tool>;
+}
+export declare namespace RunCreateParams {
+    interface AvailableComponent {
+        /**
+         * Description of what this component displays
+         */
+        description: string;
+        /**
+         * Component name (e.g., 'StockChart')
+         */
+        name: string;
+        /**
+         * JSON Schema for component props
+         */
+        propsSchema: unknown;
+        /**
+         * Optional JSON Schema for component state
+         */
+        stateSchema?: unknown;
+    }
+    /**
+     * Thread configuration
+     */
+    interface Thread {
+        /**
+         * Optional context key for thread organization
+         */
+        contextKey?: string;
+        /**
+         * Initial messages to seed the thread with
+         */
+        initialMessages?: Array<RunsAPI.InputMessage>;
+        /**
+         * Additional metadata to attach to the thread
+         */
+        metadata?: unknown;
+    }
+    interface Name {
+        name?: string;
+    }
+    interface Tool {
+        /**
+         * Description of what the tool does
+         */
+        description: string;
+        /**
+         * JSON Schema for the tool's input parameters
+         */
+        inputSchema: unknown;
+        /**
+         * Unique tool name (a-z, A-Z, 0-9, \_, -)
+         */
+        name: string;
+        /**
+         * Optional JSON Schema for structured output
+         */
+        outputSchema?: unknown;
+        /**
+         * Enable strict schema validation (OpenAI feature)
+         */
+        strict?: boolean;
+    }
+}
+export interface RunDeleteParams {
+    /**
+     * Thread ID
+     */
+    threadId: string;
+}
+export interface RunRunParams {
+    /**
+     * The user's message
+     */
+    message: InputMessage;
+    /**
+     * Available UI components the model can render
+     */
+    availableComponents?: Array<RunRunParams.AvailableComponent>;
+    /**
+     * Maximum tokens to generate
+     */
+    maxTokens?: number;
+    /**
+     * Override the default model
+     */
+    model?: string;
+    /**
+     * ID of the previous run. Required when continuing a thread that already has
+     * messages.
+     */
+    previousRunId?: string;
+    /**
+     * Metadata for the run
+     */
+    runMetadata?: unknown;
+    /**
+     * Temperature for generation (0-2)
+     */
+    temperature?: number;
+    /**
+     * How the model should use tools
+     */
+    toolChoice?: 'auto' | 'required' | 'none' | RunRunParams.Name;
+    /**
+     * Client-side tools the model can call
+     */
+    tools?: Array<RunRunParams.Tool>;
+}
+export declare namespace RunRunParams {
+    interface AvailableComponent {
+        /**
+         * Description of what this component displays
+         */
+        description: string;
+        /**
+         * Component name (e.g., 'StockChart')
+         */
+        name: string;
+        /**
+         * JSON Schema for component props
+         */
+        propsSchema: unknown;
+        /**
+         * Optional JSON Schema for component state
+         */
+        stateSchema?: unknown;
+    }
+    interface Name {
+        name?: string;
+    }
+    interface Tool {
+        /**
+         * Description of what the tool does
+         */
+        description: string;
+        /**
+         * JSON Schema for the tool's input parameters
+         */
+        inputSchema: unknown;
+        /**
+         * Unique tool name (a-z, A-Z, 0-9, \_, -)
+         */
+        name: string;
+        /**
+         * Optional JSON Schema for structured output
+         */
+        outputSchema?: unknown;
+        /**
+         * Enable strict schema validation (OpenAI feature)
+         */
+        strict?: boolean;
+    }
+}
+export declare namespace Runs {
+    export { type InputMessage as InputMessage, type RunDeleteResponse as RunDeleteResponse, type RunCreateParams as RunCreateParams, type RunDeleteParams as RunDeleteParams, type RunRunParams as RunRunParams, };
+}
+//# sourceMappingURL=runs.d.ts.map

package/resources/threads/runs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runs.d.ts","sourceRoot":"","sources":["../../src/resources/threads/runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQzE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAKvG;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAOtF;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;IAEnG;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;IAEhE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC;IAEjE;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;CACrC;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,kBAAkB;QACjC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAE9C;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,IAAI;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAE7D;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC;IAE9D;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;CAClC;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,kBAAkB;QACjC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED,UAAiB,IAAI;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;CACH"}

package/resources/threads/runs.js

@@ -0,0 +1,69 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Runs = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class Runs extends resource_1.APIResource {
+    /**
+     * Creates a new thread and immediately starts a streaming run. Returns an SSE
+     * stream of AG-UI events.
+     *
+     * @example
+     * ```ts
+     * await client.threads.runs.create({
+     *   message: {
+     *     content: [{ text: 'Hello, world!', type: 'text' }],
+     *     role: 'user',
+     *   },
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/threads/runs', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Explicitly cancel a running run. Note: closing the SSE connection also cancels
+     * the run.
+     *
+     * @example
+     * ```ts
+     * const run = await client.threads.runs.delete(
+     *   'run_xyz789abc',
+     *   { threadId: 'thr_abc123xyz' },
+     * );
+     * ```
+     */
+    delete(runID, params, options) {
+        const { threadId } = params;
+        return this._client.delete((0, path_1.path) `/v1/threads/${threadId}/runs/${runID}`, options);
+    }
+    /**
+     * Starts a streaming run on an existing thread. Returns an SSE stream of AG-UI
+     * events.
+     *
+     * @example
+     * ```ts
+     * await client.threads.runs.run('thr_abc123xyz', {
+     *   message: {
+     *     content: [{ text: 'Hello, world!', type: 'text' }],
+     *     role: 'user',
+     *   },
+     * });
+     * ```
+     */
+    run(threadID, body, options) {
+        return this._client.post((0, path_1.path) `/v1/threads/${threadID}/runs`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+exports.Runs = Runs;
+//# sourceMappingURL=runs.js.map

package/resources/threads/runs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runs.js","sourceRoot":"","sources":["../../src/resources/threads/runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAqB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAa,EAAE,MAAuB,EAAE,OAAwB;QACrE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,SAAS,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,QAAgB,EAAE,IAAkB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,OAAO,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA7DD,oBA6DC"}

package/resources/threads/runs.mjs

@@ -0,0 +1,65 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Runs extends APIResource {
+    /**
+     * Creates a new thread and immediately starts a streaming run. Returns an SSE
+     * stream of AG-UI events.
+     *
+     * @example
+     * ```ts
+     * await client.threads.runs.create({
+     *   message: {
+     *     content: [{ text: 'Hello, world!', type: 'text' }],
+     *     role: 'user',
+     *   },
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/threads/runs', {
+            body,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Explicitly cancel a running run. Note: closing the SSE connection also cancels
+     * the run.
+     *
+     * @example
+     * ```ts
+     * const run = await client.threads.runs.delete(
+     *   'run_xyz789abc',
+     *   { threadId: 'thr_abc123xyz' },
+     * );
+     * ```
+     */
+    delete(runID, params, options) {
+        const { threadId } = params;
+        return this._client.delete(path `/v1/threads/${threadId}/runs/${runID}`, options);
+    }
+    /**
+     * Starts a streaming run on an existing thread. Returns an SSE stream of AG-UI
+     * events.
+     *
+     * @example
+     * ```ts
+     * await client.threads.runs.run('thr_abc123xyz', {
+     *   message: {
+     *     content: [{ text: 'Hello, world!', type: 'text' }],
+     *     role: 'user',
+     *   },
+     * });
+     * ```
+     */
+    run(threadID, body, options) {
+        return this._client.post(path `/v1/threads/${threadID}/runs`, {
+            body,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+//# sourceMappingURL=runs.mjs.map

package/resources/threads/runs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"runs.mjs","sourceRoot":"","sources":["../../src/resources/threads/runs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAqB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAa,EAAE,MAAuB,EAAE,OAAwB;QACrE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,QAAQ,SAAS,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,QAAgB,EAAE,IAAkB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,QAAQ,OAAO,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}