Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SearchApi tool documentation #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/advanced-ai/examples/understand-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Here are a couple of other ways of expressing it:

## AI tools in n8n

n8n provides tool sub-nodes that you can connect to your AI agent. As well as providing some popular tools, such as [Wikipedia](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia/) and [SerpAPI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolserpapi/), n8n provides three especially powerful tools:
n8n provides tool sub-nodes that you can connect to your AI agent. As well as providing some popular tools, such as [Wikipedia](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia/),[SearchApi](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolsearchapi/), and [SerpAPI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolserpapi/), n8n provides three especially powerful tools:

* [Custom n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow/): use this to load any n8n workflow as a tool.
* [Custom Code Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode/): write code that your agent can run.
Expand Down
1 change: 1 addition & 0 deletions docs/advanced-ai/langchain/langchain-n8n.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ Utility tools.

* [Calculator](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcalculator/)
* [Code Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode/)
* [SearchApi](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolsearchapi/)
* [SerpAPI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolserpapi/)
* [Vector Store Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore/)
* [Wikipedia](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia/)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: SearchApi
description: Documentation for the SearchApi node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
priority: high
---

# SearchApi

The SearchApi node allows an agent in your workflow to call Google, Bing, Baidu, Google News, YouTube APIs.

On this page, you'll find the node parameters for the SearchApi node, and links to more resources.

/// note | Credentials
You can find authentication information for this node [here](/integrations/builtin/credentials/searchapi/).
///

--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md"

## Node options

* **Engine**: defines an engine that will be used to retrieve real-time data. Refer to [documentation](https://www.searchapi.io/docs/google) for all available engines.
* **Country**: refer to [Google GL Parameter: Supported Google Countries](https://www.searchapi.io/docs/parameters/google/gl){:target=_blank .external-link} for supported countries and country codes.
* **Device**: the device to use to get the search results.
* **Google Domain**: refer to [Supported Google Domains](https://www.searchapi.io/docs/parameters/google/domain) for supported domains.
* **Language**: refer to [Google HL Parameter: Supported Google Languages](https://www.searchapi.io/docs/parameters/google/hl){:target=_blank .external-link} for supported languages and language codes.
* **Video ID**: defines the video you want to search. Usable only with `youtube_transcripts` engine.
* **Lang**: defines language for transcripts. Usable only with `youtube_transcripts` engine.

## Templates and examples

<!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
[[ templatesWidget(title, 'searchapi') ]]

## Related resources

Refer to [SearchApi's documentation](https://www.searchapi.io/){:target=_blank .external-link} for more information about the service. You can also view [LangChain's documentation on integration](https://js.langchain.com/docs/integrations/tools/searchapi/){:target=_blank .external-link}.

--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md"
--8<-- "_glossary/ai-glossary.md"
36 changes: 36 additions & 0 deletions docs/integrations/builtin/credentials/searchapi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
title: SearchApi credentials
description: Documentation for the SearchApi credentials. Use these credentials to authenticate SearchApi in n8n, a workflow automation platform.
contentType: integration
priority: high
---

# SearchApi credentials

You can use these credentials to authenticate the following nodes:

* [SearchApi](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolsearchapi/)

## Prerequisites

Create a [SearchApi](https://www.searchapi.io/){:target=_blank .external-link} account.

## Supported authentication methods

- API key

## Related resources

Refer to [SearchApi's API documentation](https://www.searchapi.io/docs/google){:target=_blank .external-link} for more information about the service.

## Using API key

To configure this credential, you'll need:

- An **API Key**

To get your API key:

1. Go to **Your Account >** [**API Key**](https://www.searchapi.io/api_tokens){:target=_blank .external-link}.
2. Copy **Your Private API Key** and enter it as the **API Key** in your n8n credential.