> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Serper: Search

> Google web search for researching companies, people and websites: find a company website, LinkedIn URL, news or careers page.

Google web search for researching companies, people and websites: find a company website, LinkedIn URL, news or careers page.

> [!NOTE]
>
> Tool ID: `serper_google_search`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'serper_google_search',
  {
    "query": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute serper_google_search --input '{
  "query": "software companies hiring engineers"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "searchParameters": {
      "q": "software companies hiring engineers",
      "gl": "example",
      "hl": "example"
    },
    "knowledgeGraph": {
      "title": "VP of Engineering",
      "type": "example",
      "website": "https://example.com"
    },
    "organic": [
      {
        "title": "VP of Engineering",
        "link": "example",
        "snippet": "example"
      }
    ]
  }
}
```

Use `deepline describe serper_google_search --json` for the latest machine-readable contract.

## Input reference

Run a Serper web search against Google results.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.query` | `string` | Yes | — | Search query string. Minimum length: 1. |
| `payload.gl` | `string` | No | `"us"` | Country code. Defaults to `us`. Minimum length: 2. Maximum length: 2. |
| `payload.hl` | `string` | No | `"en"` | Language code. Defaults to `en`. Minimum length: 2. Maximum length: 8. |
| `payload.page` | `integer` | No | — | 1-indexed results page. |
| `payload.num` | `integer` | No | — | Requested result count, honoured exactly by this endpoint (num=3 returns 3 organic results). Billing is per call rather than per result, so a smaller `num` does not cost less. set it to keep the response small and easy to parse when you only need the top hits. Minimum: 1. |
| `payload.autocorrect` | `boolean` | No | — | Enable query autocorrection. |
| `payload.tbs` | `string` | No | — | Google tools/search modifier, for example `qdr:d`. Minimum length: 1. |
| `payload.location` | `string` | No | — | Human-readable location bias. Minimum length: 1. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Run a Serper web search against Google results.",
    "properties": {
      "query": {
        "type": "string",
        "description": "Search query string.",
        "minLength": 1,
        "aliases": [
          "q"
        ]
      },
      "gl": {
        "type": "string",
        "description": "Country code. Defaults to `us`.",
        "default": "us",
        "minLength": 2,
        "maxLength": 2
      },
      "hl": {
        "type": "string",
        "description": "Language code. Defaults to `en`.",
        "default": "en",
        "minLength": 2,
        "maxLength": 8
      },
      "page": {
        "type": "integer",
        "description": "1-indexed results page."
      },
      "num": {
        "type": "integer",
        "description": "Requested result count, honoured exactly by this endpoint (num=3 returns 3 organic results). Billing is per call rather than per result, so a smaller `num` does not cost less; set it to keep the response small and easy to parse when you only need the top hits.",
        "minimum": 1
      },
      "autocorrect": {
        "type": "boolean",
        "description": "Enable query autocorrection."
      },
      "tbs": {
        "type": "string",
        "description": "Google tools/search modifier, for example `qdr:d`.",
        "minLength": 1
      },
      "location": {
        "type": "string",
        "description": "Human-readable location bias.",
        "minLength": 1
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.searchParameters` | `object` | No | — | — |
| `result.data.searchParameters.q` | `string` | No | — | — |
| `result.data.searchParameters.gl` | `string` | No | — | — |
| `result.data.searchParameters.hl` | `string` | No | — | — |
| `result.data.searchParameters.num` | `number` | No | — | — |
| `result.data.searchParameters.autocorrect` | `boolean` | No | — | — |
| `result.data.searchParameters.page` | `number` | No | — | — |
| `result.data.searchParameters.type` | `string` | No | — | — |
| `result.data.knowledgeGraph` | `object` | No | — | — |
| `result.data.knowledgeGraph.title` | `string` | No | — | — |
| `result.data.knowledgeGraph.type` | `string` | No | — | — |
| `result.data.knowledgeGraph.website` | `string` | No | — | — |
| `result.data.knowledgeGraph.imageUrl` | `string` | No | — | — |
| `result.data.knowledgeGraph.description` | `string` | No | — | — |
| `result.data.knowledgeGraph.descriptionSource` | `string` | No | — | — |
| `result.data.knowledgeGraph.descriptionLink` | `string` | No | — | — |
| `result.data.knowledgeGraph.attributes` | `record` | No | — | — |
| `result.data.organic` | `array` | No | — | — |
| `result.data.organic[].title` | `string` | No | — | — |
| `result.data.organic[].link` | `string` | No | — | — |
| `result.data.organic[].snippet` | `string` | No | — | — |
| `result.data.organic[].date` | `string` | No | — | — |
| `result.data.organic[].position` | `number` | No | — | — |
| `result.data.organic[].sitelinks` | `array` | No | — | — |
| `result.data.organic[].sitelinks[].title` | `string` | No | — | — |
| `result.data.organic[].sitelinks[].link` | `string` | No | — | — |
| `result.data.first_result` | `object` | No | — | — |
| `result.data.first_result.title` | `string` | No | — | — |
| `result.data.first_result.link` | `string` | No | — | — |
| `result.data.first_result.snippet` | `string` | No | — | — |
| `result.data.first_result.date` | `string` | No | — | — |
| `result.data.first_result.position` | `number` | No | — | — |
| `result.data.first_result.sitelinks` | `array` | No | — | — |
| `result.data.first_result.sitelinks[].title` | `string` | No | — | — |
| `result.data.first_result.sitelinks[].link` | `string` | No | — | — |
| `result.data.peopleAlsoAsk` | `array` | No | — | — |
| `result.data.peopleAlsoAsk[].question` | `string` | No | — | — |
| `result.data.peopleAlsoAsk[].snippet` | `string` | No | — | — |
| `result.data.peopleAlsoAsk[].title` | `string` | No | — | — |
| `result.data.peopleAlsoAsk[].link` | `string` | No | — | — |
| `result.data.relatedSearches` | `array` | No | — | — |
| `result.data.relatedSearches[].query` | `string` | No | — | — |
| `result.meta` | `record` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "searchParameters": {
            "type": "object",
            "properties": {
              "q": {
                "type": "string"
              },
              "gl": {
                "type": "string"
              },
              "hl": {
                "type": "string"
              },
              "num": {
                "type": "number"
              },
              "autocorrect": {
                "type": "boolean"
              },
              "page": {
                "type": "number"
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "knowledgeGraph": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "website": {
                "type": "string"
              },
              "imageUrl": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "descriptionSource": {
                "type": "string"
              },
              "descriptionLink": {
                "type": "string"
              },
              "attributes": {
                "type": "object",
                "additionalProperties": {}
              }
            },
            "additionalProperties": false
          },
          "organic": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string"
                },
                "link": {
                  "type": "string"
                },
                "snippet": {
                  "type": "string"
                },
                "date": {
                  "type": "string"
                },
                "position": {
                  "type": "number"
                },
                "sitelinks": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "title": {
                        "type": "string"
                      },
                      "link": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "first_result": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "link": {
                "type": "string"
              },
              "snippet": {
                "type": "string"
              },
              "date": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "sitelinks": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string"
                    },
                    "link": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "peopleAlsoAsk": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "question": {
                  "type": "string"
                },
                "snippet": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "link": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "relatedSearches": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "query": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.02` per pricing unit.

## Related documentation

* [Serper provider guide](https://deepline.com/docs/providers/serper/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.