> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/serpapi.md).

# SerpAPI

SerpAPI provides structured search engine results. Connect to run web, news, and job searches and convert websites to markdown from your AI workflows.

## Connectors

This provider has no standalone connector in the StackAI catalog. Configure any access or service settings in the selected action or feature, using its field reference below.

## Use an action

1. Add the required **SerpAPI** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Job Search

Search for jobs on the web

#### Inputs

| Field             | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Query             | string          | Yes      | The query to search for.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Number of results | number          | No       | The number of results to return. Default: 5.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Country           | select (string) | No       | The country to search in. Available values: ARGENTINA, AUSTRALIA, AUSTRIA, BELGIUM, BRAZIL, CANADA, CHILE, CHINA, COLOMBIA, CZECH\_REPUBLIC, DENMARK, FINLAND, FRANCE, GERMANY, HONG\_KONG, INDIA, INDONESIA, ITALY, JAPAN, KOREA, MALAYSIA, MEXICO, NETHERLANDS, NEW\_ZEALAND, NORWAY, PHILIPPINES, POLAND, PORTUGAL, RUSSIA, SAUDI\_ARABIA, SINGAPORE, SOUTH\_AFRICA, SPAIN, SWEDEN, SWITZERLAND, TAIWAN, THAILAND, TURKEY, UNITED\_KINGDOM, UNITED\_STATES. Default: US.                                                     |
| Language          | select (string) | No       | The language to search in. Available values: ARABIC, BULGARIAN, CATALAN, CHINESE\_SIMPLIFIED, CHINESE\_TRADITIONAL, CZECH, DANISH, DUTCH, ENGLISH, ESTONIAN, FINNISH, FRENCH, GERMAN, GREEK, HEBREW, HINDI, HUNGARIAN, INDONESIAN, ITALIAN, JAPANESE, KANNADA, KOREAN, LATVIAN, LITHUANIAN, MALAY, MALAYALAM, MARATHI, NORWEGIAN, POLISH, PORTUGUESE\_BRAZIL, PORTUGUESE\_PORTUGAL, PUNJABI, ROMANIAN, RUSSIAN, SERBIAN, SLOVAK, SLOVENIAN, SPANISH, SWEDISH, TAMIL, TELUGU, THAI, TURKISH, UKRAINIAN, VIETNAMESE. Default: en. |

#### Outputs

| Field | Type   | Description     |
| ----- | ------ | --------------- |
| Jobs  | string | The jobs found. |

### Website to Markdown

Get a website as markdown

#### Inputs

| Field    | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| -------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| URL      | string          | Yes      | The URL to convert to markdown.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Location | select (string) | Yes      | The geographic location from which to perform the search. Available values: ARGENTINA, AUSTRALIA, AUSTRIA, BELGIUM, BRAZIL, CANADA, CHILE, CHINA, COLOMBIA, CZECH\_REPUBLIC, DENMARK, FINLAND, FRANCE, GERMANY, HONG\_KONG, INDIA, INDONESIA, ITALY, JAPAN, KOREA, MALAYSIA, MEXICO, NETHERLANDS, NEW\_ZEALAND, NORWAY, PHILIPPINES, POLAND, PORTUGAL, RUSSIA, SAUDI\_ARABIA, SINGAPORE, SOUTH\_AFRICA, SPAIN, SWEDEN, SWITZERLAND, TAIWAN, THAILAND, TURKEY, UNITED\_KINGDOM, UNITED\_STATES. Default: US. |

#### Outputs

| Field    | Type   | Description                                 |
| -------- | ------ | ------------------------------------------- |
| Markdown | string | The markdown representation of the website. |

### News Search

Search for news articles on the web

#### Inputs

