{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/serpkite-com/json-schema/serpkite-com-search-request-schema.json",
  "title": "SearchRequest",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/serpkite-com-openapi.yaml#/components/schemas/SearchRequest",
  "type": "object",
  "required": [
    "q"
  ],
  "properties": {
    "q": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "country": {
      "type": "string",
      "default": "us",
      "description": "Country code (ISO 3166-1 alpha-2, case-insensitive; uk is accepted as gb). When omitted and location ends in a country name, that country is used. Russia (ru) is supported across all search verticals, including patents"
    },
    "language": {
      "type": "string",
      "default": "en",
      "description": "Interface language: a language code with an optional region (e.g. en, ru, de, pt-br, zh-tw, es-419). Russian (ru) is supported across all search verticals; language does not change the selected country. On patents, a non-English code restricts publication language (ar, zh, da, nl, fi, fr, de, it, ja, ko, no, pt, ru, es, sv)"
    },
    "location": {
      "type": "string",
      "description": "Free-text location, e.g. \"Austin, Texas, United States\". Google and Yandex Maps apply it; other engines have no such parameter and are skipped (a 400 when you named one), never answered for the wrong place. uule works the same way"
    },
    "uule": {
      "type": "string",
      "description": "Pre-encoded Google location (overrides ll and location; percent-encoded values are decoded)"
    },
    "ll": {
      "type": "string",
      "description": "Map point \"@lat,lng,14z\" (maps and places only; zoom optional, default 14z): the map is searched around that point at that zoom, wherever the request comes from. Overrides location"
    },
    "num": {
      "type": "integer",
      "default": 10,
      "minimum": 1,
      "maximum": 100,
      "description": "1–100. Up to 10 returns one page (10 results, 1 credit; trim it yourself for fewer). Above 10 on search and news is the depth bundle (7 credits for 100; values between round up to whole pages). On images a page is a block of up to 100 images (1 credit) and num (default 100) is how many of them to return; `page` moves to the next block. Other verticals return one page as the engine serves it: up to 10 on Google (shopping cards come 40-55 to a page, and Brave and DuckDuckGo news and videos up to about 60), for 1 credit. Trim it yourself"
    },
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "maximum": 10
    },
    "time": {
      "type": "string",
      "enum": [
        "hour",
        "day",
        "week",
        "month",
        "year"
      ],
      "description": "Only results from the last hour/day/… (search, news, images, videos, shopping). A fallback engine without that window is skipped, never answered unfiltered"
    },
    "tbs": {
      "type": "string",
      "description": "Advanced: raw Google tbs filter (e.g. qdr:d, qdr:w2, cdr:1,cd_min:1/1/2026,cd_max:1/31/2026); overrides time"
    },
    "device": {
      "type": "string",
      "enum": [
        "desktop",
        "mobile"
      ],
      "default": "desktop"
    },
    "safe": {
      "type": "string",
      "enum": [
        "active",
        false
      ],
      "default": false
    },
    "autocorrect": {
      "type": "boolean",
      "default": true
    },
    "format": {
      "type": "string",
      "enum": [
        "json",
        "markdown",
        "compact"
      ],
      "default": "json"
    },
    "fields": {
      "type": "string",
      "description": "Comma-separated projection, e.g. \"results.title,results.link,knowledge_graph\""
    },
    "include_content": {
      "type": "integer",
      "minimum": 0,
      "maximum": 5,
      "default": 0,
      "description": "Also fetch the top N organic pages as Markdown (+1 credit each fetched page)"
    },
    "ads": {
      "type": "boolean",
      "default": false,
      "description": "Include sponsored results"
    },
    "max_age": {
      "type": "integer",
      "minimum": 0,
      "description": "Accept a cached result up to this many seconds old (50% of credits on a hit)"
    },
    "engine": {
      "$ref": "#/$defs/EngineParam"
    },
    "include_domains": {
      "$ref": "#/$defs/DomainList",
      "description": "Only results from these domains (search, news, images, videos). Compiled into site: operators and enforced on the results. With engine=consensus, every provider gets the operators and only providers with a remaining result are billed"
    },
    "exclude_domains": {
      "$ref": "#/$defs/DomainList",
      "description": "Drop results from these domains (search, news, images, videos)"
    },
    "boost_domains": {
      "$ref": "#/$defs/DomainList",
      "description": "Move results from these domains to the top, keeping the order within both groups (search, news)"
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "description": "Only results published on or after this date, YYYY-MM-DD (search, news, images, videos). Can't be combined with time or tbs. A fallback engine without date ranges is skipped"
    },
    "end_date": {
      "type": "string",
      "format": "date",
      "description": "Only results published on or before this date, YYYY-MM-DD. Can't be combined with time or tbs"
    },
    "highlights": {
      "type": "boolean",
      "default": false,
      "description": "Return up to 3 query-ranked passages (`highlights`) of each page read by include_content instead of the whole page (search only; needs include_content; no extra credits)"
    },
    "include_answer": {
      "type": "boolean",
      "default": false,
      "description": "Add a cited AI `answer` written by Claude over this response's results (search and news; +2 credits, +4 when it read pages via `include_content`; refunded with a `meta.warnings` entry when the model fails)"
    }
  },
  "$defs": {
    "DomainList": {
      "description": "Domains as an array or a comma-separated string, at most 20: a host (`example.com`, subdomains match), a host with a path prefix (`github.com/org`) or a TLD (`.gov`).",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "maxItems": 20,
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "EngineParam": {
      "description": "Which search providers may answer. `google` (the default) is Google only; Google requests are retried internally before failing. `auto` allows falling back to other enabled providers, in route order, when Google is blocked or times out. A single other provider (`brave`) or a list (`[\"google\",\"brave\"]`, or `google,brave` in a query string) restricts the request to those providers. `meta.engine` always names the provider that answered and credits follow that provider's price. A key with \"Allow fallback to other search engines\" on treats a request without `engine` as `auto`. `consensus` (`/v1/search` only; 400 elsewhere, and it can't be combined with other names) queries several independent search indexes in parallel (at most one Bing-backed provider, so Yahoo or DuckDuckGo never count as agreeing with Bing), merges the results by URL and ranks them by how many providers returned each one. Each result lists its `sources`; `meta.engine` is `consensus` and `meta.route` lists every provider attempt. Up to three providers answer: a provider that fails or comes back empty hands its turn to the next one in the route. It stops once `num` unique results are in hand or after a few seconds, and costs the sum of one page at each provider that returned results (providers that failed, came back empty or were never started are free). `yandex` serves `/v1/search` from Yandex web search (no `time` filter or `safe: active`: a request naming it gets a 400 with them) and `/v1/maps`, `/v1/places` and `/v1/place` from Yandex Maps, where the deployment enables it (otherwise a 503 `unavailable`, not charged); with `auto` it is the last fallback there.",
      "oneOf": [
        {
          "type": "string",
          "default": "google"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Provider"
          },
          "minItems": 1
        }
      ]
    },
    "Provider": {
      "type": "string",
      "description": "A search provider (docs/providers). Which verticals each serves depends on the deployment.",
      "enum": [
        "google",
        "brave",
        "bing",
        "yahoo",
        "duckduckgo",
        "mojeek",
        "wikipedia",
        "yandex"
      ]
    }
  }
}