fixed ollama and vllm keys

Author: waleedlatif1

apps/sim/providers/utils.test.ts

@@ -32,6 +32,7 @@ import {
   PROVIDERS_WITH_TOOL_USAGE_CONTROL,
   prepareToolExecution,
   prepareToolsWithUsageControl,
+  providerRequiresApiKey,
   shouldBillModelUsage,
   supportsTemperature,
   supportsToolUsageControl,
@@ -1385,4 +1386,37 @@ describe('Provider/Model Blacklist', () => {
       expect(getProviderFromModel('CLAUDE-SONNET-4-5')).toBe('anthropic')
     })
   })
+
+  describe('providerRequiresApiKey', () => {
+    it.concurrent('should return false for Ollama models', () => {
+      expect(providerRequiresApiKey('llama3.2:1b')).toBe(false)
+      expect(providerRequiresApiKey('codellama:13b')).toBe(false)
+      expect(providerRequiresApiKey('phi3:latest')).toBe(false)
+    })
+
+    it.concurrent('should return false for vLLM models', () => {
+      expect(providerRequiresApiKey('vllm/mistral-7b')).toBe(false)
+      expect(providerRequiresApiKey('vllm/llama-3-8b')).toBe(false)
+    })
+
+    it.concurrent('should return true for OpenAI models', () => {
+      expect(providerRequiresApiKey('gpt-4o')).toBe(true)
+      expect(providerRequiresApiKey('gpt-4o-mini')).toBe(true)
+      expect(providerRequiresApiKey('o3-mini')).toBe(true)
+    })
+
+    it.concurrent('should return true for Anthropic models', () => {
+      expect(providerRequiresApiKey('claude-sonnet-4-5')).toBe(true)
+      expect(providerRequiresApiKey('claude-opus-4-6')).toBe(true)
+    })
+
+    it.concurrent('should return true for Google models', () => {
+      expect(providerRequiresApiKey('gemini-2.0-flash')).toBe(true)
+      expect(providerRequiresApiKey('gemini-1.5-pro')).toBe(true)
+    })
+
+    it.concurrent('should return true for xAI models', () => {
+      expect(providerRequiresApiKey('grok-2')).toBe(true)
+    })
+  })
 })

apps/sim/providers/utils.ts

@@ -634,6 +634,15 @@ export function shouldBillModelUsage(model: string): boolean {
   return hostedModels.some((hostedModel) => model.toLowerCase() === hostedModel.toLowerCase())
 }
 
