search_index.json

{
  "engine": "search_index",
  "params": {
    "q": {
      "required": true,
      "description": "Parameter defines the query you want to search.",
      "group": "search_query"
    },
    "num": {
      "type": "number",
      "description": "Parameter defines the number of results to return. (default: `10`).",
      "group": "pagination"
    },
    "start": {
      "type": "number",
      "description": "Parameter defines the result offset for pagination. (e.g., `0` (default) is the first page, `10` is the second page, etc.).",
      "group": "pagination"
    },
    "safe": {
      "type": "select",
      "options": [
        "active",
        "off"
      ],
      "description": "Parameter defines the level of filtering for adult content. It can be set to `active` (default) or `off`.",
      "group": "filters"
    },
    "mode": {
      "type": "select",
      "options": [
        "deep"
      ],
      "description": "Parameter defines the search mode. Set to `deep` for expanded recall via parallel sub-query fan-out. Returns more diverse results by decomposing the query into multiple aspects.",
      "group": "filters"
    }
  },
  "common_params": {
    "engine": {
      "required": true,
      "description": "Set parameter to `search_index` to use the Search Index API engine.",
      "group": "serpapi_parameters"
    },
    "no_cache": {
      "type": "checkbox",
      "description": "Parameter will force SerpApi to fetch the Search Index results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no\\_cache and async parameters should not be used together.",
      "group": "serpapi_parameters"
    },
    "async": {
      "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no\\_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.",
      "group": "serpapi_parameters"
    },
    "zero_trace": {
      "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.",
      "group": "serpapi_parameters"
    },
    "api_key": {
      "required": true,
      "description": "Parameter defines the SerpApi private key to use.",
      "group": "serpapi_parameters"
    },
    "output": {
      "description": "Parameter defines the format of the result. It can be set to `json` (default) to get a structured JSON of the results, `html` to get the raw HTML retrieved, or `md` to get a markdown-formatted version optimized for LLMs and AI agents.",
      "group": "serpapi_parameters"
    },
    "json_restrictor": {
      "description": "Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details.",
      "group": "serpapi_parameters"
    }
  }
}