@n8n/api-types 1.32.1 → 1.33.0

package/dist/agents/agent-json-config.schema.d.ts

@@ -322,7 +322,7 @@ declare const AgentJsonTaskConfigSchema: z.ZodObject<{
 }>;
 export declare const McpAuthenticationSchemaTypes: z.ZodEnum<["none", "bearerAuth", "headerAuth", "multipleHeadersAuth", "mcpOAuth2Api"]>;
 export declare const McpServerConfigSchema: z.ZodObject<{
-    name: z.ZodString;
+    name: z.ZodEffects<z.ZodString, string, string>;
     description: z.ZodOptional<z.ZodString>;
     url: z.ZodString;
     transport: z.ZodDefault<z.ZodEnum<["sse", "streamableHttp"]>>;
@@ -771,7 +771,7 @@ declare const AgentJsonToolConfigSchema: z.ZodDiscriminatedUnion<"type", [z.ZodO
     };
     requireApproval?: boolean | undefined;
 }>]>;
-export declare const AgentJsonConfigSchema: z.ZodObject<{
+export declare const AgentJsonConfigBaseSchema: z.ZodObject<{
     name: z.ZodString;
     model: z.ZodUnion<[z.ZodLiteral<"">, z.ZodString]>;
     credential: z.ZodOptional<z.ZodString>;
@@ -1354,7 +1354,7 @@ export declare const AgentJsonConfigSchema: z.ZodObject<{
         credentialId: string;
     }>]>, "many">>;
     mcpServers: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
+        name: z.ZodEffects<z.ZodString, string, string>;
         description: z.ZodOptional<z.ZodString>;
         url: z.ZodString;
         transport: z.ZodDefault<z.ZodEnum<["sse", "streamableHttp"]>>;
@@ -2246,8 +2246,10 @@ export declare const AgentJsonConfigSchema: z.ZodObject<{
         maxIterations?: number | undefined;
     } | undefined;
 }>;