+/**
+ * Checks whether a given model's provider requires a user-supplied API key.
+ * Local providers (Ollama, vLLM) don't need one.
+ */
+export function providerRequiresApiKey(model: string): boolean {
+  const provider = getProviderFromModel(model)
+  return provider !== 'ollama' && provider !== 'vllm'
+}
+
 /**
  * Get an API key for a specific provider, handling rotation and fallbacks
  * For use server-side only

apps/sim/serializer/index.ts

@@ -14,7 +14,7 @@ import {
 } from '@/lib/workflows/subblocks/visibility'
 import { getBlock } from '@/blocks'
 import type { SubBlockConfig } from '@/blocks/types'
-import { getProviderFromModel } from '@/providers/utils'
+import { providerRequiresApiKey } from '@/providers/utils'
 import type { SerializedBlock, SerializedWorkflow } from '@/serializer/types'
 import type { BlockState, Loop, Parallel } from '@/stores/workflows/workflow/types'
 import { generateLoopBlocks, generateParallelBlocks } from '@/stores/workflows/workflow/utils'
@@ -525,15 +525,13 @@ export class Serializer {
       const canonicalId = canonicalIndex.canonicalIdBySubBlockId[subBlockConfig.id]
       const fieldValue = canonicalId ? params[canonicalId] : params[subBlockConfig.id]
       if (fieldValue === undefined || fieldValue === null || fieldValue === '') {
-        if (subBlockConfig.id === 'apiKey' && params.model) {
-          try {
-            const provider = getProviderFromModel(params.model as string)
-            if (provider === 'ollama' || provider === 'vllm') {
-              return
-            }
-          } catch {
-            // If provider resolution fails, continue with validation
-          }
+        // Skip API key validation for local providers that don't require one (Ollama, vLLM)
+        if (
+          subBlockConfig.id === 'apiKey' &&
+          params.model &&
+          !providerRequiresApiKey(params.model as string)
+        ) {
+          return
         }
         missingFields.push(subBlockConfig.title || subBlockConfig.id)
       }

apps/sim/serializer/tests/provider-api-key-validation.test.ts

@@ -0,0 +1,150 @@
+/**
+ * @vitest-environment jsdom
+ *
+ * Tests for API key validation with local providers (Ollama, vLLM).
+ * Verifies that the serializer skips API key validation for providers
+ * that don't require one, while still enforcing it for cloud providers.
+ */
+import { loggerMock } from '@sim/testing/mocks'
+import { describe, expect, it, vi } from 'vitest'
+import { Serializer } from '@/serializer/index'
+
+const agentBlockConfig = {
+  name: 'Agent',
+  category: 'blocks',
+  bgColor: '#2196F3',
+  tools: {
+    access: ['openai_chat'],
+    config: {
+      tool: () => {
+        throw new Error('Invalid model selected')
+      },
+    },
+  },
+  subBlocks: [
+    { id: 'model', type: 'combobox', title: 'Model', required: true },
+    { id: 'apiKey', type: 'short-input', title: 'API Key', required: true },
+    { id: 'messages', type: 'messages-input', title: 'Messages' },
+  ],
+  inputs: {
+    model: { type: 'string' },
+    apiKey: { type: 'string' },
+    messages: { type: 'json' },
+  },
+}
+
+vi.mock('@/blocks', () => ({
+  getBlock: (type: string) => {
+    if (type === 'agent') return agentBlockConfig
+    return null
+  },
+  getAllBlocks: () => [agentBlockConfig],
+}))
+
+vi.mock('@/tools/utils', () => ({
+  getTool: () => null,
+}))
+
+vi.mock('@sim/logger', () => loggerMock)
+
+vi.mock('@/providers/utils', () => ({
+  providerRequiresApiKey: (model: string) => {
+    if (model.startsWith('vllm/')) return false
+    if (model.startsWith('gpt') || model.startsWith('o1') || model.startsWith('o3')) return true
+    if (model.includes('claude')) return true
+    if (model.includes('gemini')) return true
+    if (model.startsWith('grok')) return true
+    // Unknown models default to ollama — no API key required
+    return false
+  },
+}))
+
+function createAgentBlock(model: string, apiKey: string | null = null): any {
+  return {
+    id: 'agent-1',
+    type: 'agent',
+    name: 'Agent',
+    position: { x: 0, y: 0 },
+    subBlocks: {
+      model: { value: model },
+      apiKey: { value: apiKey },
+      messages: { value: [] },
+    },
+    outputs: {},
+    enabled: true,
+  }
+}
+
+describe('API key validation for local providers', () => {
+  it.concurrent('should not require API key for Ollama models', () => {
+    const serializer = new Serializer()
+    const block = createAgentBlock('llama3.2:1b')
+
+    expect(() => {
+      serializer.serializeWorkflow({ 'agent-1': block }, [], {}, undefined, true)
+    }).not.toThrow()
+  })
+
+  it.concurrent('should not require API key for other Ollama model names', () => {
+    const serializer = new Serializer()
+    const block = createAgentBlock('mistral:7b')
+
+    expect(() => {
+      serializer.serializeWorkflow({ 'agent-1': block }, [], {}, undefined, true)
+    }).not.toThrow()
+  })
+
+  it.concurrent('should not require API key for vLLM models', () => {
+    const serializer = new Serializer()
+    const block = createAgentBlock('vllm/mistral-7b')
+
+    expect(() => {
+      serializer.serializeWorkflow({ 'agent-1': block }, [], {}, undefined, true)
+    }).not.toThrow()
+  })
+
+  it.concurrent('should require API key for OpenAI models', () => {
+    const serializer = new Serializer()
+    const block = createAgentBlock('gpt-4o')
+
+    expect(() => {
+      serializer.serializeWorkflow({ 'agent-1': block }, [], {}, undefined, true)
+    }).toThrow('Agent is missing required fields: API Key')
+  })
+
+  it.concurrent('should require API key for Anthropic models', () => {
+    const serializer = new Serializer()
+    const block = createAgentBlock('claude-sonnet-4-5')
+
+    expect(() => {
+      serializer.serializeWorkflow({ 'agent-1': block }, [], {}, undefined, true)
+    }).toThrow('Agent is missing required fields: API Key')
+  })
+
+  it.concurrent('should require API key for Google models', () => {
+    const serializer = new Serializer()
+    const block = createAgentBlock('gemini-2.0-flash')
+
+    expect(() => {
+      serializer.serializeWorkflow({ 'agent-1': block }, [], {}, undefined, true)
+    }).toThrow('Agent is missing required fields: API Key')
+  })
+
+  it.concurrent('should pass validation when API key is provided for cloud provider', () => {
+    const serializer = new Serializer()
+    const block = createAgentBlock('gpt-4o', 'sk-test-key')
+
+    expect(() => {
+      serializer.serializeWorkflow({ 'agent-1': block }, [], {}, undefined, true)
+    }).not.toThrow()
+  })
+
+  it.concurrent('should pass validation for Ollama even with empty string API key', () => {
+    const serializer = new Serializer()
+    const block = createAgentBlock('llama3.2:1b', '')
+
+    expect(() => {
+      serializer.serializeWorkflow({ 'agent-1': block }, [], {}, undefined, true)
+    }).not.toThrow()
+  })
+})