Sign in
search-tools

List Search Providers

Changed on

List the providers a search or fetch tool may name, for the add-tool form.

The list comes from the metadata any-search and any-fetch publish, so a provider either library adds appears with no change to the gateway. Reports per provider whether an API key is required, what endpoint a tool inherits when it declares none, and the native options a tool may set. Providers that exist only for tests are left out, and so is the fetch provider builtin, which only the implicit builtin_fetch tool uses.

What belongs to this deployment rather than to the libraries, its own tools on each provider and an endpoint a tool inherits from its settings, is shown only to a caller who operates the deployment: the tool settings reader withholds the same from anyone else.

get/api/v1/search-tools/providers

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Query parameters

kind'search' | 'fetch'

Which providers to list: search providers (the default) or fetch providers.

Response

Successful Response

default_api_basestring nullable

The endpoint a tool on this provider uses when it declares no api_base. Null means nothing supplies one, so an api_base is required. One that comes from the deployment's own settings, such as the web_search_url a searxng tool inherits, is shown only to a caller who operates the deployment: nothing else inherits it, an organization's key included.

doc_urlstring nullable

The provider's API documentation.

formatsstring[] nullable

Fetch: the formats the page text comes back in.

idstring required

Value to send as 'provider'.

instancesstring[]

The names of this deployment's configured and stored tools on this provider, shown only to a caller who operates the deployment.

key_in_urlboolean nullable

Search: true when the API key travels in the request URL.

kind'search' | 'fetch' required

Whether this is a search provider or a fetch provider.

max_resultsinteger nullable

Search: the most results one call can ask for.

max_urls_per_callinteger nullable

Fetch: the most pages one call can fetch.

query_in_urlboolean nullable

Search: true when the query travels in the request URL.

renders_javascriptboolean nullable

Fetch: true when the provider runs a page's JavaScript before reading it.

requires_api_baseboolean required

True when this provider has no endpoint of its own, so the tool must say where the backend is.

requires_api_keyboolean required

True when a tool on this provider must carry an API key.

tierstring nullable

The library's tier for the provider.

Changes

  • 23dd52e8e19eRevision changes
    • info

      added the new optional query request parameter kind

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id list_search_providers_api_v1_search_tools_providers_get removed and replaced with search-tools-list_search_providers