@langchain/langgraph-sdk 0.1.10 → 1.0.0

package/dist/client.d.ts

@@ -1,7 +1,9 @@
-import { Assistant, AssistantGraph, AssistantSortBy, AssistantSelectField, AssistantVersion, CancelAction, Checkpoint, Config, Cron, CronSelectField, CronCreateForThreadResponse, CronCreateResponse, CronSortBy, DefaultValues, GraphSchema, Item, ListNamespaceResponse, Metadata, Run, RunSelectField, RunStatus, SearchItemsResponse, SortOrder, Subgraphs, Thread, ThreadSelectField, ThreadSortBy, ThreadState, ThreadStatus } from "./schema.js";
-import type { Command, CronsCreatePayload, OnConflictBehavior, RunsCreatePayload, RunsStreamPayload, RunsWaitPayload, StreamEvent } from "./types.js";
-import type { StreamMode, ThreadStreamMode, TypedAsyncGenerator } from "./types.stream.js";
+import { Assistant, AssistantGraph, AssistantSelectField, AssistantSortBy, AssistantVersion, CancelAction, Checkpoint, Config, Cron, CronCreateForThreadResponse, CronCreateResponse, CronSelectField, CronSortBy, DefaultValues, GraphSchema, Item, ListNamespaceResponse, Metadata, Run, RunSelectField, RunStatus, SearchItemsResponse, SortOrder, Subgraphs, Thread, ThreadSelectField, ThreadSortBy, ThreadState, ThreadStatus } from "./schema.js";
+import { StreamMode, ThreadStreamMode, TypedAsyncGenerator } from "./types.stream.js";
+import { Command, CronsCreatePayload, OnConflictBehavior, RunsCreatePayload, RunsStreamPayload, RunsWaitPayload, StreamEvent } from "./types.js";
 import { AsyncCaller, AsyncCallerParams } from "./utils/async_caller.js";
+
+//#region src/client.d.ts
 type HeaderValue = string | undefined | null;
 /**
  * Get the API key from the environment.
@@ -14,667 +16,673 @@ type HeaderValue = string | undefined | null;
  * @param apiKey - Optional API key provided as an argument
  * @returns The API key if found, otherwise undefined
  */
