> ## Documentation Index
> Fetch the complete documentation index at: https://trueforge.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Create or replace the web search provider

> Upserts the single web search provider for this tenant. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).



## OpenAPI

````yaml /openapi.json put /api/v1/settings/web-search-providers
openapi: 3.1.0
info:
  description: >-
    HTTP API for the TrueForge agent server (`/api/v1`). Interactive docs are
    served at `/api/v1/docs` (OpenAPI JSON at `/api/v1/openapi.json`).


    **Authentication:** Standalone auth accepts requests without credentials —
    middleware stamps a local default user. When OIDC or TrueFoundry auth is
    configured, protected routes require a valid cookie or `Authorization:
    Bearer` token. There is no built-in API-key scheme; pass custom headers only
    if your reverse proxy or IdP layer requires them.


    Covers DB-backed sessions, the agent registry, settings catalogs, and
    model/MCP/skill/sandbox providers.
  title: TrueForge API
  version: 0.0.0
servers: []
security:
  - BearerAuth: []
tags:
  - name: Internal
  - name: Auth
  - name: Capabilities
  - name: Models
  - name: MCP Servers
  - name: Skills
  - name: Sandboxes
  - name: Web Search Providers
  - name: Agents
  - name: Schedules
  - name: Agent Sessions
paths:
  /api/v1/settings/web-search-providers:
    put:
      tags:
        - Web Search Providers
      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).
      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
components:
  schemas:
    UpdateWebSearchProviderRequest:
      additionalProperties: false
      properties:
        manifest:
          $ref: '#/components/schemas/WebSearchProviderManifest'
      required:
        - manifest
      type: object
    GetWebSearchProviderResponse:
      properties:
        data:
          $ref: '#/components/schemas/ConfiguredWebSearchProvider'
      required:
        - data
      type: object
    RequestErrorResponse:
      properties:
        error:
          properties:
            code:
              description: Optional machine-readable error code; null when not applicable.
              type:
                - string
                - 'null'
            message:
              description: Human-readable explanation of the failure.
              type: string
            param:
              description: >-
                Optional request field that caused the error; null when not
                field-specific.
              type:
                - string
                - 'null'
            type:
              description: Optional error category (e.g. validation vs conflict).
              type: string
          required:
            - message
          type: object
      required:
        - error
      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
    ConfiguredWebSearchProvider:
      additionalProperties: false
      properties:
        manifest:
          $ref: '#/components/schemas/WebSearchProviderManifest'
        name:
          $ref: '#/components/schemas/ResourceName'
      required:
        - name
        - manifest
      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
    ResourceName:
      maxLength: 64
      minLength: 2
      pattern: ^[a-z][a-z0-9-]{0,62}[a-z0-9]$
      type: string
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: >-
        Caller credential (`Authorization: Bearer <token>`). Required on
        protected routes when auth is enabled. Browser sessions may use the
        HttpOnly `id_token` or `accessToken` cookie instead.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.