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

# Update Brave Search configuration



## OpenAPI

````yaml /api-reference/openapi.json put /tools/brave/config
openapi: 3.0.3
info:
  title: Findable API
  version: 3.2.38
  description: >
    REST API for the Findable AI Assistant platform.


    ## Authentication


    All endpoints (except `/server/setup` and `/server/bootstrap`) require a
    valid **Azure AD / Entra ID Bearer token**.


    ### Obtaining a token


    1. Register (or reuse) an **App Registration** in Azure Entra ID for your
    client.

    2. Under **API Permissions**, add a delegated permission for the Findable
    server app:
       `api://<SERVER_CLIENT_ID>/User.Read`
    3. Acquire a token using MSAL (or any OAuth 2.0 library) with the following
    parameters:


    | Parameter | Value |

    |-----------|-------|

    | Authority | `https://login.microsoftonline.com/<TENANT_ID>` |

    | Client ID | Your client app registration ID |

    | Scope | `api://<SERVER_CLIENT_ID>/User.Read` |

    | Grant type | Authorization Code (interactive) or Client Credentials
    (daemon) |


    ### Example (MSAL Node.js)


    ```javascript

    const { ConfidentialClientApplication } = require("@azure/msal-node");


    const cca = new ConfidentialClientApplication({
      auth: {
        clientId: "<YOUR_CLIENT_ID>",
        authority: "https://login.microsoftonline.com/<TENANT_ID>",
        clientSecret: "<YOUR_CLIENT_SECRET>",
      },
    });


    const result = await cca.acquireTokenByClientCredential({
      scopes: ["api://<SERVER_CLIENT_ID>/.default"],
    });


    // Use result.accessToken in the Authorization header

    ```


    ### Using the token


    Include the token in every request:

    ```

    Authorization: Bearer <access_token>

    ```


    ### Roles


    Access is determined by Azure AD group membership configured in the
    application settings:

    - **Admin (Owner)**: Full access to all endpoints including admin operations

    - **Contributor**: Can create and manage chats, files, and content

    - **User**: Read access to entitled chats and resources
  contact:
    name: Findable Support
  license:
    name: Proprietary
servers:
  - url: /server
    description: Application server (relative)
security:
  - BearerAuth: []
tags:
  - name: AI
    description: Chat completion and AI generation endpoints
  - name: Chats
    description: Chat configuration CRUD with ACL enforcement
  - name: Settings
    description: Application settings and health
  - name: Files
    description: Blob storage file operations
  - name: Search
    description: Azure AI Search resource management
  - name: User
    description: User profile, feedback, chat logs, and preferences
  - name: Flows
    description: FlowEngine flow designer operations
  - name: Prompts
    description: Prompt template management
  - name: Pages
    description: Navigation page management
  - name: Admin
    description: Administrative operations (admin-only)
  - name: Bootstrap
    description: Bootstrap seed data operations (admin-only)
  - name: Setup
    description: Initial application setup (pre-auth)
  - name: Cosmos
    description: Generic Cosmos DB CRUD operations
  - name: Tools
    description: Tool providers, web search, and utility tools
  - name: MCP
    description: Model Context Protocol server management
  - name: Telemetry
    description: Version, health, and API permission checks
  - name: SharePoint
    description: SharePoint entitlement management
  - name: Data Platform
    description: Data platform connection management
  - name: Vector Stores
    description: Vector store provider operations
  - name: OneDrive
    description: OneDrive personal file storage operations
  - name: Jobs
    description: Background job and scheduler management
  - name: Memory
    description: User and organizational memory operations
  - name: Slack
    description: >-
      Slack bot interactions and webhooks (public, uses Slack signature
      verification)
  - name: Teams
    description: Microsoft Teams bot webhooks and interactions
  - name: Human Input
    description: Human-in-the-loop input requests for flow executions
  - name: Datasources
    description: Datasource catalog CRUD with ACL enforcement
  - name: Assignments
    description: >-
      Assignment lifecycle: inbox, sent, create, launch, complete, delegate,
      reject, reassign, remind, and recurring schedules. Experimental feature —
      requires experimental flag enabled.
