PIpipeshub-ai
Web Search

Get all web search providers

Changed on

Retrieve all configured web search providers and current web search settings.

Authentication: Session JWT or OAuth 2.0 access token via Authorization: Bearer. OAuth tokens must include the config:read scope. Admin role is not required.

API keys: for anyone who isn't an org admin, each provider's configuration.apiKey comes back as the placeholder ****************, and so does configuration.baseUrl (admins always get the stored address). Admins get the stored key, unless the server hides secrets from everyone (HIDE_SECRET_CONFIG=true). When updating a provider, sending the placeholder back keeps the stored key.

The built-in duckduckgo entry (never stored, empty configuration) is always listed first; it is the default when no stored provider is. With nothing stored, message is No web search providers found and the settings are the defaults. Of the query string only reveal is read.

get/configurationManager/web-search

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/configurationManager/web-search
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: config:read

Query parameters

reveal'true'

Set to true to receive stored secrets instead of placeholders. Honoured only for an admin's own configuration where the deployment allows it (see GET /configurationManager/secretReveal); ignored for OAuth-app tokens and any other value.

Response

Web search providers and settings retrieved

status'success' required
messagestring required

Human-readable status (empty list vs populated providers)

Changes

  • dbb5e203b445Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • a90ab79f26a1Revision changes
    • warning

      added the new brave enum value to the // response property for the response status

    • warning

      added the new crawl4ai enum value to the // response property for the response status

    • warning

      added the new firecrawl enum value to the // response property for the response status

    • warning

      added the new searxng enum value to the // response property for the response status