| Field    | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| -------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Query    | string          | Yes      | The query to search for.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Location | select (string) | No       | The location to search in. Available values: ARGENTINA, AUSTRALIA, AUSTRIA, BELGIUM, BRAZIL, CANADA, CHILE, CHINA, COLOMBIA, CZECH\_REPUBLIC, DENMARK, FINLAND, FRANCE, GERMANY, HONG\_KONG, INDIA, INDONESIA, ITALY, JAPAN, KOREA, MALAYSIA, MEXICO, NETHERLANDS, NEW\_ZEALAND, NORWAY, PHILIPPINES, POLAND, PORTUGAL, RUSSIA, SAUDI\_ARABIA, SINGAPORE, SOUTH\_AFRICA, SPAIN, SWEDEN, SWITZERLAND, TAIWAN, THAILAND, TURKEY, UNITED\_KINGDOM, UNITED\_STATES. Default: US.                                                    |
| Country  | select (string) | No       | The country to search in. Available values: ARGENTINA, AUSTRALIA, AUSTRIA, BELGIUM, BRAZIL, CANADA, CHILE, CHINA, COLOMBIA, CZECH\_REPUBLIC, DENMARK, FINLAND, FRANCE, GERMANY, HONG\_KONG, INDIA, INDONESIA, ITALY, JAPAN, KOREA, MALAYSIA, MEXICO, NETHERLANDS, NEW\_ZEALAND, NORWAY, PHILIPPINES, POLAND, PORTUGAL, RUSSIA, SAUDI\_ARABIA, SINGAPORE, SOUTH\_AFRICA, SPAIN, SWEDEN, SWITZERLAND, TAIWAN, THAILAND, TURKEY, UNITED\_KINGDOM, UNITED\_STATES. Default: US.                                                     |
| Language | select (string) | No       | The language to search in. Available values: ARABIC, BULGARIAN, CATALAN, CHINESE\_SIMPLIFIED, CHINESE\_TRADITIONAL, CZECH, DANISH, DUTCH, ENGLISH, ESTONIAN, FINNISH, FRENCH, GERMAN, GREEK, HEBREW, HINDI, HUNGARIAN, INDONESIAN, ITALIAN, JAPANESE, KANNADA, KOREAN, LATVIAN, LITHUANIAN, MALAY, MALAYALAM, MARATHI, NORWEGIAN, POLISH, PORTUGUESE\_BRAZIL, PORTUGUESE\_PORTUGAL, PUNJABI, ROMANIAN, RUSSIAN, SERBIAN, SLOVAK, SLOVENIAN, SPANISH, SWEDISH, TAMIL, TELUGU, THAI, TURKISH, UKRAINIAN, VIETNAMESE. Default: en. |

#### Outputs

| Field  | Type   | Description                    |
| ------ | ------ | ------------------------------ |
| Result | string | The result of the news search. |

### Web Search

Search the web for information.

#### Inputs

| Field             | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ----------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Query             | string          | Yes      | Enter the search terms you want to look up on the web.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Number of results | number          | No       | Specify how many search results you want to retrieve (default: 5). Default: 5.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Device            | select (string) | No       | Choose whether to simulate search results as seen on desktop or mobile devices. Available values: Desktop, Mobile. Default: desktop.                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Country           | select (string) | No       | Select which country's search engine to use for results. Available values: ARGENTINA, AUSTRALIA, AUSTRIA, BELGIUM, BRAZIL, CANADA, CHILE, CHINA, COLOMBIA, CZECH\_REPUBLIC, DENMARK, FINLAND, FRANCE, GERMANY, HONG\_KONG, INDIA, INDONESIA, ITALY, JAPAN, KOREA, MALAYSIA, MEXICO, NETHERLANDS, NEW\_ZEALAND, NORWAY, PHILIPPINES, POLAND, PORTUGAL, RUSSIA, SAUDI\_ARABIA, SINGAPORE, SOUTH\_AFRICA, SPAIN, SWEDEN, SWITZERLAND, TAIWAN, THAILAND, TURKEY, UNITED\_KINGDOM, UNITED\_STATES. Default: US.                                                 |
| Language          | select (string) | No       | Choose the language for search results and interface. Available values: ARABIC, BULGARIAN, CATALAN, CHINESE\_SIMPLIFIED, CHINESE\_TRADITIONAL, CZECH, DANISH, DUTCH, ENGLISH, ESTONIAN, FINNISH, FRENCH, GERMAN, GREEK, HEBREW, HINDI, HUNGARIAN, INDONESIAN, ITALIAN, JAPANESE, KANNADA, KOREAN, LATVIAN, LITHUANIAN, MALAY, MALAYALAM, MARATHI, NORWEGIAN, POLISH, PORTUGUESE\_BRAZIL, PORTUGUESE\_PORTUGAL, PUNJABI, ROMANIAN, RUSSIAN, SERBIAN, SLOVAK, SLOVENIAN, SPANISH, SWEDISH, TAMIL, TELUGU, THAI, TURKISH, UKRAINIAN, VIETNAMESE. Default: en. |

#### Outputs

| Field              | Type          | Description                                                                       |
| ------------------ | ------------- | --------------------------------------------------------------------------------- |
| Web Search Results | object\_array | A collection of web search results containing URLs, titles, and content snippets. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/serpapi.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