paths:
  /tools/brave/config:
    put:
      tags:
        - Tools
      summary: Update Brave Search configuration
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                apiKey:
                  type: string
                isEnabled:
                  type: boolean
      responses:
        '200':
          description: Configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolConfigUpdateResult'
        '400':
          description: Update failed
components:
  schemas:
    ToolConfigUpdateResult:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        config:
          description: Updated provider config (sanitized) — present on success
          type: object
          properties:
            scope:
              description: Access control model
              type: string
              enum:
                - personal
                - shared
            createdBy:
              description: UPN of the creator
              type: string
            isPublic:
              description: Allow public read access
              type: boolean
            owners:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  type:
                    type: string
                    enum:
                      - group
                      - user
                  displayName:
                    type: string
                  mail:
                    type: string
                  securityEnabled:
                    type: boolean
                  mailEnabled:
                    type: boolean
                  groupTypes:
                    nullable: true
                    type: array
                    items:
                      type: string
                  groupType:
                    type: string
                  userPrincipalName:
                    type: string
                  jobTitle:
                    type: string
                  department:
                    type: string
                  officeLocation:
                    type: string
                required:
                  - id
                  - type
                additionalProperties: {}
            contributors:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  type:
                    type: string
                    enum:
                      - group
                      - user
                  displayName:
                    type: string
                  mail:
                    type: string
                  securityEnabled:
                    type: boolean
                  mailEnabled:
                    type: boolean
                  groupTypes:
                    nullable: true
                    type: array
                    items:
                      type: string
                  groupType:
                    type: string
                  userPrincipalName:
                    type: string
                  jobTitle:
                    type: string
                  department:
                    type: string
                  officeLocation:
                    type: string
                required:
                  - id
                  - type
                additionalProperties: {}
            users:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  type:
                    type: string
                    enum:
                      - group
                      - user
                  displayName:
                    type: string
                  mail:
                    type: string
                  securityEnabled:
                    type: boolean
                  mailEnabled:
                    type: boolean
                  groupTypes:
                    nullable: true
                    type: array
                    items:
                      type: string
                  groupType:
                    type: string
                  userPrincipalName:
                    type: string
                  jobTitle:
                    type: string
                  department:
                    type: string
                  officeLocation:
                    type: string
                required:
                  - id
                  - type
                additionalProperties: {}
            inheritEntitlements:
              anyOf:
                - type: boolean
                - type: object
                  properties:
                    owners:
                      type: boolean
                    contributors:
                      type: boolean
                    users:
                      type: boolean
                  additionalProperties: false
            hideFromCatalog:
              description: >-
                Hide entity from user-facing recommendations and catalog/search
                surfaces (still accessible to owners/contributors/admins)
              type: boolean
            createdAt:
              description: ISO-8601 creation timestamp
              type: string
            updatedBy:
              type: string
            updatedAt:
              description: ISO-8601 update timestamp
              type: string
            id:
              type: string
            providerId:
              type: string
              description: Provider identifier (e.g. 'tavily', 'serp', 'sql')
            name:
              type: string
            description:
              type: string
            isEnabled:
              type: boolean
            authType:
              type: string
              enum:
                - managedSystemIdentity
                - apiKey
                - connectionString
            apiKey:
              description: Redacted in responses
              type: string
            category:
              description: e.g. 'search', 'database', 'api'
              type: string
            tags:
              type: array
              items:
                type: string
            version:
              type: string
            toolName:
              type: string
            parameters:
              type: object
              additionalProperties: {}
            integrationType:
              type: string
              enum:
                - registry
                - rest_api
                - graphql
                - function
            endpoint:
              description: REST API endpoint for rest_api type
              type: string
            method:
              type: string
              enum:
                - GET
                - POST
                - PUT
                - PATCH
                - DELETE
            functionCode:
              description: JS code for function type
              type: string
            graphqlEndpoint:
              type: string
            graphqlQuery:
              type: string
            requiredDelegatedScope:
              type: string
          required:
            - id
            - providerId
          additionalProperties: false
          title: ToolProviderConfig
      required:
        - success
        - message
      additionalProperties: false
      title: ToolConfigUpdateResult
      description: Result of a tool provider configuration update
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Azure AD access token obtained via MSAL

````