@langchain/langgraph-sdk 1.8.9 → 1.9.0

package/README.md

@@ -1,75 +1,122 @@
-# LangGraph JS/TS SDK
+# `@langchain/langgraph-sdk`
 
-This repository contains the JS/TS SDK for interacting with the LangGraph REST API.
+The JavaScript / TypeScript SDK for talking to a LangGraph API server.
+Use it to create and manage assistants, threads, runs, cron
+schedules, and the KV store — and, most importantly, to **stream**
+graph executions in real time.
 
-## Quick Start
+📚 **[Full documentation](./docs/README.md)**
 
-To get started with the JS/TS SDK, [install the package](https://www.npmjs.com/package/@langchain/langgraph-sdk)
+## Install
 
 ```bash
 pnpm add @langchain/langgraph-sdk
+# or: npm install @langchain/langgraph-sdk
+# or: yarn add @langchain/langgraph-sdk
 ```
 
-You will need a running LangGraph API server. If you're running a server locally using `langgraph-cli`, SDK will automatically point at `http://localhost:8123`, otherwise
-you would need to specify the server URL when creating a client.
+## Quick start
 
-```js
+```ts
 import { Client } from "@langchain/langgraph-sdk";
 
-const client = new Client();
+const client = new Client({ apiUrl: "http://localhost:2024" });
 
-// List all assistants
-const assistants = await client.assistants.search({
-  metadata: null,
-  offset: 0,
-  limit: 10,
+// Open a thread-centric stream (the recommended way to stream).
+const thread = client.threads.stream({ assistantId: "my-agent" });
+
+await thread.run.start({
+  input: { messages: [{ role: "user", content: "hello" }] },
 });
 
-// We auto-create an assistant for each graph you register in config.
-const agent = assistants[0];
+for await (const message of thread.messages) {
+  for await (const token of message.text) {
+    process.stdout.write(token);
+  }
+}
 
-// Start a new thread
-const thread = await client.threads.create();
+console.log(await thread.output);
+await thread.close();
+```
 
-// Start a streaming run
-const messages = [{ role: "human", content: "what's the weather in la" }];
+With no `apiUrl`, the SDK points at `http://localhost:2024` (the
+default `langgraph dev` URL).
 
-const streamResponse = client.runs.stream(
-  thread["thread_id"],
-  agent["assistant_id"],
-  {
-    input: { messages },
-  }
-);
+## What's in the SDK
 
-for await (const chunk of streamResponse) {
-  console.log(chunk);
-}
-```
+| Sub-client           | Purpose                                                      | Docs                                         |
+| -------------------- | ------------------------------------------------------------ | -------------------------------------------- |
+| `client.threads`     | Create threads, manage state, and **stream** runs.           | [Threads](./docs/threads.md) · [Streaming](./docs/streaming.md) |
+| `client.assistants`  | CRUD for assistants (schemas, graphs, versions).             | [Assistants](./docs/assistants.md)           |
+| `client.runs`        | Trigger / join / cancel runs without streaming.              | [Runs (legacy)](./docs/runs.md)              |
+| `client.crons`       | Schedule recurring runs.                                     | [Crons](./docs/crons.md)                     |
+| `client.store`       | Namespaced KV + semantic store.                              | [Store](./docs/store.md)                     |
+
+### Streaming
+
+`client.threads.stream(...)` returns a [`ThreadStream`](./docs/streaming.md)
+with typed, lazy projections for every aspect of a run:
 
-## Documentation
+- `thread.messages` / `thread.toolCalls` — assembled chat output.
+- `thread.values` / `thread.output` — graph state and final answer.
+- `thread.interrupts` / `thread.interrupted` — human-in-the-loop.
+- `thread.subgraphs` / `thread.subagents` — nested / deep-agent work.
+- `thread.extensions.<name>` — typed custom server projections.
+- `thread.audio` / `thread.images` / `thread.video` / `thread.files`
+  — media.
 
-To generate documentation, run the following commands:
+> **Deprecated.** The generator-based streaming APIs on
+> `client.runs.*` (`stream`, `joinStream`) and `client.threads.joinStream`
+> are preserved for backwards compatibility only. New code should use
+> `client.threads.stream(...)`. See
+> [Runs (legacy)](./docs/runs.md) for migration guidance.
 
-1. Generate docs.
+### Transports
 
-        pnpm typedoc
+Streaming defaults to Server-Sent Events (SSE) over HTTP. You can
+switch to WebSocket per-call or globally, or plug in a custom
+`AgentServerAdapter`:
+
+```ts
+const thread = client.threads.stream({
+  assistantId: "my-agent",
+  transport: "websocket",
+});
+```
 
-1. Consolidate doc files into one markdown file.
+See [Transports](./docs/transports.md) for full details.
 
-        npx concat-md --decrease-title-levels --ignore=js_ts_sdk_ref.md --start-title-level-at 2 docs > docs/js_ts_sdk_ref.md
+## Framework adapters
 
-1. Copy `js_ts_sdk_ref.md` to MkDocs directory.
+If you're building a UI, use the framework-specific packages that
+wrap this SDK:
 
-        cp docs/js_ts_sdk_ref.md ../../docs/docs/cloud/reference/sdk/js_ts_sdk_ref.md
+- [`@langchain/langgraph-sdk/react`](../sdk-react/docs/README.md)
+- [`@langchain/langgraph-sdk/vue`](../sdk-vue/docs/README.md)
+- [`@langchain/langgraph-sdk/svelte`](../sdk-svelte/docs/README.md)
+- [`@langchain/langgraph-sdk/angular`](../sdk-angular/docs/README.md)
 
-## Reference Documentation
+Use the SDK directly when you need low-level control, run it from a
+non-browser environment (Node.js server, edge workers, scripts), or
+integrate into a framework that does not yet have a first-party
+adapter.
 
-The reference documentation is available [here](https://reference.langchain.com/javascript/modules/_langchain_langgraph-sdk.html).
+## Architecture
 
-More usage examples can be found [here](https://docs.langchain.com/langsmith/sdk#js).
+The client code is organized into sub-client modules under
+`src/client/`:
 
+| Path                | Module                                                                            |
+| ------------------- | --------------------------------------------------------------------------------- |
+| `client/assistants/`| `AssistantsClient`                                                                |
+| `client/threads/`   | `ThreadsClient` (includes the v2 `stream(...)` primitive)                         |
+| `client/runs/`      | `RunsClient` (legacy streaming + CRUD)                                            |
+| `client/crons/`     | `CronsClient`                                                                     |
+| `client/store/`     | `StoreClient`                                                                     |
+| `client/stream/`    | `ThreadStream`, assemblers, transports                                            |
+| `client/base.ts`    | `BaseClient`, shared config & helpers                                             |
+| `client/index.ts`   | Main `Client` class & re-exports                                                  |
 
-## Change Log
+## Change log
 
-The change log for new versions can be found [here](https://github.com/langchain-ai/langgraphjs/blob/main/libs/sdk/CHANGELOG.md).
+See [CHANGELOG.md](https://github.com/langchain-ai/langgraphjs/blob/main/libs/sdk/CHANGELOG.md).

package/dist/client/assistants/index.cjs

@@ -0,0 +1,180 @@
+const require_base = require("../base.cjs");
+//#region src/client/assistants/index.ts
+var AssistantsClient = class extends require_base.BaseClient {
+	/**
+	* Get an assistant by ID.
+	*
+	* @param assistantId The ID of the assistant.
+	* @returns Assistant
+	*/
+	async get(assistantId, options) {
+		return this.fetch(`/assistants/${assistantId}`, { signal: options?.signal });
+	}
+	/**
+	* 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
+	*/
+	async getGraph(assistantId, options) {
+		return this.fetch(`/assistants/${assistantId}/graph`, {
+			params: { xray: options?.xray },
+			signal: options?.signal
+		});
+	}
+	/**
+	* Get the state and config schema of the graph assigned to a runnable
+	* @param assistantId The ID of the assistant.
+	* @returns Graph schema
+	*/
+	async getSchemas(assistantId, options) {
+		return this.fetch(`/assistants/${assistantId}/schemas`, { signal: options?.signal });
+	}
+	/**
+	* 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.
+	*/
+	async getSubgraphs(assistantId, options) {
+		if (options?.namespace) return this.fetch(`/assistants/${assistantId}/subgraphs/${options.namespace}`, {
+			params: { recurse: options?.recurse },
+			signal: options?.signal
+		});
+		return this.fetch(`/assistants/${assistantId}/subgraphs`, {
+			params: { recurse: options?.recurse },
+			signal: options?.signal
+		});
+	}
+	/**
+	* Create a new assistant.
+	* @param payload Payload for creating an assistant.
+	* @returns The created assistant.
+	*/
+	async create(payload) {
+		return this.fetch("/assistants", {
+			method: "POST",
+			json: {
+				graph_id: payload.graphId,
+				config: payload.config,
+				context: payload.context,
+				metadata: payload.metadata,
+				assistant_id: payload.assistantId,
+				if_exists: payload.ifExists,
+				name: payload.name,
+				description: payload.description
+			},
+			signal: payload.signal
+		});
+	}
+	/**
+	* Update an assistant.
+	* @param assistantId ID of the assistant.
+	* @param payload Payload for updating the assistant.
+	* @returns The updated assistant.
+	*/
+	async update(assistantId, payload) {
+		return this.fetch(`/assistants/${assistantId}`, {
+			method: "PATCH",
+			json: {
+				graph_id: payload.graphId,
+				config: payload.config,
+				context: payload.context,
+				metadata: payload.metadata,
+				name: payload.name,
+				description: payload.description
+			},
+			signal: payload.signal
+		});
+	}
+	/**
+	* Delete an assistant.
+	*
+	* @param assistantId ID of the assistant.
+	* @param deleteThreads If true, delete all threads with `metadata.assistant_id` equal to `assistantId`. Defaults to false.
+	*/
+	async delete(assistantId, options) {
+		return this.fetch(`/assistants/${assistantId}?delete_threads=${options?.deleteThreads ?? false}`, {
+			method: "DELETE",
+			signal: options?.signal
+		});
+	}
+	async search(query) {
+		const json = {
+			graph_id: query?.graphId ?? void 0,
+			name: query?.name ?? void 0,
+			metadata: query?.metadata ?? void 0,
+			limit: query?.limit ?? 10,
+			offset: query?.offset ?? 0,
+			sort_by: query?.sortBy ?? void 0,
+			sort_order: query?.sortOrder ?? void 0,
+			select: query?.select ?? void 0
+		};
+		const [assistants, response] = await this.fetch("/assistants/search", {
+			method: "POST",
+			json,
+			withResponse: true,
+			signal: query?.signal
+		});
+		if (query?.includePagination) return {
+			assistants,
+			next: response.headers.get("X-Pagination-Next")
+		};
+		return assistants;
+	}
+	/**
+	* 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.
+	* @param query.name Optional name to filter by.
+	* @returns Number of assistants matching the criteria.
+	*/
+	async count(query) {
+		return this.fetch(`/assistants/count`, {
+			method: "POST",
+			json: {
+				metadata: query?.metadata ?? void 0,
+				graph_id: query?.graphId ?? void 0,
+				name: query?.name ?? void 0
+			},
+			signal: query?.signal
+		});
+	}
+	/**
+	* List all versions of an assistant.
+	*
+	* @param assistantId ID of the assistant.
+	* @returns List of assistant versions.
+	*/
+	async getVersions(assistantId, payload) {
+		return this.fetch(`/assistants/${assistantId}/versions`, {
+			method: "POST",
+			json: {
+				metadata: payload?.metadata ?? void 0,
+				limit: payload?.limit ?? 10,
+				offset: payload?.offset ?? 0
+			},
+			signal: payload?.signal
+		});
+	}
+	/**
+	* Change the version of an assistant.
+	*
+	* @param assistantId ID of the assistant.
+	* @param version The version to change to.
+	* @returns The updated assistant.
+	*/
+	async setLatest(assistantId, version, options) {
+		return this.fetch(`/assistants/${assistantId}/latest`, {
+			method: "POST",
+			json: { version },
+			signal: options?.signal
+		});
+	}
+};
+//#endregion
+exports.AssistantsClient = AssistantsClient;
+
+//# sourceMappingURL=index.cjs.map

package/dist/client/assistants/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["BaseClient"],"sources":["../../../src/client/assistants/index.ts"],"sourcesContent":["import {\n  Assistant,\n  AssistantGraph,\n  AssistantSortBy,\n  AssistantSelectField,\n  AssistantVersion,\n  AssistantsSearchResponse,\n  Config,\n  GraphSchema,\n  Metadata,\n  SortOrder,\n  Subgraphs,\n} from \"../../schema.js\";\nimport type { OnConflictBehavior } from \"../../types.js\";\nimport { BaseClient } from \"../base.js\";\n\nexport class AssistantsClient extends BaseClient {\n  /**\n   * Get an assistant by ID.\n   *\n   * @param assistantId The ID of the assistant.\n   * @returns Assistant\n   */\n  async get(\n    assistantId: string,\n    options?: { signal?: AbortSignal }\n  ): Promise<Assistant> {\n    return this.fetch<Assistant>(`/assistants/${assistantId}`, {\n      signal: options?.signal,\n    });\n  }\n\n  /**\n   * Get the JSON representation of the graph assigned to a runnable\n   * @param assistantId The ID of the assistant.\n   * @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.\n   * @returns Serialized graph\n   */\n  async getGraph(\n    assistantId: string,\n    options?: { xray?: boolean | number; signal?: AbortSignal }\n  ): Promise<AssistantGraph> {\n    return this.fetch<AssistantGraph>(`/assistants/${assistantId}/graph`, {\n      params: { xray: options?.xray },\n      signal: options?.signal,\n    });\n  }\n\n  /**\n   * Get the state and config schema of the graph assigned to a runnable\n   * @param assistantId The ID of the assistant.\n   * @returns Graph schema\n   */\n  async getSchemas(\n    assistantId: string,\n    options?: { signal?: AbortSignal }\n  ): Promise<GraphSchema> {\n    return this.fetch<GraphSchema>(`/assistants/${assistantId}/schemas`, {\n      signal: options?.signal,\n    });\n  }\n\n  /**\n   * Get the schemas of an assistant by ID.\n   *\n   * @param assistantId The ID of the assistant to get the schema of.\n   * @param options Additional options for getting subgraphs, such as namespace or recursion extraction.\n   * @returns The subgraphs of the assistant.\n   */\n  async getSubgraphs(\n    assistantId: string,\n    options?: {\n      namespace?: string;\n      recurse?: boolean;\n      signal?: AbortSignal;\n    }\n  ): Promise<Subgraphs> {\n    if (options?.namespace) {\n      return this.fetch<Subgraphs>(\n        `/assistants/${assistantId}/subgraphs/${options.namespace}`,\n        { params: { recurse: options?.recurse }, signal: options?.signal }\n      );\n    }\n    return this.fetch<Subgraphs>(`/assistants/${assistantId}/subgraphs`, {\n      params: { recurse: options?.recurse },\n      signal: options?.signal,\n    });\n  }\n\n  /**\n   * Create a new assistant.\n   * @param payload Payload for creating an assistant.\n   * @returns The created assistant.\n   */\n  async create(payload: {\n    graphId: string;\n    config?: Config;\n    context?: unknown;\n    metadata?: Metadata;\n    assistantId?: string;\n    ifExists?: OnConflictBehavior;\n    name?: string;\n    description?: string;\n    signal?: AbortSignal;\n  }): Promise<Assistant> {\n    return this.fetch<Assistant>(\"/assistants\", {\n      method: \"POST\",\n      json: {\n        graph_id: payload.graphId,\n        config: payload.config,\n        context: payload.context,\n        metadata: payload.metadata,\n        assistant_id: payload.assistantId,\n        if_exists: payload.ifExists,\n        name: payload.name,\n        description: payload.description,\n      },\n      signal: payload.signal,\n    });\n  }\n\n  /**\n   * Update an assistant.\n   * @param assistantId ID of the assistant.\n   * @param payload Payload for updating the assistant.\n   * @returns The updated assistant.\n   */\n  async update(\n    assistantId: string,\n    payload: {\n      graphId?: string;\n      config?: Config;\n      context?: unknown;\n      metadata?: Metadata;\n      name?: string;\n      description?: string;\n      signal?: AbortSignal;\n    }\n  ): Promise<Assistant> {\n    return this.fetch<Assistant>(`/assistants/${assistantId}`, {\n      method: \"PATCH\",\n      json: {\n        graph_id: payload.graphId,\n        config: payload.config,\n        context: payload.context,\n        metadata: payload.metadata,\n        name: payload.name,\n        description: payload.description,\n      },\n      signal: payload.signal,\n    });\n  }\n\n  /**\n   * Delete an assistant.\n   *\n   * @param assistantId ID of the assistant.\n   * @param deleteThreads If true, delete all threads with `metadata.assistant_id` equal to `assistantId`. Defaults to false.\n   */\n  async delete(\n    assistantId: string,\n    options?: { signal?: AbortSignal; deleteThreads?: boolean }\n  ): Promise<void> {\n    return this.fetch<void>(\n      `/assistants/${assistantId}?delete_threads=${\n        options?.deleteThreads ?? false\n      }`,\n      {\n        method: \"DELETE\",\n        signal: options?.signal,\n      }\n    );\n  }\n\n  /**\n   * List assistants.\n   * @param query Query options.\n   * @returns List of assistants or, when includePagination is true, a mapping with the assistants and next cursor.\n   */\n  async search(query: {\n    graphId?: string;\n    name?: string;\n    metadata?: Metadata;\n    limit?: number;\n    offset?: number;\n    sortBy?: AssistantSortBy;\n    sortOrder?: SortOrder;\n    select?: AssistantSelectField[];\n    includePagination: true;\n    signal?: AbortSignal;\n  }): Promise<AssistantsSearchResponse>;\n\n  async search(query?: {\n    graphId?: string;\n    name?: string;\n    metadata?: Metadata;\n    limit?: number;\n    offset?: number;\n    sortBy?: AssistantSortBy;\n    sortOrder?: SortOrder;\n    select?: AssistantSelectField[];\n    includePagination?: false;\n    signal?: AbortSignal;\n  }): Promise<Assistant[]>;\n\n  async search(query?: {\n    graphId?: string;\n    name?: string;\n    metadata?: Metadata;\n    limit?: number;\n    offset?: number;\n    sortBy?: AssistantSortBy;\n    sortOrder?: SortOrder;\n    select?: AssistantSelectField[];\n    includePagination?: boolean;\n    signal?: AbortSignal;\n  }): Promise<Assistant[] | AssistantsSearchResponse> {\n    const json = {\n      graph_id: query?.graphId ?? undefined,\n      name: query?.name ?? undefined,\n      metadata: query?.metadata ?? undefined,\n      limit: query?.limit ?? 10,\n      offset: query?.offset ?? 0,\n      sort_by: query?.sortBy ?? undefined,\n      sort_order: query?.sortOrder ?? undefined,\n      select: query?.select ?? undefined,\n    };\n    const [assistants, response] = await this.fetch<Assistant[]>(\n      \"/assistants/search\",\n      {\n        method: \"POST\",\n        json,\n        withResponse: true,\n        signal: query?.signal,\n      }\n    );\n\n    if (query?.includePagination) {\n      const next = response.headers.get(\"X-Pagination-Next\");\n      return { assistants, next };\n    }\n\n    return assistants;\n  }\n\n  /**\n   * Count assistants matching filters.\n   *\n   * @param query.metadata Metadata to filter by. Exact match for each key/value.\n   * @param query.graphId Optional graph id to filter by.\n   * @param query.name Optional name to filter by.\n   * @returns Number of assistants matching the criteria.\n   */\n  async count(query?: {\n    metadata?: Metadata;\n    graphId?: string;\n    name?: string;\n    signal?: AbortSignal;\n  }): Promise<number> {\n    return this.fetch<number>(`/assistants/count`, {\n      method: \"POST\",\n      json: {\n        metadata: query?.metadata ?? undefined,\n        graph_id: query?.graphId ?? undefined,\n        name: query?.name ?? undefined,\n      },\n      signal: query?.signal,\n    });\n  }\n\n  /**\n   * List all versions of an assistant.\n   *\n   * @param assistantId ID of the assistant.\n   * @returns List of assistant versions.\n   */\n  async getVersions(\n    assistantId: string,\n    payload?: {\n      metadata?: Metadata;\n      limit?: number;\n      offset?: number;\n      signal?: AbortSignal;\n    }\n  ): Promise<AssistantVersion[]> {\n    return this.fetch<AssistantVersion[]>(\n      `/assistants/${assistantId}/versions`,\n      {\n        method: \"POST\",\n        json: {\n          metadata: payload?.metadata ?? undefined,\n          limit: payload?.limit ?? 10,\n          offset: payload?.offset ?? 0,\n        },\n        signal: payload?.signal,\n      }\n    );\n  }\n\n  /**\n   * Change the version of an assistant.\n   *\n   * @param assistantId ID of the assistant.\n   * @param version The version to change to.\n   * @returns The updated assistant.\n   */\n  async setLatest(\n    assistantId: string,\n    version: number,\n    options?: { signal?: AbortSignal }\n  ): Promise<Assistant> {\n    return this.fetch<Assistant>(`/assistants/${assistantId}/latest`, {\n      method: \"POST\",\n      json: { version },\n      signal: options?.signal,\n    });\n  }\n}\n"],"mappings":";;AAgBA,IAAa,mBAAb,cAAsCA,aAAAA,WAAW;;;;;;;CAO/C,MAAM,IACJ,aACA,SACoB;AACpB,SAAO,KAAK,MAAiB,eAAe,eAAe,EACzD,QAAQ,SAAS,QAClB,CAAC;;;;;;;;CASJ,MAAM,SACJ,aACA,SACyB;AACzB,SAAO,KAAK,MAAsB,eAAe,YAAY,SAAS;GACpE,QAAQ,EAAE,MAAM,SAAS,MAAM;GAC/B,QAAQ,SAAS;GAClB,CAAC;;;;;;;CAQJ,MAAM,WACJ,aACA,SACsB;AACtB,SAAO,KAAK,MAAmB,eAAe,YAAY,WAAW,EACnE,QAAQ,SAAS,QAClB,CAAC;;;;;;;;;CAUJ,MAAM,aACJ,aACA,SAKoB;AACpB,MAAI,SAAS,UACX,QAAO,KAAK,MACV,eAAe,YAAY,aAAa,QAAQ,aAChD;GAAE,QAAQ,EAAE,SAAS,SAAS,SAAS;GAAE,QAAQ,SAAS;GAAQ,CACnE;AAEH,SAAO,KAAK,MAAiB,eAAe,YAAY,aAAa;GACnE,QAAQ,EAAE,SAAS,SAAS,SAAS;GACrC,QAAQ,SAAS;GAClB,CAAC;;;;;;;CAQJ,MAAM,OAAO,SAUU;AACrB,SAAO,KAAK,MAAiB,eAAe;GAC1C,QAAQ;GACR,MAAM;IACJ,UAAU,QAAQ;IAClB,QAAQ,QAAQ;IAChB,SAAS,QAAQ;IACjB,UAAU,QAAQ;IAClB,cAAc,QAAQ;IACtB,WAAW,QAAQ;IACnB,MAAM,QAAQ;IACd,aAAa,QAAQ;IACtB;GACD,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;CASJ,MAAM,OACJ,aACA,SASoB;AACpB,SAAO,KAAK,MAAiB,eAAe,eAAe;GACzD,QAAQ;GACR,MAAM;IACJ,UAAU,QAAQ;IAClB,QAAQ,QAAQ;IAChB,SAAS,QAAQ;IACjB,UAAU,QAAQ;IAClB,MAAM,QAAQ;IACd,aAAa,QAAQ;IACtB;GACD,QAAQ,QAAQ;GACjB,CAAC;;;;;;;;CASJ,MAAM,OACJ,aACA,SACe;AACf,SAAO,KAAK,MACV,eAAe,YAAY,kBACzB,SAAS,iBAAiB,SAE5B;GACE,QAAQ;GACR,QAAQ,SAAS;GAClB,CACF;;CAkCH,MAAM,OAAO,OAWuC;EAClD,MAAM,OAAO;GACX,UAAU,OAAO,WAAW,KAAA;GAC5B,MAAM,OAAO,QAAQ,KAAA;GACrB,UAAU,OAAO,YAAY,KAAA;GAC7B,OAAO,OAAO,SAAS;GACvB,QAAQ,OAAO,UAAU;GACzB,SAAS,OAAO,UAAU,KAAA;GAC1B,YAAY,OAAO,aAAa,KAAA;GAChC,QAAQ,OAAO,UAAU,KAAA;GAC1B;EACD,MAAM,CAAC,YAAY,YAAY,MAAM,KAAK,MACxC,sBACA;GACE,QAAQ;GACR;GACA,cAAc;GACd,QAAQ,OAAO;GAChB,CACF;AAED,MAAI,OAAO,kBAET,QAAO;GAAE;GAAY,MADR,SAAS,QAAQ,IAAI,oBAAoB;GAC3B;AAG7B,SAAO;;;;;;;;;;CAWT,MAAM,MAAM,OAKQ;AAClB,SAAO,KAAK,MAAc,qBAAqB;GAC7C,QAAQ;GACR,MAAM;IACJ,UAAU,OAAO,YAAY,KAAA;IAC7B,UAAU,OAAO,WAAW,KAAA;IAC5B,MAAM,OAAO,QAAQ,KAAA;IACtB;GACD,QAAQ,OAAO;GAChB,CAAC;;;;;;;;CASJ,MAAM,YACJ,aACA,SAM6B;AAC7B,SAAO,KAAK,MACV,eAAe,YAAY,YAC3B;GACE,QAAQ;GACR,MAAM;IACJ,UAAU,SAAS,YAAY,KAAA;IAC/B,OAAO,SAAS,SAAS;IACzB,QAAQ,SAAS,UAAU;IAC5B;GACD,QAAQ,SAAS;GAClB,CACF;;;;;;;;;CAUH,MAAM,UACJ,aACA,SACA,SACoB;AACpB,SAAO,KAAK,MAAiB,eAAe,YAAY,UAAU;GAChE,QAAQ;GACR,MAAM,EAAE,SAAS;GACjB,QAAQ,SAAS;GAClB,CAAC"}

package/dist/client/assistants/index.d.cts

@@ -0,0 +1,155 @@
+import { Assistant, AssistantGraph, AssistantSelectField, AssistantSortBy, AssistantVersion, AssistantsSearchResponse, Config, GraphSchema, Metadata, SortOrder, Subgraphs } from "../../schema.cjs";
+import { OnConflictBehavior } from "../../types.cjs";
+import { BaseClient } from "../base.cjs";
+
+//#region src/client/assistants/index.d.ts
+declare class AssistantsClient extends BaseClient {
+  /**
+   * Get an assistant by ID.
+   *
+   * @param assistantId The ID of the assistant.
+   * @returns Assistant
+   */
+  get(assistantId: string, options?: {
+    signal?: AbortSignal;
+  }): 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;
+    signal?: AbortSignal;
+  }): 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, options?: {
+    signal?: AbortSignal;
+  }): 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;
+    signal?: AbortSignal;
+  }): 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;
+    signal?: AbortSignal;
+  }): 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;
+    signal?: AbortSignal;
+  }): Promise<Assistant>;
+  /**
+   * Delete an assistant.
+   *
+   * @param assistantId ID of the assistant.
+   * @param deleteThreads If true, delete all threads with `metadata.assistant_id` equal to `assistantId`. Defaults to false.
+   */
+  delete(assistantId: string, options?: {
+    signal?: AbortSignal;
+    deleteThreads?: boolean;
+  }): Promise<void>;
+  /**
+   * List assistants.
+   * @param query Query options.
+   * @returns List of assistants or, when includePagination is true, a mapping with the assistants and next cursor.
+   */
+  search(query: {
+    graphId?: string;
+    name?: string;
+    metadata?: Metadata;
+    limit?: number;
+    offset?: number;
+    sortBy?: AssistantSortBy;
+    sortOrder?: SortOrder;
+    select?: AssistantSelectField[];
+    includePagination: true;
+    signal?: AbortSignal;
+  }): Promise<AssistantsSearchResponse>;
+  search(query?: {
+    graphId?: string;
+    name?: string;
+    metadata?: Metadata;
+    limit?: number;
+    offset?: number;
+    sortBy?: AssistantSortBy;
+    sortOrder?: SortOrder;
+    select?: AssistantSelectField[];
+    includePagination?: false;
+    signal?: AbortSignal;
+  }): 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.
+   * @param query.name Optional name to filter by.
+   * @returns Number of assistants matching the criteria.
+   */
+  count(query?: {
+    metadata?: Metadata;
+    graphId?: string;
+    name?: string;
+    signal?: AbortSignal;
+  }): 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;
+    signal?: AbortSignal;
+  }): 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, options?: {
+    signal?: AbortSignal;
+  }): Promise<Assistant>;
+}
+//#endregion
+export { AssistantsClient };
+//# sourceMappingURL=index.d.cts.map

package/dist/client/assistants/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../../src/client/assistants/index.ts"],"mappings":";;;;;cAgBa,gBAAA,SAAyB,UAAA;;AAAtC;;;;;EAOQ,GAAA,CACJ,WAAA,UACA,OAAA;IAAY,MAAA,GAAS,WAAA;EAAA,IACpB,OAAA,CAAQ,SAAA;EAeR;;;;;;EAHG,QAAA,CACJ,WAAA,UACA,OAAA;IAAY,IAAA;IAAyB,MAAA,GAAS,WAAA;EAAA,IAC7C,OAAA,CAAQ,cAAA;EA8DA;;;;;EAlDL,UAAA,CACJ,WAAA,UACA,OAAA;IAAY,MAAA,GAAS,WAAA;EAAA,IACpB,OAAA,CAAQ,WAAA;EAyGY;;;;;;;EA5FjB,YAAA,CACJ,WAAA,UACA,OAAA;IACE,SAAA;IACA,OAAA;IACA,MAAA,GAAS,WAAA;EAAA,IAEV,OAAA,CAAQ,SAAA;EA4HA;;;;;EA1GL,MAAA,CAAO,OAAA;IACX,OAAA;IACA,MAAA,GAAS,MAAA;IACT,OAAA;IACA,QAAA,GAAW,QAAA;IACX,WAAA;IACA,QAAA,GAAW,kBAAA;IACX,IAAA;IACA,WAAA;IACA,MAAA,GAAS,WAAA;EAAA,IACP,OAAA,CAAQ,SAAA;EAxFkC;;;;;;EA+GxC,MAAA,CACJ,WAAA,UACA,OAAA;IACE,OAAA;IACA,MAAA,GAAS,MAAA;IACT,OAAA;IACA,QAAA,GAAW,QAAA;IACX,IAAA;IACA,WAAA;IACA,MAAA,GAAS,WAAA;EAAA,IAEV,OAAA,CAAQ,SAAA;EAjGR;;;;;;EAsHG,MAAA,CACJ,WAAA,UACA,OAAA;IAAY,MAAA,GAAS,WAAA;IAAa,aAAA;EAAA,IACjC,OAAA;EA5FD;;;;;EA6GI,MAAA,CAAO,KAAA;IACX,OAAA;IACA,IAAA;IACA,QAAA,GAAW,QAAA;IACX,KAAA;IACA,MAAA;IACA,MAAA,GAAS,eAAA;IACT,SAAA,GAAY,SAAA;IACZ,MAAA,GAAS,oBAAA;IACT,iBAAA;IACA,MAAA,GAAS,WAAA;EAAA,IACP,OAAA,CAAQ,wBAAA;EAEN,MAAA,CAAO,KAAA;IACX,OAAA;IACA,IAAA;IACA,QAAA,GAAW,QAAA;IACX,KAAA;IACA,MAAA;IACA,MAAA,GAAS,eAAA;IACT,SAAA,GAAY,SAAA;IACZ,MAAA,GAAS,oBAAA;IACT,iBAAA;IACA,MAAA,GAAS,WAAA;EAAA,IACP,OAAA,CAAQ,SAAA;EAxEC;;;;;;;;EA0HP,KAAA,CAAM,KAAA;IACV,QAAA,GAAW,QAAA;IACX,OAAA;IACA,IAAA;IACA,MAAA,GAAS,WAAA;EAAA,IACP,OAAA;EAjGmB;;;;;;EAmHjB,WAAA,CACJ,WAAA,UACA,OAAA;IACE,QAAA,GAAW,QAAA;IACX,KAAA;IACA,MAAA;IACA,MAAA,GAAS,WAAA;EAAA,IAEV,OAAA,CAAQ,gBAAA;EAnGA;;;;;;;EAyHL,SAAA,CACJ,WAAA,UACA,OAAA,UACA,OAAA;IAAY,MAAA,GAAS,WAAA;EAAA,IACpB,OAAA,CAAQ,SAAA;AAAA"}