-export declare function getApiKey(apiKey?: string): string | undefined;
-export type RequestHook = (url: URL, init: RequestInit) => Promise<RequestInit> | RequestInit;
-export interface ClientConfig {
-    apiUrl?: string;
-    apiKey?: string;
-    callerOptions?: AsyncCallerParams;
-    timeoutMs?: number;
-    defaultHeaders?: Record<string, HeaderValue>;
-    onRequest?: RequestHook;
+declare function getApiKey(apiKey?: string): string | undefined;
+type RequestHook = (url: URL, init: RequestInit) => Promise<RequestInit> | RequestInit;
+interface ClientConfig {
+  apiUrl?: string;
+  apiKey?: string;
+  callerOptions?: AsyncCallerParams;
+  timeoutMs?: number;
+  defaultHeaders?: Record<string, HeaderValue>;
+  onRequest?: RequestHook;
 }
 declare class BaseClient {
-    protected asyncCaller: AsyncCaller;
-    protected timeoutMs: number | undefined;
-    protected apiUrl: string;
-    protected defaultHeaders: Record<string, HeaderValue>;
-    protected onRequest?: RequestHook;
-    constructor(config?: ClientConfig);
-    protected prepareFetchOptions(path: string, options?: RequestInit & {
-        json?: unknown;
-        params?: Record<string, unknown>;
-        timeoutMs?: number | null;
-        withResponse?: boolean;
-    }): [url: URL, init: RequestInit];
-    protected fetch<T>(path: string, options: RequestInit & {
-        json?: unknown;
-        params?: Record<string, unknown>;
-        timeoutMs?: number | null;
-        signal?: AbortSignal;
-        withResponse: true;
-    }): Promise<[T, Response]>;
-    protected fetch<T>(path: string, options?: RequestInit & {
-        json?: unknown;
-        params?: Record<string, unknown>;
-        timeoutMs?: number | null;
-        signal?: AbortSignal;
-        withResponse?: false;
-    }): Promise<T>;
+  protected asyncCaller: AsyncCaller;
+  protected timeoutMs: number | undefined;
+  protected apiUrl: string;
+  protected defaultHeaders: Record<string, HeaderValue>;
+  protected onRequest?: RequestHook;
+  constructor(config?: ClientConfig);
+  protected prepareFetchOptions(path: string, options?: RequestInit & {
+    json?: unknown;
+    params?: Record<string, unknown>;
+    timeoutMs?: number | null;
+    withResponse?: boolean;
+  }): [url: URL, init: RequestInit];
+  protected fetch<T>(path: string, options: RequestInit & {
+    json?: unknown;
+    params?: Record<string, unknown>;
+    timeoutMs?: number | null;
+    signal?: AbortSignal;
+    withResponse: true;
+  }): Promise<[T, Response]>;
+  protected fetch<T>(path: string, options?: RequestInit & {
+    json?: unknown;
+    params?: Record<string, unknown>;
+    timeoutMs?: number | null;
+    signal?: AbortSignal;
+    withResponse?: false;
+  }): Promise<T>;
 }
-export declare class CronsClient extends BaseClient {
-    /**
-     *
-     * @param threadId The ID of the thread.
-     * @param assistantId Assistant ID to use for this cron job.
-     * @param payload Payload for creating a cron job.
-     * @returns The created background run.
-     */
-    createForThread(threadId: string, assistantId: string, payload?: CronsCreatePayload): Promise<CronCreateForThreadResponse>;
-    /**
-     *
-     * @param assistantId Assistant ID to use for this cron job.
-     * @param payload Payload for creating a cron job.
-     * @returns
-     */
-    create(assistantId: string, payload?: CronsCreatePayload): Promise<CronCreateResponse>;
-    /**
-     *
-     * @param cronId Cron ID of Cron job to delete.
-     */
-    delete(cronId: string): Promise<void>;
-    /**
-     *
-     * @param query Query options.
-     * @returns List of crons.
-     */
-    search(query?: {
-        assistantId?: string;
-        threadId?: string;
-        limit?: number;
-        offset?: number;
-        sortBy?: CronSortBy;
-        sortOrder?: SortOrder;
-        select?: CronSelectField[];
-    }): Promise<Cron[]>;
-    /**
-     * Count cron jobs matching filters.
-     *
-     * @param query.assistantId Assistant ID to filter by.
-     * @param query.threadId Thread ID to filter by.
-     * @returns Number of cron jobs matching the criteria.
-     */
-    count(query?: {
-        assistantId?: string;
-        threadId?: string;
-    }): Promise<number>;
-}
-export declare class AssistantsClient extends BaseClient {
-    /**
-     * Get an assistant by ID.
-     *
-     * @param assistantId The ID of the assistant.
-     * @returns Assistant
-     */
-    get(assistantId: string): Promise<Assistant>;
-    /**
-     * Get the JSON representation of the graph assigned to a runnable
-     * @param assistantId The ID of the assistant.
-     * @param options.xray Whether to include subgraphs in the serialized graph representation. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.
-     * @returns Serialized graph
-     */
-    getGraph(assistantId: string, options?: {
-        xray?: boolean | number;
-    }): Promise<AssistantGraph>;
-    /**
-     * Get the state and config schema of the graph assigned to a runnable
-     * @param assistantId The ID of the assistant.
-     * @returns Graph schema
-     */
-    getSchemas(assistantId: string): Promise<GraphSchema>;
-    /**
-     * Get the schemas of an assistant by ID.
-     *
-     * @param assistantId The ID of the assistant to get the schema of.
-     * @param options Additional options for getting subgraphs, such as namespace or recursion extraction.
-     * @returns The subgraphs of the assistant.
-     */
-    getSubgraphs(assistantId: string, options?: {
-        namespace?: string;
-        recurse?: boolean;
-    }): Promise<Subgraphs>;
-    /**
-     * Create a new assistant.
-     * @param payload Payload for creating an assistant.
-     * @returns The created assistant.
-     */
-    create(payload: {
-        graphId: string;
-        config?: Config;
-        context?: unknown;
-        metadata?: Metadata;
-        assistantId?: string;
-        ifExists?: OnConflictBehavior;
-        name?: string;
-        description?: string;
-    }): Promise<Assistant>;
-    /**
-     * Update an assistant.
-     * @param assistantId ID of the assistant.
-     * @param payload Payload for updating the assistant.
-     * @returns The updated assistant.
-     */
-    update(assistantId: string, payload: {
-        graphId?: string;
-        config?: Config;
-        context?: unknown;
-        metadata?: Metadata;
-        name?: string;
-        description?: string;
-    }): Promise<Assistant>;
-    /**
-     * Delete an assistant.
-     *
-     * @param assistantId ID of the assistant.
-     */
-    delete(assistantId: string): Promise<void>;
-    /**
-     * List assistants.
-     * @param query Query options.
-     * @returns List of assistants.
-     */
-    search(query?: {
-        graphId?: string;
-        metadata?: Metadata;
-        limit?: number;
-        offset?: number;
-        sortBy?: AssistantSortBy;
-        sortOrder?: SortOrder;
-        select?: AssistantSelectField[];
-    }): Promise<Assistant[]>;
-    /**
-     * Count assistants matching filters.
-     *
-     * @param query.metadata Metadata to filter by. Exact match for each key/value.
-     * @param query.graphId Optional graph id to filter by.
-     * @returns Number of assistants matching the criteria.
-     */
-    count(query?: {
-        metadata?: Metadata;
-        graphId?: string;
-    }): Promise<number>;
-    /**
-     * List all versions of an assistant.
-     *
-     * @param assistantId ID of the assistant.
-     * @returns List of assistant versions.
-     */
-    getVersions(assistantId: string, payload?: {
-        metadata?: Metadata;
-        limit?: number;
-        offset?: number;
-    }): Promise<AssistantVersion[]>;
-    /**
-     * Change the version of an assistant.
-     *
-     * @param assistantId ID of the assistant.
-     * @param version The version to change to.
-     * @returns The updated assistant.
-     */
-    setLatest(assistantId: string, version: number): Promise<Assistant>;
+declare class CronsClient extends BaseClient {
+  /**
+   *
+   * @param threadId The ID of the thread.
+   * @param assistantId Assistant ID to use for this cron job.
+   * @param payload Payload for creating a cron job.
+   * @returns The created background run.
+   */
+  createForThread(threadId: string, assistantId: string, payload?: CronsCreatePayload): Promise<CronCreateForThreadResponse>;
+  /**
+   *
+   * @param assistantId Assistant ID to use for this cron job.
+   * @param payload Payload for creating a cron job.
+   * @returns
+   */
+  create(assistantId: string, payload?: CronsCreatePayload): Promise<CronCreateResponse>;
+  /**
+   *
+   * @param cronId Cron ID of Cron job to delete.
+   */
+  delete(cronId: string): Promise<void>;
+  /**
+   *
+   * @param query Query options.
+   * @returns List of crons.
+   */
+  search(query?: {
+    assistantId?: string;
+    threadId?: string;
+    limit?: number;
+    offset?: number;
+    sortBy?: CronSortBy;
+    sortOrder?: SortOrder;
+    select?: CronSelectField[];
+  }): Promise<Cron[]>;
+  /**
+   * Count cron jobs matching filters.
+   *
+   * @param query.assistantId Assistant ID to filter by.
+   * @param query.threadId Thread ID to filter by.
+   * @returns Number of cron jobs matching the criteria.
+   */
+  count(query?: {
+    assistantId?: string;
+    threadId?: string;
+  }): Promise<number>;
 }
-export declare class ThreadsClient<TStateType = DefaultValues, TUpdateType = TStateType> extends BaseClient {
-    /**
-     * Get a thread by ID.
-     *
-     * @param threadId ID of the thread.
-     * @returns The thread.
-     */
-    get<ValuesType = TStateType>(threadId: string): Promise<Thread<ValuesType>>;
-    /**
-     * Create a new thread.
-     *
-     * @param payload Payload for creating a thread.
-     * @returns The created thread.
-     */
-    create(payload?: {
-        /**
-         * Metadata for the thread.
-         */
-        metadata?: Metadata;
-        /**
-         * ID of the thread to create.
-         *
-         * If not provided, a random UUID will be generated.
-         */
-        threadId?: string;
-        /**
-         * How to handle duplicate creation.
-         *
-         * @default "raise"
-         */
-        ifExists?: OnConflictBehavior;
-        /**
-         * Graph ID to associate with the thread.
-         */
-        graphId?: string;
-        /**
-         * Apply a list of supersteps when creating a thread, each containing a sequence of updates.
-         *
-         * Used for copying a thread between deployments.
-         */
-        supersteps?: Array<{
-            updates: Array<{
-                values: unknown;
-                command?: Command;
-                asNode: string;
-            }>;
-        }>;
-        /**
-         * Optional time-to-live in minutes for the thread.
-         * If a number is provided, it is treated as minutes and defaults to strategy "delete".
-         * You may also provide an object { ttl: number, strategy?: "delete" }.
-         */
-        ttl?: number | {
-            ttl: number;
-            strategy?: "delete";
-        };
-    }): Promise<Thread<TStateType>>;
-    /**
-     * Copy an existing thread
-     * @param threadId ID of the thread to be copied
-     * @returns Newly copied thread
-     */
-    copy(threadId: string): Promise<Thread<TStateType>>;
-    /**
-     * Update a thread.
-     *
-     * @param threadId ID of the thread.
-     * @param payload Payload for updating the thread.
-     * @returns The updated thread.
-     */
-    update(threadId: string, payload?: {
-        /**
-         * Metadata for the thread.
-         */
-        metadata?: Metadata;
-        /**
-         * Optional time-to-live in minutes for the thread.
-         * If a number is provided, it is treated as minutes and defaults to strategy "delete".
-         * You may also provide an object { ttl: number, strategy?: "delete" }.
-         */
-        ttl?: number | {
-            ttl: number;
-            strategy?: "delete";
-        };
-    }): Promise<Thread>;
-    /**
-     * Delete a thread.
-     *
-     * @param threadId ID of the thread.
-     */
-    delete(threadId: string): Promise<void>;
-    /**
-     * List threads
-     *
-     * @param query Query options
-     * @returns List of threads
-     */
-    search<ValuesType = TStateType>(query?: {
-        /**
-         * Metadata to filter threads by.
-         */
-        metadata?: Metadata;
-        /**
-         * Filter by specific thread IDs.
-         */
-        ids?: string[];
-        /**
-         * Maximum number of threads to return.
-         * Defaults to 10
-         */
-        limit?: number;
-        /**
-         * Offset to start from.
-         */
-        offset?: number;
-        /**
-         * Thread status to filter on.
-         */
-        status?: ThreadStatus;
-        /**
-         * Sort by.
-         */
-        sortBy?: ThreadSortBy;
-        /**
-         * Sort order.
-         * Must be one of 'asc' or 'desc'.
-         */
-        sortOrder?: SortOrder;
-        select?: ThreadSelectField[];
-    }): Promise<Thread<ValuesType>[]>;
-    /**
-     * Count threads matching filters.
-     *
-     * @param query.metadata Thread metadata to filter on.
-     * @param query.values State values to filter on.
-     * @param query.status Thread status to filter on.
-     * @returns Number of threads matching the criteria.
-     */
-    count<ValuesType = TStateType>(query?: {
-        metadata?: Metadata;
-        values?: ValuesType;
-        status?: ThreadStatus;
-    }): Promise<number>;
-    /**
-     * Get state for a thread.
-     *
-     * @param threadId ID of the thread.
-     * @returns Thread state.
-     */
-    getState<ValuesType = TStateType>(threadId: string, checkpoint?: Checkpoint | string, options?: {
-        subgraphs?: boolean;
-    }): Promise<ThreadState<ValuesType>>;
-    /**
-     * Add state to a thread.
-     *
-     * @param threadId The ID of the thread.
-     * @returns
-     */
-    updateState<ValuesType = TUpdateType>(threadId: string, options: {
-        values: ValuesType;
-        checkpoint?: Checkpoint;
-        checkpointId?: string;
-        asNode?: string;
-    }): Promise<Pick<Config, "configurable">>;
-    /**
-     * Patch the metadata of a thread.
-     *
-     * @param threadIdOrConfig Thread ID or config to patch the state of.
-     * @param metadata Metadata to patch the state with.
-     */
-    patchState(threadIdOrConfig: string | Config, metadata: Metadata): Promise<void>;
-    /**
-     * Get all past states for a thread.
-     *
-     * @param threadId ID of the thread.
-     * @param options Additional options.
-     * @returns List of thread states.
-     */
-    getHistory<ValuesType = TStateType>(threadId: string, options?: {
-        limit?: number;
-        before?: Config;
-        checkpoint?: Partial<Omit<Checkpoint, "thread_id">>;
-        metadata?: Metadata;
-    }): Promise<ThreadState<ValuesType>[]>;
-    joinStream(threadId: string, options?: {
-        lastEventId?: string;
-        streamMode?: ThreadStreamMode | ThreadStreamMode[];
-    }): AsyncGenerator<{
-        id?: string;
-        event: StreamEvent;
-        data: any;
-    }>;
+declare class AssistantsClient extends BaseClient {
+  /**
+   * Get an assistant by ID.
+   *
+   * @param assistantId The ID of the assistant.
+   * @returns Assistant
+   */
+  get(assistantId: string): Promise<Assistant>;
+  /**
+   * Get the JSON representation of the graph assigned to a runnable
+   * @param assistantId The ID of the assistant.
+   * @param options.xray Whether to include subgraphs in the serialized graph representation. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.
+   * @returns Serialized graph
+   */
+  getGraph(assistantId: string, options?: {
+    xray?: boolean | number;
+  }): Promise<AssistantGraph>;
+  /**
+   * Get the state and config schema of the graph assigned to a runnable
+   * @param assistantId The ID of the assistant.
+   * @returns Graph schema
+   */
+  getSchemas(assistantId: string): Promise<GraphSchema>;
+  /**
+   * Get the schemas of an assistant by ID.
+   *
+   * @param assistantId The ID of the assistant to get the schema of.
+   * @param options Additional options for getting subgraphs, such as namespace or recursion extraction.
+   * @returns The subgraphs of the assistant.
+   */
+  getSubgraphs(assistantId: string, options?: {
+    namespace?: string;
+    recurse?: boolean;
+  }): Promise<Subgraphs>;
+  /**
+   * Create a new assistant.
+   * @param payload Payload for creating an assistant.
+   * @returns The created assistant.
+   */
+  create(payload: {
+    graphId: string;
+    config?: Config;
+    context?: unknown;
+    metadata?: Metadata;
+    assistantId?: string;
+    ifExists?: OnConflictBehavior;
+    name?: string;
+    description?: string;
+  }): Promise<Assistant>;
+  /**
+   * Update an assistant.
+   * @param assistantId ID of the assistant.
+   * @param payload Payload for updating the assistant.
+   * @returns The updated assistant.
+   */
+  update(assistantId: string, payload: {
+    graphId?: string;
+    config?: Config;
+    context?: unknown;
+    metadata?: Metadata;
+    name?: string;
+    description?: string;
+  }): Promise<Assistant>;
+  /**
+   * Delete an assistant.
+   *
+   * @param assistantId ID of the assistant.
+   */
+  delete(assistantId: string): Promise<void>;
+  /**
+   * List assistants.
+   * @param query Query options.
+   * @returns List of assistants.
+   */
+  search(query?: {
+    graphId?: string;
+    metadata?: Metadata;
+    limit?: number;
+    offset?: number;
+    sortBy?: AssistantSortBy;
+    sortOrder?: SortOrder;
+    select?: AssistantSelectField[];
+  }): Promise<Assistant[]>;
+  /**
+   * Count assistants matching filters.
+   *
+   * @param query.metadata Metadata to filter by. Exact match for each key/value.
+   * @param query.graphId Optional graph id to filter by.
+   * @returns Number of assistants matching the criteria.
+   */
+  count(query?: {
+    metadata?: Metadata;
+    graphId?: string;
+  }): Promise<number>;
+  /**
+   * List all versions of an assistant.
+   *
+   * @param assistantId ID of the assistant.
+   * @returns List of assistant versions.
+   */
+  getVersions(assistantId: string, payload?: {
+    metadata?: Metadata;
+    limit?: number;
+    offset?: number;
+  }): Promise<AssistantVersion[]>;
+  /**
+   * Change the version of an assistant.
+   *
+   * @param assistantId ID of the assistant.
+   * @param version The version to change to.
+   * @returns The updated assistant.
+   */
+  setLatest(assistantId: string, version: number): Promise<Assistant>;
 }
-export declare class RunsClient<TStateType = DefaultValues, TUpdateType = TStateType, TCustomEventType = unknown> extends BaseClient {
-    stream<TStreamMode extends StreamMode | StreamMode[] = StreamMode, TSubgraphs extends boolean = false>(threadId: null, assistantId: string, payload?: Omit<RunsStreamPayload<TStreamMode, TSubgraphs>, "multitaskStrategy" | "onCompletion">): TypedAsyncGenerator<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType>;
-    stream<TStreamMode extends StreamMode | StreamMode[] = StreamMode, TSubgraphs extends boolean = false>(threadId: string, assistantId: string, payload?: RunsStreamPayload<TStreamMode, TSubgraphs>): TypedAsyncGenerator<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType>;
-    /**
-     * Create a run.
-     *
-     * @param threadId The ID of the thread.
-     * @param assistantId Assistant ID to use for this run.
-     * @param payload Payload for creating a run.
-     * @returns The created run.
-     */
-    create(threadId: string | null, assistantId: string, payload?: RunsCreatePayload): Promise<Run>;
+declare class ThreadsClient<TStateType = DefaultValues, TUpdateType = TStateType> extends BaseClient {
+  /**
+   * Get a thread by ID.
+   *
+   * @param threadId ID of the thread.
+   * @returns The thread.
+   */
+  get<ValuesType = TStateType>(threadId: string): Promise<Thread<ValuesType>>;
+  /**
+   * Create a new thread.
+   *
+   * @param payload Payload for creating a thread.
+   * @returns The created thread.
+   */
+  create(payload?: {
     /**
-     * Create a batch of stateless background runs.
-     *
-     * @param payloads An array of payloads for creating runs.
-     * @returns An array of created runs.
+     * Metadata for the thread.
      */
-    createBatch(payloads: (RunsCreatePayload & {
-        assistantId: string;
-    })[]): Promise<Run[]>;
-    wait(threadId: null, assistantId: string, payload?: Omit<RunsWaitPayload, "multitaskStrategy" | "onCompletion">): Promise<ThreadState["values"]>;
-    wait(threadId: string, assistantId: string, payload?: RunsWaitPayload): Promise<ThreadState["values"]>;
+    metadata?: Metadata;
     /**
-     * List all runs for a thread.
+     * ID of the thread to create.
      *
-     * @param threadId The ID of the thread.
-     * @param options Filtering and pagination options.
-     * @returns List of runs.
+     * If not provided, a random UUID will be generated.
      */
-    list(threadId: string, options?: {
-        /**
-         * Maximum number of runs to return.
-         * Defaults to 10
-         */
-        limit?: number;
-        /**
-         * Offset to start from.
-         * Defaults to 0.
-         */
-        offset?: number;
-        /**
-         * Status of the run to filter by.
-         */
-        status?: RunStatus;
-        select?: RunSelectField[];
-    }): Promise<Run[]>;
+    threadId?: string;
     /**
-     * Get a run by ID.
+     * How to handle duplicate creation.
      *
-     * @param threadId The ID of the thread.
-     * @param runId The ID of the run.
-     * @returns The run.
+     * @default "raise"
      */
-    get(threadId: string, runId: string): Promise<Run>;
+    ifExists?: OnConflictBehavior;
     /**
-     * Cancel a run.
-     *
-     * @param threadId The ID of the thread.
-     * @param runId The ID of the run.
-     * @param wait Whether to block when canceling
-     * @param action Action to take when cancelling the run. Possible values are `interrupt` or `rollback`. Default is `interrupt`.
-     * @returns
+     * Graph ID to associate with the thread.
      */
-    cancel(threadId: string, runId: string, wait?: boolean, action?: CancelAction): Promise<void>;
+    graphId?: string;
     /**
-     * Block until a run is done.
+     * Apply a list of supersteps when creating a thread, each containing a sequence of updates.
      *
-     * @param threadId The ID of the thread.
-     * @param runId The ID of the run.
-     * @returns
+     * Used for copying a thread between deployments.
      */
-    join(threadId: string, runId: string, options?: {
-        signal?: AbortSignal;
-    }): Promise<TStateType>;
-    /**
-     * Stream output from a run in real-time, until the run is done.
-     *
-     * @param threadId The ID of the thread. Can be set to `null` | `undefined` for stateless runs.
-     * @param runId The ID of the run.
-     * @param options Additional options for controlling the stream behavior:
-     *   - signal: An AbortSignal that can be used to cancel the stream request
-     *   - lastEventId: The ID of the last event received. Can be used to reconnect to a stream without losing events.
-     *   - cancelOnDisconnect: When true, automatically cancels the run if the client disconnects from the stream
-     *   - streamMode: Controls what types of events to receive from the stream (can be a single mode or array of modes)
-     *        Must be a subset of the stream modes passed when creating the run. Background runs default to having the union of all
-     *        stream modes enabled.
-     * @returns An async generator yielding stream parts.
-     */
-    joinStream(threadId: string | undefined | null, runId: string, options?: {
-        signal?: AbortSignal;
-        cancelOnDisconnect?: boolean;
-        lastEventId?: string;
-        streamMode?: StreamMode | StreamMode[];
-    } | AbortSignal): AsyncGenerator<{
-        id?: string;
-        event: StreamEvent;
-        data: any;
+    supersteps?: Array<{
+      updates: Array<{
+        values: unknown;
+        command?: Command;
+        asNode: string;
+      }>;
     }>;
     /**
-     * Delete a run.
-     *
-     * @param threadId The ID of the thread.
-     * @param runId The ID of the run.
-     * @returns
-     */
-    delete(threadId: string, runId: string): Promise<void>;
+     * Optional time-to-live in minutes for the thread.
+     * If a number is provided, it is treated as minutes and defaults to strategy "delete".
+     * You may also provide an object { ttl: number, strategy?: "delete" }.
+     */
+    ttl?: number | {
+      ttl: number;
+      strategy?: "delete";
+    };
+  }): Promise<Thread<TStateType>>;
+  /**
+   * Copy an existing thread
+   * @param threadId ID of the thread to be copied
+   * @returns Newly copied thread
+   */
+  copy(threadId: string): Promise<Thread<TStateType>>;
+  /**
+   * Update a thread.
+   *
+   * @param threadId ID of the thread.
+   * @param payload Payload for updating the thread.
+   * @returns The updated thread.
+   */
+  update(threadId: string, payload?: {
+    /**
+     * Metadata for the thread.
+     */
+    metadata?: Metadata;
+    /**
+     * Optional time-to-live in minutes for the thread.
+     * If a number is provided, it is treated as minutes and defaults to strategy "delete".
+     * You may also provide an object { ttl: number, strategy?: "delete" }.
+     */
+    ttl?: number | {
+      ttl: number;
+      strategy?: "delete";
+    };
+  }): Promise<Thread>;
+  /**
+   * Delete a thread.
+   *
+   * @param threadId ID of the thread.
+   */
+  delete(threadId: string): Promise<void>;
+  /**
+   * List threads
+   *
+   * @param query Query options
+   * @returns List of threads
+   */
+  search<ValuesType = TStateType>(query?: {
+    /**
+     * Metadata to filter threads by.
+     */
+    metadata?: Metadata;
+    /**
+     * Filter by specific thread IDs.
+     */
+    ids?: string[];
+    /**
+     * Maximum number of threads to return.
+     * Defaults to 10
+     */
+    limit?: number;
+    /**
+     * Offset to start from.
+     */
+    offset?: number;
+    /**
+     * Thread status to filter on.
+     */
+    status?: ThreadStatus;
+    /**
+     * Sort by.
+     */
+    sortBy?: ThreadSortBy;
+    /**
+     * Sort order.
+     * Must be one of 'asc' or 'desc'.
+     */
+    sortOrder?: SortOrder;
+    select?: ThreadSelectField[];
+  }): Promise<Thread<ValuesType>[]>;
+  /**
+   * Count threads matching filters.
+   *
+   * @param query.metadata Thread metadata to filter on.
+   * @param query.values State values to filter on.
+   * @param query.status Thread status to filter on.
+   * @returns Number of threads matching the criteria.
+   */
+  count<ValuesType = TStateType>(query?: {
+    metadata?: Metadata;
+    values?: ValuesType;
+    status?: ThreadStatus;
+  }): Promise<number>;
+  /**
+   * Get state for a thread.
+   *
+   * @param threadId ID of the thread.
+   * @returns Thread state.
+   */
+  getState<ValuesType = TStateType>(threadId: string, checkpoint?: Checkpoint | string, options?: {
+    subgraphs?: boolean;
+  }): Promise<ThreadState<ValuesType>>;
+  /**
+   * Add state to a thread.
+   *
+   * @param threadId The ID of the thread.
+   * @returns
+   */
+  updateState<ValuesType = TUpdateType>(threadId: string, options: {
+    values: ValuesType;
+    checkpoint?: Checkpoint;
+    checkpointId?: string;
+    asNode?: string;
+  }): Promise<Pick<Config, "configurable">>;
+  /**
+   * Patch the metadata of a thread.
+   *
+   * @param threadIdOrConfig Thread ID or config to patch the state of.
+   * @param metadata Metadata to patch the state with.
+   */
+  patchState(threadIdOrConfig: string | Config, metadata: Metadata): Promise<void>;
+  /**
+   * Get all past states for a thread.
+   *
+   * @param threadId ID of the thread.
+   * @param options Additional options.
+   * @returns List of thread states.
+   */
+  getHistory<ValuesType = TStateType>(threadId: string, options?: {
+    limit?: number;
+    before?: Config;
+    checkpoint?: Partial<Omit<Checkpoint, "thread_id">>;
+    metadata?: Metadata;
+  }): Promise<ThreadState<ValuesType>[]>;
+  joinStream(threadId: string, options?: {
+    lastEventId?: string;
+    streamMode?: ThreadStreamMode | ThreadStreamMode[];
+  }
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ): AsyncGenerator<{
+    id?: string;
+    event: StreamEvent;
+    data: any;
+  }>;
 }
-export declare class StoreClient extends BaseClient {
-    /**
-     * Store or update an item.
-     *
-     * @param namespace A list of strings representing the namespace path.
-     * @param key The unique identifier for the item within the namespace.
-     * @param value A dictionary containing the item's data.
-     * @param options.index Controls search indexing - null (use defaults), false (disable), or list of field paths to index.
-     * @param options.ttl Optional time-to-live in minutes for the item, or null for no expiration.
-     * @returns Promise<void>
-     *
-     * @example
-     * ```typescript
-     * await client.store.putItem(
-     *   ["documents", "user123"],
-     *   "item456",
-     *   { title: "My Document", content: "Hello World" },
-     *   { ttl: 60 } // expires in 60 minutes
-     * );
-     * ```
-     */
-    putItem(namespace: string[], key: string, value: Record<string, unknown>, options?: {
-        index?: false | string[] | null;
-        ttl?: number | null;
-    }): Promise<void>;
-    /**
-     * Retrieve a single item.
-     *
-     * @param namespace A list of strings representing the namespace path.
-     * @param key The unique identifier for the item.
-     * @param options.refreshTtl Whether to refresh the TTL on this read operation. If null, uses the store's default behavior.
-     * @returns Promise<Item>
-     *
-     * @example
-     * ```typescript
-     * const item = await client.store.getItem(
-     *   ["documents", "user123"],
-     *   "item456",
-     *   { refreshTtl: true }
-     * );
-     * console.log(item);
-     * // {
-     * //   namespace: ["documents", "user123"],
-     * //   key: "item456",
-     * //   value: { title: "My Document", content: "Hello World" },
-     * //   createdAt: "2024-07-30T12:00:00Z",
-     * //   updatedAt: "2024-07-30T12:00:00Z"
-     * // }
-     * ```
-     */
-    getItem(namespace: string[], key: string, options?: {
-        refreshTtl?: boolean | null;
-    }): Promise<Item | null>;
-    /**
-     * Delete an item.
-     *
-     * @param namespace A list of strings representing the namespace path.
-     * @param key The unique identifier for the item.
-     * @returns Promise<void>
-     */
-    deleteItem(namespace: string[], key: string): Promise<void>;
-    /**
-     * Search for items within a namespace prefix.
-     *
-     * @param namespacePrefix List of strings representing the namespace prefix.
-     * @param options.filter Optional dictionary of key-value pairs to filter results.
-     * @param options.limit Maximum number of items to return (default is 10).
-     * @param options.offset Number of items to skip before returning results (default is 0).
-     * @param options.query Optional search query.
-     * @param options.refreshTtl Whether to refresh the TTL on items returned by this search. If null, uses the store's default behavior.
-     * @returns Promise<SearchItemsResponse>
-     *
-     * @example
-     * ```typescript
-     * const results = await client.store.searchItems(
-     *   ["documents"],
-     *   {
-     *     filter: { author: "John Doe" },
-     *     limit: 5,
-     *     refreshTtl: true
-     *   }
-     * );
-     * console.log(results);
-     * // {
-     * //   items: [
-     * //     {
-     * //       namespace: ["documents", "user123"],
-     * //       key: "item789",
-     * //       value: { title: "Another Document", author: "John Doe" },
-     * //       createdAt: "2024-07-30T12:00:00Z",
-     * //       updatedAt: "2024-07-30T12:00:00Z"
-     * //     },
-     * //     // ... additional items ...
-     * //   ]
-     * // }
-     * ```
-     */
-    searchItems(namespacePrefix: string[], options?: {
-        filter?: Record<string, unknown>;
-        limit?: number;
-        offset?: number;
-        query?: string;
-        refreshTtl?: boolean | null;
-    }): Promise<SearchItemsResponse>;
-    /**
-     * List namespaces with optional match conditions.
-     *
-     * @param options.prefix Optional list of strings representing the prefix to filter namespaces.
-     * @param options.suffix Optional list of strings representing the suffix to filter namespaces.
-     * @param options.maxDepth Optional integer specifying the maximum depth of namespaces to return.
-     * @param options.limit Maximum number of namespaces to return (default is 100).
-     * @param options.offset Number of namespaces to skip before returning results (default is 0).
-     * @returns Promise<ListNamespaceResponse>
-     */
-    listNamespaces(options?: {
-        prefix?: string[];
-        suffix?: string[];
-        maxDepth?: number;
-        limit?: number;
-        offset?: number;
-    }): Promise<ListNamespaceResponse>;
+declare class RunsClient<TStateType = DefaultValues, TUpdateType = TStateType, TCustomEventType = unknown> extends BaseClient {
+  stream<TStreamMode extends StreamMode | StreamMode[] = StreamMode, TSubgraphs extends boolean = false>(threadId: null, assistantId: string, payload?: Omit<RunsStreamPayload<TStreamMode, TSubgraphs>, "multitaskStrategy" | "onCompletion">): TypedAsyncGenerator<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType>;
+  stream<TStreamMode extends StreamMode | StreamMode[] = StreamMode, TSubgraphs extends boolean = false>(threadId: string, assistantId: string, payload?: RunsStreamPayload<TStreamMode, TSubgraphs>): TypedAsyncGenerator<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType>;
+  /**
+   * Create a run.
+   *
+   * @param threadId The ID of the thread.
+   * @param assistantId Assistant ID to use for this run.
+   * @param payload Payload for creating a run.
+   * @returns The created run.
+   */
+  create(threadId: string | null, assistantId: string, payload?: RunsCreatePayload): Promise<Run>;
+  /**
+   * Create a batch of stateless background runs.
+   *
+   * @param payloads An array of payloads for creating runs.
+   * @returns An array of created runs.
+   */
+  createBatch(payloads: (RunsCreatePayload & {
+    assistantId: string;
+  })[]): Promise<Run[]>;
+  wait(threadId: null, assistantId: string, payload?: Omit<RunsWaitPayload, "multitaskStrategy" | "onCompletion">): Promise<ThreadState["values"]>;
+  wait(threadId: string, assistantId: string, payload?: RunsWaitPayload): Promise<ThreadState["values"]>;
+  /**
+   * List all runs for a thread.
+   *
+   * @param threadId The ID of the thread.
+   * @param options Filtering and pagination options.
+   * @returns List of runs.
+   */
+  list(threadId: string, options?: {
+    /**
+     * Maximum number of runs to return.
+     * Defaults to 10
+     */
+    limit?: number;
+    /**
+     * Offset to start from.
+     * Defaults to 0.
+     */
+    offset?: number;
+    /**
+     * Status of the run to filter by.
+     */
+    status?: RunStatus;
+    select?: RunSelectField[];
+  }): Promise<Run[]>;
+  /**
+   * Get a run by ID.
+   *
+   * @param threadId The ID of the thread.
+   * @param runId The ID of the run.
+   * @returns The run.
+   */
+  get(threadId: string, runId: string): Promise<Run>;
+  /**
+   * Cancel a run.
+   *
+   * @param threadId The ID of the thread.
+   * @param runId The ID of the run.
+   * @param wait Whether to block when canceling
+   * @param action Action to take when cancelling the run. Possible values are `interrupt` or `rollback`. Default is `interrupt`.
+   * @returns
+   */
+  cancel(threadId: string, runId: string, wait?: boolean, action?: CancelAction): Promise<void>;
+  /**
+   * Block until a run is done.
+   *
+   * @param threadId The ID of the thread.
+   * @param runId The ID of the run.
+   * @returns
+   */
+  join(threadId: string, runId: string, options?: {
+    signal?: AbortSignal;
+  }): Promise<TStateType>;
+  /**
+   * Stream output from a run in real-time, until the run is done.
+   *
+   * @param threadId The ID of the thread. Can be set to `null` | `undefined` for stateless runs.
+   * @param runId The ID of the run.
+   * @param options Additional options for controlling the stream behavior:
+   *   - signal: An AbortSignal that can be used to cancel the stream request
+   *   - lastEventId: The ID of the last event received. Can be used to reconnect to a stream without losing events.
+   *   - cancelOnDisconnect: When true, automatically cancels the run if the client disconnects from the stream
+   *   - streamMode: Controls what types of events to receive from the stream (can be a single mode or array of modes)
+   *        Must be a subset of the stream modes passed when creating the run. Background runs default to having the union of all
+   *        stream modes enabled.
+   * @returns An async generator yielding stream parts.
+   */
+  joinStream(threadId: string | undefined | null, runId: string, options?: {
+    signal?: AbortSignal;
+    cancelOnDisconnect?: boolean;
+    lastEventId?: string;
+    streamMode?: StreamMode | StreamMode[];
+  } | AbortSignal
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ): AsyncGenerator<{
+    id?: string;
+    event: StreamEvent;
+    data: any;
+  }>;
+  /**
+   * Delete a run.
+   *
+   * @param threadId The ID of the thread.
+   * @param runId The ID of the run.
+   * @returns
+   */
+  delete(threadId: string, runId: string): Promise<void>;
+}
+declare class StoreClient extends BaseClient {
+  /**
+   * Store or update an item.
+   *
+   * @param namespace A list of strings representing the namespace path.
+   * @param key The unique identifier for the item within the namespace.
+   * @param value A dictionary containing the item's data.
+   * @param options.index Controls search indexing - null (use defaults), false (disable), or list of field paths to index.
+   * @param options.ttl Optional time-to-live in minutes for the item, or null for no expiration.
+   * @returns Promise<void>
+   *
+   * @example
+   * ```typescript
+   * await client.store.putItem(
+   *   ["documents", "user123"],
+   *   "item456",
+   *   { title: "My Document", content: "Hello World" },
+   *   { ttl: 60 } // expires in 60 minutes
+   * );
+   * ```
+   */
+  putItem(namespace: string[], key: string, value: Record<string, unknown>, options?: {
+    index?: false | string[] | null;
+    ttl?: number | null;
+  }): Promise<void>;
+  /**
+   * Retrieve a single item.
+   *
+   * @param namespace A list of strings representing the namespace path.
+   * @param key The unique identifier for the item.
+   * @param options.refreshTtl Whether to refresh the TTL on this read operation. If null, uses the store's default behavior.
+   * @returns Promise<Item>
+   *
+   * @example
+   * ```typescript
+   * const item = await client.store.getItem(
+   *   ["documents", "user123"],
+   *   "item456",
+   *   { refreshTtl: true }
+   * );
+   * console.log(item);
+   * // {
+   * //   namespace: ["documents", "user123"],
+   * //   key: "item456",
+   * //   value: { title: "My Document", content: "Hello World" },
+   * //   createdAt: "2024-07-30T12:00:00Z",
+   * //   updatedAt: "2024-07-30T12:00:00Z"
+   * // }
+   * ```
+   */
+  getItem(namespace: string[], key: string, options?: {
+    refreshTtl?: boolean | null;
+  }): Promise<Item | null>;
+  /**
+   * Delete an item.
+   *
+   * @param namespace A list of strings representing the namespace path.
+   * @param key The unique identifier for the item.
+   * @returns Promise<void>
+   */
+  deleteItem(namespace: string[], key: string): Promise<void>;
+  /**
+   * Search for items within a namespace prefix.
+   *
+   * @param namespacePrefix List of strings representing the namespace prefix.
+   * @param options.filter Optional dictionary of key-value pairs to filter results.
+   * @param options.limit Maximum number of items to return (default is 10).
+   * @param options.offset Number of items to skip before returning results (default is 0).
+   * @param options.query Optional search query.
+   * @param options.refreshTtl Whether to refresh the TTL on items returned by this search. If null, uses the store's default behavior.
+   * @returns Promise<SearchItemsResponse>
+   *
+   * @example
+   * ```typescript
+   * const results = await client.store.searchItems(
+   *   ["documents"],
+   *   {
+   *     filter: { author: "John Doe" },
+   *     limit: 5,
+   *     refreshTtl: true
+   *   }
+   * );
+   * console.log(results);
+   * // {
+   * //   items: [
+   * //     {
+   * //       namespace: ["documents", "user123"],
+   * //       key: "item789",
+   * //       value: { title: "Another Document", author: "John Doe" },
+   * //       createdAt: "2024-07-30T12:00:00Z",
+   * //       updatedAt: "2024-07-30T12:00:00Z"
+   * //     },
+   * //     // ... additional items ...
+   * //   ]
+   * // }
+   * ```
+   */
+  searchItems(namespacePrefix: string[], options?: {
+    filter?: Record<string, unknown>;
+    limit?: number;
+    offset?: number;
+    query?: string;
+    refreshTtl?: boolean | null;
+  }): Promise<SearchItemsResponse>;
+  /**
+   * List namespaces with optional match conditions.
+   *
+   * @param options.prefix Optional list of strings representing the prefix to filter namespaces.
+   * @param options.suffix Optional list of strings representing the suffix to filter namespaces.
+   * @param options.maxDepth Optional integer specifying the maximum depth of namespaces to return.
+   * @param options.limit Maximum number of namespaces to return (default is 100).
+   * @param options.offset Number of namespaces to skip before returning results (default is 0).
+   * @returns Promise<ListNamespaceResponse>
+   */
+  listNamespaces(options?: {
+    prefix?: string[];
+    suffix?: string[];
+    maxDepth?: number;
+    limit?: number;
+    offset?: number;
+  }): Promise<ListNamespaceResponse>;
 }
 declare class UiClient extends BaseClient {
-    private static promiseCache;
-    private static getOrCached;
-    getComponent(assistantId: string, agentName: string): Promise<string>;
+  private static promiseCache;
+  private static getOrCached;
+  getComponent(assistantId: string, agentName: string): Promise<string>;
 }
-export declare class Client<TStateType = DefaultValues, TUpdateType = TStateType, TCustomEventType = unknown> {
-    /**
-     * The client for interacting with assistants.
-     */
-    assistants: AssistantsClient;
-    /**
-     * The client for interacting with threads.
-     */
-    threads: ThreadsClient<TStateType, TUpdateType>;
-    /**
-     * The client for interacting with runs.
-     */
-    runs: RunsClient<TStateType, TUpdateType, TCustomEventType>;
-    /**
-     * The client for interacting with cron runs.
-     */
-    crons: CronsClient;
-    /**
-     * The client for interacting with the KV store.
-     */
-    store: StoreClient;
-    /**
-     * The client for interacting with the UI.
-     * @internal Used by LoadExternalComponent and the API might change in the future.
-     */
-    "~ui": UiClient;
-    /**
-     * @internal Used to obtain a stable key representing the client.
-     */
-    private "~configHash";
-    constructor(config?: ClientConfig);
+declare class Client<TStateType = DefaultValues, TUpdateType = TStateType, TCustomEventType = unknown> {
+  /**
+   * The client for interacting with assistants.
+   */
+  assistants: AssistantsClient;
+  /**
+   * The client for interacting with threads.
+   */
+  threads: ThreadsClient<TStateType, TUpdateType>;
+  /**
+   * The client for interacting with runs.
+   */
+  runs: RunsClient<TStateType, TUpdateType, TCustomEventType>;
+  /**
+   * The client for interacting with cron runs.
+   */
+  crons: CronsClient;
+  /**
+   * The client for interacting with the KV store.
+   */
+  store: StoreClient;
+  /**
+   * The client for interacting with the UI.
+   * @internal Used by LoadExternalComponent and the API might change in the future.
+   */
+  "~ui": UiClient;
+  /**
+   * @internal Used to obtain a stable key representing the client.
+   */
+  private "~configHash";
+  constructor(config?: ClientConfig);
 }
 /**
  * @internal Used to obtain a stable key representing the client.
  */
-export declare function getClientConfigHash(client: Client): string | undefined;
-export {};
+declare function getClientConfigHash(client: Client): string | undefined;
+//#endregion
+export { AssistantsClient, Client, ClientConfig, CronsClient, RequestHook, RunsClient, StoreClient, ThreadsClient, getApiKey, getClientConfigHash };
+//# sourceMappingURL=client.d.ts.map