Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

Make model-provider base_url optional for well-known types. (#40)

debajyoti-truefoundry005a55246f88
diff --git a/fern/openapi/openapi.json b/fern/openapi/openapi.json
index 122d0a3fe..29641fb82 100644
--- a/fern/openapi/openapi.json
+++ b/fern/openapi/openapi.json
@@ -146,6 +146,42 @@
],
"type": "object"
},
+ "AnthropicModelProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "auth": {
+ "$ref": "#/components/schemas/ModelProviderAuth"
+ },
+ "base_url": {
+ "description": "Optional override of the provider's default API base URL.",
+ "format": "uri",
+ "type": "string"
+ },
+ "models": {
+ "items": {
+ "$ref": "#/components/schemas/ModelEntry"
+ },
+ "minItems": 1,
+ "type": "array"
+ },
+ "name": {
+ "$ref": "#/components/schemas/ResourceName"
+ },
+ "type": {
+ "enum": [
+ "anthropic"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "auth",
+ "models",
+ "type",
+ "name"
+ ],
+ "type": "object"
+ },
"AnthropicProviderModelEntry": {
"additionalProperties": false,
"properties": {
@@ -666,6 +702,102 @@
},
"type": "object"
},
+ "CustomModelProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "auth": {
+ "$ref": "#/components/schemas/ModelProviderAuth"
+ },
+ "base_url": {
+ "description": "Base URL of the provider's API.",
+ "format": "uri",
+ "type": "string"
+ },
+ "models": {
+ "items": {
+ "$ref": "#/components/schemas/ModelEntry"
+ },
+ "minItems": 1,
+ "type": "array"
+ },
+ "name": {
+ "$ref": "#/components/schemas/ResourceName"
+ },
+ "type": {
+ "enum": [
+ "custom"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "auth",
+ "models",
+ "type",
+ "base_url",
+ "name"
+ ],
+ "type": "object"
+ },
+ "CustomProviderModelEntry": {
+ "additionalProperties": false,
+ "properties": {
+ "api_format": {
+ "enum": [
+ "openai-chat-completions"
+ ],
+ "type": "string"
+ },
+ "api_key": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "base_url": {
+ "format": "uri",
+ "type": "string"
+ },
+ "headers": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "max_output_tokens": {
+ "exclusiveMinimum": 0,
+ "type": "integer"
+ },
+ "model_id": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "minLength": 1,
+ "pattern": "^[a-z0-9][a-z0-9.-]*$",
+ "type": "string"
+ },
+ "provider": {
+ "enum": [
+ "custom"
+ ],
+ "type": "string"
+ },
+ "reasoning_efforts": {
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "minItems": 1,
+ "type": "array"
+ }
+ },
+ "required": [
+ "name",
+ "max_output_tokens",
+ "provider",
+ "base_url"
+ ],
+ "type": "object"
+ },
"DaytonaSandboxProvider": {
"additionalProperties": false,
"properties": {
@@ -798,65 +930,6 @@
},
"type": "object"
},
- "GenericProviderModelEntry": {
- "additionalProperties": false,
- "properties": {
- "api_format": {
- "enum": [
- "openai-chat-completions"
- ],
- "type": "string"
- },
- "api_key": {
- "minLength": 1,
- "type": "string"
- },
- "base_url": {
- "format": "uri",
- "type": "string"
- },
- "headers": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "max_output_tokens": {
- "exclusiveMinimum": 0,
- "type": "integer"
- },
- "model_id": {
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "minLength": 1,
- "pattern": "^[a-z0-9][a-z0-9.-]*$",
- "type": "string"
- },
- "provider": {
- "enum": [
- "generic"
- ],
- "type": "string"
- },
- "reasoning_efforts": {
- "items": {
- "minLength": 1,
- "type": "string"
- },
- "minItems": 1,
- "type": "array"
- }
- },
- "required": [
- "name",
- "max_output_tokens",
- "provider",
- "base_url"
- ],
- "type": "object"
- },
"GetCapabilitiesResponse": {
"properties": {
"data": {
@@ -1147,7 +1220,7 @@
"discriminator": {
"mapping": {
"anthropic": "#/components/schemas/AnthropicProviderModelEntry",
- "generic": "#/components/schemas/GenericProviderModelEntry",
+ "custom": "#/components/schemas/CustomProviderModelEntry",
"google-gemini": "#/components/schemas/GoogleGeminiProviderModelEntry",
"openai": "#/components/schemas/OpenAIProviderModelEntry"
},
@@ -1164,7 +1237,7 @@
"$ref": "#/components/schemas/GoogleGeminiProviderModelEntry"
},
{
- "$ref": "#/components/schemas/GenericProviderModelEntry"
+ "$ref": "#/components/schemas/CustomProviderModelEntry"
}
]
}
@@ -2043,13 +2116,47 @@
"type": "object"
},
"ModelProvider": {
+ "discriminator": {
+ "mapping": {
+ "anthropic": "#/components/schemas/AnthropicModelProvider",
+ "custom": "#/components/schemas/CustomModelProvider",
+ "openai": "#/components/schemas/OpenAIModelProvider"
+ },
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIModelProvider"
+ },
+ {
+ "$ref": "#/components/schemas/AnthropicModelProvider"
+ },
+ {
+ "$ref": "#/components/schemas/CustomModelProvider"
+ }
+ ]
+ },
+ "ModelProviderAuth": {
+ "additionalProperties": false,
+ "properties": {
+ "api_key": {
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key"
+ ],
+ "type": "object"
+ },
+ "OpenAIModelProvider": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/components/schemas/ModelProviderAuth"
},
"base_url": {
- "description": "Base URL of the provider's API.",
+ "description": "Optional override of the provider's default API base URL.",
"format": "uri",
"type": "string"
},
@@ -2064,31 +2171,20 @@
"$ref": "#/components/schemas/ResourceName"
},
"type": {
- "$ref": "#/components/schemas/ProviderType"
+ "enum": [
+ "openai"
+ ],
+ "type": "string"
}
},
"required": [
- "type",
- "base_url",
"auth",
"models",
+ "type",
"name"
],
"type": "object"
},
- "ModelProviderAuth": {
- "additionalProperties": false,
- "properties": {
- "api_key": {
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "api_key"
- ],
- "type": "object"
- },
"OpenAIProviderModelEntry": {
"additionalProperties": false,
"properties": {
@@ -2160,14 +2256,6 @@
"default": "auto",
"description": "Defaults to 'auto' (chain to session last turn). Use 'null' for the session's first turn."
},
- "ProviderType": {
- "enum": [
- "openai",
- "anthropic",
- "custom"
- ],
- "type": "string"
- },
"PutMcpServerResponse": {
"properties": {
"data": {
diff --git a/packages/harness/src/core/llm/VercelAILLM.ts b/packages/harness/src/core/llm/VercelAILLM.ts
index 75b0c87c3..9cafb6558 100644
--- a/packages/harness/src/core/llm/VercelAILLM.ts
+++ b/packages/harness/src/core/llm/VercelAILLM.ts
@@ -54,7 +54,7 @@ interface ReasoningPart {
}
/** Providers with a dedicated code path in {@link buildLanguageModel}. */
-export type VercelAIProviderName = 'openai' | 'anthropic' | 'google-gemini' | 'generic';
+export type VercelAIProviderName = 'openai' | 'anthropic' | 'google-gemini' | 'custom';
/** Structural config accepted by VercelAILLM; compatible with server's ProviderConfig. */
export interface VercelAIProviderConfig {
@@ -67,7 +67,7 @@ export interface VercelAIProviderConfig {
base_url?: string | undefined;
apiKey: string;
headers: Record<string, string>;
- /** API format for the `generic` provider. Only option today; defaults when absent. */
+ /** API format for the `custom` provider. Only option today; defaults when absent. */
api_format?: 'openai-chat-completions' | undefined;
}
@@ -107,12 +107,12 @@ export function buildLanguageModel(config: VercelAIProviderConfig): LanguageMode
});
return client(modelId);
}
- case 'generic': {
+ case 'custom': {
if (base_url === undefined) {
- throw new Error('Provider "generic" requires a base_url in models.yaml');
+ throw new Error('Provider "custom" requires a base_url in models.yaml');
}
const client = createOpenAICompatible({
- name: 'generic',
+ name: 'custom',
baseURL: base_url,
apiKey,
// Without this, @ai-sdk/openai-compatible silently downgrades json_schema requests
@@ -179,7 +179,7 @@ function isReasoningLevel(v: string): v is ReasoningLevel {
/**
* Maps a harness `reasoning_effort` to the SDK's standardized `reasoning` setting. Only
* `google-gemini` needs this — `@ai-sdk/google` derives its `thinkingConfig` from it, since it has
- * no `providerOptions.google.reasoningEffort` lever like openai/anthropic/generic do.
+ * no `providerOptions.google.reasoningEffort` lever like openai/anthropic/custom do.
*/
export function toReasoningLevel({
provider,
@@ -277,7 +277,7 @@ function googleProviderOptions(rawBody: unknown): JSONObject | undefined {
return Object.keys(opts).length > 0 ? opts : undefined;
}
-function genericProviderOptions(
+function customProviderOptions(
rawBody: unknown,
reasoningEffort: string | undefined,
strictJsonSchema: boolean | undefined,
@@ -319,10 +319,10 @@ export function buildProviderOptions({
const google = googleProviderOptions(rawBody);
return google !== undefined ? { google } : {};
} else {
- // 'generic' — @ai-sdk/openai-compatible registers under the name 'generic'.
+ // 'custom' — @ai-sdk/openai-compatible registers under the name 'custom'.
// this will have to become api_format specific in the future.
- const generic = genericProviderOptions(rawBody, reasoningEffort, strictJsonSchema);
- return generic !== undefined ? { generic } : {};
+ const custom = customProviderOptions(rawBody, reasoningEffort, strictJsonSchema);
+ return custom !== undefined ? { custom } : {};
}
}
@@ -406,7 +406,7 @@ export function toUserContent(content: string | ChatCompletionContentPart[]): Us
* field in its TypeScript type, we read it via Reflect.get so no assertion is needed.
*
* `provider` is used to place the opaque reasoning-replay token under the correct providerOptions key:
- * - `'openai'` / `'generic'` → `providerOptions[provider].encryptedContent` (Responses API)
+ * - `'openai'` / `'custom'` → `providerOptions[provider].encryptedContent` (Responses API)
* - `'anthropic'` → `providerOptions.anthropic.signature`
* - `'google-gemini'` → no standalone reasoning block; replay token is per-tool-call (see below)
*
@@ -442,7 +442,7 @@ export function toAssistantModelMessage({
const signature = 'signature' in tb && typeof tb.signature === 'string' ? tb.signature : undefined;
let reasoningProviderOptions: ProviderOptions | undefined;
if (signature !== undefined && provider !== 'google-gemini') {
- if (provider === 'openai' || provider === 'generic') {
+ if (provider === 'openai' || provider === 'custom') {
reasoningProviderOptions = { [provider]: { encryptedContent: signature } };
} else {
reasoningProviderOptions = { anthropic: { signature } };
diff --git a/packages/harness/tests/core/llm/VercelAILLM.messages.test.ts b/packages/harness/tests/core/llm/VercelAILLM.messages.test.ts
index 43f19a14c..412595f65 100644
--- a/packages/harness/tests/core/llm/VercelAILLM.messages.test.ts
+++ b/packages/harness/tests/core/llm/VercelAILLM.messages.test.ts
@@ -203,18 +203,18 @@ describe('toAssistantModelMessage', () => {
expect(reasoningPart?.providerOptions).toEqual({ anthropic: { signature: 'sig-ant' } });
});
- it('places thinking_blocks as reasoning parts — generic provider → encryptedContent', () => {
+ it('places thinking_blocks as reasoning parts — custom provider → encryptedContent', () => {
const msg: Extract<ChatCompletionMessageParam, { role: 'assistant' }> = {
role: 'assistant',
content: null,
};
Reflect.set(msg, 'thinking_blocks', [{ type: 'thinking', thinking: 'step', signature: 'sig-gen' }]);
- const result = toAssistantModelMessage({ msg: msg, provider: 'generic' });
+ const result = toAssistantModelMessage({ msg: msg, provider: 'custom' });
const reasoningPart = (result.content as Array<{ type: string; providerOptions?: unknown }>).find(
p => p.type === 'reasoning',
);
- expect(reasoningPart?.providerOptions).toEqual({ generic: { encryptedContent: 'sig-gen' } });
+ expect(reasoningPart?.providerOptions).toEqual({ custom: { encryptedContent: 'sig-gen' } });
});
it('omits providerOptions on reasoning part when provider is google-gemini', () => {
diff --git a/packages/harness/tests/core/llm/VercelAILLM.model.test.ts b/packages/harness/tests/core/llm/VercelAILLM.model.test.ts
index e08d41951..cea249443 100644
--- a/packages/harness/tests/core/llm/VercelAILLM.model.test.ts
+++ b/packages/harness/tests/core/llm/VercelAILLM.model.test.ts
@@ -21,8 +21,8 @@ function makeConfig(
// ─────────── buildLanguageModel ───────────
describe('buildLanguageModel', () => {
- it('throws for generic provider without base_url', () => {
- const config = makeConfig({ provider: 'generic' });
+ it('throws for custom provider without base_url', () => {
+ const config = makeConfig({ provider: 'custom' });
expect(() => buildLanguageModel(config)).toThrow('base_url');
});
@@ -46,14 +46,14 @@ describe('buildLanguageModel', () => {
expect(model).toBeDefined();
});
- it('constructs generic model without throwing when base_url is provided', () => {
- const model = buildLanguageModel(makeConfig({ provider: 'generic', base_url: 'http://localhost:11434/v1' }));
+ it('constructs custom model without throwing when base_url is provided', () => {
+ const model = buildLanguageModel(makeConfig({ provider: 'custom', base_url: 'http://localhost:11434/v1' }));
expect(model).toBeDefined();
});
- it('sets supportsStructuredOutputs:true on the generic model instance', () => {
+ it('sets supportsStructuredOutputs:true on the custom model instance', () => {
const model: unknown = buildLanguageModel(
- makeConfig({ provider: 'generic', base_url: 'http://localhost:11434/v1' }),
+ makeConfig({ provider: 'custom', base_url: 'http://localhost:11434/v1' }),
);
if (typeof model !== 'object' || model === null) throw new Error('Expected model to be an object');
expect(Reflect.get(model, 'supportsStructuredOutputs')).toBe(true);
diff --git a/packages/harness/tests/core/llm/VercelAILLM.output.test.ts b/packages/harness/tests/core/llm/VercelAILLM.output.test.ts
index 2cac89e02..9348ce874 100644
--- a/packages/harness/tests/core/llm/VercelAILLM.output.test.ts
+++ b/packages/harness/tests/core/llm/VercelAILLM.output.test.ts
@@ -90,7 +90,7 @@ describe('toReasoningLevel', () => {
it('returns undefined for non-google-gemini providers regardless of effort', () => {
expect(toReasoningLevel({ provider: 'openai', reasoningEffort: 'high' })).toBeUndefined();
expect(toReasoningLevel({ provider: 'anthropic', reasoningEffort: 'medium' })).toBeUndefined();
- expect(toReasoningLevel({ provider: 'generic', reasoningEffort: 'low' })).toBeUndefined();
+ expect(toReasoningLevel({ provider: 'custom', reasoningEffort: 'low' })).toBeUndefined();
});
it('returns undefined when reasoningEffort is undefined', () => {
@@ -294,8 +294,8 @@ describe('buildProviderOptions', () => {
});
});
- describe('generic provider', () => {
- const config = makeConfig({ provider: 'generic', base_url: 'http://localhost/v1' });
+ describe('custom provider', () => {
+ const config = makeConfig({ provider: 'custom', base_url: 'http://localhost/v1' });
it('returns empty options when both reasoningEffort and strictJsonSchema are absent', () => {
const opts = buildProviderOptions({
@@ -314,7 +314,7 @@ describe('buildProviderOptions', () => {
structuredOutputSpec: textSpec,
rawBody: {},
});
- expect(opts['generic']).toMatchObject({ reasoningEffort: 'medium' });
+ expect(opts['custom']).toMatchObject({ reasoningEffort: 'medium' });
});
it('passes strictJsonSchema for json_schema mode', () => {
@@ -324,7 +324,7 @@ describe('buildProviderOptions', () => {
structuredOutputSpec: schemaSpecStrict,
rawBody: {},
});
- expect(opts['generic']).toMatchObject({ strictJsonSchema: true });
+ expect(opts['custom']).toMatchObject({ strictJsonSchema: true });
});
it('includes both when both are present', () => {
@@ -334,17 +334,17 @@ describe('buildProviderOptions', () => {
structuredOutputSpec: schemaSpecStrict,
rawBody: {},
});
- expect(opts['generic']).toEqual({ reasoningEffort: 'low', strictJsonSchema: true });
+ expect(opts['custom']).toEqual({ reasoningEffort: 'low', strictJsonSchema: true });
});
- it('omits the generic key when the resulting object would be empty', () => {
+ it('omits the custom key when the resulting object would be empty', () => {
const opts = buildProviderOptions({
config: config,
reasoningEffort: undefined,
structuredOutputSpec: textSpec,
rawBody: {},
});
- expect(opts).not.toHaveProperty('generic');
+ expect(opts).not.toHaveProperty('custom');
});
});
@@ -393,13 +393,13 @@ describe('buildProviderOptions', () => {
});
describe('cross-provider completeness: every provider must surface reasoningEffort somewhere', () => {
- const providers: VercelAIProviderConfig['provider'][] = ['openai', 'anthropic', 'generic', 'google-gemini'];
+ const providers: VercelAIProviderConfig['provider'][] = ['openai', 'anthropic', 'custom', 'google-gemini'];
const effort = 'high';
it.each(providers)('%s: reasoningEffort reaches providerOptions or toReasoningLevel', provider => {
const config = makeConfig({
provider,
- ...(provider === 'generic' ? { base_url: 'http://localhost/v1' } : {}),
+ ...(provider === 'custom' ? { base_url: 'http://localhost/v1' } : {}),
});
const opts = buildProviderOptions({
config: config,
@@ -412,7 +412,7 @@ describe('buildProviderOptions', () => {
const inProviderOptions =
(opts['openai'] !== undefined && 'reasoningEffort' in opts['openai']) ||
opts['anthropic'] !== undefined ||
- (opts['generic'] !== undefined && 'reasoningEffort' in opts['generic']);
+ (opts['custom'] !== undefined && 'reasoningEffort' in opts['custom']);
expect(inProviderOptions || reasoningLevel !== undefined).toBe(true);
});
diff --git a/packages/harness/tests/core/llm/VercelAILLM.replay.test.ts b/packages/harness/tests/core/llm/VercelAILLM.replay.test.ts
index 6668a3961..e0ced08b4 100644
--- a/packages/harness/tests/core/llm/VercelAILLM.replay.test.ts
+++ b/packages/harness/tests/core/llm/VercelAILLM.replay.test.ts
@@ -156,11 +156,11 @@ const REASONING_CASES: ReasoningRoundTripCase[] = [
expectedProviderOptions: { anthropic: { signature: 'ant-sig-value' } },
},
{
- provider: 'generic',
- metadataKey: 'generic',
+ provider: 'custom',
+ metadataKey: 'custom',
signatureField: 'reasoningEncryptedContent',
- signatureValue: 'enc-content-generic',
- expectedProviderOptions: { generic: { encryptedContent: 'enc-content-generic' } },
+ signatureValue: 'enc-content-custom',
+ expectedProviderOptions: { custom: { encryptedContent: 'enc-content-custom' } },
},
];
diff --git a/packages/sdk/.fern/metadata.json b/packages/sdk/.fern/metadata.json
index 6a109de55..972ef0013 100644
--- a/packages/sdk/.fern/metadata.json
+++ b/packages/sdk/.fern/metadata.json
@@ -26,7 +26,7 @@
"streamType": "web",
"useDefaultRequestParameterValues": true
},
- "originGitCommit": "dfb013c3f50f4f86afdb1d8910c410516e907cc6",
+ "originGitCommit": "7ccfd4dcd9e1fff92c74869574e01c028af33b84",
"originGitCommitIsDirty": true,
"invokedBy": "ci",
"requestedVersion": "0.0.0",
diff --git a/packages/sdk/reference.md b/packages/sdk/reference.md
index 6e16dd24d..cc558d223 100644
--- a/packages/sdk/reference.md
+++ b/packages/sdk/reference.md
@@ -1763,7 +1763,6 @@ await client.settings.modelProviders.upsert({
auth: {
apiKey: "api_key"
},
- baseUrl: "base_url",
models: [{
modelId: "model_id",
name: "name",
@@ -1773,7 +1772,7 @@ await client.settings.modelProviders.upsert({
}
}],
name: "name",
- type: "openai"
+ type: "anthropic"
});
```
diff --git a/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts b/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
index 940805f99..f3a69c929 100644
--- a/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
+++ b/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
@@ -103,7 +103,6 @@ export class ModelProvidersClient {
* auth: {
* apiKey: "api_key"
* },
- * baseUrl: "base_url",
* models: [{
* modelId: "model_id",
* name: "name",
@@ -113,7 +112,7 @@ export class ModelProvidersClient {
* }
* }],
* name: "name",
- * type: "openai"
+ * type: "anthropic"
* })
*/
public upsert(
diff --git a/packages/sdk/src/api/types/AnthropicModelProvider.ts b/packages/sdk/src/api/types/AnthropicModelProvider.ts
new file mode 100644
index 000000000..5eb7e4086
--- /dev/null
+++ b/packages/sdk/src/api/types/AnthropicModelProvider.ts
@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueHarness from "../index.js";
+
+export interface AnthropicModelProvider {
+ auth: TrueHarness.ModelProviderAuth;
+ /** Optional override of the provider's default API base URL. */
+ baseUrl?: string;
+ models: TrueHarness.ModelEntry[];
+ name: TrueHarness.ResourceName;
+ type: "anthropic";
+}
diff --git a/packages/sdk/src/api/types/CustomModelProvider.ts b/packages/sdk/src/api/types/CustomModelProvider.ts
new file mode 100644
index 000000000..97e894fc6
--- /dev/null
+++ b/packages/sdk/src/api/types/CustomModelProvider.ts
@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueHarness from "../index.js";
+
+export interface CustomModelProvider {
+ auth: TrueHarness.ModelProviderAuth;
+ /** Base URL of the provider's API. */
+ baseUrl: string;
+ models: TrueHarness.ModelEntry[];
+ name: TrueHarness.ResourceName;
+ type: "custom";
+}
diff --git a/packages/sdk/src/api/types/ModelProvider.ts b/packages/sdk/src/api/types/ModelProvider.ts
index 471bf12ae..3a5c47228 100644
--- a/packages/sdk/src/api/types/ModelProvider.ts
+++ b/packages/sdk/src/api/types/ModelProvider.ts
@@ -2,11 +2,7 @@
import type * as TrueHarness from "../index.js";
-export interface ModelProvider {
- auth: TrueHarness.ModelProviderAuth;
- /** Base URL of the provider's API. */
- baseUrl: string;
- models: TrueHarness.ModelEntry[];
- name: TrueHarness.ResourceName;
- type: TrueHarness.ProviderType;
-}
+export type ModelProvider =
+ | TrueHarness.AnthropicModelProvider
+ | TrueHarness.CustomModelProvider
+ | TrueHarness.OpenAiModelProvider;
diff --git a/packages/sdk/src/api/types/OpenAiModelProvider.ts b/packages/sdk/src/api/types/OpenAiModelProvider.ts
new file mode 100644
index 000000000..2c4fa322e
--- /dev/null
+++ b/packages/sdk/src/api/types/OpenAiModelProvider.ts
@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueHarness from "../index.js";
+
+export interface OpenAiModelProvider {
+ auth: TrueHarness.ModelProviderAuth;
+ /** Optional override of the provider's default API base URL. */
+ baseUrl?: string;
+ models: TrueHarness.ModelEntry[];
+ name: TrueHarness.ResourceName;
+ type: "openai";
+}
diff --git a/packages/sdk/src/api/types/ProviderType.ts b/packages/sdk/src/api/types/ProviderType.ts
deleted file mode 100644
index 2268e4b55..000000000
--- a/packages/sdk/src/api/types/ProviderType.ts
+++ /dev/null
@@ -1,8 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-
-export const ProviderType = {
- Openai: "openai",
- Anthropic: "anthropic",
- Custom: "custom",
-} as const;
-export type ProviderType = (typeof ProviderType)[keyof typeof ProviderType];
diff --git a/packages/sdk/src/api/types/index.ts b/packages/sdk/src/api/types/index.ts
index 0320056fb..7ce6ae09a 100644
--- a/packages/sdk/src/api/types/index.ts
+++ b/packages/sdk/src/api/types/index.ts
@@ -4,6 +4,7 @@ export * from "./AgentParent.js";
export * from "./AgentSpec.js";
export * from "./AgentSpecModel.js";
export * from "./AgentSpecUserMessage.js";
+export * from "./AnthropicModelProvider.js";
export * from "./ApprovalAllow.js";
export * from "./ApprovalDecision.js";
export * from "./ApprovalDeny.js";
@@ -28,6 +29,7 @@ export * from "./ConfiguredMcpServer.js";
export * from "./ConfiguredMcpServerAuth.js";
export * from "./ContextManagementConfig.js";
export * from "./ContextManagementConfigCompaction.js";
+export * from "./CustomModelProvider.js";
export * from "./DaytonaSandboxProvider.js";
export * from "./DaytonaSandboxProviderAuth.js";
export * from "./DynamicSubAgentsConfig.js";
@@ -100,8 +102,8 @@ export * from "./ModelParams.js";
export * from "./ModelProperties.js";
export * from "./ModelProvider.js";
export * from "./ModelProviderAuth.js";
+export * from "./OpenAiModelProvider.js";
export * from "./PreviousTurnIdInput.js";
-export * from "./ProviderType.js";
export * from "./PutMcpServerResponse.js";
export * from "./PutModelProviderResponse.js";
export * from "./PutSandboxProviderResponse.js";
diff --git a/packages/sdk/src/serialization/types/AnthropicModelProvider.ts b/packages/sdk/src/serialization/types/AnthropicModelProvider.ts
new file mode 100644
index 000000000..08a890bd1
--- /dev/null
+++ b/packages/sdk/src/serialization/types/AnthropicModelProvider.ts
@@ -0,0 +1,29 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueHarness from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { ModelEntry } from "./ModelEntry.js";
+import { ModelProviderAuth } from "./ModelProviderAuth.js";
+import { ResourceName } from "./ResourceName.js";
+
+export const AnthropicModelProvider: core.serialization.ObjectSchema<
+ serializers.AnthropicModelProvider.Raw,
+ TrueHarness.AnthropicModelProvider
+> = core.serialization.object({
+ auth: ModelProviderAuth,
+ baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
+ models: core.serialization.list(ModelEntry),
+ name: ResourceName,
+ type: core.serialization.stringLiteral("anthropic"),
+});
+
+export declare namespace AnthropicModelProvider {
+ export interface Raw {
+ auth: ModelProviderAuth.Raw;
+ base_url?: string | null;
+ models: ModelEntry.Raw[];
+ name: ResourceName.Raw;
+ type: "anthropic";
+ }
+}
diff --git a/packages/sdk/src/serialization/types/CustomModelProvider.ts b/packages/sdk/src/serialization/types/CustomModelProvider.ts
new file mode 100644
index 000000000..698cc1d14
--- /dev/null
+++ b/packages/sdk/src/serialization/types/CustomModelProvider.ts
@@ -0,0 +1,29 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueHarness from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { ModelEntry } from "./ModelEntry.js";
+import { ModelProviderAuth } from "./ModelProviderAuth.js";
+import { ResourceName } from "./ResourceName.js";
+
+export const CustomModelProvider: core.serialization.ObjectSchema<
+ serializers.CustomModelProvider.Raw,
+ TrueHarness.CustomModelProvider
+> = core.serialization.object({
+ auth: ModelProviderAuth,
+ baseUrl: core.serialization.property("base_url", core.serialization.string()),
+ models: core.serialization.list(ModelEntry),
+ name: ResourceName,
+ type: core.serialization.stringLiteral("custom"),
+});
+
+export declare namespace CustomModelProvider {
+ export interface Raw {
+ auth: ModelProviderAuth.Raw;
+ base_url: string;
+ models: ModelEntry.Raw[];
+ name: ResourceName.Raw;
+ type: "custom";
+ }
+}
diff --git a/packages/sdk/src/serialization/types/ModelProvider.ts b/packages/sdk/src/serialization/types/ModelProvider.ts
index 47dd07119..7decdec8e 100644
--- a/packages/sdk/src/serialization/types/ModelProvider.ts
+++ b/packages/sdk/src/serialization/types/ModelProvider.ts
@@ -3,26 +3,13 @@
import type * as TrueHarness from "../../api/index.js";
import * as core from "../../core/index.js";
import type * as serializers from "../index.js";
-import { ModelEntry } from "./ModelEntry.js";
-import { ModelProviderAuth } from "./ModelProviderAuth.js";
-import { ProviderType } from "./ProviderType.js";
-import { ResourceName } from "./ResourceName.js";
+import { AnthropicModelProvider } from "./AnthropicModelProvider.js";
+import { CustomModelProvider } from "./CustomModelProvider.js";
+import { OpenAiModelProvider } from "./OpenAiModelProvider.js";
-export const ModelProvider: core.serialization.ObjectSchema<serializers.ModelProvider.Raw, TrueHarness.ModelProvider> =
- core.serialization.object({
- auth: ModelProviderAuth,
- baseUrl: core.serialization.property("base_url", core.serialization.string()),
- models: core.serialization.list(ModelEntry),
- name: ResourceName,
- type: ProviderType,
- });
+export const ModelProvider: core.serialization.Schema<serializers.ModelProvider.Raw, TrueHarness.ModelProvider> =
+ core.serialization.undiscriminatedUnion([AnthropicModelProvider, CustomModelProvider, OpenAiModelProvider]);
export declare namespace ModelProvider {
- export interface Raw {
- auth: ModelProviderAuth.Raw;
- base_url: string;
- models: ModelEntry.Raw[];
- name: ResourceName.Raw;
- type: ProviderType.Raw;
- }
+ export type Raw = AnthropicModelProvider.Raw | CustomModelProvider.Raw | OpenAiModelProvider.Raw;
}
diff --git a/packages/sdk/src/serialization/types/OpenAiModelProvider.ts b/packages/sdk/src/serialization/types/OpenAiModelProvider.ts
new file mode 100644
index 000000000..34773d48c
--- /dev/null
+++ b/packages/sdk/src/serialization/types/OpenAiModelProvider.ts
@@ -0,0 +1,29 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueHarness from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { ModelEntry } from "./ModelEntry.js";
+import { ModelProviderAuth } from "./ModelProviderAuth.js";
+import { ResourceName } from "./ResourceName.js";
+
+export const OpenAiModelProvider: core.serialization.ObjectSchema<
+ serializers.OpenAiModelProvider.Raw,
+ TrueHarness.OpenAiModelProvider
+> = core.serialization.object({
+ auth: ModelProviderAuth,
+ baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
+ models: core.serialization.list(ModelEntry),
+ name: ResourceName,
+ type: core.serialization.stringLiteral("openai"),
+});
+
+export declare namespace OpenAiModelProvider {
+ export interface Raw {
+ auth: ModelProviderAuth.Raw;
+ base_url?: string | null;
+ models: ModelEntry.Raw[];
+ name: ResourceName.Raw;
+ type: "openai";
+ }
+}
diff --git a/packages/sdk/src/serialization/types/ProviderType.ts b/packages/sdk/src/serialization/types/ProviderType.ts
deleted file mode 100644
index 5807e789b..000000000
--- a/packages/sdk/src/serialization/types/ProviderType.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-
-import type * as TrueHarness from "../../api/index.js";
-import * as core from "../../core/index.js";
-import type * as serializers from "../index.js";
-
-export const ProviderType: core.serialization.Schema<serializers.ProviderType.Raw, TrueHarness.ProviderType> =
- core.serialization.enum_(["openai", "anthropic", "custom"]);
-
-export declare namespace ProviderType {
- export type Raw = "openai" | "anthropic" | "custom";
-}
diff --git a/packages/sdk/src/serialization/types/index.ts b/packages/sdk/src/serialization/types/index.ts
index 0320056fb..7ce6ae09a 100644
--- a/packages/sdk/src/serialization/types/index.ts
+++ b/packages/sdk/src/serialization/types/index.ts
@@ -4,6 +4,7 @@ export * from "./AgentParent.js";
export * from "./AgentSpec.js";
export * from "./AgentSpecModel.js";
export * from "./AgentSpecUserMessage.js";
+export * from "./AnthropicModelProvider.js";
export * from "./ApprovalAllow.js";
export * from "./ApprovalDecision.js";
export * from "./ApprovalDeny.js";
@@ -28,6 +29,7 @@ export * from "./ConfiguredMcpServer.js";
export * from "./ConfiguredMcpServerAuth.js";
export * from "./ContextManagementConfig.js";
export * from "./ContextManagementConfigCompaction.js";
+export * from "./CustomModelProvider.js";
export * from "./DaytonaSandboxProvider.js";
export * from "./DaytonaSandboxProviderAuth.js";
export * from "./DynamicSubAgentsConfig.js";
@@ -100,8 +102,8 @@ export * from "./ModelParams.js";
export * from "./ModelProperties.js";
export * from "./ModelProvider.js";
export * from "./ModelProviderAuth.js";
+export * from "./OpenAiModelProvider.js";
export * from "./PreviousTurnIdInput.js";
-export * from "./ProviderType.js";
export * from "./PutMcpServerResponse.js";
export * from "./PutModelProviderResponse.js";
export * from "./PutSandboxProviderResponse.js";
diff --git a/packages/sdk/tests/wire/settings/modelProviders.test.ts b/packages/sdk/tests/wire/settings/modelProviders.test.ts
index f3cc4f483..6f04303ef 100644
--- a/packages/sdk/tests/wire/settings/modelProviders.test.ts
+++ b/packages/sdk/tests/wire/settings/modelProviders.test.ts
@@ -18,7 +18,7 @@ describe("ModelProvidersClient", () => {
{ model_id: "model_id", name: "name", properties: { context_length: 1, max_output_tokens: 1 } },
],
name: "name",
- type: "openai",
+ type: "anthropic",
},
],
};
@@ -50,7 +50,7 @@ describe("ModelProvidersClient", () => {
},
],
name: "name",
- type: "openai",
+ type: "anthropic",
},
],
});
@@ -61,10 +61,9 @@ describe("ModelProvidersClient", () => {
const client = new TrueHarness({ maxRetries: 0, environment: server.baseUrl });
const rawRequestBody = {
auth: { api_key: "api_key" },
- base_url: "base_url",
models: [{ model_id: "model_id", name: "name", properties: { context_length: 1, max_output_tokens: 1 } }],
name: "name",
- type: "openai",
+ type: "anthropic",
};
const rawResponseBody = {
data: {
@@ -74,7 +73,7 @@ describe("ModelProvidersClient", () => {
{ model_id: "model_id", name: "name", properties: { context_length: 1, max_output_tokens: 1 } },
],
name: "name",
- type: "openai",
+ type: "anthropic",
},
};
@@ -91,7 +90,6 @@ describe("ModelProvidersClient", () => {
auth: {
apiKey: "api_key",
},
- baseUrl: "base_url",
models: [
{
modelId: "model_id",
@@ -103,7 +101,7 @@ describe("ModelProvidersClient", () => {
},
],
name: "name",
- type: "openai",
+ type: "anthropic",
});
expect(response).toEqual({
data: {
@@ -122,7 +120,7 @@ describe("ModelProvidersClient", () => {
},
],
name: "name",
- type: "openai",
+ type: "anthropic",
},
});
});
@@ -132,13 +130,12 @@ describe("ModelProvidersClient", () => {
const client = new TrueHarness({ maxRetries: 0, environment: server.baseUrl });
const rawRequestBody = {
auth: { api_key: "x" },
- base_url: "base_url",
models: [
{ model_id: "x", name: "xy", properties: { context_length: 1, max_output_tokens: 1 } },
{ model_id: "x", name: "xy", properties: { context_length: 1, max_output_tokens: 1 } },
],
name: "xy",
- type: "openai",
+ type: "anthropic",
};
const rawResponseBody = { error: { message: "message" } };
@@ -156,7 +153,6 @@ describe("ModelProvidersClient", () => {
auth: {
apiKey: "x",
},
- baseUrl: "base_url",
models: [
{
modelId: "x",
@@ -176,7 +172,7 @@ describe("ModelProvidersClient", () => {
},
],
name: "xy",
- type: "openai",
+ type: "anthropic",
});
}).rejects.toThrow(TrueHarnessTypes.BadRequestError);
});
diff --git a/packages/server/registry-example/models.yaml b/packages/server/registry-example/models.yaml
index 3f9f16b86..6212edfb9 100644
--- a/packages/server/registry-example/models.yaml
+++ b/packages/server/registry-example/models.yaml
@@ -23,12 +23,12 @@
#
# Supported providers:
# First-party (Vercel AI SDK): openai | anthropic | google-gemini
-# Generic (requires base_url): generic
+# Custom (requires base_url): custom
#
# base_url is optional for first-party providers (overrides the default endpoint)
-# and required for the generic provider.
+# and required for the custom provider.
#
-# api_format selects the API surface for the generic provider:
+# api_format selects the API surface for the custom provider:
# openai-chat-completions - OpenAI Chat Completions API (default).
#
# openai always uses the Responses API (supports o-series reasoning models,
@@ -75,10 +75,10 @@ models:
api_key: '${GOOGLE_GEMINI_API_KEY}'
max_output_tokens: 8192
- # --- Generic gateway (e.g. LiteLLM / TrueFoundry / any OpenAI-compat proxy) ---
+ # --- Custom gateway (e.g. LiteLLM / TrueFoundry / any OpenAI-compat proxy) ---
- name: claude-sonnet-4-6-gateway
model_id: anthropic/claude-sonnet-4-6
- provider: generic
+ provider: custom
api_key: '${LLM_GATEWAY_API_KEY}'
base_url: https://your-gateway.example.com/api/llm
max_output_tokens: 32768
diff --git a/packages/server/src/apis/modelProviders.ts b/packages/server/src/apis/modelProviders.ts
index 3f33e8156..2bf7a98de 100644
--- a/packages/server/src/apis/modelProviders.ts
+++ b/packages/server/src/apis/modelProviders.ts
@@ -6,7 +6,7 @@ import {
listModelProvidersRoute,
putModelProviderRoute,
} from '../routes/modelProviderRoutes';
-import type { ModelProvider, ProviderManifest } from '../schemas/modelProvider';
+import { toModelProviderManifest, type ModelProvider } from '../schemas/modelProvider';
import { TENANT_ID } from './sessions';
export interface ModelProvidersRouterDeps {
@@ -33,12 +33,11 @@ export function createModelProvidersRouter(deps: ModelProvidersRouterDeps) {
};
const putHandler: RouteHandler<typeof putModelProviderRoute> = async c => {
- const { name, ...manifestFields } = c.req.valid('json');
- const manifest: ProviderManifest = manifestFields;
+ const body = c.req.valid('json');
const record = await deps.modelProviderStore.upsertProvider({
tenant_id: TENANT_ID,
- name,
- manifest,
+ name: body.name,
+ manifest: toModelProviderManifest(body),
});
return c.json({ data: toModelProvider(record) }, 200);
};
diff --git a/packages/server/src/db/modelProviderStore.ts b/packages/server/src/db/modelProviderStore.ts
index 1d210a350..d19d1440e 100644
--- a/packages/server/src/db/modelProviderStore.ts
+++ b/packages/server/src/db/modelProviderStore.ts
@@ -1,15 +1,15 @@
/**
* DB-backed configured model providers: one row per provider per tenant,
- * identity as columns plus a Zod-validated `ProviderManifest` jsonb document.
+ * identity as columns plus a Zod-validated `ModelProviderManifest` jsonb document.
* Implementations: PostgresModelProviderStore and SqliteModelProviderStore.
*/
import type { ResourceName } from '../schemas/common';
-import type { Model, ProviderManifest } from '../schemas/modelProvider';
+import type { Model, ModelProviderManifest } from '../schemas/modelProvider';
export interface ModelProviderRecord {
tenant_id: string;
name: ResourceName;
- manifest: ProviderManifest;
+ manifest: ModelProviderManifest;
/** ISO-8601 UTC instant. */
created_at: string;
/** ISO-8601 UTC instant. */
@@ -24,7 +24,7 @@ export interface GetProviderInput {
export interface UpsertProviderInput {
tenant_id: string;
name: ResourceName;
- manifest: ProviderManifest;
+ manifest: ModelProviderManifest;
}
export interface IModelProviderStore {
diff --git a/packages/server/src/db/postgres/migrations/20260803_000001_model_provider.ts b/packages/server/src/db/postgres/migrations/20260803_000001_model_provider.ts
index 6904c13b2..b63700e68 100644
--- a/packages/server/src/db/postgres/migrations/20260803_000001_model_provider.ts
+++ b/packages/server/src/db/postgres/migrations/20260803_000001_model_provider.ts
@@ -16,7 +16,7 @@ export async function up(db: Kysely<unknown>): Promise<void> {
.addColumn('tenant_id', 'text', col => col.notNull())
// key: natural key within tenant; first segment of fully qualified model names
.addColumn('name', 'text', col => col.notNull())
- // ProviderManifest document; replaced whole on every upsert
+ // ModelProviderManifest document; replaced whole on every upsert
.addColumn('manifest', 'jsonb', col => col.notNull())
.addColumn('created_at', 'timestamptz', col => col.notNull())
.addColumn('updated_at', 'timestamptz', col => col.notNull())
diff --git a/packages/server/src/db/postgres/types.ts b/packages/server/src/db/postgres/types.ts
index 88113037f..9c9a3f9e9 100644
--- a/packages/server/src/db/postgres/types.ts
+++ b/packages/server/src/db/postgres/types.ts
@@ -15,7 +15,7 @@ import type {
import type { CurrentContextUsage } from '@truefoundry/utils/core/runtime/contextUsage';
import type { ColumnType, Generated, JSONColumnType } from 'kysely';
import type { McpServerManifest } from '../../schemas/mcpServer';
-import type { ProviderManifest } from '../../schemas/modelProvider';
+import type { ModelProviderManifest } from '../../schemas/modelProvider';
import type { SandboxProviderManifest } from '../../schemas/sandboxProvider';
import type { SkillManifest } from '../../schemas/skill';
import type { OAuthClient, OAuthPendingAuthorizationData, OAuthServer, OAuthToken } from '../mcpOAuthTypes';
@@ -295,8 +295,8 @@ export interface ModelProviderTable {
tenant_id: string;
/** key: natural key within tenant; first segment of fully qualified model names */
name: string;
- /** ProviderManifest document; replaced whole on every upsert */
- manifest: JSONColumnType<ProviderManifest, ProviderManifest, ProviderManifest>;
+ /** ModelProviderManifest document; replaced whole on every upsert */
+ manifest: JSONColumnType<ModelProviderManifest, ModelProviderManifest, ModelProviderManifest>;
created_at: Date;
updated_at: Date;
}
diff --git a/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts b/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
index 1c76855b5..d320007ca 100644
--- a/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
+++ b/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
@@ -1,5 +1,5 @@
import type { ExpressionBuilder, Kysely } from 'kysely';
-import type { Model, ProviderManifest } from '../../../schemas/modelProvider';
+import type { Model, ModelProviderManifest } from '../../../schemas/modelProvider';
import {
flattenProviderModels,
type GetProviderInput,
@@ -15,7 +15,7 @@ function recordColumns(eb: ExpressionBuilder<Database, 'model_provider'>) {
return [
'tenant_id' as const,
'name' as const,
- jsonText<ProviderManifest>(eb.ref('manifest')).as('manifest'),
+ jsonText<ModelProviderManifest>(eb.ref('manifest')).as('manifest'),
'created_at' as const,
'updated_at' as const,
];
diff --git a/packages/server/src/db/sqlite/types.ts b/packages/server/src/db/sqlite/types.ts
index 22c4e37ed..64b5a2007 100644
--- a/packages/server/src/db/sqlite/types.ts
+++ b/packages/server/src/db/sqlite/types.ts
@@ -18,7 +18,7 @@ import type {
import type { CurrentContextUsage } from '@truefoundry/utils/core/runtime/contextUsage';
import type { ColumnType, Generated, JSONColumnType } from 'kysely';
import type { McpServerManifest } from '../../schemas/mcpServer';
-import type { ProviderManifest } from '../../schemas/modelProvider';
+import type { ModelProviderManifest } from '../../schemas/modelProvider';
import type { SandboxProviderManifest } from '../../schemas/sandboxProvider';
import type { SkillManifest } from '../../schemas/skill';
import type { OAuthClient, OAuthPendingAuthorizationData, OAuthServer, OAuthToken } from '../mcpOAuthTypes';
@@ -149,8 +149,8 @@ export interface ThreadCapabilityStateTable {
export interface ModelProviderTable {
tenant_id: string;
name: string;
- /** ProviderManifest document; replaced whole on every upsert */
- manifest: JsonbColumn<ProviderManifest>;
+ /** ModelProviderManifest document; replaced whole on every upsert */
+ manifest: JsonbColumn<ModelProviderManifest>;
created_at: string;
updated_at: string;
}
diff --git a/packages/server/src/legacy-registry-store/schemas.ts b/packages/server/src/legacy-registry-store/schemas.ts
index 10b931dca..b6c897599 100644
--- a/packages/server/src/legacy-registry-store/schemas.ts
+++ b/packages/server/src/legacy-registry-store/schemas.ts
@@ -90,25 +90,25 @@ const GoogleGeminiProviderEntrySchema = ModelEntryBaseSchema.extend({
.openapi('GoogleGeminiProviderModelEntry');
/**
- * Generic OpenAI-compatible provider. Requires an explicit `base_url` since
+ * Custom OpenAI-compatible provider. Requires an explicit `base_url` since
* there is no canonical endpoint.
*/
-const GenericProviderEntrySchema = ModelEntryBaseSchema.extend({
- provider: z.literal('generic'),
+const CustomProviderEntrySchema = ModelEntryBaseSchema.extend({
+ provider: z.literal('custom'),
/** Deployment-specific base URL — required. */
base_url: z.string().url(),
/** API format used by this endpoint. Only option today; defaults when absent. */
api_format: z.literal('openai-chat-completions').optional(),
})
.strict()
- .openapi('GenericProviderModelEntry');
+ .openapi('CustomProviderModelEntry');
export const ModelEntrySchema = z
.discriminatedUnion('provider', [
OpenAIProviderEntrySchema,
AnthropicProviderEntrySchema,
GoogleGeminiProviderEntrySchema,
- GenericProviderEntrySchema,
+ CustomProviderEntrySchema,
])
.openapi('ModelEntry');
diff --git a/packages/server/src/schemas/modelProvider.ts b/packages/server/src/schemas/modelProvider.ts
index 898d1e53c..8cf5ea3cf 100644
--- a/packages/server/src/schemas/modelProvider.ts
+++ b/packages/server/src/schemas/modelProvider.ts
@@ -42,28 +42,50 @@ export function refineUniqueModels(models: { model_id: string; name: string }[],
}
}
-const ProviderAuthSchema = z
+const ModelProviderAuthSchema = z
.object({
api_key: z.string().min(1),
})
.strict()
.openapi('ModelProviderAuth');
-/**
- * Non-identity fields of a configured provider, shared verbatim between the
- * PUT request body and the persisted `model_provider.manifest` document.
- * Compose with `.superRefine(refineProviderManifest)` after any `.extend()`.
- */
-export const ProviderManifestObjectSchema = z
+const ModelProviderManifestBaseSchema = z
.object({
- type: ProviderTypeSchema,
- base_url: z.string().url().describe("Base URL of the provider's API."),
- auth: ProviderAuthSchema,
+ auth: ModelProviderAuthSchema,
models: z.array(ModelEntrySchema).min(1),
})
.strict();
-export function refineProviderManifest(
+/** Shared by openai/anthropic: optional override of the provider's default endpoint. */
+const WellKnownModelProviderManifestBaseSchema = ModelProviderManifestBaseSchema.extend({
+ base_url: z.string().url().optional().describe("Optional override of the provider's default API base URL."),
+}).strict();
+
+const OpenAIModelProviderManifestSchema = WellKnownModelProviderManifestBaseSchema.extend({
+ type: z.literal('openai'),
+}).strict();
+
+const AnthropicModelProviderManifestSchema = WellKnownModelProviderManifestBaseSchema.extend({
+ type: z.literal('anthropic'),
+}).strict();
+
+/** Same fields as well-known providers, but base_url is required (no canonical endpoint). */
+const CustomModelProviderManifestSchema = ModelProviderManifestBaseSchema.extend({
+ type: z.literal('custom'),
+ base_url: z.string().url().describe("Base URL of the provider's API."),
+}).strict();
+
+/**
+ * Non-identity fields of a configured provider, shared verbatim between the
+ * PUT request body and the persisted `model_provider.manifest` document.
+ */
+export const ModelProviderManifestObjectSchema = z.discriminatedUnion('type', [
+ OpenAIModelProviderManifestSchema,
+ AnthropicModelProviderManifestSchema,
+ CustomModelProviderManifestSchema,
+]);
+
+export function refineModelProviderManifest(
manifest: { models: { model_id: string; name: string }[] },
ctx: z.RefinementCtx,
): void {
@@ -71,16 +93,33 @@ export function refineProviderManifest(
}
export type ModelProperties = z.infer<typeof ModelPropertiesSchema>;
-export type ProviderManifest = z.infer<typeof ProviderManifestObjectSchema>;
+export type ModelProviderManifest = z.infer<typeof ModelProviderManifestObjectSchema>;
+
+const OpenAIModelProviderSchema = OpenAIModelProviderManifestSchema.extend({
+ name: NameSchema,
+})
+ .strict()
+ .openapi('OpenAIModelProvider');
+
+const AnthropicModelProviderSchema = AnthropicModelProviderManifestSchema.extend({
+ name: NameSchema,
+})
+ .strict()
+ .openapi('AnthropicModelProvider');
+
+const CustomModelProviderSchema = CustomModelProviderManifestSchema.extend({
+ name: NameSchema,
+})
+ .strict()
+ .openapi('CustomModelProvider');
/**
* Configured provider: PUT body and list/upsert response data (identity `name`
* plus manifest fields, including `auth.api_key`).
*/
-export const ModelProviderSchema = ProviderManifestObjectSchema.extend({
- name: NameSchema,
-})
- .superRefine(refineProviderManifest)
+export const ModelProviderSchema = z
+ .discriminatedUnion('type', [OpenAIModelProviderSchema, AnthropicModelProviderSchema, CustomModelProviderSchema])
+ .superRefine(refineModelProviderManifest)
.openapi('ModelProvider');
export const PutModelProviderRequestSchema = ModelProviderSchema;
@@ -118,3 +157,10 @@ export const ListModelsResponseSchema = z
export type ModelProvider = z.infer<typeof ModelProviderSchema>;
export type PutModelProviderRequest = ModelProvider;
export type Model = z.infer<typeof ModelSchema>;
+
+/** Strip wire identity `name`; remaining fields are the persisted manifest document. */
+export function toModelProviderManifest(provider: ModelProvider): ModelProviderManifest {
+ const { name, ...manifest } = provider;
+ void name;
+ return manifest;
+}
diff --git a/packages/server/tests/db/modelProviderStoreContractSuite.ts b/packages/server/tests/db/modelProviderStoreContractSuite.ts
index 54b4740dd..6b3047930 100644
--- a/packages/server/tests/db/modelProviderStoreContractSuite.ts
+++ b/packages/server/tests/db/modelProviderStoreContractSuite.ts
@@ -3,11 +3,11 @@
* Runs under jest against a fresh store per test (see backend test files).
*/
import type { IModelProviderStore } from '../../src/db/modelProviderStore';
-import type { ProviderManifest } from '../../src/schemas/modelProvider';
+import type { ModelProviderManifest } from '../../src/schemas/modelProvider';
const TENANT = 'default';
-function manifest(overrides: Partial<ProviderManifest> = {}): ProviderManifest {
+function manifest(overrides: Partial<ModelProviderManifest> = {}): ModelProviderManifest {
return {
type: 'anthropic',
base_url: 'https://api.anthropic.com/v1',
diff --git a/packages/server/tests/unit/apis/modelProviders.test.ts b/packages/server/tests/unit/apis/modelProviders.test.ts
index bdfa4357a..76991e54b 100644
--- a/packages/server/tests/unit/apis/modelProviders.test.ts
+++ b/packages/server/tests/unit/apis/modelProviders.test.ts
@@ -13,18 +13,25 @@ import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provi
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
import { SqliteOAuthTokenStore } from '../../../src/db/sqlite/token-store/SqliteOAuthTokenStore';
-const putBody = {
- type: 'anthropic',
+const model = {
+ model_id: 'claude-sonnet-4-6',
+ name: 'claude-sonnet-4-6',
+ properties: { context_length: 200000, max_output_tokens: 32768, reasoning_efforts: ['low', 'high'] },
+};
+
+const anthropicBody = {
+ type: 'anthropic' as const,
name: 'anthropic',
- base_url: 'https://api.anthropic.com/v1',
auth: { api_key: 'sk-ant-secret' },
- models: [
- {
- model_id: 'claude-sonnet-4-6',
- name: 'claude-sonnet-4-6',
- properties: { context_length: 200000, max_output_tokens: 32768, reasoning_efforts: ['low', 'high'] },
- },
- ],
+ models: [model],
+};
+
+const customBody = {
+ type: 'custom' as const,
+ name: 'internal',
+ base_url: 'https://llm.internal.example.com/v1',
+ auth: { api_key: 'sk-custom' },
+ models: [model],
};
function putInit(body: unknown): RequestInit {
@@ -70,22 +77,28 @@ describe('settings model-providers and models routers', () => {
expect(body.data.every(provider => provider.type !== 'custom')).toBe(true);
});
- it('PUT upserts a provider and echoes the stored auth', async () => {
- const response = await settingsRouter.request('/model-providers', putInit(putBody));
+ it('PUT upserts a well-known provider without base_url and echoes the stored auth', async () => {
+ const response = await settingsRouter.request('/model-providers', putInit(anthropicBody));
expect(response.status).toBe(200);
- expect(await response.json()).toEqual({ data: putBody });
+ expect(await response.json()).toEqual({ data: anthropicBody });
const list = await settingsRouter.request('/model-providers');
expect(list.status).toBe(200);
- expect(await list.json()).toEqual({ data: [putBody] });
+ expect(await list.json()).toEqual({ data: [anthropicBody] });
});
- it('PUT rejects invalid bodies at the Zod layer', async () => {
- const { base_url: _, ...withoutBaseUrl } = putBody;
+ it('PUT requires base_url for custom providers', async () => {
+ const { base_url: _, ...withoutBaseUrl } = customBody;
const missingBaseUrl = await settingsRouter.request('/model-providers', putInit(withoutBaseUrl));
expect(missingBaseUrl.status).toBe(400);
- const badName = await settingsRouter.request('/model-providers', putInit({ ...putBody, name: 'Not A Name' }));
+ const created = await settingsRouter.request('/model-providers', putInit(customBody));
+ expect(created.status).toBe(200);
+ expect(await created.json()).toEqual({ data: customBody });
+ });
+
+ it('PUT rejects invalid bodies at the Zod layer', async () => {
+ const badName = await settingsRouter.request('/model-providers', putInit({ ...anthropicBody, name: 'Not A Name' }));
expect(badName.status).toBe(400);
});
@@ -97,7 +110,12 @@ describe('settings model-providers and models routers', () => {
{
name: 'anthropic/claude-sonnet-4-6',
model_id: 'claude-sonnet-4-6',
- properties: putBody.models[0]?.properties,
+ properties: model.properties,
+ },
+ {
+ name: 'internal/claude-sonnet-4-6',
+ model_id: 'claude-sonnet-4-6',
+ properties: model.properties,
},
],
});