Skip to content

Commit b4622ff

Browse files
Add SearchApi tool documentation
1 parent 595f3e0 commit b4622ff

File tree

3 files changed

+77
-0
lines changed

3 files changed

+77
-0
lines changed

docs/advanced-ai/langchain/langchain-n8n.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ Utility tools.
156156

157157
* [Calculator](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcalculator/)
158158
* [Code Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode/)
159+
* [SearchApi](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolsearchapi/)
159160
* [SerpAPI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolserpapi/)
160161
* [Vector Store Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore/)
161162
* [Wikipedia](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia/)
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
3+
title: SearchApi
4+
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.
5+
priority: high
6+
---
7+
8+
# SearchApi
9+
10+
The SearchApi node allows an agent in your workflow to call Google, Bing, Baidu, Google News, YouTube APIs.
11+
12+
On this page, you'll find the node parameters for the SearchApi node, and links to more resources.
13+
14+
/// note | Credentials
15+
You can find authentication information for this node [here](/integrations/builtin/credentials/searchapi/).
16+
///
17+
18+
--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md"
19+
20+
## Node options
21+
22+
* **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.
23+
* **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.
24+
* **Device**: the device to use to get the search results.
25+
* **Google Domain**: refer to [Supported Google Domains](https://www.searchapi.io/docs/parameters/google/domain) for supported domains.
26+
* **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.
27+
* **Video ID**: defines the video you want to search. Usable only with `youtube_transcripts` engine.
28+
* **Lang**: defines language for transcripts. Usable only with `youtube_transcripts` engine.
29+
30+
## Templates and examples
31+
32+
<!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
33+
[[ templatesWidget(title, 'searchapi') ]]
34+
35+
## Related resources
36+
37+
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/v0.2/docs/integrations/tools/searchapi/){:target=_blank .external-link}.
38+
39+
--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md"
40+
--8<-- "_glossary/ai-glossary.md"
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
3+
title: SearchApi credentials
4+
description: Documentation for the SearchApi credentials. Use these credentials to authenticate SearchApi in n8n, a workflow automation platform.
5+
contentType: integration
6+
priority: high
7+
---
8+
9+
# SearchApi credentials
10+
11+
You can use these credentials to authenticate the following nodes:
12+
13+
* [SearchApi](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolsearchapi/)
14+
15+
## Prerequisites
16+
17+
Create a [SearchApi](https://www.searchapi.io/){:target=_blank .external-link} account.
18+
19+
## Supported authentication methods
20+
21+
- API key
22+
23+
## Related resources
24+
25+
Refer to [SearchApi's API documentation](https://www.searchapi.io/docs/google){:target=_blank .external-link} for more information about the service.
26+
27+
## Using API key
28+
29+
To configure this credential, you'll need:
30+
31+
- An **API Key**
32+
33+
To get your API key:
34+
35+
1. Go to **Your Account >** [**API Key**](https://www.searchapi.io/api_tokens){:target=_blank .external-link}.
36+
2. Copy **Your Private API Key** and enter it as the **API Key** in your n8n credential.

0 commit comments

Comments
 (0)