Skip to main content

Overview

LiteLLM is an SDK and AI gateway that gives 100+ LLM providers one OpenAI-shaped interface. Its Search API does the same for web search backends. Nimble ships as the nimble search provider, built into LiteLLM itself. Calls go to Nimble’s Search API and come back in LiteLLM’s unified search response. No fork, no plugin, no custom adapter. The provider ships in LiteLLM v1.98.0 and later. Pin that floor rather than installing “latest”:
v1.97.0 shipped without the provider. An existing install that predates v1.98.0 needs an upgrade before search_provider="nimble" resolves.

What this integration covers

This is the Search API only. search_provider: nimble routes to POST /v2/search and nothing else. Extract, Map, Crawl, and the Web Search Agent research product are not reachable through LiteLLM today. To use those, call the Nimble SDK directly or connect the Nimble MCP server.

Quick Start

1. Get a Nimble API key

Get your API key from Nimble’s dashboard (free trial available) and export it:

2. Search from the Python SDK

Call search() with search_provider="nimble":
search_provider is required and has no default. LiteLLM does not pick a search backend for you, so installing the package is not enough to reach Nimble. An async asearch() with the same signature is also available.

3. Or search through the AI Gateway

Register Nimble as a search tool in config.yaml:
Start the gateway:
Then call the search endpoint. The path segment is the search_tool_name you registered:
Send your LiteLLM virtual key in the Authorization header, not your Nimble key. The gateway holds the Nimble credential server-side, so callers never see it.

Credentials

Required. Your Nimble API key. The provider reads it from the environment, or you can pass api_key= per call in the SDK and api_key: per search tool in the gateway config.Without it, the provider raises NIMBLE_API_KEY is not set before any request leaves your machine.
Optional. Overrides the API base. Defaults to https://sdk.nimbleway.com/v2, and the provider appends /search itself. Set it only to point at a proxy or a regional endpoint.

Parameters

LiteLLM maps four unified parameters onto Nimble’s names, then forwards every other parameter to the Search API untouched.
Passing Nimble’s own include_domains or exclude_domains overrides anything derived from search_domain_filter.
Anything LiteLLM does not recognize goes into the request body as-is, so Nimble’s full parameter surface stays reachable. The values below are what the Search API accepts. LiteLLM does not validate them, so it is not the source of truth for allowed values.
Full reference: Search API.

Cost tracking on the gateway

nimble/search is priced in LiteLLM’s own model cost map, so Nimble spend lands in LiteLLM’s spend logs and dashboard alongside your model spend. No extra configuration is needed. LiteLLM’s figure is an estimate, not your invoice. It applies one flat per-query rate to every search, which does not model how Nimble bills:
  • Nimble prices Search by search_depth, and lite costs less per search than fast. LiteLLM charges the same figure for both.
  • search_depth="deep" adds a live extraction surcharge on top, billed at Extract rates for each page scraped in real time.
  • Volume plans price differently from pay-as-you-go.
See Pricing for the authoritative rates.

Additional Resources

Nimble on LiteLLM

The provider reference in LiteLLM’s own documentation.

Nimble Search API

Every parameter the provider can forward, with accepted values.

Search

Focus modes, search depth, and filtering explained.

Nimble MCP Server

Reach Extract, Map, and Crawl, which LiteLLM does not cover.