-export declare const RunnableAgentJsonConfigSchema: z.ZodObject<{
+export declare const AgentJsonConfigSchema: z.ZodEffects<z.ZodObject<{
     name: z.ZodString;
+    model: z.ZodUnion<[z.ZodLiteral<"">, z.ZodString]>;
+    credential: z.ZodOptional<z.ZodString>;
     instructions: z.ZodString;
     personalisation: z.ZodOptional<z.ZodObject<{
         icon: z.ZodString;
@@ -2827,7 +2829,7 @@ export declare const RunnableAgentJsonConfigSchema: z.ZodObject<{
         credentialId: string;
     }>]>, "many">>;
     mcpServers: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
+        name: z.ZodEffects<z.ZodString, string, string>;
         description: z.ZodOptional<z.ZodString>;
         url: z.ZodString;
         transport: z.ZodDefault<z.ZodEnum<["sse", "streamableHttp"]>>;
@@ -3296,11 +3298,10 @@ export declare const RunnableAgentJsonConfigSchema: z.ZodObject<{
         toolCallConcurrency?: number | undefined;
         maxIterations?: number | undefined;
     }>>;
-} & {
-    model: z.ZodString;
-    credential: z.ZodEffects<z.ZodString, string, string>;
 }, "strip", z.ZodTypeAny, {
     name: string;
+    model: string;
+    credential?: string | undefined;
     instructions: string;
     personalisation?: {
         icon: string;
@@ -3508,10 +3509,10 @@ export declare const RunnableAgentJsonConfigSchema: z.ZodObject<{
         toolCallConcurrency?: number | undefined;
         maxIterations?: number | undefined;
     } | undefined;
-    model: string;
-    credential: string;
 }, {
     name: string;
+    model: string;
+    credential?: string | undefined;
     instructions: string;
     personalisation?: {
         icon: string;
@@ -3719,15 +3720,433 @@ export declare const RunnableAgentJsonConfigSchema: z.ZodObject<{
         toolCallConcurrency?: number | undefined;
         maxIterations?: number | undefined;
     } | undefined;
+}>, {
+    name: string;
     model: string;
-    credential: string;
+    credential?: string | undefined;
+    instructions: string;
+    personalisation?: {
+        icon: string;
+        gradient: {
+            from: string;
+            to: string;
+            angle: number;
+            fromStop: number;
+            toStop: number;
+        };
+    } | undefined;
+    memory?: {
+        enabled: boolean;
+        storage: "n8n";
+        observationalMemory?: {
+            enabled?: boolean | undefined;
+            observerModel?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            reflectorModel?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            observerThresholdTokens?: number | undefined;
+            reflectorThresholdTokens?: number | undefined;
+            renderTokenBudget?: number | undefined;
+            observationLogTailLimit?: number | undefined;
+            lockTtlMs?: number | undefined;
+        } | undefined;
+        episodicMemory?: {
+            enabled: false;
+        } | {
+            enabled: true;
+            credential: string;
+            extractorModel?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            reflectorModel?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            topK?: number | undefined;
+            maxEntriesPerRun?: number | undefined;
+        } | undefined;
+    } | undefined;
+    subAgents?: {
+        maxChildren?: number | undefined;
+        agents?: {
+            agentId: string;
+            useWhen?: string | undefined;
+        }[] | undefined;
+        modelsByDifficulty?: {
+            low?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            medium?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            high?: {
+                model: string;
+                credential: string;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+    tools?: ({
+        type: "custom";
+        id: string;
+        requireApproval?: boolean | undefined;
+    } | {
+        type: "workflow";
+        workflow: string;
+        name?: string | undefined;
+        description?: string | undefined;
+        requireApproval?: boolean | undefined;
+        allOutputs?: boolean | undefined;
+    } | {
+        type: "node";
+        name: string;
+        description?: string | undefined;
+        inputSchema?: undefined;
+        node: {
+            nodeType: string;
+            nodeTypeVersion: number;
+            nodeParameters: Record<string, unknown>;
+            credentials?: Record<string, {
+                id: string;
+                name: string;
+            }> | undefined;
+        };
+        requireApproval?: boolean | undefined;
+    })[] | undefined;
+    skills?: {
+        type: "skill";
+        id: string;
+    }[] | undefined;
+    tasks?: {
+        type: "task";
+        id: string;
+        enabled: boolean;
+    }[] | undefined;
+    providerTools?: Record<string, Record<string, unknown>> | undefined;
+    integrations?: ({
+        type: "telegram";
+        credentialId: string;
+        settings?: {
+            accessMode: "private" | "public";
+            allowedUsers: string[];
+        } | undefined;
+    } | {
+        type: "slack";
+        credentialId: string;
+    } | {
+        type: "linear";
+        credentialId: string;
+    })[] | undefined;
+    mcpServers?: {
+        name: string;
+        description?: string | undefined;
+        url: string;
+        transport: "sse" | "streamableHttp";
+        authentication: string;
+        credential?: string | undefined;
+        metadata?: {
+            nodeTypeName?: string | undefined;
+        } | undefined;
+        toolFilter?: {
+            mode: "allow";
+            tools: string[];
+        } | {
+            mode: "exclude";
+            tools: string[];
+        } | undefined;
+        approval?: {
+            mode: "global";
+        } | {
+            mode: "selected";
+            tools: string[];
+        } | undefined;
+        connectionTimeoutMs?: number | undefined;
+    }[] | undefined;
+    vectorStores?: ({
+        name: string;
+        credential: string;
+        useWhen: string;
+        embedding: {
+            model: string;
+            credential: string;
+        };
+        provider: "pinecone";
+        indexName: string;
+        namespace?: string | undefined;
+    } | {
+        name: string;
+        credential: string;
+        useWhen: string;
+        embedding: {
+            model: string;
+            credential: string;
+        };
+        provider: "qdrant";
+        collectionName: string;
+    } | {
+        name: string;
+        credential: string;
+        useWhen: string;
+        embedding: {
+            model: string;
+            credential: string;
+        };
+        provider: "supabase";
+        tableName: string;
+        queryName?: string | undefined;
+    } | {
+        name: string;
+        credential: string;
+        useWhen: string;
+        embedding: {
+            model: string;
+            credential: string;
+        };
+        provider: "postgres";
+        tableName: string;
+    })[] | undefined;
+    config?: {
+        thinking?: {
+            provider: "anthropic" | "openai";
+            budgetTokens?: number | undefined;
+            reasoningEffort?: string | undefined;
+        } | undefined;
+        promptCaching?: {
+            enabled: boolean;
+            anthropic?: {
+                ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | undefined;
+        webSearch?: {
+            enabled: boolean;
+            provider?: "auto" | "brave" | "native" | "searxng" | undefined;
+            credential?: string | undefined;
+        } | undefined;
+        toolCallConcurrency?: number | undefined;
+        maxIterations?: number | undefined;
+    } | undefined;
+}, {
+    name: string;
+    model: string;
+    credential?: string | undefined;
+    instructions: string;
+    personalisation?: {
+        icon: string;
+        gradient?: {
+            from: string;
+            to: string;
+            angle?: number | undefined;
+            fromStop?: number | undefined;
+            toStop?: number | undefined;
+        } | undefined;
+    } | undefined;
+    memory?: {
+        enabled: boolean;
+        storage: "n8n";
+        observationalMemory?: {
+            enabled?: boolean | undefined;
+            observerModel?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            reflectorModel?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            observerThresholdTokens?: number | undefined;
+            reflectorThresholdTokens?: number | undefined;
+            renderTokenBudget?: number | undefined;
+            observationLogTailLimit?: number | undefined;
+            lockTtlMs?: number | undefined;
+        } | undefined;
+        episodicMemory?: {
+            enabled: false;
+        } | {
+            enabled: true;
+            credential: string;
+            extractorModel?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            reflectorModel?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            topK?: number | undefined;
+            maxEntriesPerRun?: number | undefined;
+        } | undefined;
+    } | undefined;
+    subAgents?: {
+        maxChildren?: number | undefined;
+        agents?: {
+            agentId: string;
+            useWhen?: string | undefined;
+        }[] | undefined;
+        modelsByDifficulty?: {
+            low?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            medium?: {
+                model: string;
+                credential: string;
+            } | undefined;
+            high?: {
+                model: string;
+                credential: string;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+    tools?: ({
+        type: "custom";
+        id: string;
+        requireApproval?: boolean | undefined;
+    } | {
+        type: "workflow";
+        workflow: string;
+        name?: string | undefined;
+        description?: string | undefined;
+        requireApproval?: boolean | undefined;
+        allOutputs?: boolean | undefined;
+    } | {
+        type: "node";
+        name: string;
+        description?: string | undefined;
+        inputSchema?: undefined;
+        node: {
+            nodeType: string;
+            nodeTypeVersion: number;
+            nodeParameters?: Record<string, unknown> | undefined;
+            credentials?: Record<string, {
+                id: string;
+                name: string;
+            }> | undefined;
+        };
+        requireApproval?: boolean | undefined;
+    })[] | undefined;
+    skills?: {
+        type: "skill";
+        id: string;
+    }[] | undefined;
+    tasks?: {
+        type: "task";
+        id: string;
+        enabled: boolean;
+    }[] | undefined;
+    providerTools?: Record<string, Record<string, unknown>> | undefined;
+    integrations?: ({
+        type: "telegram";
+        credentialId: string;
+        settings?: {
+            accessMode: "private" | "public";
+            allowedUsers?: string[] | undefined;
+        } | undefined;
+    } | {
+        type: "slack";
+        credentialId: string;
+    } | {
+        type: "linear";
+        credentialId: string;
+    })[] | undefined;
+    mcpServers?: {
+        name: string;
+        description?: string | undefined;
+        url: string;
+        transport?: "sse" | "streamableHttp" | undefined;
+        authentication?: string | undefined;
+        credential?: string | undefined;
+        metadata?: {
+            nodeTypeName?: string | undefined;
+        } | undefined;
+        toolFilter?: {
+            mode: "allow";
+            tools?: string[] | undefined;
+        } | {
+            mode: "exclude";
+            tools?: string[] | undefined;
+        } | undefined;
+        approval?: {
+            mode: "global";
+        } | {
+            mode: "selected";
+            tools: string[];
+        } | undefined;
+        connectionTimeoutMs?: number | undefined;
+    }[] | undefined;
+    vectorStores?: ({
+        name: string;
+        credential: string;
+        useWhen: string;
+        embedding: {
+            model: string;
+            credential: string;
+        };
+        provider: "pinecone";
+        indexName: string;
+        namespace?: string | undefined;
+    } | {
+        name: string;
+        credential: string;
+        useWhen: string;
+        embedding: {
+            model: string;
+            credential: string;
+        };
+        provider: "qdrant";
+        collectionName: string;
+    } | {
+        name: string;
+        credential: string;
+        useWhen: string;
+        embedding: {
+            model: string;
+            credential: string;
+        };
+        provider: "supabase";
+        tableName: string;
+        queryName?: string | undefined;
+    } | {
+        name: string;
+        credential: string;
+        useWhen: string;
+        embedding: {
+            model: string;
+            credential: string;
+        };
+        provider: "postgres";
+        tableName: string;
+    })[] | undefined;
+    config?: {
+        thinking?: {
+            provider: "anthropic" | "openai";
+            budgetTokens?: number | undefined;
+            reasoningEffort?: string | undefined;
+        } | undefined;
+        promptCaching?: {
+            enabled: boolean;
+            anthropic?: {
+                ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | undefined;
+        webSearch?: {
+            enabled: boolean;
+            provider?: "auto" | "brave" | "native" | "searxng" | undefined;
+            credential?: string | undefined;
+        } | undefined;
+        toolCallConcurrency?: number | undefined;
+        maxIterations?: number | undefined;
+    } | undefined;
 }>;
-export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
-    name: z.ZodOptional<z.ZodString>;
-    model: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"">, z.ZodString]>>;
-    credential: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-    instructions: z.ZodOptional<z.ZodString>;
-    personalisation: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+export declare const RunnableAgentJsonConfigSchema: z.ZodObject<{
+    name: z.ZodString;
+    instructions: z.ZodString;
+    personalisation: z.ZodOptional<z.ZodObject<{
         icon: z.ZodString;
         gradient: z.ZodDefault<z.ZodObject<{
             from: z.ZodString;
@@ -3766,8 +4185,8 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
             fromStop?: number | undefined;
             toStop?: number | undefined;
         } | undefined;
-    }>>>;
-    memory: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+    }>>;
+    memory: z.ZodOptional<z.ZodObject<{
         enabled: z.ZodBoolean;
         storage: z.ZodEnum<["n8n"]>;
         observationalMemory: z.ZodOptional<z.ZodObject<{
@@ -3956,8 +4375,8 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
             topK?: number | undefined;
             maxEntriesPerRun?: number | undefined;
         } | undefined;
-    }>>>;
-    subAgents: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+    }>>;
+    subAgents: z.ZodOptional<z.ZodObject<{
         maxChildren: z.ZodOptional<z.ZodNumber>;
         agents: z.ZodOptional<z.ZodArray<z.ZodObject<{
             agentId: z.ZodString;
@@ -4067,8 +4486,8 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
                 credential: string;
             } | undefined;
         } | undefined;
-    }>>>;
-    tools: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    }>>;
+    tools: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
         type: z.ZodLiteral<"custom">;
         id: z.ZodString;
         requireApproval: z.ZodOptional<z.ZodBoolean>;
@@ -4220,8 +4639,8 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
             }> | undefined;
         };
         requireApproval?: boolean | undefined;
-    })[]>>>;
-    skills: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
+    })[]>>;
+    skills: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
         type: z.ZodLiteral<"skill">;
         id: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -4236,8 +4655,8 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
     }[], {
         type: "skill";
         id: string;
-    }[]>>>;
-    tasks: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
+    }[]>>;
+    tasks: z.ZodOptional<z.ZodArray<z.ZodObject<{
         type: z.ZodLiteral<"task">;
         id: z.ZodString;
         enabled: z.ZodBoolean;
@@ -4249,9 +4668,9 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
         type: "task";
         id: string;
         enabled: boolean;
-    }>, "many">>>;
-    providerTools: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>>;
-    integrations: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<"type", readonly [z.ZodObject<{
+    }>, "many">>;
+    providerTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    integrations: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<"type", readonly [z.ZodObject<{
         type: z.ZodLiteral<"telegram">;
         credentialId: z.ZodString;
     } & {
@@ -4303,9 +4722,9 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
     }, {
         type: "linear";
         credentialId: string;
-    }>]>, "many">>>;
-    mcpServers: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
+    }>]>, "many">>;
+    mcpServers: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
         description: z.ZodOptional<z.ZodString>;
         url: z.ZodString;
         transport: z.ZodDefault<z.ZodEnum<["sse", "streamableHttp"]>>;
