@copilotkit/runtime 1.82.0 → 1.83.0

package/dist/agent/index.d.cts

@@ -1,4 +1,5 @@
 
+import { CreateSafeUrlDownloadOptions, SafeUrlDownloadOptions, createSafeUrlDownload } from "./url-download.cjs";
 import { BuiltInAgentLearnedSkills, BuiltInAgentLearnedSkillsOptions } from "./learned-skills.cjs";
 import { convertAISDKStream } from "./converters/aisdk.cjs";
 import { TanStackChatMessage, TanStackInputResult, convertInputToTanStackAI, convertTanStackStream } from "./converters/tanstack.cjs";
@@ -6,7 +7,7 @@ import { z } from "zod";
 import { InferSchemaOutput, ModelHostClass, StandardSchemaV1 } from "@copilotkit/shared";
 import { AbstractAgent, BaseEvent, Interrupt, Message, ResumeEntry, RunAgentInput } from "@ag-ui/client";
 import { Observable } from "rxjs";
-import { LanguageModel, ModelMessage, ToolChoice, ToolSet } from "ai";
+import { Experimental_DownloadFunction, LanguageModel, ModelMessage, ToolChoice, ToolSet } from "ai";
 import { AgentCapabilities } from "@ag-ui/core";
 import { StreamableHTTPClientTransportOptions } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
 
@@ -228,6 +229,13 @@ type BuiltInAgentFactoryContext = AgentFactoryContext;
  * Factory config for AI SDK backend.
  * The factory must return an object with a `fullStream` async iterable
  * (compatible with the result of `streamText()` — only `fullStream` is consumed).
