Skip to content

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

Support web search providers in stanalone and OIDC mode (#833)

Sujai Kumar Gupta829ac6e361f1
diff --git a/.changeset/20260921161604-regenerate-sdk-from-openapi.md b/.changeset/20260921161604-regenerate-sdk-from-openapi.md
new file mode 100644
index 000000000..efd8ff00f
--- /dev/null
+++ b/.changeset/20260921161604-regenerate-sdk-from-openapi.md
@@ -0,0 +1,5 @@
+---
+"@truefoundry/trueforge-sdk": patch
+---
+
+Regenerate SDK from updated OpenAPI spec.
diff --git a/.changeset/oss-web-search-providers.md b/.changeset/oss-web-search-providers.md
new file mode 100644
index 000000000..9875faf1d
--- /dev/null
+++ b/.changeset/oss-web-search-providers.md
@@ -0,0 +1,8 @@
+---
+"@truefoundry/trueforge": minor
+"@truefoundry/trueforge-core": minor
+"@truefoundry/trueforge-ui": minor
+"@truefoundry/trueforge-assistant-ui-runtime": minor
+---
+
+Add OSS web-search provider settings and catalog (Parallel): singleton settings/catalog APIs, optional API key, and UI adapter without mode config so built-in web search works outside TrueFoundry mode.
diff --git a/.changeset/web-search-settings-ui.md b/.changeset/web-search-settings-ui.md
new file mode 100644
index 000000000..aac45172a
--- /dev/null
+++ b/.changeset/web-search-settings-ui.md
@@ -0,0 +1,6 @@
+---
+"@truefoundry/trueforge-assistant-ui-runtime": minor
+"@truefoundry/trueforge-ui": minor
+---
+
+Add web-search provider settings catalog port and Settings UI so admins can configure Parallel web search (API key + mode) in standalone/OIDC deployments.
diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.json
index 9190f254e..ec7345662 100644
--- a/.github/fern/openapi/openapi.json
+++ b/.github/fern/openapi/openapi.json
@@ -712,6 +712,22 @@
],
"type": "string"
},
+ "CatalogWebSearchProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "description": "Parallel web-search provider.",
+ "enum": [
+ "parallel"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
"CatalogWellKnownModelProvider": {
"additionalProperties": false,
"properties": {
@@ -982,6 +998,22 @@
],
"type": "object"
},
+ "ConfiguredWebSearchProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "manifest": {
+ "$ref": "#/components/schemas/WebSearchProviderManifest"
+ },
+ "name": {
+ "$ref": "#/components/schemas/ResourceName"
+ }
+ },
+ "required": [
+ "name",
+ "manifest"
+ ],
+ "type": "object"
+ },
"ContextManagementConfig": {
"default": {
"compaction": {
@@ -1638,6 +1670,31 @@
],
"type": "object"
},
+ "GetWebSearchProviderCatalogResponse": {
+ "properties": {
+ "data": {
+ "items": {
+ "$ref": "#/components/schemas/CatalogWebSearchProvider"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "type": "object"
+ },
+ "GetWebSearchProviderResponse": {
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/ConfiguredWebSearchProvider"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "type": "object"
+ },
"GitSkill": {
"additionalProperties": false,
"properties": {
@@ -3313,6 +3370,21 @@
],
"type": "object"
},
+ "ParallelWebSearchProviderAuth": {
+ "additionalProperties": false,
+ "description": "Parallel authentication credentials.",
+ "properties": {
+ "api_key": {
+ "description": "Parallel API key. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored key.",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key"
+ ],
+ "type": "object"
+ },
"PermissionResourceType": {
"description": "Resource type to evaluate permissions for.",
"enum": [
@@ -5633,6 +5705,18 @@
],
"type": "object"
},
+ "UpdateWebSearchProviderRequest": {
+ "additionalProperties": false,
+ "properties": {
+ "manifest": {
+ "$ref": "#/components/schemas/WebSearchProviderManifest"
+ }
+ },
+ "required": [
+ "manifest"
+ ],
+ "type": "object"
+ },
"UserMessage": {
"properties": {
"content": {
@@ -5769,6 +5853,30 @@
},
"type": "object"
},
+ "WebSearchProviderManifest": {
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "auth": {
+ "$ref": "#/components/schemas/ParallelWebSearchProviderAuth"
+ },
+ "type": {
+ "description": "Parallel web-search provider.",
+ "enum": [
+ "parallel"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "auth"
+ ],
+ "type": "object"
+ }
+ ]
+ },
"ZaiModelProvider": {
"additionalProperties": false,
"properties": {
@@ -7079,6 +7187,42 @@
"x-fern-sdk-method-name": "list"
}
},
+ "/api/v1/catalogs/web-search-providers": {
+ "get": {
+ "description": "Shipped web-search provider presets.",
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetWebSearchProviderCatalogResponse"
+ }
+ }
+ },
+ "description": "Shipped web-search provider presets."
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Not authenticated."
+ }
+ },
+ "summary": "List web search providers",
+ "tags": [
+ "Web Search Providers"
+ ],
+ "x-fern-sdk-group-name": [
+ "catalogs",
+ "webSearchProviders"
+ ],
+ "x-fern-sdk-method-name": "list"
+ }
+ },
"/api/v1/mcp-servers": {
"get": {
"description": "Configured MCP servers as a slim name/url list for the composer.",
@@ -9966,6 +10110,116 @@
"x-fern-sdk-method-name": "create_or_update"
}
},
+ "/api/v1/settings/web-search-providers": {
+ "get": {
+ "description": "The configured provider for this tenant. `auth.api_key` is redacted when present.",
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetWebSearchProviderResponse"
+ }
+ }
+ },
+ "description": "The configured web search provider."
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Invalid Bearer token or auth cookie."
+ },
+ "403": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Authenticated but not an admin."
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "No web search provider configured."
+ }
+ },
+ "summary": "Get the web search provider",
+ "tags": [
+ "Web Search Providers"
+ ],
+ "x-fern-sdk-group-name": [
+ "settings",
+ "webSearchProviders"
+ ],
+ "x-fern-sdk-method-name": "get"
+ },
+ "put": {
+ "description": "Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateWebSearchProviderRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetWebSearchProviderResponse"
+ }
+ }
+ },
+ "description": "The saved provider."
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Invalid request body, or redacted API key with no stored secret to keep."
+ },
+ "424": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Unsupported operation because web-search providers are managed by an external system"
+ }
+ },
+ "summary": "Create or replace the web search provider",
+ "tags": [
+ "Web Search Providers"
+ ],
+ "x-fern-sdk-group-name": [
+ "settings",
+ "webSearchProviders"
+ ],
+ "x-fern-sdk-method-name": "create_or_update"
+ }
+ },
"/api/v1/skills": {
"get": {
"description": "Configured skills as a slim name/description list for the composer.",
@@ -10077,6 +10331,9 @@
{
"name": "Sandboxes"
},
+ {
+ "name": "Web Search Providers"
+ },
{
"name": "Agents"
},
diff --git a/docs/openapi.json b/docs/openapi.json
index 9190f254e..ec7345662 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -712,6 +712,22 @@
],
"type": "string"
},
+ "CatalogWebSearchProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "description": "Parallel web-search provider.",
+ "enum": [
+ "parallel"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
"CatalogWellKnownModelProvider": {
"additionalProperties": false,
"properties": {
@@ -982,6 +998,22 @@
],
"type": "object"
},
+ "ConfiguredWebSearchProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "manifest": {
+ "$ref": "#/components/schemas/WebSearchProviderManifest"
+ },
+ "name": {
+ "$ref": "#/components/schemas/ResourceName"
+ }
+ },
+ "required": [
+ "name",
+ "manifest"
+ ],
+ "type": "object"
+ },
"ContextManagementConfig": {
"default": {
"compaction": {
@@ -1638,6 +1670,31 @@
],
"type": "object"
},
+ "GetWebSearchProviderCatalogResponse": {
+ "properties": {
+ "data": {
+ "items": {
+ "$ref": "#/components/schemas/CatalogWebSearchProvider"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "type": "object"
+ },
+ "GetWebSearchProviderResponse": {
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/ConfiguredWebSearchProvider"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "type": "object"
+ },
"GitSkill": {
"additionalProperties": false,
"properties": {
@@ -3313,6 +3370,21 @@
],
"type": "object"
},
+ "ParallelWebSearchProviderAuth": {
+ "additionalProperties": false,
+ "description": "Parallel authentication credentials.",
+ "properties": {
+ "api_key": {
+ "description": "Parallel API key. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored key.",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key"
+ ],
+ "type": "object"
+ },
"PermissionResourceType": {
"description": "Resource type to evaluate permissions for.",
"enum": [
@@ -5633,6 +5705,18 @@
],
"type": "object"
},
+ "UpdateWebSearchProviderRequest": {
+ "additionalProperties": false,
+ "properties": {
+ "manifest": {
+ "$ref": "#/components/schemas/WebSearchProviderManifest"
+ }
+ },
+ "required": [
+ "manifest"
+ ],
+ "type": "object"
+ },
"UserMessage": {
"properties": {
"content": {
@@ -5769,6 +5853,30 @@
},
"type": "object"
},
+ "WebSearchProviderManifest": {
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "auth": {
+ "$ref": "#/components/schemas/ParallelWebSearchProviderAuth"
+ },
+ "type": {
+ "description": "Parallel web-search provider.",
+ "enum": [
+ "parallel"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "auth"
+ ],
+ "type": "object"
+ }
+ ]
+ },
"ZaiModelProvider": {
"additionalProperties": false,
"properties": {
@@ -7079,6 +7187,42 @@
"x-fern-sdk-method-name": "list"
}
},
+ "/api/v1/catalogs/web-search-providers": {
+ "get": {
+ "description": "Shipped web-search provider presets.",
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetWebSearchProviderCatalogResponse"
+ }
+ }
+ },
+ "description": "Shipped web-search provider presets."
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Not authenticated."
+ }
+ },
+ "summary": "List web search providers",
+ "tags": [
+ "Web Search Providers"
+ ],
+ "x-fern-sdk-group-name": [
+ "catalogs",
+ "webSearchProviders"
+ ],
+ "x-fern-sdk-method-name": "list"
+ }
+ },
"/api/v1/mcp-servers": {
"get": {
"description": "Configured MCP servers as a slim name/url list for the composer.",
@@ -9966,6 +10110,116 @@
"x-fern-sdk-method-name": "create_or_update"
}
},
+ "/api/v1/settings/web-search-providers": {
+ "get": {
+ "description": "The configured provider for this tenant. `auth.api_key` is redacted when present.",
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetWebSearchProviderResponse"
+ }
+ }
+ },
+ "description": "The configured web search provider."
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Invalid Bearer token or auth cookie."
+ },
+ "403": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Authenticated but not an admin."
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "No web search provider configured."
+ }
+ },
+ "summary": "Get the web search provider",
+ "tags": [
+ "Web Search Providers"
+ ],
+ "x-fern-sdk-group-name": [
+ "settings",
+ "webSearchProviders"
+ ],
+ "x-fern-sdk-method-name": "get"
+ },
+ "put": {
+ "description": "Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateWebSearchProviderRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetWebSearchProviderResponse"
+ }
+ }
+ },
+ "description": "The saved provider."
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Invalid request body, or redacted API key with no stored secret to keep."
+ },
+ "424": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequestErrorResponse"
+ }
+ }
+ },
+ "description": "Unsupported operation because web-search providers are managed by an external system"
+ }
+ },
+ "summary": "Create or replace the web search provider",
+ "tags": [
+ "Web Search Providers"
+ ],
+ "x-fern-sdk-group-name": [
+ "settings",
+ "webSearchProviders"
+ ],
+ "x-fern-sdk-method-name": "create_or_update"
+ }
+ },
"/api/v1/skills": {
"get": {
"description": "Configured skills as a slim name/description list for the composer.",
@@ -10077,6 +10331,9 @@
{
"name": "Sandboxes"
},
+ {
+ "name": "Web Search Providers"
+ },
{
"name": "Agents"
},
diff --git a/packages/assistant-ui-runtime/src/index.ts b/packages/assistant-ui-runtime/src/index.ts
index 383f49f38..cfdd8e993 100644
--- a/packages/assistant-ui-runtime/src/index.ts
+++ b/packages/assistant-ui-runtime/src/index.ts
@@ -130,6 +130,8 @@ export type {
CreateSessionRequest,
CreateSkillRequest,
CreateSkillRequestBase,
+ CreateWebSearchProviderRequest,
+ CreateWebSearchRequest,
CreatedBySubject,
DefinedSkill,
GithubSkill,
@@ -212,7 +214,14 @@ export type {
UpdateSandboxRequest,
UpdateScheduleRequest,
UpdateSessionRequest,
+ UpdateWebSearchProviderRequest,
+ UpdateWebSearchRequest,
UserMessage,
UserToolApprovalEvent,
UserToolResponseEvent,
+ WebSearchBase,
+ WebSearchCatalogEntry,
+ WebSearchCatalogServer,
+ WebSearchProviderBase,
+ WebSearchProviderCatalogEntry,
} from './server/index.js';
diff --git a/packages/assistant-ui-runtime/src/server/index.ts b/packages/assistant-ui-runtime/src/server/index.ts
index 0364daeb5..721400328 100644
--- a/packages/assistant-ui-runtime/src/server/index.ts
+++ b/packages/assistant-ui-runtime/src/server/index.ts
@@ -56,6 +56,8 @@ export type {
CreateSessionRequest,
CreateSkillRequest,
CreateSkillRequestBase,
+ CreateWebSearchProviderRequest,
+ CreateWebSearchRequest,
CreatedBySubject,
DefinedSkill,
GithubSkill,
@@ -130,10 +132,17 @@ export type {
UpdateSandboxRequest,
UpdateScheduleRequest,
UpdateSessionRequest,
+ UpdateWebSearchProviderRequest,
+ UpdateWebSearchRequest,
UserMessage,
UserMessageContent,
UserToolApprovalEvent,
UserToolResponseEvent,
+ WebSearchBase,
+ WebSearchCatalogEntry,
+ WebSearchCatalogServer,
+ WebSearchProviderBase,
+ WebSearchProviderCatalogEntry,
} from './types.js';
export type {
diff --git a/packages/assistant-ui-runtime/src/server/types.ts b/packages/assistant-ui-runtime/src/server/types.ts
index 7ad5a2b94..1a09b12a7 100644
--- a/packages/assistant-ui-runtime/src/server/types.ts
+++ b/packages/assistant-ui-runtime/src/server/types.ts
@@ -794,6 +794,58 @@ export interface SandboxCatalogServer<
deleteSandboxProvider?(req: { id: string }): Promise<void>;
}
+// ---------------------------------------------------------------------------
+// Web-search providers catalog β€” public rows omit credentials; writes accept them
+// ---------------------------------------------------------------------------
+
+export interface WebSearchCatalogEntry {
+ id: string;
+ name: string;
+ type: string;
+}
+
+/**
+ * Connected web-search provider row (settings/web-search). No raw `apiKey`.
+ */
+export interface WebSearchBase {
+ id: string;
+ name: string;
+ catalogId: string;
+ isConnected: boolean;
+}
+
+export interface CreateWebSearchRequest {
+ /** `WebSearchCatalogEntry.id` used to create this web-search provider. */
+ catalogId: string;
+ name: string;
+ type: string;
+ apiKey: string;
+}
+
+export interface UpdateWebSearchRequest {
+ id: string;
+ /** Omit to keep the existing key; send a value to set/rotate. */
+ apiKey?: string;
+}
+
+/** Host-facing aliases (trueforge-ui public names). */
+export type WebSearchProviderCatalogEntry = WebSearchCatalogEntry;
+export type WebSearchProviderBase = WebSearchBase;
+export type CreateWebSearchProviderRequest = CreateWebSearchRequest;
+export type UpdateWebSearchProviderRequest = UpdateWebSearchRequest;
+
+export interface WebSearchCatalogServer<
+ TProvider extends WebSearchBase = WebSearchBase,
+ TCatalogEntry extends WebSearchCatalogEntry = WebSearchCatalogEntry,
+ TCreate extends CreateWebSearchRequest = CreateWebSearchRequest,
+ TUpdate extends UpdateWebSearchRequest = UpdateWebSearchRequest,
+> {
+ getWebSearchProviderCatalog(): Promise<TCatalogEntry[]>;
+ listWebSearchProviders(req?: { query?: string }): Promise<TProvider[]>;
+ createWebSearchProvider(req: TCreate): Promise<TProvider>;
+ updateWebSearchProvider(req: TUpdate): Promise<TProvider>;
+}
+
/** Host-facing selector / compose aliases (trueforge-ui public names). */
export type ModelSelection = ModelSelectorEntry;
export type AgentSkill = SkillSelectorEntry;
@@ -803,7 +855,7 @@ export type SearchAgentsParams = SearchAgentSelectorParams;
/**
* Settings management aggregate β€” modelCatalog + connectorCatalog + optional
- * skill and sandbox catalogs.
+ * skill, sandbox, and web-search catalogs.
* Hosts may pass the whole object to an app shell, or a focused sub-port to a page.
*/
export interface CatalogServer<
@@ -811,6 +863,7 @@ export interface CatalogServer<
TConnectorCatalog extends ConnectorCatalogServer = ConnectorCatalogServer,
TSkillCatalog extends SkillCatalogServer = SkillCatalogServer,
TSandboxCatalog extends SandboxCatalogServer = SandboxCatalogServer,
+ TWebSearchCatalog extends WebSearchCatalogServer = WebSearchCatalogServer,
> {
modelCatalog: TModelCatalog;
connectorCatalog: TConnectorCatalog;
@@ -818,6 +871,8 @@ export interface CatalogServer<
skillCatalog?: TSkillCatalog;
/** Optional β€” omit when the host has no sandboxes settings surface. */
sandboxCatalog?: TSandboxCatalog;
+ /** Optional β€” omit when the host has no web-search settings surface. */
+ webSearchCatalog?: TWebSearchCatalog;
}
// ---------------------------------------------------------------------------
diff --git a/packages/trueforge-core/src/core/web-search/ParallelWebSearchProvider.ts b/packages/trueforge-core/src/core/web-search/ParallelWebSearchProvider.ts
index af846a385..c2ef604bf 100644
--- a/packages/trueforge-core/src/core/web-search/ParallelWebSearchProvider.ts
+++ b/packages/trueforge-core/src/core/web-search/ParallelWebSearchProvider.ts
@@ -1,4 +1,5 @@
import Parallel from 'parallel-web';
+import { ssrfFetch } from '../util/ssrfGuard';
import {
WebSearchProviders,
type IWebSearchProvider,
@@ -28,7 +29,10 @@ export class ParallelWebSearchProvider implements IWebSearchProvider {
readonly #mode: ParallelSearchMode;
constructor(options: ParallelWebSearchProviderOptions) {
- this.#client = new Parallel({ apiKey: options.apiKey });
+ this.#client = new Parallel({
+ apiKey: options.apiKey,
+ fetch: ssrfFetch,
+ });
this.#mode = options.mode;
}
diff --git a/packages/trueforge-sdk/package.json b/packages/trueforge-sdk/package.json
index 13ccde5b7..6c6f4e463 100644
--- a/packages/trueforge-sdk/package.json
+++ b/packages/trueforge-sdk/package.json
@@ -187,6 +187,17 @@
},
"default": "./dist/cjs/api/resources/catalogs/resources/skills/exports.js"
},
+ "./catalogs/webSearchProviders": {
+ "import": {
+ "types": "./dist/esm/api/resources/catalogs/resources/webSearchProviders/exports.d.mts",
+ "default": "./dist/esm/api/resources/catalogs/resources/webSearchProviders/exports.mjs"
+ },
+ "require": {
+ "types": "./dist/cjs/api/resources/catalogs/resources/webSearchProviders/exports.d.ts",
+ "default": "./dist/cjs/api/resources/catalogs/resources/webSearchProviders/exports.js"
+ },
+ "default": "./dist/cjs/api/resources/catalogs/resources/webSearchProviders/exports.js"
+ },
"./internal/metrics": {
"import": {
"types": "./dist/esm/api/resources/internal/resources/metrics/exports.d.mts",
@@ -286,6 +297,17 @@
},
"default": "./dist/cjs/api/resources/settings/resources/skills/exports.js"
},
+ "./settings/webSearchProviders": {
+ "import": {
+ "types": "./dist/esm/api/resources/settings/resources/webSearchProviders/exports.d.mts",
+ "default": "./dist/esm/api/resources/settings/resources/webSearchProviders/exports.mjs"
+ },
+ "require": {
+ "types": "./dist/cjs/api/resources/settings/resources/webSearchProviders/exports.d.ts",
+ "default": "./dist/cjs/api/resources/settings/resources/webSearchProviders/exports.js"
+ },
+ "default": "./dist/cjs/api/resources/settings/resources/webSearchProviders/exports.js"
+ },
"./package.json": "./package.json"
},
"files": [
diff --git a/packages/trueforge-sdk/reference.md b/packages/trueforge-sdk/reference.md
index 0936210ae..d4d1e893f 100644
--- a/packages/trueforge-sdk/reference.md
+++ b/packages/trueforge-sdk/reference.md
@@ -2793,6 +2793,62 @@ await client.catalogs.skills.list();
</dl>
+</dd>
+</dl>
+</details>
+
+## Catalogs WebSearchProviders
+<details><summary><code>client.catalogs.webSearchProviders.<a href="/src/api/resources/catalogs/resources/webSearchProviders/client/Client.ts">list</a>() -> TrueForge.GetWebSearchProviderCatalogResponse</code></summary>
+<dl>
+<dd>
+
+#### πŸ“ Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Shipped web-search provider presets.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### πŸ”Œ Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.catalogs.webSearchProviders.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### βš™οΈ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `WebSearchProvidersClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
</dd>
</dl>
</details>
@@ -3988,3 +4044,129 @@ await client.settings.skills.createOrUpdate({
</dl>
</details>
+## Settings WebSearchProviders
+<details><summary><code>client.settings.webSearchProviders.<a href="/src/api/resources/settings/resources/webSearchProviders/client/Client.ts">get</a>() -> TrueForge.GetWebSearchProviderResponse</code></summary>
+<dl>
+<dd>
+
+#### πŸ“ Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The configured provider for this tenant. `auth.api_key` is redacted when present.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### πŸ”Œ Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.settings.webSearchProviders.get();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### βš™οΈ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `WebSearchProvidersClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.settings.webSearchProviders.<a href="/src/api/resources/settings/resources/webSearchProviders/client/Client.ts">createOrUpdate</a>({ ...params }) -> TrueForge.GetWebSearchProviderResponse</code></summary>
+<dl>
+<dd>
+
+#### πŸ“ Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### πŸ”Œ Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.settings.webSearchProviders.createOrUpdate({
+ manifest: {
+ auth: {
+ apiKey: "api_key"
+ },
+ type: "parallel"
+ }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### βš™οΈ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `TrueForge.settings.UpdateWebSearchProviderRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WebSearchProvidersClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
diff --git a/packages/trueforge-sdk/src/api/resources/catalogs/client/Client.ts b/packages/trueforge-sdk/src/api/resources/catalogs/client/Client.ts
index 79f2023b8..b3bef0e8e 100644
--- a/packages/trueforge-sdk/src/api/resources/catalogs/client/Client.ts
+++ b/packages/trueforge-sdk/src/api/resources/catalogs/client/Client.ts
@@ -6,6 +6,7 @@ import { McpServersClient } from "../resources/mcpServers/client/Client.js";
import { ModelProvidersClient } from "../resources/modelProviders/client/Client.js";
import { SandboxProvidersClient } from "../resources/sandboxProviders/client/Client.js";
import { SkillsClient } from "../resources/skills/client/Client.js";
+import { WebSearchProvidersClient } from "../resources/webSearchProviders/client/Client.js";
export declare namespace CatalogsClient {
export type Options = BaseClientOptions;
@@ -17,6 +18,7 @@ export class CatalogsClient {
protected _modelProviders: ModelProvidersClient | undefined;
protected _sandboxProviders: SandboxProvidersClient | undefined;
protected _skills: SkillsClient | undefined;
+ protected _webSearchProviders: WebSearchProvidersClient | undefined;
constructor(options: CatalogsClient.Options) {
this._options = normalizeClientOptionsWithAuth(options);
@@ -37,4 +39,8 @@ export class CatalogsClient {
public get skills(): SkillsClient {
return (this._skills ??= new SkillsClient(this._options));
}
+
+ public get webSearchProviders(): WebSearchProvidersClient {
+ return (this._webSearchProviders ??= new WebSearchProvidersClient(this._options));
+ }
}
diff --git a/packages/trueforge-sdk/src/api/resources/catalogs/resources/index.ts b/packages/trueforge-sdk/src/api/resources/catalogs/resources/index.ts
index 160fb572f..e03815286 100644
--- a/packages/trueforge-sdk/src/api/resources/catalogs/resources/index.ts
+++ b/packages/trueforge-sdk/src/api/resources/catalogs/resources/index.ts
@@ -2,3 +2,4 @@ export * as mcpServers from "./mcpServers/index.js";
export * as modelProviders from "./modelProviders/index.js";
export * as sandboxProviders from "./sandboxProviders/index.js";
export * as skills from "./skills/index.js";
+export * as webSearchProviders from "./webSearchProviders/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/client/Client.ts b/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/client/Client.ts
new file mode 100644
index 000000000..90ba26dc8
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/client/Client.ts
@@ -0,0 +1,109 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import { mergeHeaders } from "../../../../../../core/headers.js";
+import * as core from "../../../../../../core/index.js";
+import { handleNonStatusCodeError } from "../../../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../../../errors/index.js";
+import * as serializers from "../../../../../../serialization/index.js";
+import * as TrueForge from "../../../../../index.js";
+
+export declare namespace WebSearchProvidersClient {
+ export type Options = BaseClientOptions;
+
+ export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class WebSearchProvidersClient {
+ protected readonly _options: NormalizedClientOptionsWithAuth<WebSearchProvidersClient.Options>;
+
+ constructor(options: WebSearchProvidersClient.Options) {
+ this._options = normalizeClientOptionsWithAuth(options);
+ }
+
+ /**
+ * Shipped web-search provider presets.
+ *
+ * @param {WebSearchProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
+ *
+ * @throws {@link TrueForge.UnauthorizedError}
+ * @throws {@link errors.TrueForgeError}
+ * @throws {@link errors.TrueForgeTimeoutError}
+ *
+ * @example
+ * await client.catalogs.webSearchProviders.list()
+ */
+ public list(
+ requestOptions?: WebSearchProvidersClient.RequestOptions,
+ ): core.HttpResponsePromise<TrueForge.GetWebSearchProviderCatalogResponse> {
+ return core.HttpResponsePromise.fromPromise(this.__list(requestOptions));
+ }
+
+ private async __list(
+ requestOptions?: WebSearchProvidersClient.RequestOptions,
+ ): Promise<core.WithRawResponse<TrueForge.GetWebSearchProviderCatalogResponse>> {
+ const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+ const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+ _authRequest.headers,
+ this._options?.headers,
+ requestOptions?.headers,
+ );
+ const _response = await (this._options.fetcher ?? core.fetcher)({
+ url: core.url.join(
+ (await core.Supplier.get(this._options.baseUrl)) ??
+ (await core.Supplier.get(this._options.environment)),
+ "api/v1/catalogs/web-search-providers",
+ ),
+ method: "GET",
+ headers: _headers,
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
+ fetchFn: this._options?.fetch,
+ logging: this._options.logging,
+ });
+ if (_response.ok) {
+ return {
+ data: serializers.GetWebSearchProviderCatalogResponse.parseOrThrow(_response.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ rawResponse: _response.rawResponse,
+ };
+ }
+
+ if (_response.error.reason === "status-code") {
+ switch (_response.error.statusCode) {
+ case 401:
+ throw new TrueForge.UnauthorizedError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ default:
+ throw new errors.TrueForgeError({
+ statusCode: _response.error.statusCode,
+ body: _response.error.body,
+ rawResponse: _response.rawResponse,
+ });
+ }
+ }
+
+ return handleNonStatusCodeError(
+ _response.error,
+ _response.rawResponse,
+ "GET",
+ "/api/v1/catalogs/web-search-providers",
+ );
+ }
+}
diff --git a/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/client/index.ts b/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/client/index.ts
new file mode 100644
index 000000000..cb0ff5c3b
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/client/index.ts
@@ -0,0 +1 @@
+export {};
diff --git a/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/exports.ts b/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/exports.ts
new file mode 100644
index 000000000..8198c3c0d
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/exports.ts
@@ -0,0 +1,4 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export { WebSearchProvidersClient } from "./client/Client.js";
+export * from "./client/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/index.ts b/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/index.ts
new file mode 100644
index 000000000..914b8c3c7
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/catalogs/resources/webSearchProviders/index.ts
@@ -0,0 +1 @@
+export * from "./client/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/settings/client/Client.ts b/packages/trueforge-sdk/src/api/resources/settings/client/Client.ts
index f932bd78f..9b1809df1 100644
--- a/packages/trueforge-sdk/src/api/resources/settings/client/Client.ts
+++ b/packages/trueforge-sdk/src/api/resources/settings/client/Client.ts
@@ -6,6 +6,7 @@ import { McpServersClient } from "../resources/mcpServers/client/Client.js";
import { ModelProvidersClient } from "../resources/modelProviders/client/Client.js";
import { SandboxProvidersClient } from "../resources/sandboxProviders/client/Client.js";
import { SkillsClient } from "../resources/skills/client/Client.js";
+import { WebSearchProvidersClient } from "../resources/webSearchProviders/client/Client.js";
export declare namespace SettingsClient {
export type Options = BaseClientOptions;
@@ -17,6 +18,7 @@ export class SettingsClient {
protected _modelProviders: ModelProvidersClient | undefined;
protected _sandboxProviders: SandboxProvidersClient | undefined;
protected _skills: SkillsClient | undefined;
+ protected _webSearchProviders: WebSearchProvidersClient | undefined;
constructor(options: SettingsClient.Options) {
this._options = normalizeClientOptionsWithAuth(options);
@@ -37,4 +39,8 @@ export class SettingsClient {
public get skills(): SkillsClient {
return (this._skills ??= new SkillsClient(this._options));
}
+
+ public get webSearchProviders(): WebSearchProvidersClient {
+ return (this._webSearchProviders ??= new WebSearchProvidersClient(this._options));
+ }
}
diff --git a/packages/trueforge-sdk/src/api/resources/settings/resources/index.ts b/packages/trueforge-sdk/src/api/resources/settings/resources/index.ts
index 61dea343e..bc60478e7 100644
--- a/packages/trueforge-sdk/src/api/resources/settings/resources/index.ts
+++ b/packages/trueforge-sdk/src/api/resources/settings/resources/index.ts
@@ -6,3 +6,5 @@ export * from "./sandboxProviders/client/requests/index.js";
export * as sandboxProviders from "./sandboxProviders/index.js";
export * from "./skills/client/requests/index.js";
export * as skills from "./skills/index.js";
+export * from "./webSearchProviders/client/requests/index.js";
+export * as webSearchProviders from "./webSearchProviders/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/Client.ts b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/Client.ts
new file mode 100644
index 000000000..c25d9a1a7
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/Client.ts
@@ -0,0 +1,252 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import { mergeHeaders } from "../../../../../../core/headers.js";
+import * as core from "../../../../../../core/index.js";
+import { mergeAdditionalBodyParameters } from "../../../../../../core/requestBody.js";
+import { handleNonStatusCodeError } from "../../../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../../../errors/index.js";
+import * as serializers from "../../../../../../serialization/index.js";
+import * as TrueForge from "../../../../../index.js";
+
+export declare namespace WebSearchProvidersClient {
+ export type Options = BaseClientOptions;
+
+ export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class WebSearchProvidersClient {
+ protected readonly _options: NormalizedClientOptionsWithAuth<WebSearchProvidersClient.Options>;
+
+ constructor(options: WebSearchProvidersClient.Options) {
+ this._options = normalizeClientOptionsWithAuth(options);
+ }
+
+ /**
+ * The configured provider for this tenant. `auth.api_key` is redacted when present.
+ *
+ * @param {WebSearchProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
+ *
+ * @throws {@link TrueForge.UnauthorizedError}
+ * @throws {@link TrueForge.ForbiddenError}
+ * @throws {@link TrueForge.NotFoundError}
+ * @throws {@link errors.TrueForgeError}
+ * @throws {@link errors.TrueForgeTimeoutError}
+ *
+ * @example
+ * await client.settings.webSearchProviders.get()
+ */
+ public get(
+ requestOptions?: WebSearchProvidersClient.RequestOptions,
+ ): core.HttpResponsePromise<TrueForge.GetWebSearchProviderResponse> {
+ return core.HttpResponsePromise.fromPromise(this.__get(requestOptions));
+ }
+
+ private async __get(
+ requestOptions?: WebSearchProvidersClient.RequestOptions,
+ ): Promise<core.WithRawResponse<TrueForge.GetWebSearchProviderResponse>> {
+ const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+ const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+ _authRequest.headers,
+ this._options?.headers,
+ requestOptions?.headers,
+ );
+ const _response = await (this._options.fetcher ?? core.fetcher)({
+ url: core.url.join(
+ (await core.Supplier.get(this._options.baseUrl)) ??
+ (await core.Supplier.get(this._options.environment)),
+ "api/v1/settings/web-search-providers",
+ ),
+ method: "GET",
+ headers: _headers,
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
+ fetchFn: this._options?.fetch,
+ logging: this._options.logging,
+ });
+ if (_response.ok) {
+ return {
+ data: serializers.GetWebSearchProviderResponse.parseOrThrow(_response.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ rawResponse: _response.rawResponse,
+ };
+ }
+
+ if (_response.error.reason === "status-code") {
+ switch (_response.error.statusCode) {
+ case 401:
+ throw new TrueForge.UnauthorizedError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ case 403:
+ throw new TrueForge.ForbiddenError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ case 404:
+ throw new TrueForge.NotFoundError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ default:
+ throw new errors.TrueForgeError({
+ statusCode: _response.error.statusCode,
+ body: _response.error.body,
+ rawResponse: _response.rawResponse,
+ });
+ }
+ }
+
+ return handleNonStatusCodeError(
+ _response.error,
+ _response.rawResponse,
+ "GET",
+ "/api/v1/settings/web-search-providers",
+ );
+ }
+
+ /**
+ * Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
+ *
+ * @param {TrueForge.settings.UpdateWebSearchProviderRequest} request
+ * @param {WebSearchProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
+ *
+ * @throws {@link TrueForge.BadRequestError}
+ * @throws {@link TrueForge.FailedDependencyError}
+ * @throws {@link errors.TrueForgeError}
+ * @throws {@link errors.TrueForgeTimeoutError}
+ *
+ * @example
+ * await client.settings.webSearchProviders.createOrUpdate({
+ * manifest: {
+ * auth: {
+ * apiKey: "api_key"
+ * },
+ * type: "parallel"
+ * }
+ * })
+ */
+ public createOrUpdate(
+ request: TrueForge.settings.UpdateWebSearchProviderRequest,
+ requestOptions?: WebSearchProvidersClient.RequestOptions,
+ ): core.HttpResponsePromise<TrueForge.GetWebSearchProviderResponse> {
+ return core.HttpResponsePromise.fromPromise(this.__createOrUpdate(request, requestOptions));
+ }
+
+ private async __createOrUpdate(
+ request: TrueForge.settings.UpdateWebSearchProviderRequest,
+ requestOptions?: WebSearchProvidersClient.RequestOptions,
+ ): Promise<core.WithRawResponse<TrueForge.GetWebSearchProviderResponse>> {
+ const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+ const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+ _authRequest.headers,
+ this._options?.headers,
+ requestOptions?.headers,
+ );
+ const _response = await (this._options.fetcher ?? core.fetcher)({
+ url: core.url.join(
+ (await core.Supplier.get(this._options.baseUrl)) ??
+ (await core.Supplier.get(this._options.environment)),
+ "api/v1/settings/web-search-providers",
+ ),
+ method: "PUT",
+ headers: _headers,
+ contentType: "application/json",
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+ requestType: "json",
+ body: mergeAdditionalBodyParameters(
+ serializers.settings.UpdateWebSearchProviderRequest.jsonOrThrow(request, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ omitUndefined: true,
+ }),
+ requestOptions?.additionalBodyParameters,
+ ),
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
+ fetchFn: this._options?.fetch,
+ logging: this._options.logging,
+ });
+ if (_response.ok) {
+ return {
+ data: serializers.GetWebSearchProviderResponse.parseOrThrow(_response.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ rawResponse: _response.rawResponse,
+ };
+ }
+
+ if (_response.error.reason === "status-code") {
+ switch (_response.error.statusCode) {
+ case 400:
+ throw new TrueForge.BadRequestError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ case 424:
+ throw new TrueForge.FailedDependencyError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ default:
+ throw new errors.TrueForgeError({
+ statusCode: _response.error.statusCode,
+ body: _response.error.body,
+ rawResponse: _response.rawResponse,
+ });
+ }
+ }
+
+ return handleNonStatusCodeError(
+ _response.error,
+ _response.rawResponse,
+ "PUT",
+ "/api/v1/settings/web-search-providers",
+ );
+ }
+}
diff --git a/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/index.ts b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/index.ts
new file mode 100644
index 000000000..195f9aa8a
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/index.ts
@@ -0,0 +1 @@
+export * from "./requests/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/requests/UpdateWebSearchProviderRequest.ts b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/requests/UpdateWebSearchProviderRequest.ts
new file mode 100644
index 000000000..d24b84863
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/requests/UpdateWebSearchProviderRequest.ts
@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../../../../../index.js";
+
+/**
+ * @example
+ * {
+ * manifest: {
+ * auth: {
+ * apiKey: "api_key"
+ * },
+ * type: "parallel"
+ * }
+ * }
+ */
+export interface UpdateWebSearchProviderRequest {
+ manifest: TrueForge.WebSearchProviderManifest;
+}
diff --git a/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/requests/index.ts b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/requests/index.ts
new file mode 100644
index 000000000..6b1f7c852
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/client/requests/index.ts
@@ -0,0 +1 @@
+export type { UpdateWebSearchProviderRequest } from "./UpdateWebSearchProviderRequest.js";
diff --git a/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/exports.ts b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/exports.ts
new file mode 100644
index 000000000..8198c3c0d
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/exports.ts
@@ -0,0 +1,4 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export { WebSearchProvidersClient } from "./client/Client.js";
+export * from "./client/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/index.ts b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/index.ts
new file mode 100644
index 000000000..914b8c3c7
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/settings/resources/webSearchProviders/index.ts
@@ -0,0 +1 @@
+export * from "./client/index.js";
diff --git a/packages/trueforge-sdk/src/api/types/CatalogWebSearchProvider.ts b/packages/trueforge-sdk/src/api/types/CatalogWebSearchProvider.ts
new file mode 100644
index 000000000..eb94bb2d6
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/CatalogWebSearchProvider.ts
@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface CatalogWebSearchProvider {
+ /** Parallel web-search provider. */
+ type: "parallel";
+}
diff --git a/packages/trueforge-sdk/src/api/types/ConfiguredWebSearchProvider.ts b/packages/trueforge-sdk/src/api/types/ConfiguredWebSearchProvider.ts
new file mode 100644
index 000000000..1d7c4c214
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/ConfiguredWebSearchProvider.ts
@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface ConfiguredWebSearchProvider {
+ manifest: TrueForge.WebSearchProviderManifest;
+ name: TrueForge.ResourceName;
+}
diff --git a/packages/trueforge-sdk/src/api/types/GetWebSearchProviderCatalogResponse.ts b/packages/trueforge-sdk/src/api/types/GetWebSearchProviderCatalogResponse.ts
new file mode 100644
index 000000000..4234a59c8
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/GetWebSearchProviderCatalogResponse.ts
@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface GetWebSearchProviderCatalogResponse {
+ data: TrueForge.CatalogWebSearchProvider[];
+}
diff --git a/packages/trueforge-sdk/src/api/types/GetWebSearchProviderResponse.ts b/packages/trueforge-sdk/src/api/types/GetWebSearchProviderResponse.ts
new file mode 100644
index 000000000..8e60d753e
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/GetWebSearchProviderResponse.ts
@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface GetWebSearchProviderResponse {
+ data: TrueForge.ConfiguredWebSearchProvider;
+}
diff --git a/packages/trueforge-sdk/src/api/types/ParallelWebSearchProviderAuth.ts b/packages/trueforge-sdk/src/api/types/ParallelWebSearchProviderAuth.ts
new file mode 100644
index 000000000..b22edb01e
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/ParallelWebSearchProviderAuth.ts
@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * Parallel authentication credentials.
+ */
+export interface ParallelWebSearchProviderAuth {
+ /** Parallel API key. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored key. */
+ apiKey: string;
+}
diff --git a/packages/trueforge-sdk/src/api/types/WebSearchProviderManifest.ts b/packages/trueforge-sdk/src/api/types/WebSearchProviderManifest.ts
new file mode 100644
index 000000000..fb70fa908
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/WebSearchProviderManifest.ts
@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface WebSearchProviderManifest {
+ auth: TrueForge.ParallelWebSearchProviderAuth;
+ /** Parallel web-search provider. */
+ type: "parallel";
+}
diff --git a/packages/trueforge-sdk/src/api/types/index.ts b/packages/trueforge-sdk/src/api/types/index.ts
index 9b29138b5..3c8a2dcf3 100644
--- a/packages/trueforge-sdk/src/api/types/index.ts
+++ b/packages/trueforge-sdk/src/api/types/index.ts
@@ -29,6 +29,7 @@ export * from "./CatalogModelProvider.js";
export * from "./CatalogSandboxProvider.js";
export * from "./CatalogSkill.js";
export * from "./CatalogSkillType.js";
+export * from "./CatalogWebSearchProvider.js";
export * from "./CatalogWellKnownModelProvider.js";
export * from "./CatalogWellKnownModelProviderType.js";
export * from "./ChatCompletionChunkDeltaToolCall.js";
@@ -43,6 +44,7 @@ export * from "./ConfiguredModel.js";
export * from "./ConfiguredModelProvider.js";
export * from "./ConfiguredSandboxProvider.js";
export * from "./ConfiguredSkill.js";
+export * from "./ConfiguredWebSearchProvider.js";
export * from "./ContextManagementConfig.js";
export * from "./CreatedBySubject.js";
export * from "./CreateScheduleRunResponse.js";
@@ -78,6 +80,8 @@ export * from "./GetSessionResponse.js";
export * from "./GetSkillCatalogResponse.js";
export * from "./GetSkillResponse.js";
export * from "./GetTurnResponse.js";
+export * from "./GetWebSearchProviderCatalogResponse.js";
+export * from "./GetWebSearchProviderResponse.js";
export * from "./GitSkill.js";
export * from "./GoogleGeminiModelProvider.js";
export * from "./InitialUserMessage.js";
@@ -136,6 +140,7 @@ export * from "./ModelProviderAuth.js";
export * from "./ModelProviderManifest.js";
export * from "./MoonshotModelProvider.js";
export * from "./OpenAiModelProvider.js";
+export * from "./ParallelWebSearchProviderAuth.js";
export * from "./PermissionResourceType.js";
export * from "./PreviousTurnIdInput.js";
export * from "./RawToolCall.js";
@@ -234,4 +239,5 @@ export * from "./UserToolApprovalEvent.js";
export * from "./UserToolResponseEvent.js";
export * from "./WebSearchCapability.js";
export * from "./WebSearchConfig.js";
+export * from "./WebSearchProviderManifest.js";
export * from "./ZaiModelProvider.js";
diff --git a/packages/trueforge-sdk/src/serialization/resources/settings/resources/index.ts b/packages/trueforge-sdk/src/serialization/resources/settings/resources/index.ts
index 61dea343e..bc60478e7 100644
--- a/packages/trueforge-sdk/src/serialization/resources/settings/resources/index.ts
+++ b/packages/trueforge-sdk/src/serialization/resources/settings/resources/index.ts
@@ -6,3 +6,5 @@ export * from "./sandboxProviders/client/requests/index.js";
export * as sandboxProviders from "./sandboxProviders/index.js";
export * from "./skills/client/requests/index.js";
export * as skills from "./skills/index.js";
+export * from "./webSearchProviders/client/requests/index.js";
+export * as webSearchProviders from "./webSearchProviders/index.js";
diff --git a/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/index.ts b/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/index.ts
new file mode 100644
index 000000000..195f9aa8a
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/index.ts
@@ -0,0 +1 @@
+export * from "./requests/index.js";
diff --git a/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/requests/UpdateWebSearchProviderRequest.ts b/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/requests/UpdateWebSearchProviderRequest.ts
new file mode 100644
index 000000000..758108d85
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/requests/UpdateWebSearchProviderRequest.ts
@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../../../../../../api/index.js";
+import * as core from "../../../../../../../core/index.js";
+import type * as serializers from "../../../../../../index.js";
+import { WebSearchProviderManifest } from "../../../../../../types/WebSearchProviderManifest.js";
+
+export const UpdateWebSearchProviderRequest: core.serialization.Schema<
+ serializers.settings.UpdateWebSearchProviderRequest.Raw,
+ TrueForge.settings.UpdateWebSearchProviderRequest
+> = core.serialization.object({
+ manifest: WebSearchProviderManifest,
+});
+
+export declare namespace UpdateWebSearchProviderRequest {
+ export interface Raw {
+ manifest: WebSearchProviderManifest.Raw;
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/requests/index.ts b/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/requests/index.ts
new file mode 100644
index 000000000..a8fe92d27
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/client/requests/index.ts
@@ -0,0 +1 @@
+export { UpdateWebSearchProviderRequest } from "./UpdateWebSearchProviderRequest.js";
diff --git a/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/index.ts b/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/index.ts
new file mode 100644
index 000000000..914b8c3c7
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/resources/settings/resources/webSearchProviders/index.ts
@@ -0,0 +1 @@
+export * from "./client/index.js";
diff --git a/packages/trueforge-sdk/src/serialization/types/CatalogWebSearchProvider.ts b/packages/trueforge-sdk/src/serialization/types/CatalogWebSearchProvider.ts
new file mode 100644
index 000000000..1b6ec7bef
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/CatalogWebSearchProvider.ts
@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+
+export const CatalogWebSearchProvider: core.serialization.ObjectSchema<
+ serializers.CatalogWebSearchProvider.Raw,
+ TrueForge.CatalogWebSearchProvider
+> = core.serialization.object({
+ type: core.serialization.stringLiteral("parallel"),
+});
+
+export declare namespace CatalogWebSearchProvider {
+ export interface Raw {
+ type: "parallel";
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/ConfiguredWebSearchProvider.ts b/packages/trueforge-sdk/src/serialization/types/ConfiguredWebSearchProvider.ts
new file mode 100644
index 000000000..698c294d0
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/ConfiguredWebSearchProvider.ts
@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { ResourceName } from "./ResourceName.js";
+import { WebSearchProviderManifest } from "./WebSearchProviderManifest.js";
+
+export const ConfiguredWebSearchProvider: core.serialization.ObjectSchema<
+ serializers.ConfiguredWebSearchProvider.Raw,
+ TrueForge.ConfiguredWebSearchProvider
+> = core.serialization.object({
+ manifest: WebSearchProviderManifest,
+ name: ResourceName,
+});
+
+export declare namespace ConfiguredWebSearchProvider {
+ export interface Raw {
+ manifest: WebSearchProviderManifest.Raw;
+ name: ResourceName.Raw;
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/GetWebSearchProviderCatalogResponse.ts b/packages/trueforge-sdk/src/serialization/types/GetWebSearchProviderCatalogResponse.ts
new file mode 100644
index 000000000..436c52914
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/GetWebSearchProviderCatalogResponse.ts
@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { CatalogWebSearchProvider } from "./CatalogWebSearchProvider.js";
+
+export const GetWebSearchProviderCatalogResponse: core.serialization.ObjectSchema<
+ serializers.GetWebSearchProviderCatalogResponse.Raw,
+ TrueForge.GetWebSearchProviderCatalogResponse
+> = core.serialization.object({
+ data: core.serialization.list(CatalogWebSearchProvider),
+});
+
+export declare namespace GetWebSearchProviderCatalogResponse {
+ export interface Raw {
+ data: CatalogWebSearchProvider.Raw[];
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/GetWebSearchProviderResponse.ts b/packages/trueforge-sdk/src/serialization/types/GetWebSearchProviderResponse.ts
new file mode 100644
index 000000000..006ca039a
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/GetWebSearchProviderResponse.ts
@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { ConfiguredWebSearchProvider } from "./ConfiguredWebSearchProvider.js";
+
+export const GetWebSearchProviderResponse: core.serialization.ObjectSchema<
+ serializers.GetWebSearchProviderResponse.Raw,
+ TrueForge.GetWebSearchProviderResponse
+> = core.serialization.object({
+ data: ConfiguredWebSearchProvider,
+});
+
+export declare namespace GetWebSearchProviderResponse {
+ export interface Raw {
+ data: ConfiguredWebSearchProvider.Raw;
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/ParallelWebSearchProviderAuth.ts b/packages/trueforge-sdk/src/serialization/types/ParallelWebSearchProviderAuth.ts
new file mode 100644
index 000000000..98604a17f
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/ParallelWebSearchProviderAuth.ts
@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+
+export const ParallelWebSearchProviderAuth: core.serialization.ObjectSchema<
+ serializers.ParallelWebSearchProviderAuth.Raw,
+ TrueForge.ParallelWebSearchProviderAuth
+> = core.serialization.object({
+ apiKey: core.serialization.property("api_key", core.serialization.string()),
+});
+
+export declare namespace ParallelWebSearchProviderAuth {
+ export interface Raw {
+ api_key: string;
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/WebSearchProviderManifest.ts b/packages/trueforge-sdk/src/serialization/types/WebSearchProviderManifest.ts
new file mode 100644
index 000000000..aba4ab2bc
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/WebSearchProviderManifest.ts
@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { ParallelWebSearchProviderAuth } from "./ParallelWebSearchProviderAuth.js";
+
+export const WebSearchProviderManifest: core.serialization.ObjectSchema<
+ serializers.WebSearchProviderManifest.Raw,
+ TrueForge.WebSearchProviderManifest
+> = core.serialization.object({
+ auth: ParallelWebSearchProviderAuth,
+ type: core.serialization.stringLiteral("parallel"),
+});
+
+export declare namespace WebSearchProviderManifest {
+ export interface Raw {
+ auth: ParallelWebSearchProviderAuth.Raw;
+ type: "parallel";
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/index.ts b/packages/trueforge-sdk/src/serialization/types/index.ts
index 9b29138b5..3c8a2dcf3 100644
--- a/packages/trueforge-sdk/src/serialization/types/index.ts
+++ b/packages/trueforge-sdk/src/serialization/types/index.ts
@@ -29,6 +29,7 @@ export * from "./CatalogModelProvider.js";
export * from "./CatalogSandboxProvider.js";
export * from "./CatalogSkill.js";
export * from "./CatalogSkillType.js";
+export * from "./CatalogWebSearchProvider.js";
export * from "./CatalogWellKnownModelProvider.js";
export * from "./CatalogWellKnownModelProviderType.js";
export * from "./ChatCompletionChunkDeltaToolCall.js";
@@ -43,6 +44,7 @@ export * from "./ConfiguredModel.js";
export * from "./ConfiguredModelProvider.js";
export * from "./ConfiguredSandboxProvider.js";
export * from "./ConfiguredSkill.js";
+export * from "./ConfiguredWebSearchProvider.js";
export * from "./ContextManagementConfig.js";
export * from "./CreatedBySubject.js";
export * from "./CreateScheduleRunResponse.js";
@@ -78,6 +80,8 @@ export * from "./GetSessionResponse.js";
export * from "./GetSkillCatalogResponse.js";
export * from "./GetSkillResponse.js";
export * from "./GetTurnResponse.js";
+export * from "./GetWebSearchProviderCatalogResponse.js";
+export * from "./GetWebSearchProviderResponse.js";
export * from "./GitSkill.js";
export * from "./GoogleGeminiModelProvider.js";
export * from "./InitialUserMessage.js";
@@ -136,6 +140,7 @@ export * from "./ModelProviderAuth.js";
export * from "./ModelProviderManifest.js";
export * from "./MoonshotModelProvider.js";
export * from "./OpenAiModelProvider.js";
+export * from "./ParallelWebSearchProviderAuth.js";
export * from "./PermissionResourceType.js";
export * from "./PreviousTurnIdInput.js";
export * from "./RawToolCall.js";
@@ -234,4 +239,5 @@ export * from "./UserToolApprovalEvent.js";
export * from "./UserToolResponseEvent.js";
export * from "./WebSearchCapability.js";
export * from "./WebSearchConfig.js";
+export * from "./WebSearchProviderManifest.js";
export * from "./ZaiModelProvider.js";
diff --git a/packages/trueforge-sdk/tests/wire/catalogs/webSearchProviders.test.ts b/packages/trueforge-sdk/tests/wire/catalogs/webSearchProviders.test.ts
new file mode 100644
index 000000000..f07a981d4
--- /dev/null
+++ b/packages/trueforge-sdk/tests/wire/catalogs/webSearchProviders.test.ts
@@ -0,0 +1,50 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import * as TrueForgeTypes from "../../../src/api/index";
+import { TrueForge } from "../../../src/Client";
+import { mockServerPool } from "../../mock-server/MockServerPool";
+
+describe("WebSearchProvidersClient", () => {
+ test("list (1)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = { data: [{ type: "parallel" }] };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/catalogs/web-search-providers")
+ .respondWith()
+ .statusCode(200)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ const response = await client.catalogs.webSearchProviders.list();
+ expect(response).toEqual({
+ data: [
+ {
+ type: "parallel",
+ },
+ ],
+ });
+ });
+
+ test("list (2)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/catalogs/web-search-providers")
+ .respondWith()
+ .statusCode(401)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.catalogs.webSearchProviders.list();
+ }).rejects.toThrow(TrueForgeTypes.UnauthorizedError);
+ });
+});
diff --git a/packages/trueforge-sdk/tests/wire/settings/webSearchProviders.test.ts b/packages/trueforge-sdk/tests/wire/settings/webSearchProviders.test.ts
new file mode 100644
index 000000000..0ae7ef59a
--- /dev/null
+++ b/packages/trueforge-sdk/tests/wire/settings/webSearchProviders.test.ts
@@ -0,0 +1,186 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import * as TrueForgeTypes from "../../../src/api/index";
+import { TrueForge } from "../../../src/Client";
+import { mockServerPool } from "../../mock-server/MockServerPool";
+
+describe("WebSearchProvidersClient", () => {
+ test("get (1)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = {
+ data: { manifest: { auth: { api_key: "api_key" }, type: "parallel" }, name: "name" },
+ };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/settings/web-search-providers")
+ .respondWith()
+ .statusCode(200)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ const response = await client.settings.webSearchProviders.get();
+ expect(response).toEqual({
+ data: {
+ manifest: {
+ auth: {
+ apiKey: "api_key",
+ },
+ type: "parallel",
+ },
+ name: "name",
+ },
+ });
+ });
+
+ test("get (2)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/settings/web-search-providers")
+ .respondWith()
+ .statusCode(401)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.settings.webSearchProviders.get();
+ }).rejects.toThrow(TrueForgeTypes.UnauthorizedError);
+ });
+
+ test("get (3)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/settings/web-search-providers")
+ .respondWith()
+ .statusCode(403)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.settings.webSearchProviders.get();
+ }).rejects.toThrow(TrueForgeTypes.ForbiddenError);
+ });
+
+ test("get (4)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/settings/web-search-providers")
+ .respondWith()
+ .statusCode(404)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.settings.webSearchProviders.get();
+ }).rejects.toThrow(TrueForgeTypes.NotFoundError);
+ });
+
+ test("create_or_update (1)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+ const rawRequestBody = { manifest: { auth: { api_key: "api_key" }, type: "parallel" } };
+ const rawResponseBody = {
+ data: { manifest: { auth: { api_key: "api_key" }, type: "parallel" }, name: "name" },
+ };
+
+ server
+ .mockEndpoint()
+ .put("/api/v1/settings/web-search-providers")
+ .jsonBody(rawRequestBody)
+ .respondWith()
+ .statusCode(200)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ const response = await client.settings.webSearchProviders.createOrUpdate({
+ manifest: {
+ auth: {
+ apiKey: "api_key",
+ },
+ type: "parallel",
+ },
+ });
+ expect(response).toEqual({
+ data: {
+ manifest: {
+ auth: {
+ apiKey: "api_key",
+ },
+ type: "parallel",
+ },
+ name: "name",
+ },
+ });
+ });
+
+ test("create_or_update (2)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+ const rawRequestBody = { manifest: { auth: { api_key: "x" }, type: "parallel" } };
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .put("/api/v1/settings/web-search-providers")
+ .jsonBody(rawRequestBody)
+ .respondWith()
+ .statusCode(400)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.settings.webSearchProviders.createOrUpdate({
+ manifest: {
+ auth: {
+ apiKey: "x",
+ },
+ type: "parallel",
+ },
+ });
+ }).rejects.toThrow(TrueForgeTypes.BadRequestError);
+ });
+
+ test("create_or_update (3)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+ const rawRequestBody = { manifest: { auth: { api_key: "x" }, type: "parallel" } };
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .put("/api/v1/settings/web-search-providers")
+ .jsonBody(rawRequestBody)
+ .respondWith()
+ .statusCode(424)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.settings.webSearchProviders.createOrUpdate({
+ manifest: {
+ auth: {
+ apiKey: "x",
+ },
+ type: "parallel",
+ },
+ });
+ }).rejects.toThrow(TrueForgeTypes.FailedDependencyError);
+ });
+});
diff --git a/packages/trueforge-ui/src/atoms/agent-details/AgentSessionMetricsStrip.tsx b/packages/trueforge-ui/src/atoms/agent-details/AgentSessionMetricsStrip.tsx
index e23d74237..f2fbf268f 100644
--- a/packages/trueforge-ui/src/atoms/agent-details/AgentSessionMetricsStrip.tsx
+++ b/packages/trueforge-ui/src/atoms/agent-details/AgentSessionMetricsStrip.tsx
@@ -55,7 +55,7 @@ export function AgentSessionMetricsStrip({ metrics }: AgentSessionMetricsStripPr
metrics.totalCostUsd == null ? '@min-[48rem]:grid-cols-7' : '@min-[48rem]:grid-cols-8',
)}
>
- <SessionMetricTile id="turns" label="Turns" value={metrics.totalTurns} />
+ <SessionMetricTile id="turns" label={metrics.totalTurns > 1 ? 'Turns' : 'Turn'} value={metrics.totalTurns} />
<SessionMetricTile
id="wall-time"
label="Duration"
diff --git a/packages/trueforge-ui/src/containers/SettingsBuilder/ConfigureWebSearchForm.tsx b/packages/trueforge-ui/src/containers/SettingsBuilder/ConfigureWebSearchForm.tsx
new file mode 100644
index 000000000..f11834cab
--- /dev/null
+++ b/packages/trueforge-ui/src/containers/SettingsBuilder/ConfigureWebSearchForm.tsx
@@ -0,0 +1,119 @@
+'use client';
+
+import { useEffect, useState, type FormEvent } from 'react';
+
+import { auiInputClass } from '../../atoms/lib/inputClasses.js';
+import { Button } from '../../atoms/primitives/Button.js';
+import { CenteredModal } from '../../atoms/primitives/CenteredModal.js';
+import { Icon } from '../../icons/Icon.js';
+
+export type WebSearchConfigDraft = {
+ apiKey: string;
+};
+
+type ConfigureWebSearchFormProps = {
+ open: boolean;
+ onOpenChange: (open: boolean) => void;
+ onSave: (draft: WebSearchConfigDraft) => void | Promise<void>;
+ title: string;
+ description?: string;
+ /** When false (updates), empty apiKey means keep the existing key. */
+ requireApiKey?: boolean;
+ busy?: boolean;
+ error?: string | null;
+};
+
+const inputClassName = auiInputClass('h-11 shadow-sm');
+
+const ConfigureWebSearchForm = ({
+ open,
+ onOpenChange,
+ onSave,
+ title,
+ description,
+ requireApiKey = true,
+ busy = false,
+ error,
+}: ConfigureWebSearchFormProps) => {
+ const [apiKey, setApiKey] = useState('');
+
+ const resetForm = () => {
+ setApiKey('');
+ };
+
+ useEffect(() => {
+ if (!open) return;
+ setApiKey('');
+ }, [open]);
+
+ const handleOpenChange = (nextOpen: boolean) => {
+ if (!nextOpen) resetForm();
+ onOpenChange(nextOpen);
+ };
+
+ const trimmedKey = apiKey.trim();
+ const isValid = !requireApiKey || !!trimmedKey;
+
+ const handleSubmit = async (event: FormEvent<HTMLFormElement>) => {
+ event.preventDefault();
+ if (!isValid || busy) return;
+
+ try {
+ await onSave({ apiKey: trimmedKey });
+ resetForm();
+ onOpenChange(false);
+ } catch {
+ // Parent surfaces error; keep form open.
+ }
+ };
+
+ return (
+ <CenteredModal
+ open={open}
+ onOpenChange={handleOpenChange}
+ title={title}
+ description={description}
+ contentSized
+ headerIcon={
+ <span
+ className="flex size-11 shrink-0 items-center justify-center rounded-lg border border-border bg-secondary-bg text-text-primary"
+ aria-hidden
+ >
+ <Icon name="search" className="size-6" />
+ </span>
+ }
+ >
+ <form className="flex flex-col overflow-y-auto p-5 md:p-6" onSubmit={handleSubmit}>
+ <div className="space-y-4">
+ <div>
+ <label htmlFor="web-search-api-key" className="mb-1.5 block text-sm font-medium text-text-primary">
+ API key
+ {!requireApiKey ? <span className="font-normal text-text-secondary"> (optional)</span> : null}
+ </label>
+ <input
+ id="web-search-api-key"
+ type="password"
+ required={requireApiKey}
+ value={apiKey}
+ onChange={event => {
+ setApiKey(event.target.value);
+ }}
+ placeholder={requireApiKey ? 'Parallel API key' : 'Leave blank to keep existing'}
+ autoFocus
+ className={inputClassName}
+ />
+ </div>
+ </div>
+
+ <div className="mt-6 space-y-3">
+ {error ? <p className="text-failure-bg text-sm">{error}</p> : null}
+ <Button.Primary type="submit" size="large" disabled={!isValid || busy} className="w-full shrink-0">
+ Save
+ </Button.Primary>
+ </div>
+ </form>
+ </CenteredModal>
+ );
+};
+
+export default ConfigureWebSearchForm;
diff --git a/packages/trueforge-ui/src/containers/SettingsBuilder/WebSearchSettings.tsx b/packages/trueforge-ui/src/containers/SettingsBuilder/WebSearchSettings.tsx
new file mode 100644
index 000000000..f96d986f0
--- /dev/null
+++ b/packages/trueforge-ui/src/containers/SettingsBuilder/WebSearchSettings.tsx
@@ -0,0 +1,260 @@
+'use client';
+
+import { useCallback, useEffect, useMemo, useState } from 'react';
+
+import { Button } from '../../atoms/primitives/Button.js';
+import { Icon } from '../../icons/Icon.js';
+import { useCatalogServer } from '../../server/ServerContext.js';
+import type { WebSearchProviderBase, WebSearchProviderCatalogEntry } from '../../server/types.js';
+import { getErrorMessage } from '../../utils/getErrorMessage.js';
+import { useToasterOptional } from '../ToasterContainer.js';
+import ConfigureWebSearchForm, { type WebSearchConfigDraft } from './ConfigureWebSearchForm.js';
+
+const WebSearchSettings = () => {
+ const { webSearchCatalog } = useCatalogServer();
+ const toaster = useToasterOptional();
+
+ const [providers, setProviders] = useState<WebSearchProviderBase[]>([]);
+ const [catalog, setCatalog] = useState<WebSearchProviderCatalogEntry[]>([]);
+ const [loading, setLoading] = useState(true);
+ const [error, setError] = useState<string | null>(null);
+ const [formError, setFormError] = useState<string | null>(null);
+ const [busy, setBusy] = useState(false);
+
+ const [createEntry, setCreateEntry] = useState<WebSearchProviderCatalogEntry | null>(null);
+ const [updateProvider, setUpdateProvider] = useState<WebSearchProviderBase | null>(null);
+
+ const refresh = useCallback(
+ async ({ quiet = false }: { quiet?: boolean } = {}) => {
+ if (!webSearchCatalog) return;
+ if (!quiet) setLoading(true);
+ setError(null);
+ try {
+ const [listed, available] = await Promise.all([
+ webSearchCatalog.listWebSearchProviders(),
+ webSearchCatalog.getWebSearchProviderCatalog(),
+ ]);
+ setProviders(listed);
+ setCatalog(available);
+ } catch (err) {
+ setError(getErrorMessage(err, 'Failed to load web search providers'));
+ } finally {
+ if (!quiet) setLoading(false);
+ }
+ },
+ [webSearchCatalog],
+ );
+
+ useEffect(() => {
+ void refresh();
+ }, [refresh]);
+
+ // Tenant/UI-wide: only one web-search provider may be configured at a time.
+ const hasConfiguredProvider = providers.length > 0;
+ const availableEntries = useMemo(() => {
+ if (hasConfiguredProvider) return [];
+ const connectedCatalogIds = new Set(providers.map(provider => provider.catalogId));
+ return catalog.filter(entry => !connectedCatalogIds.has(entry.id));
+ }, [catalog, providers, hasConfiguredProvider]);
+
+ if (!webSearchCatalog) {
+ return <p className="text-sm text-text-secondary">Web search provider catalog is not available.</p>;
+ }
+
+ const runMutation = async (fn: () => Promise<void>, setMutationError = setError) => {
+ setBusy(true);
+ setError(null);
+ try {
+ await fn();
+ await refresh({ quiet: true });
+ } catch (err) {
+ setMutationError(getErrorMessage(err, 'Request failed'));
+ throw err;
+ } finally {
+ setBusy(false);
+ }
+ };
+
+ const handleCreate = async (draft: WebSearchConfigDraft) => {
+ if (!createEntry) return;
+ setFormError(null);
+ await runMutation(async () => {
+ await webSearchCatalog.createWebSearchProvider({
+ catalogId: createEntry.id,
+ name: createEntry.name,
+ type: createEntry.type,
+ apiKey: draft.apiKey,
+ });
+ }, setFormError);
+ setCreateEntry(null);
+ setTimeout(() => {
+ toaster?.showSuccess({ title: `${createEntry.name} configured` });
+ }, 0);
+ };
+
+ const handleUpdate = async (draft: WebSearchConfigDraft) => {
+ if (!updateProvider) return;
+ setFormError(null);
+ await runMutation(async () => {
+ await webSearchCatalog.updateWebSearchProvider({
+ id: updateProvider.id,
+ ...(draft.apiKey ? { apiKey: draft.apiKey } : {}),
+ });
+ }, setFormError);
+ setUpdateProvider(null);
+ setTimeout(() => {
+ toaster?.showSuccess({ title: `${updateProvider.name} updated` });
+ }, 0);
+ };
+
+ const formOpen = createEntry != null || updateProvider != null;
+ const isUpdate = updateProvider != null;
+ const formTitle = updateProvider
+ ? `Update ${updateProvider.name}`
+ : createEntry
+ ? `Configure ${createEntry.name}`
+ : 'Configure web search provider';
+
+ return (
+ <>
+ <h3 className="text-xl font-semibold tracking-tight text-text-primary">Web search</h3>
+ <p className="mt-1 text-sm text-text-secondary">
+ Configure a provider so agents can search the web. Only one can be active at a time.
+ </p>
+
+ {error ? (
+ <p className="mt-3 rounded-md border border-failure-bg/30 bg-failure-bg/10 px-3 py-2 text-sm text-failure-bg">
+ {error}
+ </p>
+ ) : null}
+
+ <div className="mt-4 flex-1 overflow-y-auto">
+ {loading ? (
+ <p className="text-sm text-text-secondary">Loading web search providers…</p>
+ ) : (
+ <div className="space-y-6">
+ {providers.length > 0 ? (
+ <section>
+ <h4 className="mb-2 text-xs font-semibold uppercase tracking-wide text-text-secondary">
+ Configured Β· {providers.length}
+ </h4>
+ <div className="overflow-hidden rounded-xl border border-border bg-card-bg">
+ {providers.map(provider => (
+ <article
+ key={provider.id}
+ className="flex flex-col gap-3 border-b border-border p-3 last:border-b-0 sm:flex-row sm:items-center"
+ >
+ <div className="flex min-w-0 flex-1 items-center gap-3">
+ <span
+ className="flex size-9 shrink-0 items-center justify-center rounded-lg border border-border bg-secondary-bg text-text-primary"
+ aria-hidden
+ >
+ <Icon name="search" className="size-4.5" />
+ </span>
+ <div className="min-w-0">
+ <h5 className="truncate text-sm font-medium text-text-primary">{provider.name}</h5>
+ <p className="truncate text-xs text-text-secondary">Parallel web search</p>
+ </div>
+ </div>
+
+ <div className="flex flex-wrap items-center gap-2.5 sm:justify-end">
+ <span className="inline-flex items-center gap-1.5 text-sm font-medium text-success-bg">
+ <span className="size-2 rounded-full bg-success-bg" aria-hidden />
+ Connected
+ </span>
+ <Button.Secondary
+ size="small"
+ type="button"
+ disabled={busy}
+ onClick={() => {
+ setFormError(null);
+ setCreateEntry(null);
+ setUpdateProvider(provider);
+ }}
+ >
+ Update
+ </Button.Secondary>
+ </div>
+ </article>
+ ))}
+ </div>
+ </section>
+ ) : null}
+
+ {!hasConfiguredProvider ? (
+ <section>
+ <h4 className="mb-2 text-xs font-semibold uppercase tracking-wide text-text-secondary">
+ Available Β· {availableEntries.length}
+ </h4>
+ {availableEntries.length === 0 ? (
+ <p className="text-sm text-text-secondary">
+ {catalog.length > 0
+ ? 'All catalog providers are configured.'
+ : 'No web search providers in the catalog.'}
+ </p>
+ ) : (
+ <div className="overflow-hidden rounded-xl border border-border bg-card-bg">
+ {availableEntries.map(entry => (
+ <article
+ key={entry.id}
+ className="flex flex-col gap-3 border-b border-border p-3 last:border-b-0 sm:flex-row sm:items-center"
+ >
+ <div className="flex min-w-0 flex-1 items-center gap-3">
+ <span
+ className="flex size-9 shrink-0 items-center justify-center rounded-lg border border-border bg-secondary-bg text-text-primary"
+ aria-hidden
+ >
+ <Icon name="search" className="size-4.5" />
+ </span>
+ <div className="min-w-0">
+ <h5 className="truncate text-sm font-medium text-text-primary">{entry.name}</h5>
+ <p className="truncate text-xs text-text-secondary">Parallel web search</p>
+ </div>
+ </div>
+
+ <Button.Secondary
+ type="button"
+ disabled={busy}
+ onClick={() => {
+ setFormError(null);
+ setUpdateProvider(null);
+ setCreateEntry(entry);
+ }}
+ >
+ Configure
+ </Button.Secondary>
+ </article>
+ ))}
+ </div>
+ )}
+ </section>
+ ) : null}
+ </div>
+ )}
+ </div>
+
+ <ConfigureWebSearchForm
+ open={formOpen}
+ onOpenChange={open => {
+ if (!open) {
+ setFormError(null);
+ setCreateEntry(null);
+ setUpdateProvider(null);
+ }
+ }}
+ onSave={isUpdate ? handleUpdate : handleCreate}
+ title={formTitle}
+ description={
+ isUpdate
+ ? 'Update this web search provider. Leave API key blank to keep the existing key.'
+ : 'Configure this web search provider. API key is never stored in the catalog.'
+ }
+ requireApiKey={!isUpdate}
+ busy={busy}
+ error={formError}
+ />
+ </>
+ );
+};
+
+export default WebSearchSettings;
diff --git a/packages/trueforge-ui/src/containers/SettingsBuilder/index.tsx b/packages/trueforge-ui/src/containers/SettingsBuilder/index.tsx
index 4f1736a1f..cdb23c64f 100644
--- a/packages/trueforge-ui/src/containers/SettingsBuilder/index.tsx
+++ b/packages/trueforge-ui/src/containers/SettingsBuilder/index.tsx
@@ -17,6 +17,7 @@ const ModelSettings = lazy(() => import('./ModelSettings.js'));
const ConnectorSettings = lazy(() => import('./ConnectorSettings.js'));
const SkillSettings = lazy(() => import('./SkillSettings.js'));
const SandboxSettings = lazy(() => import('./SandboxSettings.js'));
+const WebSearchSettings = lazy(() => import('./WebSearchSettings.js'));
function SettingsSectionFallback() {
return (
@@ -36,6 +37,7 @@ const TruefoundrySettingsBuilder = () => {
const compact = useCompactLayout();
const hasSkills = catalog?.skillCatalog != null;
const hasSandbox = catalog?.sandboxCatalog != null;
+ const hasWebSearch = catalog?.webSearchCatalog != null;
const closeSettings = useCallback(() => {
setSettingsOpen(false);
@@ -57,7 +59,10 @@ const TruefoundrySettingsBuilder = () => {
if (!hasSandbox && section === 'sandbox') {
setSettingsOpen(settingsOpen, 'models');
}
- }, [hasSkills, hasSandbox, section, settingsOpen, setSettingsOpen]);
+ if (!hasWebSearch && section === 'web-search') {
+ setSettingsOpen(settingsOpen, 'models');
+ }
+ }, [hasSkills, hasSandbox, hasWebSearch, section, settingsOpen, setSettingsOpen]);
useEffect(() => {
if (!settingsOpen) return;
@@ -75,13 +80,13 @@ const TruefoundrySettingsBuilder = () => {
Array<{
id: SettingsSection;
label: string;
- icon: 'cpu' | 'plug' | 'lightbulb' | 'cube';
+ icon: 'cpu' | 'plug' | 'lightbulb' | 'cube' | 'search';
}>
>(() => {
const baseSections: Array<{
id: SettingsSection;
label: string;
- icon: 'cpu' | 'plug' | 'lightbulb' | 'cube';
+ icon: 'cpu' | 'plug' | 'lightbulb' | 'cube' | 'search';
}> = [
{ id: 'models', label: 'Models', icon: 'cpu' },
{ id: 'connectors', label: 'Connectors', icon: 'plug' },
@@ -92,8 +97,11 @@ const TruefoundrySettingsBuilder = () => {
if (hasSandbox) {
baseSections.push({ id: 'sandbox', label: 'Sandbox providers', icon: 'cube' });
}
+ if (hasWebSearch) {
+ baseSections.push({ id: 'web-search', label: 'Web search', icon: 'search' });
+ }
return baseSections;
- }, [hasSkills, hasSandbox]);
+ }, [hasSkills, hasSandbox, hasWebSearch]);
if (!settingsOpen || !catalog) return null;
@@ -154,6 +162,7 @@ const TruefoundrySettingsBuilder = () => {
{section === 'connectors' ? <ConnectorSettings /> : null}
{section === 'skills' && hasSkills ? <SkillSettings /> : null}
{section === 'sandbox' && hasSandbox ? <SandboxSettings /> : null}
+ {section === 'web-search' && hasWebSearch ? <WebSearchSettings /> : null}
</Suspense>
</div>
</section>
diff --git a/packages/trueforge-ui/src/index.ts b/packages/trueforge-ui/src/index.ts
index 651daed6a..ad55ee35d 100644
--- a/packages/trueforge-ui/src/index.ts
+++ b/packages/trueforge-ui/src/index.ts
@@ -371,6 +371,7 @@ export type {
CreateSessionRequest,
CreateSkillRequest,
CreateSkillRequestBase,
+ CreateWebSearchProviderRequest,
CreatedBySubject,
DefinedSkill,
GithubSkill,
@@ -430,10 +431,14 @@ export type {
UpdateModelProviderRequest,
UpdateSandboxProviderRequest,
UpdateSessionRequest,
+ UpdateWebSearchProviderRequest,
UserMessage,
UserMessageContent,
UserToolApprovalEvent,
UserToolResponseEvent,
+ WebSearchCatalogServer,
+ WebSearchProviderBase,
+ WebSearchProviderCatalogEntry,
} from './server/types.js';
export { AgentCodeBlock } from './atoms/agent-details/AgentCodeBlock.js';
diff --git a/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/catalogs/webSearchProviderCatalog.ts b/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/catalogs/webSearchProviderCatalog.ts
new file mode 100644
index 000000000..7eff34801
--- /dev/null
+++ b/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/catalogs/webSearchProviderCatalog.ts
@@ -0,0 +1,124 @@
+/**
+ * Maps trueforge-ui web-search-settings calls onto Harness
+ * `/api/v1/settings/web-search-providers` (singleton upsert, no delete).
+ *
+ * UI: multi-row providers with `id` / `catalogId` / `name` / flat `apiKey`.
+ * Harness: one Parallel provider per tenant; catalog YAML has no name β€” synthetic
+ * identity uses `type` (`parallel`) as id/catalogId and display name `Parallel`.
+ */
+import type { TrueForge } from '@truefoundry/trueforge-sdk';
+import { TrueForgeApi } from '@truefoundry/trueforge-sdk';
+import type {
+ WebSearchCatalogServer,
+ WebSearchProviderBase,
+ WebSearchProviderCatalogEntry,
+} from '../../../server/types.js';
+
+export type UiWebSearchProvider = WebSearchProviderBase;
+export type UiWebSearchProviderCatalogEntry = WebSearchProviderCatalogEntry;
+
+const PARALLEL_TYPE = 'parallel';
+const PARALLEL_DISPLAY_NAME = 'Parallel';
+
+function displayNameForType(type: string): string {
+ if (type === PARALLEL_TYPE) {
+ return PARALLEL_DISPLAY_NAME;
+ }
+ return type;
+}
+
+export function toUiCatalogEntry(provider: TrueForgeApi.CatalogWebSearchProvider): UiWebSearchProviderCatalogEntry {
+ return {
+ id: provider.type,
+ name: displayNameForType(provider.type),
+ type: provider.type,
+ };
+}
+
+export function toUiWebSearchProvider(provider: TrueForgeApi.WebSearchProviderManifest): UiWebSearchProvider {
+ return {
+ id: provider.type,
+ name: displayNameForType(provider.type),
+ catalogId: provider.type,
+ isConnected: true,
+ };
+}
+
+export function filterUiWebSearchProviders({
+ providers,
+ query,
+}: {
+ providers: UiWebSearchProvider[];
+ query?: string;
+}): UiWebSearchProvider[] {
+ const normalizedQuery = query?.trim().toLowerCase();
+ if (normalizedQuery === undefined || normalizedQuery === '') {
+ return providers;
+ }
+ return providers.filter(
+ provider =>
+ provider.name.toLowerCase().includes(normalizedQuery) || provider.id.toLowerCase().includes(normalizedQuery),
+ );
+}
+
+export function toHarnessManifest({
+ type,
+ apiKey,
+}: {
+ type: string;
+ apiKey: string;
+}): TrueForgeApi.WebSearchProviderManifest {
+ if (type !== PARALLEL_TYPE) {
+ throw new Error(`Unsupported web-search provider type: ${type}`);
+ }
+ return {
+ type: PARALLEL_TYPE,
+ auth: { apiKey },
+ };
+}
+
+/** Settings web-search-catalog port for `createTrueForgeServer`. Delete omitted (no BE route). */
+export function createWebSearchProviderCatalog(client: TrueForge): WebSearchCatalogServer {
+ async function resolveApiKey(apiKey: string | undefined): Promise<string> {
+ const trimmed = apiKey?.trim();
+ if (trimmed !== undefined && trimmed !== '') {
+ return trimmed;
+ }
+ const existing = await client.settings.webSearchProviders.get();
+ return existing.data.manifest.auth.apiKey;
+ }
+
+ return {
+ getWebSearchProviderCatalog: async () => {
+ const body = await client.catalogs.webSearchProviders.list();
+ return body.data.map(toUiCatalogEntry);
+ },
+ listWebSearchProviders: async req => {
+ let providers: UiWebSearchProvider[];
+ try {
+ const body = await client.settings.webSearchProviders.get();
+ providers = [toUiWebSearchProvider(body.data.manifest)];
+ } catch (err) {
+ if (err instanceof TrueForgeApi.NotFoundError) {
+ providers = [];
+ } else {
+ throw err;
+ }
+ }
+ return filterUiWebSearchProviders({ providers, query: req?.query });
+ },
+ createWebSearchProvider: async req => {
+ const body = await client.settings.webSearchProviders.createOrUpdate({
+ manifest: toHarnessManifest({ type: req.type, apiKey: req.apiKey }),
+ });
+ return toUiWebSearchProvider(body.data.manifest);
+ },
+ updateWebSearchProvider: async req => {
+ const apiKey = await resolveApiKey(req.apiKey);
+ const body = await client.settings.webSearchProviders.createOrUpdate({
+ manifest: toHarnessManifest({ type: PARALLEL_TYPE, apiKey }),
+ });
+ return toUiWebSearchProvider(body.data.manifest);
+ },
+ };
+}
diff --git a/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/index.ts b/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/index.ts
index d07861aa2..bf0dfc84c 100644
--- a/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/index.ts
+++ b/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/index.ts
@@ -10,6 +10,7 @@ import { createConnectorCatalog } from './catalogs/connectorCatalog.js';
import { createModelProviderCatalog } from './catalogs/modelProviderCatalog.js';
import { createSandboxProviderCatalog } from './catalogs/sandboxProviderCatalog.js';
import { createSkillCatalog } from './catalogs/skillCatalog.js';
+import { createWebSearchProviderCatalog } from './catalogs/webSearchProviderCatalog.js';
import { createHarnessChatServer } from './chatServer.js';
import { createTrueForgeClient, type CreateTrueForgeClientOptions } from './client.js';
import { createHarnessPermissionsServer } from './permissionsServer.js';
@@ -49,6 +50,13 @@ export {
toUiSandboxProviderListEntry,
} from './catalogs/sandboxProviderCatalog.js';
export { createSkillCatalog, toHarnessManifest as toHarnessSkillManifest, toUiSkill } from './catalogs/skillCatalog.js';
+export {
+ createWebSearchProviderCatalog,
+ filterUiWebSearchProviders,
+ toHarnessManifest as toHarnessWebSearchManifest,
+ toUiCatalogEntry as toUiWebSearchCatalogEntry,
+ toUiWebSearchProvider,
+} from './catalogs/webSearchProviderCatalog.js';
export {
createHarnessChatServer,
toHarnessAgentSpec,
@@ -82,6 +90,7 @@ export function createTrueForgeAgentUIServer(options: CreateTrueForgeAgentUIServ
connectorCatalog: createConnectorCatalog(client),
skillCatalog: createSkillCatalog(client),
sandboxCatalog: createSandboxProviderCatalog(client),
+ webSearchCatalog: createWebSearchProviderCatalog(client),
} satisfies CatalogServer);
return createTrueForgeServer<HarnessAgentSpec>({
diff --git a/packages/trueforge-ui/src/server/ShellModeContext.tsx b/packages/trueforge-ui/src/server/ShellModeContext.tsx
index ad5c41b2c..95ce0a133 100644
--- a/packages/trueforge-ui/src/server/ShellModeContext.tsx
+++ b/packages/trueforge-ui/src/server/ShellModeContext.tsx
@@ -71,7 +71,7 @@ export type SelectLibraryAgentRequest = {
agentSpec?: AgentSpec;
};
-export type SettingsSection = 'models' | 'connectors' | 'skills' | 'sandbox';
+export type SettingsSection = 'models' | 'connectors' | 'skills' | 'sandbox' | 'web-search';
export type HistoryAgentFilter = {
agentId?: string;
diff --git a/packages/trueforge-ui/src/server/types.ts b/packages/trueforge-ui/src/server/types.ts
index f7c7dc6ea..28fa1e38a 100644
--- a/packages/trueforge-ui/src/server/types.ts
+++ b/packages/trueforge-ui/src/server/types.ts
@@ -59,6 +59,7 @@ export type {
CreateSessionRequest,
CreateSkillRequest,
CreateSkillRequestBase,
+ CreateWebSearchProviderRequest,
CreatedBySubject,
DefinedSkill,
GithubSkill,
@@ -126,8 +127,14 @@ export type {
UpdateSandboxProviderRequest,
UpdateScheduleRequest,
UpdateSessionRequest,
+ UpdateWebSearchProviderRequest,
UserMessage,
UserMessageContent,
UserToolApprovalEvent,
UserToolResponseEvent,
+ WebSearchBase,
+ WebSearchCatalogEntry,
+ WebSearchCatalogServer,
+ WebSearchProviderBase,
+ WebSearchProviderCatalogEntry,
} from '@truefoundry/trueforge-assistant-ui-runtime/server';
diff --git a/packages/trueforge-ui/test/containers/AgentSessionTimelineContainer.test.tsx b/packages/trueforge-ui/test/containers/AgentSessionTimelineContainer.test.tsx
index ef0fc0470..059e8b29f 100644
--- a/packages/trueforge-ui/test/containers/AgentSessionTimelineContainer.test.tsx
+++ b/packages/trueforge-ui/test/containers/AgentSessionTimelineContainer.test.tsx
@@ -176,7 +176,7 @@ describe('AgentSessionTimelineContainer', () => {
expect(await screen.findByText('timeline turns=1')).toBeInTheDocument();
expect(await screen.findByText('Turn 1')).toBeInTheDocument();
- expect(screen.getByText('Turns')).toBeInTheDocument();
+ expect(screen.getByText('Turn')).toBeInTheDocument();
expect(screen.getByText('Duration')).toBeInTheDocument();
expect(await screen.findAllByRole('button', { name: 'Copy' })).not.toHaveLength(0);
fireEvent.click(screen.getByRole('button', { name: 'timeline turns=1' }));
diff --git a/packages/trueforge-ui/test/containers/SettingsBuilder/WebSearchSettings.test.tsx b/packages/trueforge-ui/test/containers/SettingsBuilder/WebSearchSettings.test.tsx
new file mode 100644
index 000000000..6fbb54a5c
--- /dev/null
+++ b/packages/trueforge-ui/test/containers/SettingsBuilder/WebSearchSettings.test.tsx
@@ -0,0 +1,165 @@
+// @vitest-environment jsdom
+import { fireEvent, render, screen, waitFor } from '@testing-library/react';
+import type { ReactNode } from 'react';
+import { beforeAll, describe, expect, it } from 'vitest';
+
+import WebSearchSettings from '@/containers/SettingsBuilder/WebSearchSettings.js';
+import { ServerProvider } from '@/server/ServerContext.js';
+import type {
+ CreateWebSearchProviderRequest,
+ UpdateWebSearchProviderRequest,
+ WebSearchProviderBase,
+ WebSearchProviderCatalogEntry,
+} from '@/server/types.js';
+import { createMockAgentUIServer, createMockCatalog } from '../../server/mockServer.js';
+
+beforeAll(() => {
+ HTMLDialogElement.prototype.showModal = function showModal() {
+ this.setAttribute('open', '');
+ };
+ HTMLDialogElement.prototype.close = function close() {
+ this.removeAttribute('open');
+ };
+});
+
+const catalogEntry: WebSearchProviderCatalogEntry = {
+ id: 'parallel',
+ name: 'Parallel',
+ type: 'parallel',
+};
+
+function createFakeHost(initial: WebSearchProviderBase[] = []) {
+ let providers = [...initial];
+ const created: CreateWebSearchProviderRequest[] = [];
+ const updated: UpdateWebSearchProviderRequest[] = [];
+
+ const webSearchCatalog = {
+ getWebSearchProviderCatalog: async () => [catalogEntry],
+ listWebSearchProviders: async () => providers,
+ createWebSearchProvider: async (req: CreateWebSearchProviderRequest) => {
+ created.push(req);
+ const provider: WebSearchProviderBase = {
+ id: req.catalogId,
+ name: req.name,
+ catalogId: req.catalogId,
+ isConnected: true,
+ };
+ providers = [...providers, provider];
+ return provider;
+ },
+ updateWebSearchProvider: async (req: UpdateWebSearchProviderRequest) => {
+ updated.push(req);
+ const next = providers.find(provider => provider.id === req.id);
+ if (next === undefined) {
+ throw new Error(`Web search provider "${req.id}" not found`);
+ }
+ return next;
+ },
+ };
+
+ const server = createMockAgentUIServer({
+ catalog: createMockCatalog({ webSearchCatalog }),
+ });
+
+ return {
+ created,
+ updated,
+ wrapper: ({ children }: { children: ReactNode }) => <ServerProvider server={server}>{children}</ServerProvider>,
+ };
+}
+
+describe('WebSearchSettings', () => {
+ it('requires apiKey on create', async () => {
+ const host = createFakeHost();
+ const { wrapper: Wrapper } = host;
+ render(
+ <Wrapper>
+ <WebSearchSettings />
+ </Wrapper>,
+ );
+
+ await waitFor(() => {
+ expect(screen.getByText('Parallel')).toBeTruthy();
+ });
+
+ fireEvent.click(screen.getByRole('button', { name: 'Configure' }));
+
+ await waitFor(() => {
+ expect(screen.getByLabelText('API key')).toBeTruthy();
+ });
+ expect(screen.getByLabelText('API key')).toHaveProperty('value', '');
+
+ fireEvent.change(screen.getByLabelText('API key'), {
+ target: { value: 'par_secret' },
+ });
+ fireEvent.click(screen.getByRole('button', { name: 'Save' }));
+
+ await waitFor(() => {
+ expect(host.created).toHaveLength(1);
+ });
+ expect(host.created[0]).toMatchObject({
+ catalogId: 'parallel',
+ name: 'Parallel',
+ type: 'parallel',
+ apiKey: 'par_secret',
+ });
+ });
+
+ it('allows update without re-entering apiKey', async () => {
+ const existing: WebSearchProviderBase = {
+ id: 'parallel',
+ name: 'Parallel',
+ catalogId: 'parallel',
+ isConnected: true,
+ };
+ const host = createFakeHost([existing]);
+ const { wrapper: Wrapper } = host;
+ render(
+ <Wrapper>
+ <WebSearchSettings />
+ </Wrapper>,
+ );
+
+ await waitFor(() => {
+ expect(screen.getByRole('button', { name: 'Update' })).toBeTruthy();
+ });
+
+ fireEvent.click(screen.getByRole('button', { name: 'Update' }));
+
+ await waitFor(() => {
+ expect(screen.getByLabelText(/API key/)).toHaveProperty('value', '');
+ });
+
+ fireEvent.click(screen.getByRole('button', { name: 'Save' }));
+
+ await waitFor(() => {
+ expect(host.updated).toHaveLength(1);
+ });
+ expect(host.updated[0]).toEqual({
+ id: 'parallel',
+ });
+ expect(host.updated[0]).not.toHaveProperty('apiKey');
+ });
+
+ it('hides other catalog providers once one is configured', async () => {
+ const existing: WebSearchProviderBase = {
+ id: 'parallel',
+ name: 'Parallel',
+ catalogId: 'parallel',
+ isConnected: true,
+ };
+ const host = createFakeHost([existing]);
+ const { wrapper: Wrapper } = host;
+ render(
+ <Wrapper>
+ <WebSearchSettings />
+ </Wrapper>,
+ );
+
+ await waitFor(() => {
+ expect(screen.getByText('Web search')).toBeTruthy();
+ });
+ expect(screen.queryByRole('button', { name: 'Configure' })).toBeNull();
+ expect(screen.queryByText(/^Available Β·/)).toBeNull();
+ });
+});
diff --git a/packages/trueforge-ui/test/containers/SettingsBuilder/index.test.tsx b/packages/trueforge-ui/test/containers/SettingsBuilder/index.test.tsx
index 572721636..7474b4a3d 100644
--- a/packages/trueforge-ui/test/containers/SettingsBuilder/index.test.tsx
+++ b/packages/trueforge-ui/test/containers/SettingsBuilder/index.test.tsx
@@ -7,7 +7,12 @@ import { DraftCatalogProvider } from '@/atoms/draft/DraftCatalogProvider.js';
import TruefoundrySettingsBuilder from '@/containers/SettingsBuilder/index.js';
import { ServerProvider } from '@/server/ServerContext.js';
import { ShellModeProvider, useShellMode } from '@/server/ShellModeContext.js';
-import type { AgentUIServer, SandboxCatalogServer, SkillCatalogServer } from '@/server/types.js';
+import type {
+ AgentUIServer,
+ SandboxCatalogServer,
+ SkillCatalogServer,
+ WebSearchCatalogServer,
+} from '@/server/types.js';
import { createMockAgentUIServer, createMockCatalog } from '../../server/mockServer.js';
vi.mock('@/containers/SettingsBuilder/ModelSettings.js', () => ({
@@ -26,6 +31,10 @@ vi.mock('@/containers/SettingsBuilder/SandboxSettings.js', () => ({
default: () => <div>Sandbox settings content</div>,
}));
+vi.mock('@/containers/SettingsBuilder/WebSearchSettings.js', () => ({
+ default: () => <div>Web search settings content</div>,
+}));
+
async function unavailable(): Promise<never> {
throw new Error('Unexpected settings section call');
}
@@ -43,7 +52,16 @@ const sandboxCatalog: SandboxCatalogServer = {
updateSandboxProvider: unavailable,
};
-function createServer(options: { catalog?: boolean; skills?: boolean; sandbox?: boolean } = {}): AgentUIServer {
+const webSearchCatalog: WebSearchCatalogServer = {
+ getWebSearchProviderCatalog: async () => [],
+ listWebSearchProviders: async () => [],
+ createWebSearchProvider: unavailable,
+ updateWebSearchProvider: unavailable,
+};
+
+function createServer(
+ options: { catalog?: boolean; skills?: boolean; sandbox?: boolean; webSearch?: boolean } = {},
+): AgentUIServer {
if (options.catalog === false) {
return createMockAgentUIServer();
}
@@ -51,6 +69,7 @@ function createServer(options: { catalog?: boolean; skills?: boolean; sandbox?:
catalog: createMockCatalog({
...(options.skills ? { skillCatalog } : {}),
...(options.sandbox ? { sandboxCatalog } : {}),
+ ...(options.webSearch ? { webSearchCatalog } : {}),
}),
});
}
@@ -113,11 +132,12 @@ describe('TruefoundrySettingsBuilder', () => {
expect(screen.getByRole('button', { name: 'Connectors' })).toBeInTheDocument();
expect(screen.queryByRole('button', { name: 'Skills' })).not.toBeInTheDocument();
expect(screen.queryByRole('button', { name: 'Sandbox' })).not.toBeInTheDocument();
+ expect(screen.queryByRole('button', { name: 'Web search' })).not.toBeInTheDocument();
await waitFor(() => {
expect(screen.getByText('Model settings content')).toBeInTheDocument();
});
- rerender(<TestShell server={createServer({ skills: true, sandbox: true })} />);
+ rerender(<TestShell server={createServer({ skills: true, sandbox: true, webSearch: true })} />);
fireEvent.click(await screen.findByRole('button', { name: 'Skills' }));
await waitFor(() => {
@@ -129,6 +149,11 @@ describe('TruefoundrySettingsBuilder', () => {
expect(screen.getByText('Sandbox settings content')).toBeInTheDocument();
});
+ fireEvent.click(screen.getByRole('button', { name: 'Web search' }));
+ await waitFor(() => {
+ expect(screen.getByText('Web search settings content')).toBeInTheDocument();
+ });
+
fireEvent.click(screen.getByRole('button', { name: 'Connectors' }));
await waitFor(() => {
expect(screen.getByText('Connector settings content')).toBeInTheDocument();
diff --git a/packages/trueforge-ui/test/plugins/trueforge-agent-server-adapter/catalogs/webSearchProviderCatalog.test.ts b/packages/trueforge-ui/test/plugins/trueforge-agent-server-adapter/catalogs/webSearchProviderCatalog.test.ts
new file mode 100644
index 000000000..47341e6b8
--- /dev/null
+++ b/packages/trueforge-ui/test/plugins/trueforge-agent-server-adapter/catalogs/webSearchProviderCatalog.test.ts
@@ -0,0 +1,54 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'vitest';
+
+import {
+ filterUiWebSearchProviders,
+ toHarnessManifest,
+ toUiCatalogEntry,
+ toUiWebSearchProvider,
+} from '@/plugins/trueforge-agent-server-adapter/catalogs/webSearchProviderCatalog.js';
+
+describe('webSearchProviderCatalog mappers', () => {
+ const harnessCatalog = {
+ type: 'parallel' as const,
+ };
+
+ const harnessConfigured = {
+ ...harnessCatalog,
+ auth: { apiKey: 'par_secret' },
+ };
+
+ it('stamps catalog identity from type and strips auth', () => {
+ assert.deepEqual(toUiCatalogEntry(harnessCatalog), {
+ id: 'parallel',
+ name: 'Parallel',
+ type: 'parallel',
+ });
+ });
+
+ it('maps configured provider without embedding apiKey', () => {
+ assert.deepEqual(toUiWebSearchProvider(harnessConfigured), {
+ id: 'parallel',
+ name: 'Parallel',
+ catalogId: 'parallel',
+ isConnected: true,
+ });
+ assert.equal('auth' in toUiWebSearchProvider(harnessConfigured), false);
+ assert.equal('apiKey' in toUiWebSearchProvider(harnessConfigured), false);
+ });
+
+ it('filters providers by provider identity', () => {
+ const provider = toUiWebSearchProvider(harnessConfigured);
+
+ assert.deepEqual(filterUiWebSearchProviders({ providers: [provider], query: ' PAR ' }), [provider]);
+ assert.deepEqual(filterUiWebSearchProviders({ providers: [provider], query: 'missing' }), []);
+ });
+
+ it('round-trips apiKey into harness upsert body', () => {
+ assert.deepEqual(toHarnessManifest({ type: 'parallel', apiKey: 'par_secret' }), harnessConfigured);
+ });
+
+ it('rejects unsupported web-search provider types', () => {
+ assert.throws(() => toHarnessManifest({ type: 'other', apiKey: 'x' }), /Unsupported web-search provider type/);
+ });
+});
diff --git a/packages/trueforge/.env.example b/packages/trueforge/.env.example
index ce176669a..daf3e77e6 100644
--- a/packages/trueforge/.env.example
+++ b/packages/trueforge/.env.example
@@ -35,6 +35,9 @@ PORT=8790
## When unset, the catalog inlined at build time (catalog/sandbox-catalog.yaml) is used.
# SANDBOX_CATALOG_PATH=/path/to/sandbox-catalog.yaml
+## Optional override for the shipped web-search catalog (discovery presets).
+# WEB_SEARCH_CATALOG_PATH=/path/to/web-search-catalog.yaml
+
## Frontend build the server serves alongside the API. Optional; defaults to
## packages/trueforge/dist/_frontend (after build) or monorepo packages/frontend/dist.
## With no build there the server logs a warning and serves the API only.
diff --git a/packages/trueforge/catalog/web-search-catalog.yaml b/packages/trueforge/catalog/web-search-catalog.yaml
new file mode 100644
index 000000000..a6d34646b
--- /dev/null
+++ b/packages/trueforge/catalog/web-search-catalog.yaml
@@ -0,0 +1,2 @@
+providers:
+ - type: parallel
diff --git a/packages/trueforge/scripts/generate-catalog.mjs b/packages/trueforge/scripts/generate-catalog.mjs
index cba9c04dc..f9d550c0c 100644
--- a/packages/trueforge/scripts/generate-catalog.mjs
+++ b/packages/trueforge/scripts/generate-catalog.mjs
@@ -1,6 +1,6 @@
/**
* Inlines catalog/*.yaml into generated TS modules so ModelCatalog / McpCatalog /
- * SkillCatalog / SandboxCatalog can load shipped catalogs with no loose YAML
+ * SkillCatalog / SandboxCatalog / WebSearchCatalog can load shipped catalogs with no loose YAML
* beside the bundle. Plain generated `.ts` files work unchanged across tsup and tsx.
*
* Runs via the `build:gen` script before build/typecheck/test/dev. Generated
@@ -24,3 +24,4 @@ writeShippedCatalog('model-catalog.yaml', 'shippedModelCatalogYaml', 'modelCatal
writeShippedCatalog('mcp-catalog.yaml', 'shippedMcpCatalogYaml', 'mcpCatalog.gen.ts');
writeShippedCatalog('skill-catalog.yaml', 'shippedSkillCatalogYaml', 'skillCatalog.gen.ts');
writeShippedCatalog('sandbox-catalog.yaml', 'shippedSandboxCatalogYaml', 'sandboxCatalog.gen.ts');
+writeShippedCatalog('web-search-catalog.yaml', 'shippedWebSearchCatalogYaml', 'webSearchCatalog.gen.ts');
diff --git a/packages/trueforge/scripts/write-openapi.ts b/packages/trueforge/scripts/write-openapi.ts
index 69c19657d..078c1c727 100644
--- a/packages/trueforge/scripts/write-openapi.ts
+++ b/packages/trueforge/scripts/write-openapi.ts
@@ -20,6 +20,7 @@ import { McpCatalog } from '../src/catalog/McpCatalog';
import { ModelCatalog } from '../src/catalog/ModelCatalog';
import { SandboxCatalog } from '../src/catalog/SandboxCatalog';
import { SkillCatalog } from '../src/catalog/SkillCatalog';
+import { WebSearchCatalog } from '../src/catalog/WebSearchCatalog';
import configuration from '../src/config';
import { McpServerWithAuthStore } from '../src/db/McpServerWithAuthStore';
import { SqliteAgentStore } from '../src/db/sqlite/agent-store/SqliteAgentStore';
@@ -31,6 +32,7 @@ import { SqliteScheduleStore } from '../src/db/sqlite/schedule-store/SqliteSched
import { SqliteSessionMetricsStore } from '../src/db/sqlite/session-metrics/SqliteSessionMetricsStore';
import { SqliteSkillStore } from '../src/db/sqlite/skill-store/SqliteSkillStore';
import { SqliteOAuthTokenStore } from '../src/db/sqlite/token-store/SqliteOAuthTokenStore';
+import { SqliteWebSearchProviderStore } from '../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import { ActiveTurnRegistry } from '../src/runtime/activeTurns';
import { EventSubscriptionRegistry } from '../src/runtime/event-subscription';
@@ -64,11 +66,13 @@ const tokenStore = new SqliteOAuthTokenStore(db);
const agentStore = new SqliteAgentStore(db);
const skillStore = new SqliteSkillStore(db);
const sandboxProviderStore = new SqliteSandboxProviderStore(db);
+const webSearchProviderStore = new SqliteWebSearchProviderStore(db);
const app = createServerApp({
modelCatalog: ModelCatalog.load(),
mcpCatalog: McpCatalog.load(),
skillCatalog: SkillCatalog.load(),
sandboxCatalog: SandboxCatalog.load(),
+ webSearchCatalog: WebSearchCatalog.load(),
resolveModelProviderStore: () => new SqliteModelProviderStore(db),
resolveMcpServerStore: () =>
new McpServerWithAuthStore({
@@ -78,6 +82,7 @@ const app = createServerApp({
}),
resolveSkillStore: () => skillStore,
resolveSandboxProviderStore: () => sandboxProviderStore,
+ resolveWebSearchProviderStore: () => webSearchProviderStore,
resolveAgentStore: () => agentStore,
resolveImportAgentStore: () => agentStore,
agentStore,
diff --git a/packages/trueforge/src/apis/agents.ts b/packages/trueforge/src/apis/agents.ts
index fafe32daf..f5d25ae21 100644
--- a/packages/trueforge/src/apis/agents.ts
+++ b/packages/trueforge/src/apis/agents.ts
@@ -18,6 +18,7 @@ import type { IModelProviderStore } from '../db/modelProviderStore';
import type { ISandboxProviderStore } from '../db/sandboxProviderStore';
import type { ISkillStore } from '../db/skillStore';
import type { WithTransaction } from '../db/transaction';
+import type { IWebSearchProviderStore } from '../db/webSearchProviderStore';
import {
createAgentRoute,
deleteAgentRoute,
@@ -38,6 +39,7 @@ export interface AgentsRouterDeps<TTransaction> {
resolveMcpServerStore: (c: Context) => IMcpServerStore<TTransaction>;
resolveSkillStore: ResolveSkillStore<TTransaction>;
resolveSandboxProviderStore: (c: Context) => ISandboxProviderStore<TTransaction>;
+ resolveWebSearchProviderStore: (c: Context) => IWebSearchProviderStore<TTransaction>;
withTransaction: WithTransaction<TTransaction>;
resolveRequestContext: ResolveRequestContext;
authorizer: Authorizer;
@@ -60,6 +62,7 @@ async function validateManifest<TTransaction>({
mcpServerStore,
skillStore,
sandboxProviderStore,
+ webSearchProviderStore,
tenant_id,
}: {
spec: AgentSpec;
@@ -67,6 +70,7 @@ async function validateManifest<TTransaction>({
mcpServerStore: IMcpServerStore<TTransaction>;
skillStore: ISkillStore<TTransaction>;
sandboxProviderStore: ISandboxProviderStore<TTransaction>;
+ webSearchProviderStore: IWebSearchProviderStore<TTransaction>;
tenant_id: string;
}): Promise<AgentSpec> {
await validateAgentSpec({
@@ -76,6 +80,7 @@ async function validateManifest<TTransaction>({
mcpServerStore,
skillStore,
sandboxProviderStore,
+ webSearchProviderStore,
});
return spec;
}
@@ -112,6 +117,7 @@ export function createAgentsRouter<TTransaction>(deps: AgentsRouterDeps<TTransac
mcpServerStore: deps.resolveMcpServerStore(c),
skillStore: deps.resolveSkillStore(c),
sandboxProviderStore: deps.resolveSandboxProviderStore(c),
+ webSearchProviderStore: deps.resolveWebSearchProviderStore(c),
tenant_id: requestContext.tenant_id,
});
try {
@@ -216,6 +222,7 @@ export function createAgentsRouter<TTransaction>(deps: AgentsRouterDeps<TTransac
mcpServerStore: deps.resolveMcpServerStore(c),
skillStore: deps.resolveSkillStore(c),
sandboxProviderStore: deps.resolveSandboxProviderStore(c),
+ webSearchProviderStore: deps.resolveWebSearchProviderStore(c),
tenant_id: requestContext.tenant_id,
});
const record = await deps.resolveAgentStore(c).updateAgent({
diff --git a/packages/trueforge/src/apis/capabilities.ts b/packages/trueforge/src/apis/capabilities.ts
index 6920521e2..fdabd8906 100644
--- a/packages/trueforge/src/apis/capabilities.ts
+++ b/packages/trueforge/src/apis/capabilities.ts
@@ -5,11 +5,12 @@ import type { Logger } from 'winston';
import { hasAdminRole, type ResolveRequestContext } from '../auth/identity';
import type { ISandboxProviderStore } from '../db/sandboxProviderStore';
import type { WithTransaction } from '../db/transaction';
+import type { IWebSearchProviderStore } from '../db/webSearchProviderStore';
import { getCapabilitiesRoute } from '../routes/capabilityRoutes';
import { isLocalSandboxFallbackEnabled } from '../sandbox/localRuntime';
import { checkSnapshotStatus } from '../sandbox/providerUtils';
import type { SandboxBuildStatus } from '../schemas/sandboxProvider';
-import { resolveWebSearchProvider } from '../websearch/providers';
+import { hasConfiguredWebSearchProvider } from '../websearch/providers';
/**
* Why skills are unavailable, keyed off the sandbox build status.
@@ -24,6 +25,7 @@ function skillDisabledReason(status: SandboxBuildStatus | undefined): string {
export function createCapabilitiesRouter<TTransaction>(deps: {
resolveSandboxProviderStore: (c: Context) => ISandboxProviderStore<TTransaction>;
+ resolveWebSearchProviderStore: (c: Context) => IWebSearchProviderStore<TTransaction>;
withTransaction: WithTransaction<TTransaction>;
logger: Logger;
resolveRequestContext: ResolveRequestContext;
@@ -46,7 +48,10 @@ export function createCapabilitiesRouter<TTransaction>(deps: {
}
const sandboxEnabled = status === 'ready' || (status === undefined && isLocalSandboxFallbackEnabled());
const settingsEnabled = hasAdminRole(requestContext);
- const webSearchEnabled = resolveWebSearchProvider() !== undefined;
+ const webSearchEnabled = await hasConfiguredWebSearchProvider({
+ tenant_id: requestContext.tenant_id,
+ store: deps.resolveWebSearchProviderStore(c),
+ });
return c.json(
{
data: {
diff --git a/packages/trueforge/src/apis/catalog.ts b/packages/trueforge/src/apis/catalog.ts
index 3a2bb2c65..212344d57 100644
--- a/packages/trueforge/src/apis/catalog.ts
+++ b/packages/trueforge/src/apis/catalog.ts
@@ -4,11 +4,13 @@ import type { McpCatalog } from '../catalog/McpCatalog';
import type { ModelCatalog } from '../catalog/ModelCatalog';
import type { SandboxCatalog } from '../catalog/SandboxCatalog';
import type { SkillCatalog } from '../catalog/SkillCatalog';
+import type { WebSearchCatalog } from '../catalog/WebSearchCatalog';
import {
listMcpServerCatalogRoute,
listModelProviderCatalogRoute,
listSandboxProviderCatalogRoute,
listSkillCatalogRoute,
+ listWebSearchProviderCatalogRoute,
} from '../routes/catalogRoutes';
import type { CatalogModelProvider } from '../schemas/modelCatalog';
@@ -17,6 +19,7 @@ export interface CatalogRouterDeps {
mcpCatalog: McpCatalog;
skillCatalog: SkillCatalog;
sandboxCatalog: SandboxCatalog;
+ webSearchCatalog: WebSearchCatalog;
}
export function createCatalogRouter(deps: CatalogRouterDeps) {
@@ -43,10 +46,15 @@ export function createCatalogRouter(deps: CatalogRouterDeps) {
return c.json({ data: [...deps.sandboxCatalog.list()] }, 200);
};
+ const listWebSearchProvidersHandler: RouteHandler<typeof listWebSearchProviderCatalogRoute> = c => {
+ return c.json({ data: [...deps.webSearchCatalog.list()] }, 200);
+ };
+
const router = new OpenAPIHono();
router.openapi(listModelProviderCatalogRoute, listModelProvidersHandler);
router.openapi(listMcpServerCatalogRoute, listMcpServersHandler);
router.openapi(listSkillCatalogRoute, listSkillsHandler);
router.openapi(listSandboxProviderCatalogRoute, listSandboxProvidersHandler);
+ router.openapi(listWebSearchProviderCatalogRoute, listWebSearchProvidersHandler);
return router;
}
diff --git a/packages/trueforge/src/apis/schedules.ts b/packages/trueforge/src/apis/schedules.ts
index fa3c53010..75bbf9955 100644
--- a/packages/trueforge/src/apis/schedules.ts
+++ b/packages/trueforge/src/apis/schedules.ts
@@ -39,6 +39,7 @@ import {
} from '../db/scheduleStore';
import type { ISkillStore } from '../db/skillStore';
import type { WithTransaction } from '../db/transaction';
+import type { IWebSearchProviderStore } from '../db/webSearchProviderStore';
import {
createScheduleRoute,
createScheduleRunRoute,
@@ -73,6 +74,7 @@ export interface ScheduleTurnExecutionDeps<TTransaction> {
resolveModelProviderStore: (c: Context, runAsAgent?: AgentRecord) => IModelProviderStore<TTransaction>;
resolveMcpServerStore: (c: Context, runAsAgent?: AgentRecord) => IMcpServerWithAuthStore<TTransaction>;
resolveSandboxProviderStore: (c: Context) => ISandboxProviderStore<TTransaction>;
+ resolveWebSearchProviderStore: (c: Context) => IWebSearchProviderStore<TTransaction>;
/** Persistence agent store (schedule agent binding is not caller-scoped). */
agentStore: IAgentStore<TTransaction>;
turnSkillsResolverStore: Pick<ISkillStore, 'resolveTurnSkills'>;
@@ -116,6 +118,7 @@ export async function startScheduleRunOnRequest<TTransaction>(params: {
modelProviderStore: deps.resolveModelProviderStore(c, prepared.agent),
mcpServerStore: deps.resolveMcpServerStore(c, prepared.agent),
sandboxProviderStore: deps.resolveSandboxProviderStore(c),
+ webSearchProviderStore: deps.resolveWebSearchProviderStore(c),
skillStore: deps.turnSkillsResolverStore,
logger: deps.logger,
},
diff --git a/packages/trueforge/src/apis/sessions.ts b/packages/trueforge/src/apis/sessions.ts
index 37083e58b..d238c48e0 100644
--- a/packages/trueforge/src/apis/sessions.ts
+++ b/packages/trueforge/src/apis/sessions.ts
@@ -28,6 +28,7 @@ import type { IAgentStore } from '../db/agentStore';
import type { IMcpServerStore } from '../db/mcpServerStore';
import type { IModelProviderStore } from '../db/modelProviderStore';
import type { ISandboxProviderStore } from '../db/sandboxProviderStore';
+import type { IWebSearchProviderStore } from '../db/webSearchProviderStore';
import {
cancelSessionRoute,
createSessionRoute,
@@ -80,6 +81,7 @@ export interface SessionsRouterDeps {
resolveSkillStore: ResolveSkillStore;
resolveAgentStore: (c: Context) => IAgentStore;
resolveSandboxProviderStore: (c: Context) => ISandboxProviderStore;
+ resolveWebSearchProviderStore: (c: Context) => IWebSearchProviderStore;
redis?: RedisClientType | undefined;
requestReplyRouter: RequestReplyRouter;
resolveRequestContext: ResolveRequestContext;
@@ -236,6 +238,7 @@ type InternalSessionsRouterDeps = Pick<
| 'resolveSkillStore'
| 'resolveAgentStore'
| 'resolveSandboxProviderStore'
+ | 'resolveWebSearchProviderStore'
| 'resolveRequestContext'
| 'authorizer'
>;
@@ -289,6 +292,7 @@ function createGetOrCreateSessionByExternalIdHandler(
mcpServerStore: deps.resolveMcpServerStore(c),
skillStore: deps.resolveSkillStore(c),
sandboxProviderStore: deps.resolveSandboxProviderStore(c),
+ webSearchProviderStore: deps.resolveWebSearchProviderStore(c),
});
agent = { type: 'inline', spec: body.agent.spec };
}
@@ -361,6 +365,7 @@ export function createSessionsRouter(deps: SessionsRouterDeps) {
mcpServerStore: deps.resolveMcpServerStore(c),
skillStore: deps.resolveSkillStore(c),
sandboxProviderStore: deps.resolveSandboxProviderStore(c),
+ webSearchProviderStore: deps.resolveWebSearchProviderStore(c),
});
const session = await deps.sessions.create({
tenant_id: requestContext.tenant_id,
@@ -452,6 +457,7 @@ export function createSessionsRouter(deps: SessionsRouterDeps) {
mcpServerStore: deps.resolveMcpServerStore(c),
skillStore: deps.resolveSkillStore(c),
sandboxProviderStore: deps.resolveSandboxProviderStore(c),
+ webSearchProviderStore: deps.resolveWebSearchProviderStore(c),
});
}
try {
diff --git a/packages/trueforge/src/apis/settings.ts b/packages/trueforge/src/apis/settings.ts
index 783da8d36..e6e9e4667 100644
--- a/packages/trueforge/src/apis/settings.ts
+++ b/packages/trueforge/src/apis/settings.ts
@@ -11,11 +11,13 @@ import type { IMcpServerWithAuthStore } from '../db/mcpServerStore';
import type { IModelProviderStore } from '../db/modelProviderStore';
import type { ISandboxProviderStore } from '../db/sandboxProviderStore';
import type { WithTransaction } from '../db/transaction';
+import type { IWebSearchProviderStore } from '../db/webSearchProviderStore';
import type { IOAuthTokenStore } from '../mcp/auth/types';
import { createSettingsMcpServersRouter } from './mcpServers';
import { createModelProvidersRouter } from './modelProviders';
import { createSandboxProvidersRouter } from './sandboxProviders';
import { createSkillsRouter, type ResolveSkillStore } from './skills';
+import { createWebSearchProvidersRouter } from './webSearchProviders';
export interface SettingsRouterDeps<TTransaction> {
resolveModelProviderStore: (c: Context) => IModelProviderStore<TTransaction>;
@@ -23,6 +25,7 @@ export interface SettingsRouterDeps<TTransaction> {
tokenStore: IOAuthTokenStore<TTransaction>;
resolveSkillStore: ResolveSkillStore<TTransaction>;
resolveSandboxProviderStore: (c: Context) => ISandboxProviderStore<TTransaction>;
+ resolveWebSearchProviderStore: (c: Context) => IWebSearchProviderStore<TTransaction>;
withTransaction: WithTransaction<TTransaction>;
logger: Logger;
resolveRequestContext: ResolveRequestContext;
@@ -65,5 +68,12 @@ export function createSettingsRouter<TTransaction>(deps: SettingsRouterDeps<TTra
resolveRequestContext: deps.resolveRequestContext,
}),
);
+ router.route(
+ '/web-search-providers',
+ createWebSearchProvidersRouter({
+ resolveWebSearchProviderStore: deps.resolveWebSearchProviderStore,
+ resolveRequestContext: deps.resolveRequestContext,
+ }),
+ );
return router;
}
diff --git a/packages/trueforge/src/apis/turns.ts b/packages/trueforge/src/apis/turns.ts
index e47e67f75..4ffc8994c 100644
--- a/packages/trueforge/src/apis/turns.ts
+++ b/packages/trueforge/src/apis/turns.ts
@@ -39,6 +39,7 @@ import type { IMcpServerWithAuthStore } from '../db/mcpServerStore';
import type { IModelProviderStore } from '../db/modelProviderStore';
import type { ISandboxProviderStore } from '../db/sandboxProviderStore';
import type { ISkillStore } from '../db/skillStore';
+import type { IWebSearchProviderStore } from '../db/webSearchProviderStore';
import {
createAndExecuteTurnRoute,
downloadSandboxFileRoute,
@@ -119,6 +120,7 @@ export interface TurnsRouterDeps {
/** Resumable live turn-event transport: create-turn writes, subscribe polls. */
eventSubscriptions: EventSubscriptionRegistry<TurnStreamingEvent>;
resolveSandboxProviderStore: (c: Context) => ISandboxProviderStore;
+ resolveWebSearchProviderStore: (c: Context) => IWebSearchProviderStore;
logger: Logger;
resolveRequestContext: ResolveRequestContext;
authorizer: Authorizer;
@@ -134,6 +136,7 @@ export type BeginTurnExecutionDeps = Pick<TurnsRouterDeps, 'activeTurns' | 'even
modelProviderStore: IModelProviderStore;
mcpServerStore: IMcpServerWithAuthStore;
sandboxProviderStore: ISandboxProviderStore;
+ webSearchProviderStore: IWebSearchProviderStore;
skillStore: Pick<ISkillStore, 'resolveTurnSkills'>;
};
@@ -406,13 +409,17 @@ export async function beginTurnExecution(
const abortController = new AbortController();
const tenant_id = session.tenant_id;
+ const webSearchProvider = await resolveWebSearchProvider({
+ tenant_id,
+ store: deps.webSearchProviderStore,
+ });
const resolver = createTurnResolver({
mcpServerStore: deps.mcpServerStore,
skillStore: deps.skillStore,
sandboxProviderStore: deps.sandboxProviderStore,
agentStore: deps.agentStore,
modelProviderStore: deps.modelProviderStore,
- webSearchProvider: resolveWebSearchProvider(),
+ webSearchProvider,
logger: deps.logger,
signal: abortController.signal,
userRef,
@@ -790,6 +797,7 @@ export function createTurnsRouter(deps: TurnsRouterDeps) {
skillStore: deps.resolveSkillStore(c),
agentStore: deps.resolveAgentStore(c),
sandboxProviderStore: deps.resolveSandboxProviderStore(c),
+ webSearchProviderStore: deps.resolveWebSearchProviderStore(c),
},
};
diff --git a/packages/trueforge/src/apis/webSearchProviders.ts b/packages/trueforge/src/apis/webSearchProviders.ts
new file mode 100644
index 000000000..5184d4dff
--- /dev/null
+++ b/packages/trueforge/src/apis/webSearchProviders.ts
@@ -0,0 +1,86 @@
+import { OpenAPIHono, type RouteHandler } from '@hono/zod-openapi';
+import type { Context } from 'hono';
+import type { ResolveRequestContext } from '../auth/identity';
+import type { IWebSearchProviderStore, WebSearchProviderRecord } from '../db/webSearchProviderStore';
+import { getWebSearchProviderRoute, putWebSearchProviderRoute } from '../routes/webSearchProviderRoutes';
+import {
+ webSearchProviderName,
+ type ConfiguredWebSearchProvider,
+ type UpdateWebSearchProviderRequest,
+ type WebSearchProviderManifest,
+} from '../schemas/webSearchProvider';
+import { MissingStoredSecretError, resolveStoredSecretValue, toRedactedSecretValue } from '../utils/secretRedaction';
+
+export interface WebSearchProvidersRouterDeps {
+ resolveWebSearchProviderStore: (c: Context) => IWebSearchProviderStore;
+ resolveRequestContext: ResolveRequestContext;
+}
+
+function redactWebSearchProvider(manifest: WebSearchProviderManifest): WebSearchProviderManifest {
+ return {
+ ...manifest,
+ auth: { api_key: toRedactedSecretValue(manifest.auth.api_key) },
+ };
+}
+
+function resolveWebSearchProviderManifestForWrite({
+ incoming,
+ existing,
+}: {
+ incoming: WebSearchProviderManifest;
+ existing: WebSearchProviderManifest | undefined;
+}): WebSearchProviderManifest {
+ return {
+ ...incoming,
+ auth: {
+ api_key: resolveStoredSecretValue({
+ incoming: incoming.auth.api_key,
+ existing: existing?.auth.api_key,
+ }),
+ },
+ };
+}
+
+function toWireProvider(record: WebSearchProviderRecord): ConfiguredWebSearchProvider {
+ return {
+ name: webSearchProviderName(record.manifest),
+ manifest: redactWebSearchProvider(record.manifest),
+ };
+}
+
+export function createWebSearchProvidersRouter(deps: WebSearchProvidersRouterDeps) {
+ const getHandler: RouteHandler<typeof getWebSearchProviderRoute> = async c => {
+ const requestContext = deps.resolveRequestContext(c);
+ const record = await deps.resolveWebSearchProviderStore(c).getProvider(requestContext.tenant_id);
+ if (!record) {
+ return c.json({ error: { message: 'No web search provider configured' } }, 404);
+ }
+ return c.json({ data: toWireProvider(record) }, 200);
+ };
+
+ const putHandler: RouteHandler<typeof putWebSearchProviderRoute> = async c => {
+ const store = deps.resolveWebSearchProviderStore(c);
+ const body: UpdateWebSearchProviderRequest = c.req.valid('json');
+ const requestContext = deps.resolveRequestContext(c);
+ const provider = body.manifest;
+ try {
+ const existing = await store.getProvider(requestContext.tenant_id);
+ const manifest = resolveWebSearchProviderManifestForWrite({
+ incoming: provider,
+ existing: existing?.manifest,
+ });
+ const record = await store.upsertProvider({ tenant_id: requestContext.tenant_id, manifest });
+ return c.json({ data: toWireProvider(record) }, 200);
+ } catch (error) {
+ if (error instanceof MissingStoredSecretError) {
+ return c.json({ error: { message: 'API key is required' } }, 400);
+ }
+ throw error;
+ }
+ };
+
+ const router = new OpenAPIHono();
+ router.openapi(getWebSearchProviderRoute, getHandler);
+ router.openapi(putWebSearchProviderRoute, putHandler);
+ return router;
+}
diff --git a/packages/trueforge/src/app.ts b/packages/trueforge/src/app.ts
index 3efb8b554..cbfecdedb 100644
--- a/packages/trueforge/src/app.ts
+++ b/packages/trueforge/src/app.ts
@@ -38,6 +38,7 @@ import type { McpCatalog } from './catalog/McpCatalog';
import type { ModelCatalog } from './catalog/ModelCatalog';
import type { SandboxCatalog } from './catalog/SandboxCatalog';
import type { SkillCatalog } from './catalog/SkillCatalog';
+import type { WebSearchCatalog } from './catalog/WebSearchCatalog';
import configuration, { getPublicUiBasePath, getTrueForgeAuthMode, TrueForgeAuthMode } from './config';
import type { AgentRecord, IAgentStore } from './db/agentStore';
import type { IMcpServerWithAuthStore } from './db/mcpServerStore';
@@ -47,6 +48,7 @@ import type { IScheduleStore } from './db/scheduleStore';
import type { ISessionMetricsStore } from './db/sessionMetricsStore';
import type { ISkillStore } from './db/skillStore';
import type { WithTransaction } from './db/transaction';
+import type { IWebSearchProviderStore } from './db/webSearchProviderStore';
import { createClientCertificateMiddleware } from './http/tls';
import type { IOAuthTokenStore } from './mcp/auth/types';
import { PACKAGE_VERSION } from './packageVersion';
@@ -177,6 +179,7 @@ export interface ServerDeps<TTransaction> {
mcpCatalog: McpCatalog;
skillCatalog: SkillCatalog;
sandboxCatalog: SandboxCatalog;
+ webSearchCatalog: WebSearchCatalog;
/** Per-request store: DB singleton, or a token-bound TrueFoundry store in TrueFoundry mode. */
resolveModelProviderStore: (c: Context, runAsAgent?: AgentRecord) => IModelProviderStore<TTransaction>;
/**
@@ -193,6 +196,7 @@ export interface ServerDeps<TTransaction> {
* (`TRUEFOUNDRY_SANDBOX_*` + static SETTINGS JSON).
*/
resolveSandboxProviderStore: (c: Context) => ISandboxProviderStore<TTransaction>;
+ resolveWebSearchProviderStore: (c: Context) => IWebSearchProviderStore<TTransaction>;
/** Per-request store: DB git skills, or TrueFoundry registry catalog in TrueFoundry mode. */
resolveSkillStore: ResolveSkillStore<TTransaction>;
withTransaction: WithTransaction<TTransaction>;
@@ -236,6 +240,7 @@ export function createServerApp<TTransaction>(deps: ServerDeps<TTransaction>) {
resolveModelProviderStore: deps.resolveModelProviderStore,
resolveMcpServerStore: deps.resolveMcpServerStore,
resolveSandboxProviderStore: deps.resolveSandboxProviderStore,
+ resolveWebSearchProviderStore: deps.resolveWebSearchProviderStore,
activeTurns: deps.activeTurns,
turnSkillsResolverStore: deps.turnSkillsResolverStore,
};
@@ -263,6 +268,7 @@ export function createServerApp<TTransaction>(deps: ServerDeps<TTransaction>) {
withAuth(
createCapabilitiesRouter({
resolveSandboxProviderStore: deps.resolveSandboxProviderStore,
+ resolveWebSearchProviderStore: deps.resolveWebSearchProviderStore,
withTransaction: deps.withTransaction,
logger: deps.logger,
resolveRequestContext,
@@ -289,6 +295,7 @@ export function createServerApp<TTransaction>(deps: ServerDeps<TTransaction>) {
mcpCatalog: deps.mcpCatalog,
skillCatalog: deps.skillCatalog,
sandboxCatalog: deps.sandboxCatalog,
+ webSearchCatalog: deps.webSearchCatalog,
}),
authMiddleware,
),
@@ -336,6 +343,7 @@ export function createServerApp<TTransaction>(deps: ServerDeps<TTransaction>) {
resolveMcpServerStore: deps.resolveMcpServerStore,
resolveSkillStore: deps.resolveSkillStore,
resolveSandboxProviderStore: deps.resolveSandboxProviderStore,
+ resolveWebSearchProviderStore: deps.resolveWebSearchProviderStore,
withTransaction: deps.withTransaction,
resolveRequestContext,
authorizer: deps.authorizer,
@@ -369,6 +377,7 @@ export function createServerApp<TTransaction>(deps: ServerDeps<TTransaction>) {
tokenStore: deps.tokenStore,
resolveSkillStore: deps.resolveSkillStore,
resolveSandboxProviderStore: deps.resolveSandboxProviderStore,
+ resolveWebSearchProviderStore: deps.resolveWebSearchProviderStore,
withTransaction: deps.withTransaction,
logger: deps.logger,
resolveRequestContext,
@@ -396,6 +405,7 @@ export function createServerApp<TTransaction>(deps: ServerDeps<TTransaction>) {
resolveSkillStore: deps.resolveSkillStore,
resolveAgentStore: deps.resolveAgentStore,
resolveSandboxProviderStore: deps.resolveSandboxProviderStore,
+ resolveWebSearchProviderStore: deps.resolveWebSearchProviderStore,
resolveRequestContext,
authorizer: deps.authorizer,
}),
@@ -439,6 +449,7 @@ export function createServerApp<TTransaction>(deps: ServerDeps<TTransaction>) {
resolveSkillStore: deps.resolveSkillStore,
resolveAgentStore: deps.resolveAgentStore,
resolveSandboxProviderStore: deps.resolveSandboxProviderStore,
+ resolveWebSearchProviderStore: deps.resolveWebSearchProviderStore,
redis: deps.redis,
requestReplyRouter: deps.requestReplyRouter,
resolveRequestContext,
@@ -461,6 +472,7 @@ export function createServerApp<TTransaction>(deps: ServerDeps<TTransaction>) {
resolveAgentStore: deps.resolveAgentStore,
eventSubscriptions: deps.eventSubscriptions,
resolveSandboxProviderStore: deps.resolveSandboxProviderStore,
+ resolveWebSearchProviderStore: deps.resolveWebSearchProviderStore,
logger: deps.logger,
resolveRequestContext,
authorizer: deps.authorizer,
diff --git a/packages/trueforge/src/catalog/WebSearchCatalog.ts b/packages/trueforge/src/catalog/WebSearchCatalog.ts
new file mode 100644
index 000000000..400acbad4
--- /dev/null
+++ b/packages/trueforge/src/catalog/WebSearchCatalog.ts
@@ -0,0 +1,25 @@
+import configuration from '../config';
+import { WebSearchCatalogFileSchema, type CatalogWebSearchProvider } from '../schemas/webSearchCatalog';
+import { loadYamlAtPath, parseYamlString } from './loadYaml';
+import { shippedWebSearchCatalogYaml } from './webSearchCatalog.gen';
+
+export class WebSearchCatalog {
+ private readonly providers: readonly CatalogWebSearchProvider[];
+
+ constructor(providers: readonly CatalogWebSearchProvider[]) {
+ this.providers = providers;
+ }
+
+ static load(): WebSearchCatalog {
+ if (configuration.WEB_SEARCH_CATALOG_PATH) {
+ const file = loadYamlAtPath(configuration.WEB_SEARCH_CATALOG_PATH, WebSearchCatalogFileSchema);
+ return new WebSearchCatalog(file.providers);
+ }
+ const file = parseYamlString(shippedWebSearchCatalogYaml, WebSearchCatalogFileSchema, 'shipped web-search-catalog');
+ return new WebSearchCatalog(file.providers);
+ }
+
+ list(): readonly CatalogWebSearchProvider[] {
+ return this.providers;
+ }
+}
diff --git a/packages/trueforge/src/catalog/webSearchCatalog.gen.ts b/packages/trueforge/src/catalog/webSearchCatalog.gen.ts
new file mode 100644
index 000000000..5af2a7658
--- /dev/null
+++ b/packages/trueforge/src/catalog/webSearchCatalog.gen.ts
@@ -0,0 +1,2 @@
+// AUTO-GENERATED by scripts/generate-catalog.mjs β€” do not edit.
+export const shippedWebSearchCatalogYaml = 'providers:\n - type: parallel\n' as const;
diff --git a/packages/trueforge/src/config.ts b/packages/trueforge/src/config.ts
index 6599b837d..6426caa2a 100644
--- a/packages/trueforge/src/config.ts
+++ b/packages/trueforge/src/config.ts
@@ -564,6 +564,12 @@ export interface SharedServerConfiguration {
* time is used. Env: `SANDBOX_CATALOG_PATH`.
*/
SANDBOX_CATALOG_PATH: string | undefined;
+ /**
+ * Optional override for the web-search catalog YAML (discovery presets for
+ * GET /catalogs/web-search-providers). When unset, the catalog inlined at build
+ * time is used. Env: `WEB_SEARCH_CATALOG_PATH`.
+ */
+ WEB_SEARCH_CATALOG_PATH: string | undefined;
/**
* Frontend build served alongside the API; a missing directory leaves the server API-only.
* Env: `FRONTEND_DIR`. Default: packaged `dist/_frontend` (npx tarball) or
@@ -857,6 +863,7 @@ const shared: SharedServerConfiguration = {
MCP_CATALOG_PATH: resolveOptionalPathEnv('MCP_CATALOG_PATH'),
SKILL_CATALOG_PATH: resolveOptionalPathEnv('SKILL_CATALOG_PATH'),
SANDBOX_CATALOG_PATH: resolveOptionalPathEnv('SANDBOX_CATALOG_PATH'),
+ WEB_SEARCH_CATALOG_PATH: resolveOptionalPathEnv('WEB_SEARCH_CATALOG_PATH'),
FRONTEND_DIR: resolveFrontendDir(),
MCP_REQUEST_TIMEOUT_MS: parsePositiveInt({
diff --git a/packages/trueforge/src/db/postgres/migrations/20260921_000001_web_search_provider.ts b/packages/trueforge/src/db/postgres/migrations/20260921_000001_web_search_provider.ts
new file mode 100644
index 000000000..b8c254328
--- /dev/null
+++ b/packages/trueforge/src/db/postgres/migrations/20260921_000001_web_search_provider.ts
@@ -0,0 +1,24 @@
+import { sql, type Kysely } from 'kysely';
+
+/**
+ * Configured web-search provider (canonical DDL owner).
+ *
+ * Singleton per tenant: PK is `tenant_id` only. Manifest (type, auth) is one
+ * jsonb document validated by Zod on every write.
+ */
+export async function up(db: Kysely<unknown>): Promise<void> {
+ await sql`SET LOCAL lock_timeout = '5s'`.execute(db);
+ await db.schema
+ .createTable('web_search_provider')
+ .addColumn('tenant_id', 'text', col => col.notNull())
+ .addColumn('manifest', 'jsonb', col => col.notNull())
+ .addColumn('created_at', 'timestamptz', col => col.notNull())
+ .addColumn('updated_at', 'timestamptz', col => col.notNull())
+ .addPrimaryKeyConstraint('web_search_provider_pkey', ['tenant_id'])
+ .execute();
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+ await sql`SET LOCAL lock_timeout = '5s'`.execute(db);
+ await db.schema.dropTable('web_search_provider').ifExists().cascade().execute();
+}
diff --git a/packages/trueforge/src/db/postgres/types.ts b/packages/trueforge/src/db/postgres/types.ts
index 41d78f462..e9afee3fe 100644
--- a/packages/trueforge/src/db/postgres/types.ts
+++ b/packages/trueforge/src/db/postgres/types.ts
@@ -32,6 +32,7 @@ import type {
} from '../../schemas/sandboxProvider';
import type { ScheduleManifest, ScheduleRunStatus, ScheduleStatus } from '../../schemas/schedule';
import type { SkillManifest } from '../../schemas/skill';
+import type { WebSearchProviderManifest } from '../../schemas/webSearchProvider';
import type { OAuthClient, OAuthPendingAuthorizationData, OAuthServer, OAuthToken } from '../mcpServerStore';
/**
@@ -341,6 +342,17 @@ export interface ModelProviderTable {
updated_at: Date;
}
+/**
+ * Configured web-search provider β€” mirrors the Postgres `web_search_provider` table.
+ * PRIMARY KEY (tenant_id)
+ */
+export interface WebSearchProviderTable {
+ tenant_id: string;
+ manifest: JSONColumnType<WebSearchProviderManifest, WebSearchProviderManifest, WebSearchProviderManifest>;
+ created_at: Date;
+ updated_at: Date;
+}
+
/**
* Configured skills β€” mirrors the Postgres `skill` table.
* PRIMARY KEY (tenant_id, name)
@@ -523,6 +535,7 @@ export interface Database {
thread_context_log: ThreadContextLogTable;
thread_capability_state: ThreadCapabilityStateTable;
model_provider: ModelProviderTable;
+ web_search_provider: WebSearchProviderTable;
skill: SkillTable;
sandbox_provider: SandboxProviderTable;
agent: AgentTable;
diff --git a/packages/trueforge/src/db/postgres/web-search-provider-store/PostgresWebSearchProviderStore.ts b/packages/trueforge/src/db/postgres/web-search-provider-store/PostgresWebSearchProviderStore.ts
new file mode 100644
index 000000000..adbb3f99a
--- /dev/null
+++ b/packages/trueforge/src/db/postgres/web-search-provider-store/PostgresWebSearchProviderStore.ts
@@ -0,0 +1,62 @@
+import type { Kysely, Selectable, Transaction } from 'kysely';
+import type {
+ IWebSearchProviderStore,
+ UpsertWebSearchProviderInput,
+ WebSearchProviderRecord,
+} from '../../webSearchProviderStore';
+import { json, now } from '../sqlExpressions';
+import type { Database, WebSearchProviderTable } from '../types';
+
+function toRecord(row: Selectable<WebSearchProviderTable>): WebSearchProviderRecord {
+ return {
+ tenant_id: row.tenant_id,
+ manifest: row.manifest,
+ created_at: row.created_at.toISOString(),
+ updated_at: row.updated_at.toISOString(),
+ };
+}
+
+export class PostgresWebSearchProviderStore implements IWebSearchProviderStore<Transaction<Database>> {
+ readonly #db: Kysely<Database>;
+
+ constructor(db: Kysely<Database>) {
+ this.#db = db;
+ }
+
+ async getProvider(
+ tenantId: string,
+ transaction?: Transaction<Database>,
+ ): Promise<WebSearchProviderRecord | undefined> {
+ const db = transaction ?? this.#db;
+ const row = await db
+ .selectFrom('web_search_provider')
+ .selectAll()
+ .where('tenant_id', '=', tenantId)
+ .executeTakeFirst();
+ return row ? toRecord(row) : undefined;
+ }
+
+ async upsertProvider(
+ input: UpsertWebSearchProviderInput,
+ transaction?: Transaction<Database>,
+ ): Promise<WebSearchProviderRecord> {
+ const db = transaction ?? this.#db;
+ const row = await db
+ .insertInto('web_search_provider')
+ .values({
+ tenant_id: input.tenant_id,
+ manifest: json(input.manifest),
+ created_at: now(),
+ updated_at: now(),
+ })
+ .onConflict(oc =>
+ oc.column('tenant_id').doUpdateSet({
+ manifest: json(input.manifest),
+ updated_at: now(),
+ }),
+ )
+ .returningAll()
+ .executeTakeFirstOrThrow();
+ return toRecord(row);
+ }
+}
diff --git a/packages/trueforge/src/db/sqlite/migrations/20260921_000001_web_search_provider.ts b/packages/trueforge/src/db/sqlite/migrations/20260921_000001_web_search_provider.ts
new file mode 100644
index 000000000..cad8a581d
--- /dev/null
+++ b/packages/trueforge/src/db/sqlite/migrations/20260921_000001_web_search_provider.ts
@@ -0,0 +1,25 @@
+import { sql, type Kysely } from 'kysely';
+
+/**
+ * Configured web-search provider β€” mirrors Postgres `web_search_provider`.
+ * Singleton per tenant: PK is `tenant_id` only.
+ */
+export async function up(db: Kysely<unknown>): Promise<void> {
+ await db.transaction().execute(async trx => {
+ await sql`
+ CREATE TABLE web_search_provider (
+ tenant_id TEXT NOT NULL,
+ manifest BLOB NOT NULL,
+ created_at TEXT NOT NULL,
+ updated_at TEXT NOT NULL,
+ PRIMARY KEY (tenant_id)
+ ) STRICT
+ `.execute(trx);
+ });
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+ await db.transaction().execute(async trx => {
+ await sql`DROP TABLE IF EXISTS web_search_provider`.execute(trx);
+ });
+}
diff --git a/packages/trueforge/src/db/sqlite/types.ts b/packages/trueforge/src/db/sqlite/types.ts
index 9c2b62303..de10ff0be 100644
--- a/packages/trueforge/src/db/sqlite/types.ts
+++ b/packages/trueforge/src/db/sqlite/types.ts
@@ -35,6 +35,7 @@ import type {
} from '../../schemas/sandboxProvider';
import type { ScheduleManifest, ScheduleRunStatus, ScheduleStatus } from '../../schemas/schedule';
import type { SkillManifest } from '../../schemas/skill';
+import type { WebSearchProviderManifest } from '../../schemas/webSearchProvider';
import type { OAuthClient, OAuthPendingAuthorizationData, OAuthServer, OAuthToken } from '../mcpServerStore';
/**
@@ -187,6 +188,17 @@ export interface ModelProviderTable {
updated_at: string;
}
+/**
+ * Configured web-search provider β€” mirrors the Postgres `web_search_provider` table.
+ * PRIMARY KEY (tenant_id)
+ */
+export interface WebSearchProviderTable {
+ tenant_id: string;
+ manifest: JsonbColumn<WebSearchProviderManifest>;
+ created_at: string;
+ updated_at: string;
+}
+
/**
* Configured skills β€” mirrors the Postgres `skill` table.
* PRIMARY KEY (tenant_id, name)
@@ -343,6 +355,7 @@ export interface Database {
thread_context_log: ThreadContextLogTable;
thread_capability_state: ThreadCapabilityStateTable;
model_provider: ModelProviderTable;
+ web_search_provider: WebSearchProviderTable;
skill: SkillTable;
sandbox_provider: SandboxProviderTable;
agent: AgentTable;
diff --git a/packages/trueforge/src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore.ts b/packages/trueforge/src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore.ts
new file mode 100644
index 000000000..179bbece2
--- /dev/null
+++ b/packages/trueforge/src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore.ts
@@ -0,0 +1,63 @@
+import type { ExpressionBuilder, Kysely, Transaction } from 'kysely';
+import type { WebSearchProviderManifest } from '../../../schemas/webSearchProvider';
+import type {
+ IWebSearchProviderStore,
+ UpsertWebSearchProviderInput,
+ WebSearchProviderRecord,
+} from '../../webSearchProviderStore';
+import { jsonbBind, jsonText, nowIso } from '../sqlExpressions';
+import type { Database } from '../types';
+
+/** Projects JSONB manifest via JSON_RESULT_COLUMNS. */
+function recordColumns(eb: ExpressionBuilder<Database, 'web_search_provider'>) {
+ return [
+ 'tenant_id' as const,
+ jsonText<WebSearchProviderManifest>(eb.ref('manifest')).as('manifest'),
+ 'created_at' as const,
+ 'updated_at' as const,
+ ];
+}
+
+export class SqliteWebSearchProviderStore implements IWebSearchProviderStore<Transaction<Database>> {
+ readonly #db: Kysely<Database>;
+
+ constructor(db: Kysely<Database>) {
+ this.#db = db;
+ }
+
+ async getProvider(
+ tenantId: string,
+ transaction?: Transaction<Database>,
+ ): Promise<WebSearchProviderRecord | undefined> {
+ const db = transaction ?? this.#db;
+ return await db
+ .selectFrom('web_search_provider')
+ .select(recordColumns)
+ .where('tenant_id', '=', tenantId)
+ .executeTakeFirst();
+ }
+
+ async upsertProvider(
+ input: UpsertWebSearchProviderInput,
+ transaction?: Transaction<Database>,
+ ): Promise<WebSearchProviderRecord> {
+ const db = transaction ?? this.#db;
+ const timestamp = nowIso();
+ return await db
+ .insertInto('web_search_provider')
+ .values({
+ tenant_id: input.tenant_id,
+ manifest: jsonbBind(input.manifest),
+ created_at: timestamp,
+ updated_at: timestamp,
+ })
+ .onConflict(oc =>
+ oc.column('tenant_id').doUpdateSet({
+ manifest: jsonbBind(input.manifest),
+ updated_at: timestamp,
+ }),
+ )
+ .returning(recordColumns)
+ .executeTakeFirstOrThrow();
+ }
+}
diff --git a/packages/trueforge/src/db/webSearchProviderStore.ts b/packages/trueforge/src/db/webSearchProviderStore.ts
new file mode 100644
index 000000000..57ca3c53f
--- /dev/null
+++ b/packages/trueforge/src/db/webSearchProviderStore.ts
@@ -0,0 +1,19 @@
+import type { WebSearchProviderManifest } from '../schemas/webSearchProvider';
+
+export interface WebSearchProviderRecord {
+ tenant_id: string;
+ manifest: WebSearchProviderManifest;
+ created_at: string;
+ updated_at: string;
+}
+
+export interface UpsertWebSearchProviderInput {
+ tenant_id: string;
+ manifest: WebSearchProviderManifest;
+}
+
+export interface IWebSearchProviderStore<TTransaction = never> {
+ getProvider(tenantId: string, transaction?: TTransaction): Promise<WebSearchProviderRecord | undefined>;
+ /** Single-row write: creates the provider or replaces the whole manifest. */
+ upsertProvider(input: UpsertWebSearchProviderInput, transaction?: TTransaction): Promise<WebSearchProviderRecord>;
+}
diff --git a/packages/trueforge/src/main.ts b/packages/trueforge/src/main.ts
index 63531d3b3..3308c51e5 100644
--- a/packages/trueforge/src/main.ts
+++ b/packages/trueforge/src/main.ts
@@ -70,6 +70,7 @@ import { McpCatalog } from './catalog/McpCatalog';
import { ModelCatalog } from './catalog/ModelCatalog';
import { SandboxCatalog } from './catalog/SandboxCatalog';
import { SkillCatalog } from './catalog/SkillCatalog';
+import { WebSearchCatalog } from './catalog/WebSearchCatalog';
import { type DistributedServerConfiguration } from './config';
import { createController } from './controller';
import type { AgentRecord, IAgentStore } from './db/agentStore';
@@ -84,6 +85,7 @@ import type { ISessionMetricsStore } from './db/sessionMetricsStore';
import type { ISkillStore } from './db/skillStore';
import type { Database as SqliteDatabase } from './db/sqlite/types';
import type { WithTransaction } from './db/transaction';
+import type { IWebSearchProviderStore } from './db/webSearchProviderStore';
import { mountFrontend } from './frontend';
import { serverTlsServeOptions } from './http/tls';
import { createServerLogger, shouldColorize } from './logger';
@@ -107,6 +109,7 @@ import { TrueFoundryModelProviderStore } from './truefoundry/TrueFoundryModelPro
import { TrueFoundrySandboxProviderStore } from './truefoundry/TrueFoundrySandboxProviderStore';
import { TrueFoundryServiceFoundryServerClient } from './truefoundry/TrueFoundryServiceFoundryServerClient';
import { TrueFoundryAdminSkillStore, TrueFoundrySkillStore } from './truefoundry/TrueFoundrySkillStore';
+import { TrueFoundryWebSearchProviderStore } from './truefoundry/TrueFoundryWebSearchProviderStore';
/** Persistence + optional Redis wired for the selected topology. */
interface ServerPersistence<TTransaction> {
@@ -123,6 +126,7 @@ interface ServerPersistence<TTransaction> {
perServerHeaders?: PerServerMcpHeaders,
) => IMcpServerWithAuthStore<TTransaction>;
resolveSandboxProviderStore: (rc: RequestContext) => ISandboxProviderStore<TTransaction>;
+ resolveWebSearchProviderStore: (rc: RequestContext) => IWebSearchProviderStore<TTransaction>;
/** Per-request store: DB git skills, or TrueFoundry registry catalog in TrueFoundry mode. */
resolveSkillStore: (rc: RequestContext) => ISkillStore<TTransaction>;
resolveAgentStore: (rc: RequestContext) => IAgentStore<TTransaction>;
@@ -279,6 +283,16 @@ function buildResolveSandboxProviderStore<TTransaction>(options: {
return () => persistenceStore;
}
+function buildResolveWebSearchProviderStore<TTransaction>(options: {
+ persistenceStore: IWebSearchProviderStore<TTransaction>;
+}): (rc: RequestContext) => IWebSearchProviderStore<TTransaction> {
+ const { persistenceStore } = options;
+ if (isTrueFoundryModeEnabled(configuration)) {
+ return () => new TrueFoundryWebSearchProviderStore<TTransaction>();
+ }
+ return () => persistenceStore;
+}
+
/** SQLite stores; Redis unused (executor peering disabled). */
async function createStandalonePersistence(options: {
sqlitePath: string;
@@ -297,6 +311,7 @@ async function createStandalonePersistence(options: {
import('./db/sqlite/token-store/SqliteOAuthTokenStore'),
import('./db/sqlite/skill-store/SqliteSkillStore'),
import('./db/sqlite/sandbox-provider-store/SqliteSandboxProviderStore'),
+ import('./db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore'),
import('./db/sqlite/agent-store/SqliteAgentStore'),
import('./db/sqlite/schedule-store/SqliteScheduleStore'),
]),
@@ -309,6 +324,7 @@ async function createStandalonePersistence(options: {
{ SqliteOAuthTokenStore },
{ SqliteSkillStore },
{ SqliteSandboxProviderStore },
+ { SqliteWebSearchProviderStore },
{ SqliteAgentStore },
{ SqliteScheduleStore },
] = sqliteStores;
@@ -327,6 +343,7 @@ async function createStandalonePersistence(options: {
clientName: configuration.MCP_DCR_OAUTH_CLIENT_NAME,
});
const sandboxProviderStore = new SqliteSandboxProviderStore(db);
+ const webSearchProviderStore = new SqliteWebSearchProviderStore(db);
const skillStore = new SqliteSkillStore(db);
return {
withTransaction: callback => db.transaction().execute(callback),
@@ -338,6 +355,7 @@ async function createStandalonePersistence(options: {
resolveModelProviderStore: () => modelProviderStore,
resolveMcpServerStore: () => mcpServerStore,
resolveSandboxProviderStore: () => sandboxProviderStore,
+ resolveWebSearchProviderStore: () => webSearchProviderStore,
resolveSkillStore: () => skillStore,
resolveAgentStore: () => agentStore,
resolveImportAgentStore: () => agentStore,
@@ -377,6 +395,7 @@ async function createDistributedPersistence(options: {
import('./db/postgres/token-store/PostgresOAuthTokenStore'),
import('./db/postgres/skill-store/PostgresSkillStore'),
import('./db/postgres/sandbox-provider-store/PostgresSandboxProviderStore'),
+ import('./db/postgres/web-search-provider-store/PostgresWebSearchProviderStore'),
import('./db/postgres/agent-store/PostgresAgentStore'),
import('./db/postgres/schedule-store/PostgresScheduleStore'),
]),
@@ -389,6 +408,7 @@ async function createDistributedPersistence(options: {
{ PostgresOAuthTokenStore },
{ PostgresSkillStore },
{ PostgresSandboxProviderStore },
+ { PostgresWebSearchProviderStore },
{ PostgresAgentStore },
{ PostgresScheduleStore },
] = postgresStores;
@@ -413,6 +433,7 @@ async function createDistributedPersistence(options: {
clientName: configuration.MCP_DCR_OAUTH_CLIENT_NAME,
});
const sandboxProviderStore = new PostgresSandboxProviderStore(db);
+ const webSearchProviderStore = new PostgresWebSearchProviderStore(db);
const skillStore = new PostgresSkillStore(db);
const agentStore = new PostgresAgentStore(db);
const turnSkillsResolverStore = buildTurnSkillsResolverStore({
@@ -457,6 +478,9 @@ async function createDistributedPersistence(options: {
const resolveSandboxProviderStore = buildResolveSandboxProviderStore({
persistenceStore: sandboxProviderStore,
});
+ const resolveWebSearchProviderStore = buildResolveWebSearchProviderStore({
+ persistenceStore: webSearchProviderStore,
+ });
const resolveSkillStore = buildResolveSkillStore({
persistenceStore: skillStore,
client: serviceFoundryClient,
@@ -471,6 +495,7 @@ async function createDistributedPersistence(options: {
resolveModelProviderStore,
resolveMcpServerStore,
resolveSandboxProviderStore,
+ resolveWebSearchProviderStore,
resolveSkillStore,
resolveAgentStore,
resolveImportAgentStore,
@@ -566,6 +591,8 @@ async function createServerRuntime<TTransaction>(persistence: ServerPersistence<
};
const resolveAgentStore = (c: Context) => persistence.resolveAgentStore(resolveRequestContext(c));
const resolveSandboxProviderStore = (c: Context) => persistence.resolveSandboxProviderStore(resolveRequestContext(c));
+ const resolveWebSearchProviderStore = (c: Context) =>
+ persistence.resolveWebSearchProviderStore(resolveRequestContext(c));
const resolveSkillStore = (c: Context) => {
const store = persistence.resolveSkillStore(resolveRequestContext(c));
if (!isTrueFoundryModeEnabled(configuration)) {
@@ -582,11 +609,13 @@ async function createServerRuntime<TTransaction>(persistence: ServerPersistence<
mcpCatalog: McpCatalog.load(),
skillCatalog: SkillCatalog.load(),
sandboxCatalog: SandboxCatalog.load(),
+ webSearchCatalog: WebSearchCatalog.load(),
resolveModelProviderStore,
resolveMcpServerStore,
resolveAgentStore,
resolveImportAgentStore,
resolveSandboxProviderStore,
+ resolveWebSearchProviderStore,
resolveSkillStore,
withTransaction,
tokenStore,
diff --git a/packages/trueforge/src/routes/catalogRoutes.ts b/packages/trueforge/src/routes/catalogRoutes.ts
index 3eb95d688..d5cf883a0 100644
--- a/packages/trueforge/src/routes/catalogRoutes.ts
+++ b/packages/trueforge/src/routes/catalogRoutes.ts
@@ -8,6 +8,7 @@ import { GetMcpServerCatalogResponseSchema } from '../schemas/mcpCatalog';
import { GetModelProviderCatalogResponseSchema } from '../schemas/modelCatalog';
import { GetSandboxProviderCatalogResponseSchema } from '../schemas/sandboxCatalog';
import { GetSkillCatalogResponseSchema } from '../schemas/skillCatalog';
+import { GetWebSearchProviderCatalogResponseSchema } from '../schemas/webSearchCatalog';
import { OpenApiTag } from './openapiTags';
export const listModelProviderCatalogRoute = createRoute({
@@ -92,3 +93,23 @@ export const listSandboxProviderCatalogRoute = createRoute({
},
},
});
+
+export const listWebSearchProviderCatalogRoute = createRoute({
+ method: 'get',
+ path: '/web-search-providers',
+ tags: [OpenApiTag.WEB_SEARCH],
+ summary: 'List web search providers',
+ description: 'Shipped web-search provider presets.',
+ 'x-fern-sdk-group-name': ['catalogs', 'webSearchProviders'],
+ 'x-fern-sdk-method-name': 'list',
+ responses: {
+ 200: {
+ content: { 'application/json': { schema: GetWebSearchProviderCatalogResponseSchema } },
+ description: 'Shipped web-search provider presets.',
+ },
+ 401: {
+ content: { 'application/json': { schema: RequestErrorResponseSchema } },
+ description: 'Not authenticated.',
+ },
+ },
+});
diff --git a/packages/trueforge/src/routes/openapiTags.ts b/packages/trueforge/src/routes/openapiTags.ts
index 1082e870b..8f7fd5548 100644
--- a/packages/trueforge/src/routes/openapiTags.ts
+++ b/packages/trueforge/src/routes/openapiTags.ts
@@ -7,6 +7,7 @@ export enum OpenApiTag {
MCP_SERVERS = 'MCP Servers',
SKILLS = 'Skills',
SANDBOXES = 'Sandboxes',
+ WEB_SEARCH = 'Web Search Providers',
AGENTS = 'Agents',
SCHEDULES = 'Schedules',
AGENT_SESSIONS = 'Agent Sessions',
@@ -21,6 +22,7 @@ export const OPENAPI_DOCUMENT_TAGS: { name: OpenApiTag }[] = [
{ name: OpenApiTag.MCP_SERVERS },
{ name: OpenApiTag.SKILLS },
{ name: OpenApiTag.SANDBOXES },
+ { name: OpenApiTag.WEB_SEARCH },
{ name: OpenApiTag.AGENTS },
{ name: OpenApiTag.SCHEDULES },
{ name: OpenApiTag.AGENT_SESSIONS },
diff --git a/packages/trueforge/src/routes/webSearchProviderRoutes.ts b/packages/trueforge/src/routes/webSearchProviderRoutes.ts
new file mode 100644
index 000000000..88392ef12
--- /dev/null
+++ b/packages/trueforge/src/routes/webSearchProviderRoutes.ts
@@ -0,0 +1,64 @@
+import { createRoute } from '@hono/zod-openapi';
+import { RequestErrorResponseSchema } from '../schemas/errors';
+import { GetWebSearchProviderResponseSchema, UpdateWebSearchProviderRequestSchema } from '../schemas/webSearchProvider';
+import { OpenApiTag } from './openapiTags';
+
+export const getWebSearchProviderRoute = createRoute({
+ method: 'get',
+ path: '/',
+ tags: [OpenApiTag.WEB_SEARCH],
+ summary: 'Get the web search provider',
+ description: 'The configured provider for this tenant. `auth.api_key` is redacted when present.',
+ 'x-fern-sdk-group-name': ['settings', 'webSearchProviders'],
+ 'x-fern-sdk-method-name': 'get',
+ responses: {
+ 200: {
+ content: { 'application/json': { schema: GetWebSearchProviderResponseSchema } },
+ description: 'The configured web search provider.',
+ },
+ 401: {
+ content: { 'application/json': { schema: RequestErrorResponseSchema } },
+ description: 'Invalid Bearer token or auth cookie.',
+ },
+ 403: {
+ content: { 'application/json': { schema: RequestErrorResponseSchema } },
+ description: 'Authenticated but not an admin.',
+ },
+ 404: {
+ content: { 'application/json': { schema: RequestErrorResponseSchema } },
+ description: 'No web search provider configured.',
+ },
+ },
+});
+
+export const putWebSearchProviderRoute = createRoute({
+ method: 'put',
+ path: '/',
+ tags: [OpenApiTag.WEB_SEARCH],
+ summary: 'Create or replace the web search provider',
+ description:
+ 'Upserts the single web search provider for this tenant. ' +
+ '`auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).',
+ 'x-fern-sdk-group-name': ['settings', 'webSearchProviders'],
+ 'x-fern-sdk-method-name': 'create_or_update',
+ request: {
+ body: {
+ content: { 'application/json': { schema: UpdateWebSearchProviderRequestSchema } },
+ required: true,
+ },
+ },
+ responses: {
+ 200: {
+ content: { 'application/json': { schema: GetWebSearchProviderResponseSchema } },
+ description: 'The saved provider.',
+ },
+ 400: {
+ content: { 'application/json': { schema: RequestErrorResponseSchema } },
+ description: 'Invalid request body, or redacted API key with no stored secret to keep.',
+ },
+ 424: {
+ content: { 'application/json': { schema: RequestErrorResponseSchema } },
+ description: 'Unsupported operation because web-search providers are managed by an external system',
+ },
+ },
+});
diff --git a/packages/trueforge/src/runtime/sessionResources.ts b/packages/trueforge/src/runtime/sessionResources.ts
index 7a01b042d..f2670ba92 100644
--- a/packages/trueforge/src/runtime/sessionResources.ts
+++ b/packages/trueforge/src/runtime/sessionResources.ts
@@ -19,11 +19,12 @@ import type { IMcpServerStore, IMcpServerWithAuthStore } from '../db/mcpServerSt
import type { IModelProviderStore } from '../db/modelProviderStore';
import type { ISandboxProviderStore } from '../db/sandboxProviderStore';
import type { ISkillStore } from '../db/skillStore';
+import type { IWebSearchProviderStore } from '../db/webSearchProviderStore';
import { LocalSandboxProvider } from '../sandbox/local/provider/LocalSandboxProvider';
import { getCachedLocalSandboxSupport, isLocalSandboxFallbackEnabled } from '../sandbox/localRuntime';
import { toSandboxProviderFromRecord } from '../sandbox/providerUtils';
import type { ReasoningEffort } from '../schemas/modelProvider';
-import { resolveWebSearchProvider } from '../websearch/providers';
+import { hasConfiguredWebSearchProvider } from '../websearch/providers';
export interface McpConnection {
url: string;
@@ -309,6 +310,7 @@ export async function validateAgentSpec({
mcpServerStore,
skillStore,
sandboxProviderStore,
+ webSearchProviderStore,
}: {
spec: AgentSpec;
tenant_id: string;
@@ -316,6 +318,7 @@ export async function validateAgentSpec({
mcpServerStore: IMcpServerStore;
skillStore: ISkillStore;
sandboxProviderStore: ISandboxProviderStore;
+ webSearchProviderStore: IWebSearchProviderStore;
}): Promise<void> {
const resolved = await getModelDetails({
tenant_id,
@@ -371,9 +374,12 @@ export async function validateAgentSpec({
}
}
- if (spec.config.web_search.enabled && resolveWebSearchProvider() === undefined) {
- throw new HTTPException(422, {
- message: 'web_search is enabled but no web-search provider is configured',
- });
+ if (spec.config.web_search.enabled) {
+ const hasProvider = await hasConfiguredWebSearchProvider({ tenant_id, store: webSearchProviderStore });
+ if (!hasProvider) {
+ throw new HTTPException(422, {
+ message: 'web_search is enabled but no web-search provider is configured',
+ });
+ }
}
}
diff --git a/packages/trueforge/src/schemas/webSearchCatalog.ts b/packages/trueforge/src/schemas/webSearchCatalog.ts
new file mode 100644
index 000000000..2b5e9b9f8
--- /dev/null
+++ b/packages/trueforge/src/schemas/webSearchCatalog.ts
@@ -0,0 +1,21 @@
+import { z } from '@hono/zod-openapi';
+import { ParallelWebSearchProviderSchema } from './webSearchProvider';
+
+export const CatalogWebSearchProviderSchema = ParallelWebSearchProviderSchema.omit({ auth: true })
+ .strict()
+ .openapi('CatalogWebSearchProvider');
+
+export const WebSearchCatalogFileSchema = z
+ .object({
+ providers: z.array(CatalogWebSearchProviderSchema),
+ })
+ .strict();
+
+export const GetWebSearchProviderCatalogResponseSchema = z
+ .object({
+ data: z.array(CatalogWebSearchProviderSchema),
+ })
+ .openapi('GetWebSearchProviderCatalogResponse');
+
+export type CatalogWebSearchProvider = z.infer<typeof CatalogWebSearchProviderSchema>;
+export type WebSearchCatalogFile = z.infer<typeof WebSearchCatalogFileSchema>;
diff --git a/packages/trueforge/src/schemas/webSearchProvider.ts b/packages/trueforge/src/schemas/webSearchProvider.ts
new file mode 100644
index 000000000..e94934c36
--- /dev/null
+++ b/packages/trueforge/src/schemas/webSearchProvider.ts
@@ -0,0 +1,55 @@
+import { z } from '@hono/zod-openapi';
+import { NameSchema, type ResourceName } from './common';
+
+const ParallelWebSearchProviderAuthSchema = z
+ .object({
+ api_key: z
+ .string()
+ .min(1)
+ .describe(
+ 'Parallel API key. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored key.',
+ ),
+ })
+ .strict()
+ .describe('Parallel authentication credentials.')
+ .openapi('ParallelWebSearchProviderAuth');
+
+export const ParallelWebSearchProviderSchema = z
+ .object({
+ type: z.literal('parallel').describe('Parallel web-search provider.'),
+ auth: ParallelWebSearchProviderAuthSchema,
+ })
+ .strict();
+
+export const WebSearchProviderManifestSchema = z
+ .discriminatedUnion('type', [ParallelWebSearchProviderSchema])
+ .openapi('WebSearchProviderManifest');
+
+export function webSearchProviderName(provider: WebSearchProviderManifest): ResourceName {
+ return provider.type;
+}
+
+export const ConfiguredWebSearchProviderSchema = z
+ .object({
+ name: NameSchema,
+ manifest: WebSearchProviderManifestSchema,
+ })
+ .strict()
+ .openapi('ConfiguredWebSearchProvider');
+
+export const UpdateWebSearchProviderRequestSchema = z
+ .object({
+ manifest: WebSearchProviderManifestSchema,
+ })
+ .strict()
+ .openapi('UpdateWebSearchProviderRequest');
+
+export const GetWebSearchProviderResponseSchema = z
+ .object({
+ data: ConfiguredWebSearchProviderSchema,
+ })
+ .openapi('GetWebSearchProviderResponse');
+
+export type WebSearchProviderManifest = z.infer<typeof WebSearchProviderManifestSchema>;
+export type ConfiguredWebSearchProvider = z.infer<typeof ConfiguredWebSearchProviderSchema>;
+export type UpdateWebSearchProviderRequest = z.infer<typeof UpdateWebSearchProviderRequestSchema>;
diff --git a/packages/trueforge/src/truefoundry/TrueFoundryWebSearchProviderStore.ts b/packages/trueforge/src/truefoundry/TrueFoundryWebSearchProviderStore.ts
new file mode 100644
index 000000000..d4007ea65
--- /dev/null
+++ b/packages/trueforge/src/truefoundry/TrueFoundryWebSearchProviderStore.ts
@@ -0,0 +1,40 @@
+import configuration, { isTrueFoundryModeEnabled } from '../config';
+import type {
+ IWebSearchProviderStore,
+ UpsertWebSearchProviderInput,
+ WebSearchProviderRecord,
+} from '../db/webSearchProviderStore';
+import { trueFoundryManaged } from './errors';
+
+function synthesizeParallelRecord(tenantId: string): WebSearchProviderRecord | undefined {
+ if (!isTrueFoundryModeEnabled(configuration)) {
+ return undefined;
+ }
+ const env = configuration.TRUEFOUNDRY_WEB_SEARCH_PROVIDER;
+ if (!env) {
+ return undefined;
+ }
+ const now = new Date().toISOString();
+ return {
+ tenant_id: tenantId,
+ manifest: {
+ type: 'parallel',
+ auth: { api_key: env.api_key },
+ },
+ created_at: now,
+ updated_at: now,
+ };
+}
+
+export class TrueFoundryWebSearchProviderStore<TTransaction = never> implements IWebSearchProviderStore<TTransaction> {
+ getProvider(tenantId: string, transaction?: TTransaction): Promise<WebSearchProviderRecord | undefined> {
+ void transaction;
+ return Promise.resolve(synthesizeParallelRecord(tenantId));
+ }
+
+ upsertProvider(input: UpsertWebSearchProviderInput, transaction?: TTransaction): Promise<WebSearchProviderRecord> {
+ void input;
+ void transaction;
+ return trueFoundryManaged();
+ }
+}
diff --git a/packages/trueforge/src/websearch/providers.ts b/packages/trueforge/src/websearch/providers.ts
index 7f16efc28..a9fef5a6c 100644
--- a/packages/trueforge/src/websearch/providers.ts
+++ b/packages/trueforge/src/websearch/providers.ts
@@ -1,14 +1,28 @@
import { ParallelWebSearchProvider, type IWebSearchProvider } from '@truefoundry/trueforge-core/core';
-import configuration, { isTrueFoundryModeEnabled } from '../config';
+import type { IWebSearchProviderStore } from '../db/webSearchProviderStore';
-/** Build the host web-search backend (TrueFoundry mode only), or `undefined` when unset. */
-export function resolveWebSearchProvider(): IWebSearchProvider | undefined {
- if (!isTrueFoundryModeEnabled(configuration)) {
- return undefined;
- }
- const env = configuration.TRUEFOUNDRY_WEB_SEARCH_PROVIDER;
- if (!env) {
+export async function hasConfiguredWebSearchProvider({
+ tenant_id,
+ store,
+}: {
+ tenant_id: string;
+ store: IWebSearchProviderStore;
+}): Promise<boolean> {
+ const record = await store.getProvider(tenant_id);
+ return record !== undefined;
+}
+
+export async function resolveWebSearchProvider({
+ tenant_id,
+ store,
+}: {
+ tenant_id: string;
+ store: IWebSearchProviderStore;
+}): Promise<IWebSearchProvider | undefined> {
+ const record = await store.getProvider(tenant_id);
+ if (!record) {
return undefined;
}
- return new ParallelWebSearchProvider({ apiKey: env.api_key, mode: 'turbo' });
+ const { manifest } = record;
+ return new ParallelWebSearchProvider({ apiKey: manifest.auth.api_key, mode: 'turbo' });
}
diff --git a/packages/trueforge/tests/unit/apis/agents.test.ts b/packages/trueforge/tests/unit/apis/agents.test.ts
index dbb83d6c6..a85368e0a 100644
--- a/packages/trueforge/tests/unit/apis/agents.test.ts
+++ b/packages/trueforge/tests/unit/apis/agents.test.ts
@@ -9,6 +9,7 @@ import { SqliteMcpServerStore } from '../../../src/db/sqlite/mcp-server-store/Sq
import { SqliteModelProviderStore } from '../../../src/db/sqlite/model-provider-store/SqliteModelProviderStore';
import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provider-store/SqliteSandboxProviderStore';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import { ListAgentsResponseSchema } from '../../../src/schemas/agent';
const modelProvider = {
@@ -104,6 +105,7 @@ describe('agents router', () => {
resolveMcpServerStore: () => new SqliteMcpServerStore(db),
resolveSkillStore: () => new SqliteSkillStore(db),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
withTransaction: callback => db.transaction().execute(callback),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: new TrueForgeAuthorizer(),
@@ -114,6 +116,7 @@ describe('agents router', () => {
resolveMcpServerStore: () => new SqliteMcpServerStore(db),
resolveSkillStore: () => new SqliteSkillStore(db),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
withTransaction: callback => db.transaction().execute(callback),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: denyAllAuthorizer,
diff --git a/packages/trueforge/tests/unit/apis/capabilities.test.ts b/packages/trueforge/tests/unit/apis/capabilities.test.ts
index 720398a5a..7f95232fe 100644
--- a/packages/trueforge/tests/unit/apis/capabilities.test.ts
+++ b/packages/trueforge/tests/unit/apis/capabilities.test.ts
@@ -16,6 +16,7 @@ import type { OIDCConfig } from '../../../src/config';
import { migrateSqliteToLatest } from '../../../src/db/migrateSqlite';
import { createSqliteDb } from '../../../src/db/sqlite/client';
import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provider-store/SqliteSandboxProviderStore';
+import type { IWebSearchProviderStore } from '../../../src/db/webSearchProviderStore';
import { setCachedLocalSandboxSupport } from '../../../src/sandbox/localRuntime';
import { checkSnapshotStatus } from '../../../src/sandbox/providerUtils';
import type { SandboxBuildStatus, SandboxStatus } from '../../../src/schemas/sandboxProvider';
@@ -69,11 +70,22 @@ describe('capabilities routers', () => {
setCachedLocalSandboxSupport(undefined);
});
- function makeRouter(authenticator: Authenticator = new StandaloneAuthenticator()): OpenAPIHono {
+ function makeRouter({
+ authenticator = new StandaloneAuthenticator(),
+ webSearchStore,
+ }: {
+ authenticator?: Authenticator;
+ webSearchStore?: IWebSearchProviderStore;
+ } = {}): OpenAPIHono {
const db = createSqliteDb(':memory:');
+ const emptyWebSearchStore: IWebSearchProviderStore = {
+ getProvider: () => Promise.resolve(undefined),
+ upsertProvider: () => Promise.reject(new Error('not used')),
+ };
return withAuth(
createCapabilitiesRouter({
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => webSearchStore ?? emptyWebSearchStore,
withTransaction: callback => db.transaction().execute(callback),
logger: silentLogger,
resolveRequestContext,
@@ -102,6 +114,28 @@ describe('capabilities routers', () => {
});
});
+ it('reports web_search enabled when a provider is configured', async () => {
+ disableOidcAuth();
+ mockStatus.mockResolvedValue(undefined);
+ const configuredStore: IWebSearchProviderStore = {
+ getProvider: () =>
+ Promise.resolve({
+ tenant_id: 'default',
+ manifest: { type: 'parallel', auth: { api_key: 'test-key' } },
+ created_at: '2026-01-01T00:00:00.000Z',
+ updated_at: '2026-01-01T00:00:00.000Z',
+ }),
+ upsertProvider: () => Promise.reject(new Error('not used')),
+ };
+ const router = makeRouter({ webSearchStore: configuredStore });
+
+ const response = await router.request('/');
+ expect(response.status).toBe(200);
+ expect(await response.json()).toMatchObject({
+ data: { web_search: { enabled: true } },
+ });
+ });
+
it('reports sandbox + skill enabled when local fallback is cached and no image status exists', async () => {
disableOidcAuth();
mockStatus.mockResolvedValue(undefined);
@@ -247,9 +281,14 @@ describe('capabilities routers', () => {
it('marks settings enabled for admin callers and disabled for non-admin callers', async () => {
const db = createSqliteDb(':memory:');
await migrateSqliteToLatest(db);
+ const emptyWebSearchStore: IWebSearchProviderStore = {
+ getProvider: () => Promise.resolve(undefined),
+ upsertProvider: () => Promise.reject(new Error('not used')),
+ };
const router = withAuth(
createCapabilitiesRouter({
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => emptyWebSearchStore,
withTransaction: callback => db.transaction().execute(callback),
logger: silentLogger,
resolveRequestContext,
diff --git a/packages/trueforge/tests/unit/apis/deletedSessionCrud.test.ts b/packages/trueforge/tests/unit/apis/deletedSessionCrud.test.ts
index 4c48f6f63..51b5c5ea6 100644
--- a/packages/trueforge/tests/unit/apis/deletedSessionCrud.test.ts
+++ b/packages/trueforge/tests/unit/apis/deletedSessionCrud.test.ts
@@ -17,6 +17,7 @@ import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provi
import { SqliteSessionStore } from '../../../src/db/sqlite/session-store/SqliteSessionStore';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
import { SqliteOAuthTokenStore } from '../../../src/db/sqlite/token-store/SqliteOAuthTokenStore';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import { ActiveTurnRegistry } from '../../../src/runtime/activeTurns';
import { EventSubscriptionRegistry } from '../../../src/runtime/event-subscription/index.js';
import { ListSessionsResponseSchema } from '../../../src/schemas/session';
@@ -38,6 +39,7 @@ describe('public CRUD after session deletion', () => {
const skillStore = new SqliteSkillStore(db);
const agentStore = new SqliteAgentStore(db);
const sandboxProviderStore = new SqliteSandboxProviderStore(db);
+ const webSearchProviderStore = new SqliteWebSearchProviderStore(db);
const app = new OpenAPIHono();
app.route(
@@ -51,6 +53,7 @@ describe('public CRUD after session deletion', () => {
resolveSkillStore: () => skillStore,
resolveAgentStore: () => agentStore,
resolveSandboxProviderStore: () => sandboxProviderStore,
+ resolveWebSearchProviderStore: () => webSearchProviderStore,
redis: createClient(),
requestReplyRouter: new RequestReplyRouter(),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
@@ -70,6 +73,7 @@ describe('public CRUD after session deletion', () => {
resolveAgentStore: () => agentStore,
eventSubscriptions: new EventSubscriptionRegistry(undefined),
resolveSandboxProviderStore: () => sandboxProviderStore,
+ resolveWebSearchProviderStore: () => webSearchProviderStore,
logger: createLogger({ silent: true }),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: new TrueForgeAuthorizer(),
diff --git a/packages/trueforge/tests/unit/apis/mcpServers.test.ts b/packages/trueforge/tests/unit/apis/mcpServers.test.ts
index c950c9141..9c4f5dd33 100644
--- a/packages/trueforge/tests/unit/apis/mcpServers.test.ts
+++ b/packages/trueforge/tests/unit/apis/mcpServers.test.ts
@@ -7,6 +7,7 @@ import { McpCatalog } from '../../../src/catalog/McpCatalog';
import { ModelCatalog } from '../../../src/catalog/ModelCatalog';
import { SandboxCatalog } from '../../../src/catalog/SandboxCatalog';
import { SkillCatalog } from '../../../src/catalog/SkillCatalog';
+import { WebSearchCatalog } from '../../../src/catalog/WebSearchCatalog';
import configuration from '../../../src/config';
import { McpServerWithAuthStore } from '../../../src/db/McpServerWithAuthStore';
import type { IMcpServerWithAuthStore } from '../../../src/db/mcpServerStore';
@@ -143,6 +144,7 @@ describe('mcp-servers routers', () => {
mcpCatalog: McpCatalog.load(),
skillCatalog: SkillCatalog.load(),
sandboxCatalog: SandboxCatalog.load(),
+ webSearchCatalog: WebSearchCatalog.load(),
});
mcpServersRouter = createMcpServersRouter({
resolveMcpServerStore: () => mcpServerStore,
diff --git a/packages/trueforge/tests/unit/apis/modelProviders.test.ts b/packages/trueforge/tests/unit/apis/modelProviders.test.ts
index ed725b0cd..23d5ec809 100644
--- a/packages/trueforge/tests/unit/apis/modelProviders.test.ts
+++ b/packages/trueforge/tests/unit/apis/modelProviders.test.ts
@@ -8,6 +8,7 @@ import { McpCatalog } from '../../../src/catalog/McpCatalog';
import { ModelCatalog } from '../../../src/catalog/ModelCatalog';
import { SandboxCatalog } from '../../../src/catalog/SandboxCatalog';
import { SkillCatalog } from '../../../src/catalog/SkillCatalog';
+import { WebSearchCatalog } from '../../../src/catalog/WebSearchCatalog';
import configuration from '../../../src/config';
import { McpServerWithAuthStore } from '../../../src/db/McpServerWithAuthStore';
import { migrateSqliteToLatest } from '../../../src/db/migrateSqlite';
@@ -18,6 +19,7 @@ import { SqliteModelProviderStore } from '../../../src/db/sqlite/model-provider-
import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provider-store/SqliteSandboxProviderStore';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
import { SqliteOAuthTokenStore } from '../../../src/db/sqlite/token-store/SqliteOAuthTokenStore';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import { toRedactedSecretValue } from '../../../src/utils/secretRedaction';
const model = {
@@ -130,6 +132,7 @@ async function createRouters(): Promise<{
tokenStore,
resolveSkillStore: () => new SqliteSkillStore(db),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
withTransaction: callback => db.transaction().execute(callback),
logger: winston.createLogger({ silent: true }),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
@@ -139,6 +142,7 @@ async function createRouters(): Promise<{
mcpCatalog: McpCatalog.load(),
skillCatalog: SkillCatalog.load(),
sandboxCatalog: SandboxCatalog.load(),
+ webSearchCatalog: WebSearchCatalog.load(),
}),
modelsRouter: createModelsRouter({
resolveModelProviderStore: () => modelProviderStore,
diff --git a/packages/trueforge/tests/unit/apis/sandboxFileDownload.test.ts b/packages/trueforge/tests/unit/apis/sandboxFileDownload.test.ts
index 3ad136a6c..87ba267ab 100644
--- a/packages/trueforge/tests/unit/apis/sandboxFileDownload.test.ts
+++ b/packages/trueforge/tests/unit/apis/sandboxFileDownload.test.ts
@@ -15,6 +15,7 @@ import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provi
import { SqliteSessionStore } from '../../../src/db/sqlite/session-store/SqliteSessionStore';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
import { SqliteOAuthTokenStore } from '../../../src/db/sqlite/token-store/SqliteOAuthTokenStore';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import { ActiveTurnRegistry } from '../../../src/runtime/activeTurns';
import { EventSubscriptionRegistry } from '../../../src/runtime/event-subscription';
@@ -51,6 +52,7 @@ async function buildApp() {
resolveAgentStore: () => new SqliteAgentStore(db),
eventSubscriptions: new EventSubscriptionRegistry(undefined),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
logger: createLogger({ silent: true }),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: new TrueForgeAuthorizer(),
diff --git a/packages/trueforge/tests/unit/apis/sandboxProviders.test.ts b/packages/trueforge/tests/unit/apis/sandboxProviders.test.ts
index 56140983f..0be8b1c9a 100644
--- a/packages/trueforge/tests/unit/apis/sandboxProviders.test.ts
+++ b/packages/trueforge/tests/unit/apis/sandboxProviders.test.ts
@@ -17,6 +17,7 @@ import { McpCatalog } from '../../../src/catalog/McpCatalog';
import { ModelCatalog } from '../../../src/catalog/ModelCatalog';
import { SandboxCatalog } from '../../../src/catalog/SandboxCatalog';
import { SkillCatalog } from '../../../src/catalog/SkillCatalog';
+import { WebSearchCatalog } from '../../../src/catalog/WebSearchCatalog';
import { migrateSqliteToLatest } from '../../../src/db/migrateSqlite';
import type { ISandboxProviderStore } from '../../../src/db/sandboxProviderStore';
import { createSqliteDb } from '../../../src/db/sqlite/client';
@@ -123,6 +124,7 @@ describe('sandboxProviders router', () => {
mcpCatalog: McpCatalog.load(),
skillCatalog: SkillCatalog.load(),
sandboxCatalog: SandboxCatalog.load(),
+ webSearchCatalog: WebSearchCatalog.load(),
});
});
diff --git a/packages/trueforge/tests/unit/apis/schedules.test.ts b/packages/trueforge/tests/unit/apis/schedules.test.ts
index af4b1bf1f..199272e38 100644
--- a/packages/trueforge/tests/unit/apis/schedules.test.ts
+++ b/packages/trueforge/tests/unit/apis/schedules.test.ts
@@ -72,6 +72,7 @@ function stubTurnExecutionDeps(agentStore: SqliteAgentStore, scheduleStore: Sqli
resolveMcpServerStore: () => ({}) as never,
turnSkillsResolverStore: { resolveTurnSkills: async () => [] },
resolveSandboxProviderStore: () => ({}) as never,
+ resolveWebSearchProviderStore: () => ({}) as never,
};
}
diff --git a/packages/trueforge/tests/unit/apis/sessionHttp.test.ts b/packages/trueforge/tests/unit/apis/sessionHttp.test.ts
index 43e94f0b4..5e64789f2 100644
--- a/packages/trueforge/tests/unit/apis/sessionHttp.test.ts
+++ b/packages/trueforge/tests/unit/apis/sessionHttp.test.ts
@@ -20,6 +20,7 @@ import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provi
import { SqliteSessionMetricsStore } from '../../../src/db/sqlite/session-metrics/SqliteSessionMetricsStore';
import { SqliteSessionStore } from '../../../src/db/sqlite/session-store/SqliteSessionStore';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import { ActiveTurnRegistry } from '../../../src/runtime/activeTurns';
import { ListSessionsResponseSchema } from '../../../src/schemas/session';
import {
@@ -68,6 +69,7 @@ describe('sessions HTTP agent binding', () => {
const mcpServerStore = new SqliteMcpServerStore(db);
const skillStore = new SqliteSkillStore(db);
const sandboxProviderStore = new SqliteSandboxProviderStore(db);
+ const webSearchProviderStore = new SqliteWebSearchProviderStore(db);
agentStore = new SqliteAgentStore(db);
await modelProviderStore.upsertProvider({
@@ -96,6 +98,7 @@ describe('sessions HTTP agent binding', () => {
resolveSkillStore: () => skillStore,
resolveAgentStore: () => agentStore,
resolveSandboxProviderStore: () => sandboxProviderStore,
+ resolveWebSearchProviderStore: () => webSearchProviderStore,
redis: createClient(),
requestReplyRouter: new RequestReplyRouter(),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
diff --git a/packages/trueforge/tests/unit/apis/skills.test.ts b/packages/trueforge/tests/unit/apis/skills.test.ts
index c3d37cd95..8f637b472 100644
--- a/packages/trueforge/tests/unit/apis/skills.test.ts
+++ b/packages/trueforge/tests/unit/apis/skills.test.ts
@@ -5,6 +5,7 @@ import { McpCatalog } from '../../../src/catalog/McpCatalog';
import { ModelCatalog } from '../../../src/catalog/ModelCatalog';
import { SandboxCatalog } from '../../../src/catalog/SandboxCatalog';
import { SkillCatalog } from '../../../src/catalog/SkillCatalog';
+import { WebSearchCatalog } from '../../../src/catalog/WebSearchCatalog';
import { migrateSqliteToLatest } from '../../../src/db/migrateSqlite';
import { createSqliteDb } from '../../../src/db/sqlite/client';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
@@ -62,6 +63,7 @@ describe('skills routers', () => {
mcpCatalog: McpCatalog.load(),
skillCatalog: SkillCatalog.load(),
sandboxCatalog: SandboxCatalog.load(),
+ webSearchCatalog: WebSearchCatalog.load(),
});
availableRouter = createAvailableSkillsRouter({
resolveSkillStore: () => skillStore,
diff --git a/packages/trueforge/tests/unit/apis/turnHarnessErrorStatus.test.ts b/packages/trueforge/tests/unit/apis/turnHarnessErrorStatus.test.ts
index eb270a7ca..a9e444870 100644
--- a/packages/trueforge/tests/unit/apis/turnHarnessErrorStatus.test.ts
+++ b/packages/trueforge/tests/unit/apis/turnHarnessErrorStatus.test.ts
@@ -15,6 +15,7 @@ import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provi
import { SqliteSessionStore } from '../../../src/db/sqlite/session-store/SqliteSessionStore';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
import { SqliteOAuthTokenStore } from '../../../src/db/sqlite/token-store/SqliteOAuthTokenStore';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import { ActiveTurnRegistry } from '../../../src/runtime/activeTurns';
import { EventSubscriptionRegistry } from '../../../src/runtime/event-subscription/index.js';
@@ -79,6 +80,7 @@ async function postTurnRejectingWith(error: AgentHarnessError): Promise<Response
resolveAgentStore: () => new SqliteAgentStore(db),
eventSubscriptions: new EventSubscriptionRegistry(undefined),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
logger: createLogger({ silent: true }),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: new TrueForgeAuthorizer(),
diff --git a/packages/trueforge/tests/unit/apis/turns.test.ts b/packages/trueforge/tests/unit/apis/turns.test.ts
index 1d893d6e3..b8bdc9be2 100644
--- a/packages/trueforge/tests/unit/apis/turns.test.ts
+++ b/packages/trueforge/tests/unit/apis/turns.test.ts
@@ -21,6 +21,7 @@ import { SqliteSessionStore } from '../../../src/db/sqlite/session-store/SqliteS
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
import { SqliteOAuthTokenStore } from '../../../src/db/sqlite/token-store/SqliteOAuthTokenStore';
import type { Database } from '../../../src/db/sqlite/types';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import { ActiveTurnRegistry } from '../../../src/runtime/activeTurns';
import { EventSubscriptionRegistry } from '../../../src/runtime/event-subscription/index.js';
@@ -75,6 +76,7 @@ describe('turns', () => {
resolveAgentStore: () => new SqliteAgentStore(db),
eventSubscriptions: new EventSubscriptionRegistry(undefined),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
logger: createLogger({ silent: true }),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: new TrueForgeAuthorizer(),
@@ -152,6 +154,7 @@ describe('turns', () => {
resolveAgentStore: () => agentStore,
eventSubscriptions: new EventSubscriptionRegistry(undefined),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
logger: createLogger({ silent: true }),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: {
@@ -233,6 +236,7 @@ describe('turns', () => {
resolveAgentStore: () => new SqliteAgentStore(db),
eventSubscriptions: new EventSubscriptionRegistry(undefined),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
logger: createLogger({ silent: true }),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: new TrueForgeAuthorizer(),
@@ -339,6 +343,7 @@ describe('turns', () => {
resolveSkillStore: () => new SqliteSkillStore(db),
eventSubscriptions,
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
logger,
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: new TrueForgeAuthorizer(),
@@ -446,6 +451,7 @@ describe('turns', () => {
resolveAgentStore: () => new SqliteAgentStore(db),
eventSubscriptions: new EventSubscriptionRegistry(undefined),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
logger,
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer: new TrueForgeAuthorizer(),
@@ -531,6 +537,7 @@ describe('turns', () => {
resolveAgentStore: () => agentStore,
eventSubscriptions: new EventSubscriptionRegistry(undefined),
resolveSandboxProviderStore: () => new SqliteSandboxProviderStore(db),
+ resolveWebSearchProviderStore: () => new SqliteWebSearchProviderStore(db),
logger: createLogger({ silent: true }),
resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
authorizer,
diff --git a/packages/trueforge/tests/unit/apis/webSearchProviders.test.ts b/packages/trueforge/tests/unit/apis/webSearchProviders.test.ts
new file mode 100644
index 000000000..ddb050c2c
--- /dev/null
+++ b/packages/trueforge/tests/unit/apis/webSearchProviders.test.ts
@@ -0,0 +1,85 @@
+import { createWebSearchProvidersRouter } from '../../../src/apis/webSearchProviders';
+import { STANDALONE_REQUEST_CONTEXT } from '../../../src/auth/identity';
+import { migrateSqliteToLatest } from '../../../src/db/migrateSqlite';
+import { createSqliteDb } from '../../../src/db/sqlite/client';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
+import { toRedactedSecretValue } from '../../../src/utils/secretRedaction';
+
+function putInit(manifest: unknown): RequestInit {
+ return {
+ method: 'PUT',
+ headers: { 'content-type': 'application/json' },
+ body: JSON.stringify({ manifest }),
+ };
+}
+
+async function createRouter() {
+ const db = createSqliteDb(':memory:');
+ await migrateSqliteToLatest(db);
+ const store = new SqliteWebSearchProviderStore(db);
+ const router = createWebSearchProvidersRouter({
+ resolveWebSearchProviderStore: () => store,
+ resolveRequestContext: () => STANDALONE_REQUEST_CONTEXT,
+ });
+ return { router, store };
+}
+
+describe('settings web-search-providers router', () => {
+ it('GET returns 404 when none configured', async () => {
+ const { router } = await createRouter();
+ const response = await router.request('/');
+ expect(response.status).toBe(404);
+ expect(await response.json()).toEqual({ error: { message: 'No web search provider configured' } });
+ });
+
+ it('PUT without auth is rejected', async () => {
+ const { router } = await createRouter();
+ const put = await router.request('/', putInit({ type: 'parallel' }));
+ expect(put.status).toBe(400);
+ });
+
+ it('PUT with api_key upserts the singleton, redacts on response, and second PUT replaces the same row', async () => {
+ const { router, store } = await createRouter();
+ const apiKey = 'parallel-secret-key';
+ const created = await router.request('/', putInit({ type: 'parallel', auth: { api_key: apiKey } }));
+ expect(created.status).toBe(200);
+ expect(await created.json()).toEqual({
+ data: {
+ name: 'parallel',
+ manifest: { type: 'parallel', auth: { api_key: toRedactedSecretValue(apiKey) } },
+ },
+ });
+
+ const get = await router.request('/');
+ expect(get.status).toBe(200);
+ expect(await get.json()).toEqual({
+ data: {
+ name: 'parallel',
+ manifest: { type: 'parallel', auth: { api_key: toRedactedSecretValue(apiKey) } },
+ },
+ });
+
+ const first = await store.getProvider('default');
+ expect(first?.manifest.auth.api_key).toBe(apiKey);
+
+ const rotated = await router.request('/', putInit({ type: 'parallel', auth: { api_key: 'parallel-rotated-key' } }));
+ expect(rotated.status).toBe(200);
+
+ const second = await store.getProvider('default');
+ expect(second?.manifest.auth.api_key).toBe('parallel-rotated-key');
+ expect(second?.created_at).toBe(first?.created_at);
+ });
+
+ it('PUT with redacted api_key keeps the stored secret', async () => {
+ const { router, store } = await createRouter();
+ const apiKey = 'parallel-keep-secret';
+ await router.request('/', putInit({ type: 'parallel', auth: { api_key: apiKey } }));
+
+ const keep = await router.request(
+ '/',
+ putInit({ type: 'parallel', auth: { api_key: toRedactedSecretValue(apiKey) } }),
+ );
+ expect(keep.status).toBe(200);
+ expect((await store.getProvider('default'))?.manifest.auth.api_key).toBe(apiKey);
+ });
+});
diff --git a/packages/trueforge/tests/unit/runtime/sessionResources.test.ts b/packages/trueforge/tests/unit/runtime/sessionResources.test.ts
index 5bb8a7c89..839655c29 100644
--- a/packages/trueforge/tests/unit/runtime/sessionResources.test.ts
+++ b/packages/trueforge/tests/unit/runtime/sessionResources.test.ts
@@ -5,7 +5,6 @@ import {
type SessionAgent,
type SessionHandle,
} from '@truefoundry/trueforge-core/agent-session';
-import { WebSearchProviders, type IWebSearchProvider } from '@truefoundry/trueforge-core/core';
import { HTTPException } from 'hono/http-exception';
import { validateGitAgentSkills } from '../../../src/db/gitSkillMounts';
import { migrateSqliteToLatest } from '../../../src/db/migrateSqlite';
@@ -15,6 +14,7 @@ import { SqliteMcpServerStore } from '../../../src/db/sqlite/mcp-server-store/Sq
import { SqliteModelProviderStore } from '../../../src/db/sqlite/model-provider-store/SqliteModelProviderStore';
import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provider-store/SqliteSandboxProviderStore';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
+import { SqliteWebSearchProviderStore } from '../../../src/db/sqlite/web-search-provider-store/SqliteWebSearchProviderStore';
import {
buildGatewayMetadata,
getModelDetails,
@@ -28,18 +28,12 @@ import {
} from '../../../src/runtime/sessionResources';
import { setCachedLocalSandboxSupport } from '../../../src/sandbox/localRuntime';
import type { ReasoningEffort } from '../../../src/schemas/modelProvider';
-import { resolveWebSearchProvider } from '../../../src/websearch/providers';
+import { hasConfiguredWebSearchProvider } from '../../../src/websearch/providers';
jest.mock('../../../src/websearch/providers', () => ({
- resolveWebSearchProvider: jest.fn(() => undefined),
+ hasConfiguredWebSearchProvider: jest.fn(() => Promise.resolve(false)),
}));
-const mockWebSearchProvider: IWebSearchProvider = {
- id: WebSearchProviders.Parallel,
- search: () => Promise.resolve({ hits: [] }),
- fetch: () => Promise.resolve({ pages: [] }),
-};
-
async function createGatewayMetadataSession(input: { agent: SessionAgent }): Promise<SessionHandle> {
const sessions = new Sessions({ sessionStore: new InMemorySessionStore() });
return sessions.create({
@@ -176,8 +170,8 @@ describe('localSandboxSessionSegment', () => {
describe('validateAgentSpec', () => {
afterEach(() => {
setCachedLocalSandboxSupport(undefined);
- jest.mocked(resolveWebSearchProvider).mockReset();
- jest.mocked(resolveWebSearchProvider).mockReturnValue(undefined);
+ jest.mocked(hasConfiguredWebSearchProvider).mockReset();
+ jest.mocked(hasConfiguredWebSearchProvider).mockResolvedValue(false);
});
async function setup(options?: { reasoningEfforts?: ReasoningEffort[] | undefined }) {
@@ -211,6 +205,7 @@ describe('validateAgentSpec', () => {
mcpServerStore: new SqliteMcpServerStore(db),
skillStore: new SqliteSkillStore(db),
sandboxProviderStore: new SqliteSandboxProviderStore(db),
+ webSearchProviderStore: new SqliteWebSearchProviderStore(db),
};
}
@@ -376,7 +371,7 @@ describe('validateAgentSpec', () => {
it('admits web_search.enabled when a web-search provider resolves', async () => {
const stores = await setup();
- jest.mocked(resolveWebSearchProvider).mockReturnValueOnce(mockWebSearchProvider);
+ jest.mocked(hasConfiguredWebSearchProvider).mockResolvedValueOnce(true);
await expect(
validateAgentSpec({
spec: AgentSpecSchema.parse({
diff --git a/python/trueforge_sdk/reference.md b/python/trueforge_sdk/reference.md
index aa8c83132..e6f916a46 100644
--- a/python/trueforge_sdk/reference.md
+++ b/python/trueforge_sdk/reference.md
@@ -3303,6 +3303,69 @@ client.catalogs.skills.list()
</dl>
+</dd>
+</dl>
+</details>
+
+## Catalogs WebSearchProviders
+<details><summary><code>client.catalogs.web_search_providers.<a href="src/trueforge_sdk/catalogs/web_search_providers/client.py">list</a>() -> GetWebSearchProviderCatalogResponse</code></summary>
+<dl>
+<dd>
+
+#### πŸ“ Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Shipped web-search provider presets.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### πŸ”Œ Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from trueforge_sdk import TrueForge
+
+client = TrueForge(
+ token="<token>",
+ base_url="https://yourhost.com/path/to/api",
+)
+
+client.catalogs.web_search_providers.list()
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### βš™οΈ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
</dd>
</dl>
</details>
@@ -4690,3 +4753,143 @@ client.settings.skills.create_or_update(
</dl>
</details>
+## Settings WebSearchProviders
+<details><summary><code>client.settings.web_search_providers.<a href="src/trueforge_sdk/settings/web_search_providers/client.py">get</a>() -> GetWebSearchProviderResponse</code></summary>
+<dl>
+<dd>
+
+#### πŸ“ Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The configured provider for this tenant. `auth.api_key` is redacted when present.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### πŸ”Œ Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from trueforge_sdk import TrueForge
+
+client = TrueForge(
+ token="<token>",
+ base_url="https://yourhost.com/path/to/api",
+)
+
+client.settings.web_search_providers.get()
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### βš™οΈ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.settings.web_search_providers.<a href="src/trueforge_sdk/settings/web_search_providers/client.py">create_or_update</a>(...) -> GetWebSearchProviderResponse</code></summary>
+<dl>
+<dd>
+
+#### πŸ“ Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### πŸ”Œ Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from trueforge_sdk import TrueForge, WebSearchProviderManifest, ParallelWebSearchProviderAuth
+
+client = TrueForge(
+ token="<token>",
+ base_url="https://yourhost.com/path/to/api",
+)
+
+client.settings.web_search_providers.create_or_update(
+ manifest=WebSearchProviderManifest(
+ auth=ParallelWebSearchProviderAuth(
+ api_key="api_key",
+ ),
+ type="parallel",
+ ),
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### βš™οΈ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**manifest:** `WebSearchProviderManifest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
diff --git a/python/trueforge_sdk/src/trueforge_sdk/__init__.py b/python/trueforge_sdk/src/trueforge_sdk/__init__.py
index 7242c3c63..9b49e63fa 100644
--- a/python/trueforge_sdk/src/trueforge_sdk/__init__.py
+++ b/python/trueforge_sdk/src/trueforge_sdk/__init__.py
@@ -38,6 +38,7 @@ if typing.TYPE_CHECKING:
CatalogSandboxProvider,
CatalogSkill,
CatalogSkillType,
+ CatalogWebSearchProvider,
CatalogWellKnownModelProvider,
CatalogWellKnownModelProviderType,
ChatCompletionChunkDeltaToolCall,
@@ -52,6 +53,7 @@ if typing.TYPE_CHECKING:
ConfiguredModelProvider,
ConfiguredSandboxProvider,
ConfiguredSkill,
+ ConfiguredWebSearchProvider,
ContextManagementConfig,
CreateScheduleRunResponse,
CreateSessionAgent,
@@ -87,6 +89,8 @@ if typing.TYPE_CHECKING:
GetSkillCatalogResponse,
GetSkillResponse,
GetTurnResponse,
+ GetWebSearchProviderCatalogResponse,
+ GetWebSearchProviderResponse,
GitSkill,
GoogleGeminiModelProvider,
InitialUserMessage,
@@ -145,6 +149,7 @@ if typing.TYPE_CHECKING:
ModelProviderManifest,
MoonshotModelProvider,
OpenAiModelProvider,
+ ParallelWebSearchProviderAuth,
PermissionResourceType,
PreviousTurnIdInput,
RawToolCall,
@@ -243,6 +248,7 @@ if typing.TYPE_CHECKING:
UserToolResponseEvent,
WebSearchCapability,
WebSearchConfig,
+ WebSearchProviderManifest,
ZaiModelProvider,
)
from .errors import (
@@ -298,6 +304,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"CatalogSandboxProvider": ".types",
"CatalogSkill": ".types",
"CatalogSkillType": ".types",
+ "CatalogWebSearchProvider": ".types",
"CatalogWellKnownModelProvider": ".types",
"CatalogWellKnownModelProviderType": ".types",
"ChatCompletionChunkDeltaToolCall": ".types",
@@ -312,6 +319,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ConfiguredModelProvider": ".types",
"ConfiguredSandboxProvider": ".types",
"ConfiguredSkill": ".types",
+ "ConfiguredWebSearchProvider": ".types",
"ConflictError": ".errors",
"ContentTooLargeError": ".errors",
"ContextManagementConfig": ".types",
@@ -353,6 +361,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"GetSkillCatalogResponse": ".types",
"GetSkillResponse": ".types",
"GetTurnResponse": ".types",
+ "GetWebSearchProviderCatalogResponse": ".types",
+ "GetWebSearchProviderResponse": ".types",
"GitSkill": ".types",
"GoneError": ".errors",
"GoogleGeminiModelProvider": ".types",
@@ -414,6 +424,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"MoonshotModelProvider": ".types",
"NotFoundError": ".errors",
"OpenAiModelProvider": ".types",
+ "ParallelWebSearchProviderAuth": ".types",
"PermissionResourceType": ".types",
"PreconditionFailedError": ".errors",
"PreviousTurnIdInput": ".types",
@@ -516,6 +527,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"UserToolResponseEvent": ".types",
"WebSearchCapability": ".types",
"WebSearchConfig": ".types",
+ "WebSearchProviderManifest": ".types",
"ZaiModelProvider": ".types",
"__version__": ".version",
"agents": ".agents",
@@ -588,6 +600,7 @@ __all__ = [
"CatalogSandboxProvider",
"CatalogSkill",
"CatalogSkillType",
+ "CatalogWebSearchProvider",
"CatalogWellKnownModelProvider",
"CatalogWellKnownModelProviderType",
"ChatCompletionChunkDeltaToolCall",
@@ -602,6 +615,7 @@ __all__ = [
"ConfiguredModelProvider",
"ConfiguredSandboxProvider",
"ConfiguredSkill",
+ "ConfiguredWebSearchProvider",
"ConflictError",
"ContentTooLargeError",
"ContextManagementConfig",
@@ -643,6 +657,8 @@ __all__ = [
"GetSkillCatalogResponse",
"GetSkillResponse",
"GetTurnResponse",
+ "GetWebSearchProviderCatalogResponse",
+ "GetWebSearchProviderResponse",
"GitSkill",
"GoneError",
"GoogleGeminiModelProvider",
@@ -704,6 +720,7 @@ __all__ = [
"MoonshotModelProvider",
"NotFoundError",
"OpenAiModelProvider",
+ "ParallelWebSearchProviderAuth",
"PermissionResourceType",
"PreconditionFailedError",
"PreviousTurnIdInput",
@@ -806,6 +823,7 @@ __all__ = [
"UserToolResponseEvent",
"WebSearchCapability",
"WebSearchConfig",
+ "WebSearchProviderManifest",
"ZaiModelProvider",
"__version__",
"agents",
diff --git a/python/trueforge_sdk/src/trueforge_sdk/catalogs/__init__.py b/python/trueforge_sdk/src/trueforge_sdk/catalogs/__init__.py
index c8555edfe..0755f2665 100644
--- a/python/trueforge_sdk/src/trueforge_sdk/catalogs/__init__.py
+++ b/python/trueforge_sdk/src/trueforge_sdk/catalogs/__init__.py
@@ -6,12 +6,13 @@ import typing
from importlib import import_module
if typing.TYPE_CHECKING:
- from . import mcp_servers, model_providers, sandbox_providers, skills
+ from . import mcp_servers, model_providers, sandbox_providers, skills, web_search_providers
_dynamic_imports: typing.Dict[str, str] = {
"mcp_servers": ".mcp_servers",
"model_providers": ".model_providers",
"sandbox_providers": ".sandbox_providers",
"skills": ".skills",
+ "web_search_providers": ".web_search_providers",
}
@@ -36,4 +37,4 @@ def __dir__():
return sorted(lazy_attrs)
-__all__ = ["mcp_servers", "model_providers", "sandbox_providers", "skills"]
+__all__ = ["mcp_servers", "model_providers", "sandbox_providers", "skills", "web_search_providers"]
diff --git a/python/trueforge_sdk/src/trueforge_sdk/catalogs/client.py b/python/trueforge_sdk/src/trueforge_sdk/catalogs/client.py
index d74c24af1..9d97a177c 100644
--- a/python/trueforge_sdk/src/trueforge_sdk/catalogs/client.py
+++ b/python/trueforge_sdk/src/trueforge_sdk/catalogs/client.py
@@ -12,6 +12,7 @@ if typing.TYPE_CHECKING:
from .model_providers.client import AsyncModelProvidersClient, ModelProvidersClient
from .sandbox_providers.client import AsyncSandboxProvidersClient, SandboxProvidersClient
from .skills.client import AsyncSkillsClient, SkillsClient
+ from .web_search_providers.client import AsyncWebSearchProvidersClient, WebSearchProvidersClient
class CatalogsClient:
@@ -22,6 +23,7 @@ class CatalogsClient:
self._model_providers: typing.Optional[ModelProvidersClient] = None
self._sandbox_providers: typing.Optional[SandboxProvidersClient] = None
self._skills: typing.Optional[SkillsClient] = None
+ self._web_search_providers: typing.Optional[WebSearchProvidersClient] = None
@property
def with_raw_response(self) -> RawCatalogsClient:
@@ -66,6 +68,14 @@ class CatalogsClient:
self._skills = SkillsClient(client_wrapper=self._client_wrapper)
return self._skills
+ @property
+ def web_search_providers(self):
+ if self._web_search_providers is None:
+ from .web_search_providers.client import WebSearchProvidersClient # noqa: E402
+
+ self._web_search_providers = WebSearchProvidersClient(client_wrapper=self._client_wrapper)
+ return self._web_search_providers
+
class AsyncCatalogsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -75,6 +85,7 @@ class AsyncCatalogsClient:
self._model_providers: typing.Optional[AsyncModelProvidersClient] = None
self._sandbox_providers: typing.Optional[AsyncSandboxProvidersClient] = None
self._skills: typing.Optional[AsyncSkillsClient] = None
+ self._web_search_providers: typing.Optional[AsyncWebSearchProvidersClient] = None
@property
def with_raw_response(self) -> AsyncRawCatalogsClient:
@@ -118,3 +129,11 @@ class AsyncCatalogsClient:
self._skills = AsyncSkillsClient(client_wrapper=self._client_wrapper)
return self._skills
+
+ @property
+ def web_search_providers(self):
+ if self._web_search_providers is None:
+ from .web_search_providers.client import AsyncWebSearchProvidersClient # noqa: E402
+
+ self._web_search_providers = AsyncWebSearchProvidersClient(client_wrapper=self._client_wrapper)
+ return self._web_search_providers
diff --git a/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/__init__.py b/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/__init__.py
new file mode 100644
index 000000000..5cde0202d
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/__init__.py
@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
diff --git a/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/client.py b/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/client.py
new file mode 100644
index 000000000..4bb6f981c
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/client.py
@@ -0,0 +1,104 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.get_web_search_provider_catalog_response import GetWebSearchProviderCatalogResponse
+from .raw_client import AsyncRawWebSearchProvidersClient, RawWebSearchProvidersClient
+
+
+class WebSearchProvidersClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawWebSearchProvidersClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawWebSearchProvidersClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawWebSearchProvidersClient
+ """
+ return self._raw_client
+
+ def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> GetWebSearchProviderCatalogResponse:
+ """
+ Shipped web-search provider presets.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GetWebSearchProviderCatalogResponse
+ Shipped web-search provider presets.
+
+ Examples
+ --------
+ from trueforge_sdk import TrueForge
+
+ client = TrueForge(
+ token="YOUR_TOKEN",
+ base_url="https://yourhost.com/path/to/api",
+ )
+ client.catalogs.web_search_providers.list()
+ """
+ _response = self._raw_client.list(request_options=request_options)
+ return _response.data
+
+
+class AsyncWebSearchProvidersClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawWebSearchProvidersClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawWebSearchProvidersClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawWebSearchProvidersClient
+ """
+ return self._raw_client
+
+ async def list(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> GetWebSearchProviderCatalogResponse:
+ """
+ Shipped web-search provider presets.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GetWebSearchProviderCatalogResponse
+ Shipped web-search provider presets.
+
+ Examples
+ --------
+ import asyncio
+
+ from trueforge_sdk import AsyncTrueForge
+
+ client = AsyncTrueForge(
+ token="YOUR_TOKEN",
+ base_url="https://yourhost.com/path/to/api",
+ )
+
+
+ async def main() -> None:
+ await client.catalogs.web_search_providers.list()
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.list(request_options=request_options)
+ return _response.data
diff --git a/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/raw_client.py b/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/raw_client.py
new file mode 100644
index 000000000..15a2ac908
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/catalogs/web_search_providers/raw_client.py
@@ -0,0 +1,127 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.parse_error import ParsingError
+from ...core.request_options import RequestOptions
+from ...core.unchecked_base_model import construct_type
+from ...errors.unauthorized_error import UnauthorizedError
+from ...types.get_web_search_provider_catalog_response import GetWebSearchProviderCatalogResponse
+from ...types.request_error_response import RequestErrorResponse
+from pydantic import ValidationError
+
+
+class RawWebSearchProvidersClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def list(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[GetWebSearchProviderCatalogResponse]:
+ """
+ Shipped web-search provider presets.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[GetWebSearchProviderCatalogResponse]
+ Shipped web-search provider presets.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ "api/v1/catalogs/web-search-providers",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GetWebSearchProviderCatalogResponse,
+ construct_type(
+ type_=GetWebSearchProviderCatalogResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawWebSearchProvidersClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def list(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[GetWebSearchProviderCatalogResponse]:
+ """
+ Shipped web-search provider presets.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[GetWebSearchProviderCatalogResponse]
+ Shipped web-search provider presets.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ "api/v1/catalogs/web-search-providers",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GetWebSearchProviderCatalogResponse,
+ construct_type(
+ type_=GetWebSearchProviderCatalogResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/python/trueforge_sdk/src/trueforge_sdk/settings/__init__.py b/python/trueforge_sdk/src/trueforge_sdk/settings/__init__.py
index c8555edfe..0755f2665 100644
--- a/python/trueforge_sdk/src/trueforge_sdk/settings/__init__.py
+++ b/python/trueforge_sdk/src/trueforge_sdk/settings/__init__.py
@@ -6,12 +6,13 @@ import typing
from importlib import import_module
if typing.TYPE_CHECKING:
- from . import mcp_servers, model_providers, sandbox_providers, skills
+ from . import mcp_servers, model_providers, sandbox_providers, skills, web_search_providers
_dynamic_imports: typing.Dict[str, str] = {
"mcp_servers": ".mcp_servers",
"model_providers": ".model_providers",
"sandbox_providers": ".sandbox_providers",
"skills": ".skills",
+ "web_search_providers": ".web_search_providers",
}
@@ -36,4 +37,4 @@ def __dir__():
return sorted(lazy_attrs)
-__all__ = ["mcp_servers", "model_providers", "sandbox_providers", "skills"]
+__all__ = ["mcp_servers", "model_providers", "sandbox_providers", "skills", "web_search_providers"]
diff --git a/python/trueforge_sdk/src/trueforge_sdk/settings/client.py b/python/trueforge_sdk/src/trueforge_sdk/settings/client.py
index 26014cb68..d37bd7ade 100644
--- a/python/trueforge_sdk/src/trueforge_sdk/settings/client.py
+++ b/python/trueforge_sdk/src/trueforge_sdk/settings/client.py
@@ -12,6 +12,7 @@ if typing.TYPE_CHECKING:
from .model_providers.client import AsyncModelProvidersClient, ModelProvidersClient
from .sandbox_providers.client import AsyncSandboxProvidersClient, SandboxProvidersClient
from .skills.client import AsyncSkillsClient, SkillsClient
+ from .web_search_providers.client import AsyncWebSearchProvidersClient, WebSearchProvidersClient
class SettingsClient:
@@ -22,6 +23,7 @@ class SettingsClient:
self._model_providers: typing.Optional[ModelProvidersClient] = None
self._sandbox_providers: typing.Optional[SandboxProvidersClient] = None
self._skills: typing.Optional[SkillsClient] = None
+ self._web_search_providers: typing.Optional[WebSearchProvidersClient] = None
@property
def with_raw_response(self) -> RawSettingsClient:
@@ -66,6 +68,14 @@ class SettingsClient:
self._skills = SkillsClient(client_wrapper=self._client_wrapper)
return self._skills
+ @property
+ def web_search_providers(self):
+ if self._web_search_providers is None:
+ from .web_search_providers.client import WebSearchProvidersClient # noqa: E402
+
+ self._web_search_providers = WebSearchProvidersClient(client_wrapper=self._client_wrapper)
+ return self._web_search_providers
+
class AsyncSettingsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -75,6 +85,7 @@ class AsyncSettingsClient:
self._model_providers: typing.Optional[AsyncModelProvidersClient] = None
self._sandbox_providers: typing.Optional[AsyncSandboxProvidersClient] = None
self._skills: typing.Optional[AsyncSkillsClient] = None
+ self._web_search_providers: typing.Optional[AsyncWebSearchProvidersClient] = None
@property
def with_raw_response(self) -> AsyncRawSettingsClient:
@@ -118,3 +129,11 @@ class AsyncSettingsClient:
self._skills = AsyncSkillsClient(client_wrapper=self._client_wrapper)
return self._skills
+
+ @property
+ def web_search_providers(self):
+ if self._web_search_providers is None:
+ from .web_search_providers.client import AsyncWebSearchProvidersClient # noqa: E402
+
+ self._web_search_providers = AsyncWebSearchProvidersClient(client_wrapper=self._client_wrapper)
+ return self._web_search_providers
diff --git a/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/__init__.py b/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/__init__.py
new file mode 100644
index 000000000..5cde0202d
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/__init__.py
@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
diff --git a/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/client.py b/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/client.py
new file mode 100644
index 000000000..dd3f9d838
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/client.py
@@ -0,0 +1,196 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.get_web_search_provider_response import GetWebSearchProviderResponse
+from ...types.web_search_provider_manifest import WebSearchProviderManifest
+from .raw_client import AsyncRawWebSearchProvidersClient, RawWebSearchProvidersClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class WebSearchProvidersClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawWebSearchProvidersClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawWebSearchProvidersClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawWebSearchProvidersClient
+ """
+ return self._raw_client
+
+ def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> GetWebSearchProviderResponse:
+ """
+ The configured provider for this tenant. `auth.api_key` is redacted when present.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GetWebSearchProviderResponse
+ The configured web search provider.
+
+ Examples
+ --------
+ from trueforge_sdk import TrueForge
+
+ client = TrueForge(
+ token="YOUR_TOKEN",
+ base_url="https://yourhost.com/path/to/api",
+ )
+ client.settings.web_search_providers.get()
+ """
+ _response = self._raw_client.get(request_options=request_options)
+ return _response.data
+
+ def create_or_update(
+ self, *, manifest: WebSearchProviderManifest, request_options: typing.Optional[RequestOptions] = None
+ ) -> GetWebSearchProviderResponse:
+ """
+ Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
+
+ Parameters
+ ----------
+ manifest : WebSearchProviderManifest
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GetWebSearchProviderResponse
+ The saved provider.
+
+ Examples
+ --------
+ from trueforge_sdk import (
+ ParallelWebSearchProviderAuth,
+ TrueForge,
+ WebSearchProviderManifest,
+ )
+
+ client = TrueForge(
+ token="YOUR_TOKEN",
+ base_url="https://yourhost.com/path/to/api",
+ )
+ client.settings.web_search_providers.create_or_update(
+ manifest=WebSearchProviderManifest(
+ auth=ParallelWebSearchProviderAuth(
+ api_key="api_key",
+ ),
+ ),
+ )
+ """
+ _response = self._raw_client.create_or_update(manifest=manifest, request_options=request_options)
+ return _response.data
+
+
+class AsyncWebSearchProvidersClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawWebSearchProvidersClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawWebSearchProvidersClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawWebSearchProvidersClient
+ """
+ return self._raw_client
+
+ async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> GetWebSearchProviderResponse:
+ """
+ The configured provider for this tenant. `auth.api_key` is redacted when present.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GetWebSearchProviderResponse
+ The configured web search provider.
+
+ Examples
+ --------
+ import asyncio
+
+ from trueforge_sdk import AsyncTrueForge
+
+ client = AsyncTrueForge(
+ token="YOUR_TOKEN",
+ base_url="https://yourhost.com/path/to/api",
+ )
+
+
+ async def main() -> None:
+ await client.settings.web_search_providers.get()
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.get(request_options=request_options)
+ return _response.data
+
+ async def create_or_update(
+ self, *, manifest: WebSearchProviderManifest, request_options: typing.Optional[RequestOptions] = None
+ ) -> GetWebSearchProviderResponse:
+ """
+ Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
+
+ Parameters
+ ----------
+ manifest : WebSearchProviderManifest
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GetWebSearchProviderResponse
+ The saved provider.
+
+ Examples
+ --------
+ import asyncio
+
+ from trueforge_sdk import (
+ AsyncTrueForge,
+ ParallelWebSearchProviderAuth,
+ WebSearchProviderManifest,
+ )
+
+ client = AsyncTrueForge(
+ token="YOUR_TOKEN",
+ base_url="https://yourhost.com/path/to/api",
+ )
+
+
+ async def main() -> None:
+ await client.settings.web_search_providers.create_or_update(
+ manifest=WebSearchProviderManifest(
+ auth=ParallelWebSearchProviderAuth(
+ api_key="api_key",
+ ),
+ ),
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.create_or_update(manifest=manifest, request_options=request_options)
+ return _response.data
diff --git a/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/raw_client.py b/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/raw_client.py
new file mode 100644
index 000000000..339d97d29
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/settings/web_search_providers/raw_client.py
@@ -0,0 +1,326 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.parse_error import ParsingError
+from ...core.request_options import RequestOptions
+from ...core.serialization import convert_and_respect_annotation_metadata
+from ...core.unchecked_base_model import construct_type
+from ...errors.bad_request_error import BadRequestError
+from ...errors.failed_dependency_error import FailedDependencyError
+from ...errors.forbidden_error import ForbiddenError
+from ...errors.not_found_error import NotFoundError
+from ...errors.unauthorized_error import UnauthorizedError
+from ...types.get_web_search_provider_response import GetWebSearchProviderResponse
+from ...types.request_error_response import RequestErrorResponse
+from ...types.web_search_provider_manifest import WebSearchProviderManifest
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawWebSearchProvidersClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def get(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[GetWebSearchProviderResponse]:
+ """
+ The configured provider for this tenant. `auth.api_key` is redacted when present.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[GetWebSearchProviderResponse]
+ The configured web search provider.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ "api/v1/settings/web-search-providers",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GetWebSearchProviderResponse,
+ construct_type(
+ type_=GetWebSearchProviderResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def create_or_update(
+ self, *, manifest: WebSearchProviderManifest, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[GetWebSearchProviderResponse]:
+ """
+ Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
+
+ Parameters
+ ----------
+ manifest : WebSearchProviderManifest
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[GetWebSearchProviderResponse]
+ The saved provider.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ "api/v1/settings/web-search-providers",
+ method="PUT",
+ json={
+ "manifest": convert_and_respect_annotation_metadata(
+ object_=manifest, annotation=WebSearchProviderManifest, direction="write"
+ ),
+ },
+ headers={
+ "content-type": "application/json",
+ },
+ request_options=request_options,
+ omit=OMIT,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GetWebSearchProviderResponse,
+ construct_type(
+ type_=GetWebSearchProviderResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 424:
+ raise FailedDependencyError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawWebSearchProvidersClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def get(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[GetWebSearchProviderResponse]:
+ """
+ The configured provider for this tenant. `auth.api_key` is redacted when present.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[GetWebSearchProviderResponse]
+ The configured web search provider.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ "api/v1/settings/web-search-providers",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GetWebSearchProviderResponse,
+ construct_type(
+ type_=GetWebSearchProviderResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def create_or_update(
+ self, *, manifest: WebSearchProviderManifest, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[GetWebSearchProviderResponse]:
+ """
+ Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
+
+ Parameters
+ ----------
+ manifest : WebSearchProviderManifest
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[GetWebSearchProviderResponse]
+ The saved provider.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ "api/v1/settings/web-search-providers",
+ method="PUT",
+ json={
+ "manifest": convert_and_respect_annotation_metadata(
+ object_=manifest, annotation=WebSearchProviderManifest, direction="write"
+ ),
+ },
+ headers={
+ "content-type": "application/json",
+ },
+ request_options=request_options,
+ omit=OMIT,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GetWebSearchProviderResponse,
+ construct_type(
+ type_=GetWebSearchProviderResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 424:
+ raise FailedDependencyError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ RequestErrorResponse,
+ construct_type(
+ type_=RequestErrorResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/python/trueforge_sdk/src/trueforge_sdk/types/__init__.py b/python/trueforge_sdk/src/trueforge_sdk/types/__init__.py
index 2e83715b6..07d9b1918 100644
--- a/python/trueforge_sdk/src/trueforge_sdk/types/__init__.py
+++ b/python/trueforge_sdk/src/trueforge_sdk/types/__init__.py
@@ -37,6 +37,7 @@ if typing.TYPE_CHECKING:
from .catalog_sandbox_provider import CatalogSandboxProvider
from .catalog_skill import CatalogSkill
from .catalog_skill_type import CatalogSkillType
+ from .catalog_web_search_provider import CatalogWebSearchProvider
from .catalog_well_known_model_provider import CatalogWellKnownModelProvider
from .catalog_well_known_model_provider_type import CatalogWellKnownModelProviderType
from .chat_completion_chunk_delta_tool_call import ChatCompletionChunkDeltaToolCall
@@ -51,6 +52,7 @@ if typing.TYPE_CHECKING:
from .configured_model_provider import ConfiguredModelProvider
from .configured_sandbox_provider import ConfiguredSandboxProvider
from .configured_skill import ConfiguredSkill
+ from .configured_web_search_provider import ConfiguredWebSearchProvider
from .context_management_config import ContextManagementConfig
from .create_schedule_run_response import CreateScheduleRunResponse
from .create_session_agent import CreateSessionAgent
@@ -86,6 +88,8 @@ if typing.TYPE_CHECKING:
from .get_skill_catalog_response import GetSkillCatalogResponse
from .get_skill_response import GetSkillResponse
from .get_turn_response import GetTurnResponse
+ from .get_web_search_provider_catalog_response import GetWebSearchProviderCatalogResponse
+ from .get_web_search_provider_response import GetWebSearchProviderResponse
from .git_skill import GitSkill
from .google_gemini_model_provider import GoogleGeminiModelProvider
from .initial_user_message import InitialUserMessage
@@ -144,6 +148,7 @@ if typing.TYPE_CHECKING:
from .model_provider_manifest import ModelProviderManifest
from .moonshot_model_provider import MoonshotModelProvider
from .open_ai_model_provider import OpenAiModelProvider
+ from .parallel_web_search_provider_auth import ParallelWebSearchProviderAuth
from .permission_resource_type import PermissionResourceType
from .previous_turn_id_input import PreviousTurnIdInput
from .raw_tool_call import RawToolCall
@@ -242,6 +247,7 @@ if typing.TYPE_CHECKING:
from .user_tool_response_event import UserToolResponseEvent
from .web_search_capability import WebSearchCapability
from .web_search_config import WebSearchConfig
+ from .web_search_provider_manifest import WebSearchProviderManifest
from .zai_model_provider import ZaiModelProvider
_dynamic_imports: typing.Dict[str, str] = {
"ActionRequired": ".action_required",
@@ -275,6 +281,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"CatalogSandboxProvider": ".catalog_sandbox_provider",
"CatalogSkill": ".catalog_skill",
"CatalogSkillType": ".catalog_skill_type",
+ "CatalogWebSearchProvider": ".catalog_web_search_provider",
"CatalogWellKnownModelProvider": ".catalog_well_known_model_provider",
"CatalogWellKnownModelProviderType": ".catalog_well_known_model_provider_type",
"ChatCompletionChunkDeltaToolCall": ".chat_completion_chunk_delta_tool_call",
@@ -289,6 +296,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ConfiguredModelProvider": ".configured_model_provider",
"ConfiguredSandboxProvider": ".configured_sandbox_provider",
"ConfiguredSkill": ".configured_skill",
+ "ConfiguredWebSearchProvider": ".configured_web_search_provider",
"ContextManagementConfig": ".context_management_config",
"CreateScheduleRunResponse": ".create_schedule_run_response",
"CreateSessionAgent": ".create_session_agent",
@@ -324,6 +332,8 @@ _dynamic_imports: typing.Dict[str, str] = {
"GetSkillCatalogResponse": ".get_skill_catalog_response",
"GetSkillResponse": ".get_skill_response",
"GetTurnResponse": ".get_turn_response",
+ "GetWebSearchProviderCatalogResponse": ".get_web_search_provider_catalog_response",
+ "GetWebSearchProviderResponse": ".get_web_search_provider_response",
"GitSkill": ".git_skill",
"GoogleGeminiModelProvider": ".google_gemini_model_provider",
"InitialUserMessage": ".initial_user_message",
@@ -382,6 +392,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"ModelProviderManifest": ".model_provider_manifest",
"MoonshotModelProvider": ".moonshot_model_provider",
"OpenAiModelProvider": ".open_ai_model_provider",
+ "ParallelWebSearchProviderAuth": ".parallel_web_search_provider_auth",
"PermissionResourceType": ".permission_resource_type",
"PreviousTurnIdInput": ".previous_turn_id_input",
"RawToolCall": ".raw_tool_call",
@@ -480,6 +491,7 @@ _dynamic_imports: typing.Dict[str, str] = {
"UserToolResponseEvent": ".user_tool_response_event",
"WebSearchCapability": ".web_search_capability",
"WebSearchConfig": ".web_search_config",
+ "WebSearchProviderManifest": ".web_search_provider_manifest",
"ZaiModelProvider": ".zai_model_provider",
}
@@ -537,6 +549,7 @@ __all__ = [
"CatalogSandboxProvider",
"CatalogSkill",
"CatalogSkillType",
+ "CatalogWebSearchProvider",
"CatalogWellKnownModelProvider",
"CatalogWellKnownModelProviderType",
"ChatCompletionChunkDeltaToolCall",
@@ -551,6 +564,7 @@ __all__ = [
"ConfiguredModelProvider",
"ConfiguredSandboxProvider",
"ConfiguredSkill",
+ "ConfiguredWebSearchProvider",
"ContextManagementConfig",
"CreateScheduleRunResponse",
"CreateSessionAgent",
@@ -586,6 +600,8 @@ __all__ = [
"GetSkillCatalogResponse",
"GetSkillResponse",
"GetTurnResponse",
+ "GetWebSearchProviderCatalogResponse",
+ "GetWebSearchProviderResponse",
"GitSkill",
"GoogleGeminiModelProvider",
"InitialUserMessage",
@@ -644,6 +660,7 @@ __all__ = [
"ModelProviderManifest",
"MoonshotModelProvider",
"OpenAiModelProvider",
+ "ParallelWebSearchProviderAuth",
"PermissionResourceType",
"PreviousTurnIdInput",
"RawToolCall",
@@ -742,5 +759,6 @@ __all__ = [
"UserToolResponseEvent",
"WebSearchCapability",
"WebSearchConfig",
+ "WebSearchProviderManifest",
"ZaiModelProvider",
]
diff --git a/python/trueforge_sdk/src/trueforge_sdk/types/catalog_web_search_provider.py b/python/trueforge_sdk/src/trueforge_sdk/types/catalog_web_search_provider.py
new file mode 100644
index 000000000..7ec58278c
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/types/catalog_web_search_provider.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class CatalogWebSearchProvider(UncheckedBaseModel):
+ type: typing.Literal["parallel"] = pydantic.Field(default="parallel")
+ """
+ Parallel web-search provider.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow") # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/python/trueforge_sdk/src/trueforge_sdk/types/configured_web_search_provider.py b/python/trueforge_sdk/src/trueforge_sdk/types/configured_web_search_provider.py
new file mode 100644
index 000000000..025d45e50
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/types/configured_web_search_provider.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .resource_name import ResourceName
+from .web_search_provider_manifest import WebSearchProviderManifest
+
+
+class ConfiguredWebSearchProvider(UncheckedBaseModel):
+ manifest: WebSearchProviderManifest
+ name: ResourceName
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow") # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/python/trueforge_sdk/src/trueforge_sdk/types/get_web_search_provider_catalog_response.py b/python/trueforge_sdk/src/trueforge_sdk/types/get_web_search_provider_catalog_response.py
new file mode 100644
index 000000000..4115cef9b
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/types/get_web_search_provider_catalog_response.py
@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .catalog_web_search_provider import CatalogWebSearchProvider
+
+
+class GetWebSearchProviderCatalogResponse(UncheckedBaseModel):
+ data: typing.List[CatalogWebSearchProvider]
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow") # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/python/trueforge_sdk/src/trueforge_sdk/types/get_web_search_provider_response.py b/python/trueforge_sdk/src/trueforge_sdk/types/get_web_search_provider_response.py
new file mode 100644
index 000000000..3e77b1ea0
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/types/get_web_search_provider_response.py
@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .configured_web_search_provider import ConfiguredWebSearchProvider
+
+
+class GetWebSearchProviderResponse(UncheckedBaseModel):
+ data: ConfiguredWebSearchProvider
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow") # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/python/trueforge_sdk/src/trueforge_sdk/types/parallel_web_search_provider_auth.py b/python/trueforge_sdk/src/trueforge_sdk/types/parallel_web_search_provider_auth.py
new file mode 100644
index 000000000..9e89e933a
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/types/parallel_web_search_provider_auth.py
@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ParallelWebSearchProviderAuth(UncheckedBaseModel):
+ """
+ Parallel authentication credentials.
+ """
+
+ api_key: str = pydantic.Field()
+ """
+ Parallel API key. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored key.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow") # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/python/trueforge_sdk/src/trueforge_sdk/types/web_search_provider_manifest.py b/python/trueforge_sdk/src/trueforge_sdk/types/web_search_provider_manifest.py
new file mode 100644
index 000000000..6d19700a2
--- /dev/null
+++ b/python/trueforge_sdk/src/trueforge_sdk/types/web_search_provider_manifest.py
@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .parallel_web_search_provider_auth import ParallelWebSearchProviderAuth
+
+
+class WebSearchProviderManifest(UncheckedBaseModel):
+ auth: ParallelWebSearchProviderAuth
+ type: typing.Literal["parallel"] = pydantic.Field(default="parallel")
+ """
+ Parallel web-search provider.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow") # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ smart_union = True
+ extra = pydantic.Extra.allow