@@ -4450,8 +4869,8 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
             tools: string[];
         } | undefined;
         connectionTimeoutMs?: number | undefined;
-    }[]>>>;
-    vectorStores: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodDiscriminatedUnion<"provider", [z.ZodObject<{
+    }[]>>;
+    vectorStores: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodDiscriminatedUnion<"provider", [z.ZodObject<{
         name: z.ZodString;
         credential: z.ZodString;
         useWhen: z.ZodString;
@@ -4685,8 +5104,8 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
         };
         provider: "postgres";
         tableName: string;
-    })[]>>>;
-    config: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+    })[]>>;
+    config: z.ZodOptional<z.ZodObject<{
         thinking: z.ZodOptional<z.ZodObject<{
             provider: z.ZodEnum<["anthropic", "openai"]>;
             budgetTokens: z.ZodOptional<z.ZodNumber>;
@@ -4773,12 +5192,13 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
         } | undefined;
         toolCallConcurrency?: number | undefined;
         maxIterations?: number | undefined;
-    }>>>;
+    }>>;
+} & {
+    model: z.ZodString;
+    credential: z.ZodEffects<z.ZodString, string, string>;
 }, "strip", z.ZodTypeAny, {
-    name?: string | undefined;
-    model?: string | undefined;
-    credential?: string | undefined;
-    instructions?: string | undefined;
+    name: string;
+    instructions: string;
     personalisation?: {
         icon: string;
         gradient: {
@@ -4985,11 +5405,11 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
         toolCallConcurrency?: number | undefined;
         maxIterations?: number | undefined;
     } | undefined;
+    model: string;
+    credential: string;
 }, {
-    name?: string | undefined;
-    model?: string | undefined;
-    credential?: string | undefined;
-    instructions?: string | undefined;
+    name: string;
+    instructions: string;
     personalisation?: {
         icon: string;
         gradient?: {
@@ -5196,6 +5616,8 @@ export declare const AgentJsonConfigPartialSchema: z.ZodObject<{
         toolCallConcurrency?: number | undefined;
         maxIterations?: number | undefined;
     } | undefined;
+    model: string;
+    credential: string;
 }>;
 export type AgentJsonConfig = z.infer<typeof AgentJsonConfigSchema>;
 export type RunnableAgentJsonConfig = z.infer<typeof RunnableAgentJsonConfigSchema>;
@@ -5234,4 +5656,5 @@ export declare function tryParseConfigJson(raw: string): {
 };
 export declare function findVectorStoreToolNameCollisions(config: Pick<AgentJsonConfig, 'tools' | 'vectorStores'>): string[];
 export declare function formatZodErrors(error: ZodError): ConfigValidationError[];
+export declare function formatAgentConfigZodError(error: ZodError): string;
 export {};