+ *
+ * You own the `streamText()` call, so you also own its URL downloads. Pass
+ * `experimental_download: createSafeUrlDownload({ signal: ctx.abortSignal })`
+ * (imported from `@copilotkit/runtime/v2`) to keep the server from fetching
+ * internal addresses named in request attachments, and to stop the downloads
+ * when the run is aborted. BuiltInAgent's `urlDownload` setting does not apply
+ * here: setting it in factory mode throws when the agent is constructed.
  */
 interface BuiltInAgentAISDKFactoryConfig {
   /** Opt in to automatic snapshot acquisition before each run, including resumes. */
@@ -368,6 +376,33 @@ interface BuiltInAgentClassicConfig {
    * Example: `{ openai: { reasoningEffort: "high" } }`
    */
   providerOptions?: Record<string, any>;
+  /**
+   * How the server downloads URL attachments (image and file parts) that the
+   * model cannot take as a URL. The URL comes from the request, so the server
+   * must not fetch it blindly.
+   *
+   * - Not set or an options object (default): download only from public
+   *   internet addresses. The hostname is resolved and every address must be
+   *   public; the connection uses only the checked addresses; each redirect is
+   *   checked again, and a redirect from https to http is refused; the size
+   *   (default 20 MiB) and the time (default 30 s) of each download, and the
+   *   number of distinct URLs (20) and total size (50 MiB) of the downloads
+   *   for one model call are limited. The AI SDK downloads the attachments
+   *   again for each step of a multi-step run. `allowedHosts` limits
+   *   downloads to the hostnames you list: `cdn.example.com` matches exactly,
+   *   `*.example.com` matches subdomains only. Invalid options, including an
+   *   unknown option name, throw when the agent is constructed.
+   * - `"disabled"`: never download from the network. Any attachment URL other
+   *   than `data:` that the model cannot take directly fails the run.
+   * - A function: your own AI SDK download function. You are responsible for
+   *   what it fetches.
+   *
+   * URLs that the model takes directly are sent to the provider unchanged and
+   * are not downloaded by the server. `data:` URLs are decoded locally by the
+   * AI SDK in every mode. Classic config only: in factory mode, see
+   * {@link BuiltInAgentAISDKFactoryConfig}.
+   */
+  urlDownload?: "disabled" | SafeUrlDownloadOptions | Experimental_DownloadFunction;
   /**
    * Explicit agent capabilities. **Shallow-merged** at the category level on
    * top of auto-inferred defaults — providing a category (e.g. `tools`)
@@ -404,6 +439,11 @@ declare class BuiltInAgent extends AbstractAgent {
    * to classify.
    */
   readonly modelHostClass: ModelHostClass;
+  /**
+   * Gives the download function for URL attachments for one run (classic
+   * config only). Resolved in the constructor so a bad setting fails fast.
+   */
+  private readonly urlDownload?;
   constructor(config: BuiltInAgentConfiguration);
   /**
    * Check if a property can be overridden by forwardedProps

package/dist/agent/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/agent/index.ts"],"mappings":";;;;;;;;;;;;;;AA+FA;;;KAAY,mBAAA;;AAoBZ;;;;KAAY,iBAAA;AAkCZ;;;AAAA,KAAY,cAAA,YAA0B,aAAA;;AAKtC;;UAAiB,mBAAA;EAoB+B;EAlB9C,IAAA;EASA;;;;;;AAeF;;EAfE,IAAA;EA8BgB;EA5BhB,GAAA;EAwBA;;;;;;EAjBA,OAAA,GAAU,oCAAA;AAAA;;;;UAMK,kBAAA;EA+BiB;EA7BhC,IAAA;EA+BgB;;;;;;AAqJlB;;EA3KE,IAAA;EA8Kc;EA5Kd,GAAA;EA0KA;EAxKA,OAAA,GAAU,MAAA;AAAA;;;AAuRZ;KAjRY,eAAA,GAAkB,mBAAA,GAAsB,kBAAA;;;;;;;;AAuTpD;UA7SiB,iBAAA;;EAEf,KAAA,IAAS,OAAA,CAAQ,OAAA;AAAA;AAAA,iBAqJH,YAAA,CACd,IAAA,EAAM,cAAA,EACN,MAAA,YACC,aAAA;;;;;;;;;;;AA6JH;;;;;;;;;;iBAhDgB,iBAAA,CAAkB,IAAA,EAAM,cAAA,GAAiB,cAAA;;;;;;cAsC5C,eAAA,SAAwB,KAAA;EAAA,SACP,UAAA,EAAY,SAAA;cAAZ,UAAA,EAAY,SAAA;AAAA;;;;UASzB,cAAA,qBACK,gBAAA,GAAmB,gBAAA;EAEvC,IAAA;EACA,WAAA;EACA,UAAA,EAAY,WAAA;EAiBI;AAWlB;;;EAvBE,OAAA,IAAW,IAAA,EAAM,iBAAA,CAAkB,WAAA,MAAiB,OAAA;EA0BxC;;;;;;;EAlBZ,SAAA;EAeyB;EAbzB,eAAA;EAcA;EAZA,gBAAA;AAAA;;;;;;;;;iBAWc,UAAA,qBAA+B,gBAAA,CAAA,CAAkB,MAAA;EAC/D,IAAA;EACA,WAAA;EACA,UAAA,EAAY,WAAA;EACZ,OAAA,IAAW,IAAA,EAAM,iBAAA,CAAkB,WAAA,MAAiB,OAAA;EACpD,SAAA;EACA,eAAA;EACA,gBAAA;AAAA,IACE,cAAA,CAAe,WAAA;;;AAuKnB;UARiB,wBAAA;EACf,qBAAA;EACA,wBAAA;AAAA;;;;iBAMc,oCAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAS,wBAAA,GACR,YAAA;;;;UAgFO,UAAA;EACR,IAAA;EAQA,WAAA;EACA,UAAA,GAAa,MAAA,SAAe,UAAA;EAC5B,QAAA;EACA,KAAA,GAAQ,UAAA;EACR,IAAA;EAIA,KAAA,GAAQ,UAAA;EACR,KAAA,GAAQ,UAAA;AAAA;;;;iBAMM,4BAAA,CACd,UAAA,EAAY,UAAA,EACZ,QAAA,YACC,CAAA,CAAE,SAAA;;iBA2GW,2BAAA,CACd,KAAA,EAAO,aAAA,YACN,OAAA;;;;;;;;iBA+Ca,qCAAA,CACd,KAAA,EAAO,cAAA,KACN,OAAA;;;;UA6Bc,mBAAA;EA9LD;EAgMd,aAAA,EAAe,yBAAA;EACf,KAAA,EAAO,aAAA;EA9LK;;;;;EAoMZ,eAAA,EAAiB,eAAA;EACjB,WAAA,EAAa,WAAA;EArMD;AA2Gd;;;;;;;EAmGE,SAAA,GAAY,UAAA,EAAY,SAAA,OAAgB,OAAA,CAAQ,WAAA;AAAA;AAlDlD;AAAA,KAsDY,0BAAA,GAA6B,mBAAA;;;;;;UAOxB,8BAAA;EA3DP;EA6DR,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA;IAED,UAAA,EAAY,aAAA;EAAA,IACd,OAAA;IAAU,UAAA,EAAY,aAAA;EAAA;AAAA;;;;;UAOX,iCAAA;EA3CA;EA6Cf,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA,KACF,aAAA,YAAyB,OAAA,CAAQ,aAAA;AAAA;;;;UAMvB,+BAAA;EAtCH;EAwCZ,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA,KACF,aAAA,CAAc,SAAA,IAAa,OAAA,CAAQ,aAAA,CAAc,SAAA;AAAA;AAxCxD;;;AAAA,KA8CY,yBAAA,GACR,8BAAA,GACA,iCAAA,GACA,+BAAA;;AA1CJ;;UA+CiB,yBAAA;EA7CC;EA+ChB,aAAA,GAAgB,gCAAA;EA1CE;;;EA8ClB,KAAA,EAAO,iBAAA,GAAoB,aAAA;EA7ChB;;;;;;;;EAsDX,MAAA;EAtDI;;;EA0DJ,QAAA;EA1DuC;AAOzC;;EAuDE,UAAA,GAAa,UAAA,CAAW,MAAA;EArDR;;;EAyDhB,eAAA;EArD8B;;;EAyD9B,WAAA;EA7DgB;;;EAiEhB,IAAA;EA9DE;;;EAkEF,IAAA;EAjEmD;;AAMrD;EA+DE,eAAA;;;;EAIA,gBAAA;EA7DK;;;EAiEL,aAAA;EAjEuC;;;EAqEvC,IAAA;EAxEA;;;EA4EA,UAAA;EAzEK;;;EA6EL,MAAA;EA7EsD;;;EAiFtD,qBAAA,GAAwB,mBAAA;EA3EW;;;EA+EnC,UAAA,GAAa,eAAA;EA5EX;;;;;;;;AAKJ;;;EAmFE,UAAA,GAAa,iBAAA;EA7EN;;;EAiFP,KAAA,GAAQ,cAAA;EApBgB;;;;EAyBxB,qBAAA;EAmBuB;;;;EAdvB,wBAAA;EA/FgB;;;;EAoGhB,eAAA,GAAkB,MAAA;EAnFlB;;;;;;;;EA4FA,YAAA,GAAe,OAAA,CAAQ,iBAAA;AAAA;;;;;;;;KAUb,yBAAA,GACR,yBAAA,GACA,yBAAA;AAAA,cAWS,YAAA,SAAqB,aAAA;EAAA,QAmBZ,MAAA;EAAA,QAlBZ,eAAA;EAAA,QACA,aAAA;EA5CR;;;;;;;;;AA6BF;;;;EA7BE,SA2DS,cAAA,EAAgB,cAAA;cAEL,MAAA,EAAQ,yBAAA;EAnBJ;;;EAiCxB,WAAA,CAAY,QAAA,EAAU,mBAAA;EAKhB,eAAA,CAAA,GAAmB,OAAA,CAAQ,iBAAA;EA+BjC,GAAA,CAAI,KAAA,EAAO,aAAA,GAAgB,UAAA,CAAW,SAAA;EAAA,QA29B9B,UAAA;EAmQR,KAAA,CAAA,GAAK,YAAA;EAeL,QAAA,CAAA;AAAA;;;;cAQW,UAAA,SAAmB,YAAA;cAClB,MAAA,EAAQ,yBAAA;AAAA;;KAOV,uBAAA,GAA0B,yBAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/agent/index.ts"],"mappings":";;;;;;;;;;;;;;AAkGA;;;;AAAA,KAAY,mBAAA;AAoBZ;;;;;AAAA,KAAY,iBAAA;;;;KAkCA,cAAA,YAA0B,aAAA;AAKtC;;;AAAA,UAAiB,mBAAA;EAEf;EAAA,IAAA;EAWA;;;;;AAaF;;;EAfE,IAAA;EAiBA;EAfA,GAAA;EA0BA;;;;;AAQF;EA3BE,OAAA,GAAU,oCAAA;AAAA;;;AAqCZ;UA/BiB,kBAAA;;EAEf,IAAA;EA+BA;;;;;AAqJF;;;EA3KE,IAAA;EA4KM;EA1KN,GAAA;EA2KA;EAzKA,OAAA,GAAU,MAAA;AAAA;;AAuRZ;;KAjRY,eAAA,GAAkB,mBAAA,GAAsB,kBAAA;;;;;;;AAuTpD;;UA7SiB,iBAAA;EA8SyB;EA5SxC,KAAA,IAAS,OAAA,CAAQ,OAAA;AAAA;AAAA,iBAqJH,YAAA,CACd,IAAA,EAAM,cAAA,EACN,MAAA,YACC,aAAA;;;;;;;;;;AA6JH;;;;;;;;;;;iBAhDgB,iBAAA,CAAkB,IAAA,EAAM,cAAA,GAAiB,cAAA;;;;;;cAsC5C,eAAA,SAAwB,KAAA;EAAA,SACP,UAAA,EAAY,SAAA;cAAZ,UAAA,EAAY,SAAA;AAAA;;;;UASzB,cAAA,qBACK,gBAAA,GAAmB,gBAAA;EAEvC,IAAA;EACA,WAAA;EACA,UAAA,EAAY,WAAA;EA4BE;;;;EAvBd,OAAA,IAAW,IAAA,EAAM,iBAAA,CAAkB,WAAA,MAAiB,OAAA;EA2BjB;;;;;;;EAnBnC,SAAA;EAe6C;EAb7C,eAAA;EAeA;EAbA,gBAAA;AAAA;;;;;;;;;iBAWc,UAAA,qBAA+B,gBAAA,CAAA,CAAkB,MAAA;EAC/D,IAAA;EACA,WAAA;EACA,UAAA,EAAY,WAAA;EACZ,OAAA,IAAW,IAAA,EAAM,iBAAA,CAAkB,WAAA,MAAiB,OAAA;EACpD,SAAA;EACA,eAAA;EACA,gBAAA;AAAA,IACE,cAAA,CAAe,WAAA;;AAuKnB;;UARiB,wBAAA;EACf,qBAAA;EACA,wBAAA;AAAA;;;;iBAMc,oCAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAS,wBAAA,GACR,YAAA;;;;UAgFO,UAAA;EACR,IAAA;EAQA,WAAA;EACA,UAAA,GAAa,MAAA,SAAe,UAAA;EAC5B,QAAA;EACA,KAAA,GAAQ,UAAA;EACR,IAAA;EAIA,KAAA,GAAQ,UAAA;EACR,KAAA,GAAQ,UAAA;AAAA;;;;iBAMM,4BAAA,CACd,UAAA,EAAY,UAAA,EACZ,QAAA,YACC,CAAA,CAAE,SAAA;;iBA2GW,2BAAA,CACd,KAAA,EAAO,aAAA,YACN,OAAA;;;;;;;;iBA+Ca,qCAAA,CACd,KAAA,EAAO,cAAA,KACN,OAAA;;;;UA6Bc,mBAAA;EA9L2B;EAgM1C,aAAA,EAAe,yBAAA;EACf,KAAA,EAAO,aAAA;EAhMK;;;;;EAsMZ,eAAA,EAAiB,eAAA;EACjB,WAAA,EAAa,WAAA;EA1FC;;;;;;;;EAmGd,SAAA,GAAY,UAAA,EAAY,SAAA,OAAgB,OAAA,CAAQ,WAAA;AAAA;;KAItC,0BAAA,GAA6B,mBAAA;;;;;;;AAvBzC;;;;;;UAqCiB,8BAAA;EAlBS;EAoBxB,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA;IAED,UAAA,EAAY,aAAA;EAAA,IACd,OAAA;IAAU,UAAA,EAAY,aAAA;EAAA;AAAA;;;;;UAOX,iCAAA;EAjCS;EAmCxB,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA,KACF,aAAA,YAAyB,OAAA,CAAQ,aAAA;AAAA;;AAnCxC;;UAyCiB,+BAAA;EAzCwB;EA2CvC,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA,KACF,aAAA,CAAc,SAAA,IAAa,OAAA,CAAQ,aAAA,CAAc,SAAA;AAAA;;;;KAM5C,yBAAA,GACR,8BAAA,GACA,iCAAA,GACA,+BAAA;;;;UAKa,yBAAA;EA7CC;EA+ChB,aAAA,GAAgB,gCAAA;EA7ChB;;;EAiDA,KAAA,EAAO,iBAAA,GAAoB,aAAA;EA9CT;;;;;;AAQpB;;EA+CE,MAAA;EA7CgB;;;EAiDhB,QAAA;EA7C8B;;;EAiD9B,UAAA,GAAa,UAAA,CAAW,MAAA;EArDR;;;EAyDhB,eAAA;EAtDE;;;EA0DF,WAAA;EAzDmD;;AAMrD;EAuDE,IAAA;;;;EAIA,IAAA;EArDK;;;EAyDL,eAAA;EAzDuC;;;EA6DvC,gBAAA;EAhEA;;;EAoEA,aAAA;EAjEK;;;EAqEL,IAAA;EArEsD;;;EAyEtD,UAAA;EAnEmC;;;EAuEnC,MAAA;EApEE;;;EAwEF,qBAAA,GAAwB,mBAAA;EAzEtB;;;EA6EF,UAAA,GAAa,eAAA;EAvEE;;;;;;;;;;;EAmFf,UAAA,GAAa,iBAAA;EAmBK;;;EAflB,KAAA,GAAQ,cAAA;EAsDO;;;;EAjDf,qBAAA;EAtFA;;;;EA2FA,wBAAA;EA1EA;;;;EA+EA,eAAA,GAAkB,MAAA;EAnElB;;;;;;;;;;;;;;;;;;;;;;;;;;EA8FA,WAAA,gBAEI,sBAAA,GACA,6BAAA;EASoC;AAU1C;;;;;AAaA;;EAvBE,YAAA,GAAe,OAAA,CAAQ,iBAAA;AAAA;;;;;;;;KAUb,yBAAA,GACR,yBAAA,GACA,yBAAA;AAAA,cAWS,YAAA,SAAqB,aAAA;EAAA,QA2BZ,MAAA;EAAA,QA1BZ,eAAA;EAAA,QACA,aAAA;EAyBY;;;;;;;;;;;;;EAAA,SAVX,cAAA,EAAgB,cAAA;EAwCQ;;;;EAAA,iBAlChB,WAAA;cAIG,MAAA,EAAQ,yBAAA;EA4hCpB;;;EAngCR,WAAA,CAAY,QAAA,EAAU,mBAAA;EAKhB,eAAA,CAAA,GAAmB,OAAA,CAAQ,iBAAA;EA+BjC,GAAA,CAAI,KAAA,EAAO,aAAA,GAAgB,UAAA,CAAW,SAAA;EAAA,QA+9B9B,UAAA;EAmQR,KAAA,CAAA,GAAK,YAAA;EAeL,QAAA,CAAA;AAAA;;;;cAQW,UAAA,SAAmB,YAAA;cAClB,MAAA,EAAQ,yBAAA;AAAA;AAOtB;AAAA,KAAY,uBAAA,GAA0B,yBAAA"}

package/dist/agent/index.d.mts

@@ -1,13 +1,14 @@
 
+import { CreateSafeUrlDownloadOptions, SafeUrlDownloadOptions, createSafeUrlDownload } from "./url-download.mjs";
 import { BuiltInAgentLearnedSkills, BuiltInAgentLearnedSkillsOptions } from "./learned-skills.mjs";
 import { convertAISDKStream } from "./converters/aisdk.mjs";
 import { TanStackChatMessage, TanStackInputResult, convertInputToTanStackAI, convertTanStackStream } from "./converters/tanstack.mjs";
 import "./converters/index.mjs";
 import { InferSchemaOutput, ModelHostClass, StandardSchemaV1 } from "@copilotkit/shared";
 import { Observable } from "rxjs";
-import { AbstractAgent, BaseEvent, Interrupt, Message, ResumeEntry, RunAgentInput } from "@ag-ui/client";
-import { LanguageModel, ModelMessage, ToolChoice, ToolSet } from "ai";
 import { z } from "zod";
+import { AbstractAgent, BaseEvent, Interrupt, Message, ResumeEntry, RunAgentInput } from "@ag-ui/client";
+import { Experimental_DownloadFunction, LanguageModel, ModelMessage, ToolChoice, ToolSet } from "ai";
 import { StreamableHTTPClientTransportOptions } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
 import { AgentCapabilities } from "@ag-ui/core";
 
@@ -229,6 +230,13 @@ type BuiltInAgentFactoryContext = AgentFactoryContext;
  * Factory config for AI SDK backend.
  * The factory must return an object with a `fullStream` async iterable
  * (compatible with the result of `streamText()` — only `fullStream` is consumed).
+ *
+ * You own the `streamText()` call, so you also own its URL downloads. Pass
+ * `experimental_download: createSafeUrlDownload({ signal: ctx.abortSignal })`
+ * (imported from `@copilotkit/runtime/v2`) to keep the server from fetching
+ * internal addresses named in request attachments, and to stop the downloads
+ * when the run is aborted. BuiltInAgent's `urlDownload` setting does not apply
+ * here: setting it in factory mode throws when the agent is constructed.
  */
 interface BuiltInAgentAISDKFactoryConfig {
   /** Opt in to automatic snapshot acquisition before each run, including resumes. */
@@ -369,6 +377,33 @@ interface BuiltInAgentClassicConfig {
    * Example: `{ openai: { reasoningEffort: "high" } }`
    */
   providerOptions?: Record<string, any>;
+  /**
+   * How the server downloads URL attachments (image and file parts) that the
+   * model cannot take as a URL. The URL comes from the request, so the server
+   * must not fetch it blindly.
+   *
+   * - Not set or an options object (default): download only from public
+   *   internet addresses. The hostname is resolved and every address must be
+   *   public; the connection uses only the checked addresses; each redirect is
+   *   checked again, and a redirect from https to http is refused; the size
+   *   (default 20 MiB) and the time (default 30 s) of each download, and the
+   *   number of distinct URLs (20) and total size (50 MiB) of the downloads
+   *   for one model call are limited. The AI SDK downloads the attachments
+   *   again for each step of a multi-step run. `allowedHosts` limits
+   *   downloads to the hostnames you list: `cdn.example.com` matches exactly,
+   *   `*.example.com` matches subdomains only. Invalid options, including an
+   *   unknown option name, throw when the agent is constructed.
+   * - `"disabled"`: never download from the network. Any attachment URL other
+   *   than `data:` that the model cannot take directly fails the run.
+   * - A function: your own AI SDK download function. You are responsible for
+   *   what it fetches.
+   *
+   * URLs that the model takes directly are sent to the provider unchanged and
+   * are not downloaded by the server. `data:` URLs are decoded locally by the
+   * AI SDK in every mode. Classic config only: in factory mode, see
+   * {@link BuiltInAgentAISDKFactoryConfig}.
+   */
+  urlDownload?: "disabled" | SafeUrlDownloadOptions | Experimental_DownloadFunction;
   /**
    * Explicit agent capabilities. **Shallow-merged** at the category level on
    * top of auto-inferred defaults — providing a category (e.g. `tools`)
@@ -405,6 +440,11 @@ declare class BuiltInAgent extends AbstractAgent {
    * to classify.
    */
   readonly modelHostClass: ModelHostClass;
+  /**
+   * Gives the download function for URL attachments for one run (classic
+   * config only). Resolved in the constructor so a bad setting fails fast.
+   */
+  private readonly urlDownload?;
   constructor(config: BuiltInAgentConfiguration);
   /**
    * Check if a property can be overridden by forwardedProps

package/dist/agent/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/agent/index.ts"],"mappings":";;;;;;;;;;;;;;;;AA+FA;;KAAY,mBAAA;;;AAoBZ;;;KAAY,iBAAA;;AAkCZ;;KAAY,cAAA,YAA0B,aAAA;;;AAKtC;UAAiB,mBAAA;;EAEf,IAAA;EAAA;;;;;;;AAwBF;EAfE,IAAA;;EAEA,GAAA;EAeA;;;;;;EARA,OAAA,GAAU,oCAAA;AAAA;;;;UAMK,kBAAA;EA+BA;EA7Bf,IAAA;;;;;;;;AAoLF;EA3KE,IAAA;;EAEA,GAAA;EA0KM;EAxKN,OAAA,GAAU,MAAA;AAAA;;;;KAMA,eAAA,GAAkB,mBAAA,GAAsB,kBAAA;;;;;;;;;UAUnC,iBAAA;EA6SY;EA3S3B,KAAA,IAAS,OAAA,CAAQ,OAAA;AAAA;AAAA,iBAqJH,YAAA,CACd,IAAA,EAAM,cAAA,EACN,MAAA,YACC,aAAA;;;;;;;;;;;;AA6JH;;;;;;;;;iBAhDgB,iBAAA,CAAkB,IAAA,EAAM,cAAA,GAAiB,cAAA;;;;;;cAsC5C,eAAA,SAAwB,KAAA;EAAA,SACP,UAAA,EAAY,SAAA;cAAZ,UAAA,EAAY,SAAA;AAAA;;;;UASzB,cAAA,qBACK,gBAAA,GAAmB,gBAAA;EAEvC,IAAA;EACA,WAAA;EACA,UAAA,EAAY,WAAA;EAiBI;;AAWlB;;EAvBE,OAAA,IAAW,IAAA,EAAM,iBAAA,CAAkB,WAAA,MAAiB,OAAA;EAuBP;;;;;;;EAf7C,SAAA;EAuBgB;EArBhB,eAAA;EAa6C;EAX7C,gBAAA;AAAA;;;;;;;;;iBAWc,UAAA,qBAA+B,gBAAA,CAAA,CAAkB,MAAA;EAC/D,IAAA;EACA,WAAA;EACA,UAAA,EAAY,WAAA;EACZ,OAAA,IAAW,IAAA,EAAM,iBAAA,CAAkB,WAAA,MAAiB,OAAA;EACpD,SAAA;EACA,eAAA;EACA,gBAAA;AAAA,IACE,cAAA,CAAe,WAAA;;;;UA+JF,wBAAA;EACf,qBAAA;EACA,wBAAA;AAAA;;;;iBAMc,oCAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAS,wBAAA,GACR,YAAA;;;;UAgFO,UAAA;EACR,IAAA;EAQA,WAAA;EACA,UAAA,GAAa,MAAA,SAAe,UAAA;EAC5B,QAAA;EACA,KAAA,GAAQ,UAAA;EACR,IAAA;EAIA,KAAA,GAAQ,UAAA;EACR,KAAA,GAAQ,UAAA;AAAA;;;;iBAMM,8BAAA,CACd,UAAA,EAAY,UAAA,EACZ,QAAA,YACC,CAAA,CAAE,SAAA;;iBA2GW,2BAAA,CACd,KAAA,EAAO,aAAA,YACN,OAAA;;;;;;;;iBA+Ca,qCAAA,CACd,KAAA,EAAO,cAAA,KACN,OAAA;;;;UA6Bc,mBAAA;EApMG;EAsMlB,aAAA,EAAe,yBAAA;EACf,KAAA,EAAO,aAAA;;;;;;EAMP,eAAA,EAAiB,eAAA;EACjB,WAAA,EAAa,WAAA;EArMD;;AA2Gd;;;;;;EAmGE,SAAA,GAAY,UAAA,EAAY,SAAA,OAAgB,OAAA,CAAQ,WAAA;AAAA;;KAItC,0BAAA,GAA6B,mBAAA;;;;;;UAOxB,8BAAA;EA3DP;EA6DR,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA;IAED,UAAA,EAAY,aAAA;EAAA,IACd,OAAA;IAAU,UAAA,EAAY,aAAA;EAAA;AAAA;;;;;UAOX,iCAAA;EA3Cf;EA6CA,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA,KACF,aAAA,YAAyB,OAAA,CAAQ,aAAA;AAAA;;;;UAMvB,+BAAA;EAtCS;EAwCxB,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA,KACF,aAAA,CAAc,SAAA,IAAa,OAAA,CAAQ,aAAA,CAAc,SAAA;AAAA;;AAxCxD;;KA8CY,yBAAA,GACR,8BAAA,GACA,iCAAA,GACA,+BAAA;;;AA1CJ;UA+CiB,yBAAA;;EAEf,aAAA,GAAgB,gCAAA;EA5CT;;;EAgDP,KAAA,EAAO,iBAAA,GAAoB,aAAA;EA7ChB;;;;;;;;EAsDX,MAAA;EAvDkB;;;EA2DlB,QAAA;EA1DuC;;AAOzC;EAuDE,UAAA,GAAa,UAAA,CAAW,MAAA;;;;EAIxB,eAAA;EArDsC;;;EAyDtC,WAAA;EA7DA;;;EAiEA,IAAA;EA9DO;;;EAkEP,IAAA;EAjEsC;;;EAqEtC,eAAA;EA/D8C;;;EAmE9C,gBAAA;EA7DmB;;;EAiEnB,aAAA;EAjEgC;;;EAqEhC,IAAA;EAzEgB;;;EA6EhB,UAAA;EA1EE;;;EA8EF,MAAA;EA7EwC;;;EAiFxC,qBAAA,GAAwB,mBAAA;EA3Ed;;;EA+EV,UAAA,GAAa,eAAA;EA7EX;;;;;;;;;AAMJ;;EAmFE,UAAA,GAAa,iBAAA;EAjFG;;;EAqFhB,KAAA,GAAQ,cAAA;EAhEK;;;;EAqEb,qBAAA;EAUkB;;;;EALlB,wBAAA;EA/FA;;;;EAoGA,eAAA,GAAkB,MAAA;EAvFlB;;;;;;;;EAgGA,YAAA,GAAe,OAAA,CAAQ,iBAAA;AAAA;;;;;;;;KAUb,yBAAA,GACR,yBAAA,GACA,yBAAA;AAAA,cAWS,YAAA,SAAqB,aAAA;EAAA,QAmBZ,MAAA;EAAA,QAlBZ,eAAA;EAAA,QACA,aAAA;EAjDA;;;;;;;;;;AAkCV;;;EAlCU,SAgEC,cAAA,EAAgB,cAAA;cAEL,MAAA,EAAQ,yBAAA;EAnBjB;;;EAiCX,WAAA,CAAY,QAAA,EAAU,mBAAA;EAKhB,eAAA,CAAA,GAAmB,OAAA,CAAQ,iBAAA;EA+BjC,GAAA,CAAI,KAAA,EAAO,aAAA,GAAgB,UAAA,CAAW,SAAA;EAAA,QA29B9B,UAAA;EAmQR,KAAA,CAAA,GAAK,YAAA;EAeL,QAAA,CAAA;AAAA;;;;cAQW,UAAA,SAAmB,YAAA;cAClB,MAAA,EAAQ,yBAAA;AAAA;;KAOV,uBAAA,GAA0B,yBAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/agent/index.ts"],"mappings":";;;;;;;;;;;;;;;;AAkGA;;;KAAY,mBAAA;;AAoBZ;;;;KAAY,iBAAA;AAkCZ;;;AAAA,KAAY,cAAA,YAA0B,aAAA;;AAKtC;;UAAiB,mBAAA;EAoB+B;EAlB9C,IAAA;EASA;;;;;;AAeF;;EAfE,IAAA;EA8BgB;EA5BhB,GAAA;EAwBA;;;;;;EAjBA,OAAA,GAAU,oCAAA;AAAA;;;;UAMK,kBAAA;EA+BiB;EA7BhC,IAAA;EA+BgB;;;;;;AAqJlB;;EA3KE,IAAA;EA8Kc;EA5Kd,GAAA;EA0KA;EAxKA,OAAA,GAAU,MAAA;AAAA;;;AAuRZ;KAjRY,eAAA,GAAkB,mBAAA,GAAsB,kBAAA;;;;;;;;AAuTpD;UA7SiB,iBAAA;;EAEf,KAAA,IAAS,OAAA,CAAQ,OAAA;AAAA;AAAA,iBAqJH,YAAA,CACd,IAAA,EAAM,cAAA,EACN,MAAA,YACC,aAAA;;;;;;;;;;;AA6JH;;;;;;;;;;iBAhDgB,iBAAA,CAAkB,IAAA,EAAM,cAAA,GAAiB,cAAA;;;;;;cAsC5C,eAAA,SAAwB,KAAA;EAAA,SACP,UAAA,EAAY,SAAA;cAAZ,UAAA,EAAY,SAAA;AAAA;;;;UASzB,cAAA,qBACK,gBAAA,GAAmB,gBAAA;EAEvC,IAAA;EACA,WAAA;EACA,UAAA,EAAY,WAAA;EAiBI;AAWlB;;;EAvBE,OAAA,IAAW,IAAA,EAAM,iBAAA,CAAkB,WAAA,MAAiB,OAAA;EA0BxC;;;;;;;EAlBZ,SAAA;EAeyB;EAbzB,eAAA;EAcA;EAZA,gBAAA;AAAA;;;;;;;;;iBAWc,UAAA,qBAA+B,gBAAA,CAAA,CAAkB,MAAA;EAC/D,IAAA;EACA,WAAA;EACA,UAAA,EAAY,WAAA;EACZ,OAAA,IAAW,IAAA,EAAM,iBAAA,CAAkB,WAAA,MAAiB,OAAA;EACpD,SAAA;EACA,eAAA;EACA,gBAAA;AAAA,IACE,cAAA,CAAe,WAAA;;;AAuKnB;UARiB,wBAAA;EACf,qBAAA;EACA,wBAAA;AAAA;;;;iBAMc,oCAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAS,wBAAA,GACR,YAAA;;;;UAgFO,UAAA;EACR,IAAA;EAQA,WAAA;EACA,UAAA,GAAa,MAAA,SAAe,UAAA;EAC5B,QAAA;EACA,KAAA,GAAQ,UAAA;EACR,IAAA;EAIA,KAAA,GAAQ,UAAA;EACR,KAAA,GAAQ,UAAA;AAAA;;;;iBAMM,8BAAA,CACd,UAAA,EAAY,UAAA,EACZ,QAAA,YACC,CAAA,CAAE,SAAA;;iBA2GW,2BAAA,CACd,KAAA,EAAO,aAAA,YACN,OAAA;;;;;;;;iBA+Ca,qCAAA,CACd,KAAA,EAAO,cAAA,KACN,OAAA;;;;UA6Bc,mBAAA;EA9LD;EAgMd,aAAA,EAAe,yBAAA;EACf,KAAA,EAAO,aAAA;EA9LK;;;;;EAoMZ,eAAA,EAAiB,eAAA;EACjB,WAAA,EAAa,WAAA;EArMD;AA2Gd;;;;;;;EAmGE,SAAA,GAAY,UAAA,EAAY,SAAA,OAAgB,OAAA,CAAQ,WAAA;AAAA;AAlDlD;AAAA,KAsDY,0BAAA,GAA6B,mBAAA;;;;;;;;AAvBzC;;;;;UAqCiB,8BAAA;EA3BF;EA6Bb,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA;IAED,UAAA,EAAY,aAAA;EAAA,IACd,OAAA;IAAU,UAAA,EAAY,aAAA;EAAA;AAAA;;;;;UAOX,iCAAA;EAjCf;EAmCA,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA,KACF,aAAA,YAAyB,OAAA,CAAQ,aAAA;AAAA;;;AAnCxC;UAyCiB,+BAAA;;EAEf,aAAA,GAAgB,gCAAA;EAChB,IAAA;EACA,OAAA,GACE,GAAA,EAAK,mBAAA,KACF,aAAA,CAAc,SAAA,IAAa,OAAA,CAAQ,aAAA,CAAc,SAAA;AAAA;;;;KAM5C,yBAAA,GACR,8BAAA,GACA,iCAAA,GACA,+BAAA;;;;UAKa,yBAAA;EA7Cf;EA+CA,aAAA,GAAgB,gCAAA;EA9ChB;;;EAkDA,KAAA,EAAO,iBAAA,GAAoB,aAAA;EA9CrB;;;;;;;AAQR;EA+CE,MAAA;;;;EAIA,QAAA;EA7CsC;;;EAiDtC,UAAA,GAAa,UAAA,CAAW,MAAA;EArDxB;;;EAyDA,eAAA;EAtDO;;;EA0DP,WAAA;EAzDsC;;;EA6DtC,IAAA;EAvD8C;;;EA2D9C,IAAA;EArDmB;;;EAyDnB,eAAA;EAzDgC;;;EA6DhC,gBAAA;EAjEgB;;;EAqEhB,aAAA;EAlEE;;;EAsEF,IAAA;EArEwC;;;EAyExC,UAAA;EAnEU;;;EAuEV,MAAA;EArEE;;;EAyEF,qBAAA,GAAwB,mBAAA;EA1EtB;;;EA8EF,UAAA,GAAa,eAAA;EA5EoB;AAKnC;;;;;;;;;;EAmFE,UAAA,GAAa,iBAAA;EAIL;;;EAAR,KAAA,GAAQ,cAAA;EAsDe;;;;EAjDvB,qBAAA;EA1FgB;;;;EA+FhB,wBAAA;EA9EA;;;;EAmFA,eAAA,GAAkB,MAAA;EAvElB;;;;;;;;;;;;;;;;;;;;;;;;;;EAkGA,WAAA,gBAEI,sBAAA,GACA,6BAAA;EASoC;;AAU1C;;;;;AAaA;EAvBE,YAAA,GAAe,OAAA,CAAQ,iBAAA;AAAA;;;;;;;;KAUb,yBAAA,GACR,yBAAA,GACA,yBAAA;AAAA,cAWS,YAAA,SAAqB,aAAA;EAAA,QA2BZ,MAAA;EAAA,QA1BZ,eAAA;EAAA,QACA,aAAA;EAFwB;;;;;;;;;;;;;EAAA,SAiBvB,cAAA,EAAgB,cAAA;EAwCA;;;;EAAA,iBAlCR,WAAA;cAIG,MAAA,EAAQ,yBAAA;EA6DU;;;EApCtC,WAAA,CAAY,QAAA,EAAU,mBAAA;EAKhB,eAAA,CAAA,GAAmB,OAAA,CAAQ,iBAAA;EA+BjC,GAAA,CAAI,KAAA,EAAO,aAAA,GAAgB,UAAA,CAAW,SAAA;EAAA,QA+9B9B,UAAA;EAmQR,KAAA,CAAA,GAAK,YAAA;EAeL,QAAA,CAAA;AAAA;;;;cAQW,UAAA,SAAmB,YAAA;cAClB,MAAA,EAAQ,yBAAA;AAAA;;KAOV,uBAAA,GAA0B,yBAAA"}

package/dist/agent/index.mjs

@@ -1,5 +1,6 @@
 import "reflect-metadata";
 import { describeEndpoint } from "../lib/runtime/mcp-client-cache.mjs";
+import { createSafeUrlDownload, logModelCallError, resolveUrlDownloadSetting } from "./url-download.mjs";
 import { createStateEventNormalizer } from "./state-delta.mjs";
 import { collectStandardRunFinishedDetails, getNonEmptyString, isRecord } from "./converters/usage.mjs";
 import { convertAISDKStream, formatToolError, getAISDKRunFinishedDetails, resolveStreamPartMessageId } from "./converters/aisdk.mjs";
@@ -11,6 +12,7 @@ import { createOpenAI } from "@ai-sdk/openai";
 import { classifyModelHost, randomUUID, safeParseToolArgs, schemaToJsonSchema } from "@copilotkit/shared";
 import { createGoogleGenerativeAI } from "@ai-sdk/google";
 import { Observable } from "rxjs";
+import { z } from "zod";
 import { AbstractAgent, EventType, PROTOCOL_VERSION } from "@ag-ui/client";
 import { RENDER_A2UI_TOOL } from "@ag-ui/a2ui-middleware";
 import { Validator } from "@cfworker/json-schema";
@@ -18,7 +20,6 @@ import { jsonSchema, stepCountIs, streamText, tool } from "ai";
 import { createMCPClient } from "@ai-sdk/mcp";
 import { createAnthropic } from "@ai-sdk/anthropic";
 import { createVertex } from "@ai-sdk/google-vertex";
-import { z } from "zod";
 import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
 
 //#region src/agent/index.ts
@@ -550,6 +551,8 @@ var BuiltInAgent = class BuiltInAgent extends AbstractAgent {
 	constructor(config) {
 		super();
 		this.config = config;
+		if (!isFactoryConfig(config)) this.urlDownload = resolveUrlDownloadSetting(config.urlDownload);
+		else if ("urlDownload" in config) throw new Error("BuiltInAgent: urlDownload has no effect in factory mode. Pass experimental_download: createSafeUrlDownload({ signal: ctx.abortSignal }) (from @copilotkit/runtime/v2) to your own streamText() call instead.");
 		this.skillRegistry = config.learnedSkills === void 0 ? void 0 : new SkillRegistry(config.learnedSkills);
 		this.modelHostClass = isFactoryConfig(config) ? "unknown" : classifyModelSpec(config.model);
 	}
@@ -670,7 +673,8 @@ This is state from the application that you can edit by calling AGUISendStateSna
 				stopSequences: config.stopSequences,
 				seed: config.seed,
 				providerOptions: config.providerOptions,
-				maxRetries: config.maxRetries
+				maxRetries: config.maxRetries,
+				experimental_download: this.urlDownload?.(abortController.signal)
 			};
 			if (input.forwardedProps && typeof input.forwardedProps === "object") {
 				const props = input.forwardedProps;
@@ -816,7 +820,8 @@ This is state from the application that you can edit by calling AGUISendStateSna
 					const response = streamText({
 						...streamTextParams,
 						...messages.length > 0 ? { system: systemMessages.length > 0 ? systemMessages : void 0 } : { messages: systemMessages },
-						abortSignal: abortController.signal
+						abortSignal: abortController.signal,
+						onError: ({ error }) => logModelCallError(error)
 					});
 					const interruptToolNames = new Set((isFactoryConfig(this.config) ? [] : this.config.tools ?? []).filter((t) => t.interrupt).map((t) => t.name));
 					const interruptToolMeta = new Map((isFactoryConfig(this.config) ? [] : this.config.tools ?? []).filter((t) => t.interrupt).map((t) => [t.name, {