Skip to content

Commit 3026c33

Browse files
committed
updating readmes
1 parent 4da9d36 commit 3026c33

File tree

3 files changed

+41
-35
lines changed

3 files changed

+41
-35
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,17 @@ Search the web with [SearchApi.io](https://www.searchapi.io/) directly from your
1414
### Via the n8n UI (recommended)
1515

1616
1. Open **Settings → Community Nodes** inside your self‑hosted n8n instance.
17-
2. Click **Install → Browse** and search for `n8n-nodes-searchapi`.
17+
2. Fill **npm Package Name** with `@searchapi/n8n-nodes-searchapi`.
1818
3. Select the package, accept the risk prompt, and hit **Install**.
19+
4. It should now appear as a node when you search for it.
1920

2021
### Via the command line
2122

2223
```bash
2324
# inside your n8n installation folder
24-
npm install n8n-nodes-searchapi
25+
npm install @searchapi/n8n-nodes-searchapi
2526
# or with pnpm
26-
pnpm add n8n-nodes-searchapi
27+
pnpm add @searchapi/n8n-nodes-searchapi
2728
```
2829

2930
Restart n8n after the install finishes.
@@ -50,7 +51,7 @@ Restart n8n after the install finishes.
5051

5152
1. Add the **SearchApi** node to your workflow.
5253
2. Choose your **Credential** and the **Engine**.
53-
3. Under **Parameters,** click **Add Parameter** for each query string field you need. To determine which fields to add, refer to the engine's documentation.
54+
3. Under **Parameters,** click **Add Parameter** for each query string field you need. To determine which fields to add, refer to the engine's documentation. Example:
5455
- **Name**: `q`
5556
- **Value**: `weather new york`
5657
4. Execute the workflow to receive the response as JSON.

examples/searchapi_chatbot/README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## 🤖 AI Agent Web Search using SearchAPI & LLM
1+
## 🤖 AI Agent Web Search using SearchApi & LLM
22

33
### Who is this for?
44

@@ -10,26 +10,28 @@ This workflow automates web searches by enabling an AI agent to retrieve and sum
1010

1111
### What this workflow does
1212

13-
* Connects an AI agent node to [SearchAPI.io](https://searchapi.io/) as an integrated search tool.
14-
* Empowers the AI agent to perform real-time web searches using various SearchAPI engines (e.g., Google, Bing).
13+
* Connects an AI agent node to [SearchApi.io](https://www.searchapi.io/) as an integrated search tool.
14+
* Empowers the AI agent to perform real-time web searches using various SearchApi engines (e.g., Google, Bing).
1515
* Allows the AI agent to dynamically determine search parameters based on user interaction, delivering contextually relevant results.
1616
* Ensures responses include clearly cited sources for validation and further exploration.
1717

1818
### Setup
1919

20-
1. **API Configuration**:
20+
1. **Install the [SearchApi community node](https://www.npmjs.com/package/@searchapi/n8n-nodes-searchapi)**:
21+
* Open **Settings → Community Nodes** inside your self‑hosted n8n instance.
22+
* Fill **npm Package Name** with `@searchapi/n8n-nodes-searchapi`.
23+
* Accept the risk prompt, and hit **Install**.
24+
* It should now appear as a node when you search for it.
2125

22-
* Set your [SearchAPI.io](https://searchapi.io/) credentials in n8n.
23-
* Connect your preferred AI provider (e.g., OpenRouter, ChatGPT) to the AI agent node.
26+
2. **API Configuration**:
27+
* Set up your [SearchApi.io](https://www.searchapi.io/) credentials in n8n.
28+
* Add your preferred LLM provider credentials (e.g., OpenRouter API).
2429

25-
2. **Input Requirements**:
30+
3. **Input Requirements**:
31+
* Provide the YouTube video ID (e.g., `wBuULAoJxok`).
2632

27-
* User inputs queries via chat interaction with the AI agent.
28-
29-
3. **Configure the AI Agent Node**:
30-
31-
* Select the desired search engines from SearchAPI (e.g., Google, Bing).
32-
* Define parameters the agent can adjust for refined searches.
33+
4. **Connect LLM Integration**:
34+
* Configure the summarization chain with your chosen model and parameters for text splitting.
3335

3436
### How to customize this workflow to your needs
3537

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,45 @@
1-
## 🎥 Summarize YouTube Videos using SearchAPI & LLM
1+
## 🎥 Summarize YouTube Videos using SearchApi & LLM
22

33
### Who is this for?
44

5-
This workflow is perfect for **content creators**, **students**, **digital marketers**, **educators**, and **researchers** who want to quickly summarize YouTube videos.
5+
This workflow is ideal for **content creators**, **students**, **digital marketers**, **educators**, and **researchers** who want to quickly summarize YouTube videos.
66

7-
### What problem does this workflow solve? / Use case
7+
### What problem does this workflow solve?
88

9-
Manually extracting important information from lengthy YouTube videos can be tedious and error-prone. This workflow streamlines the process by automatically fetching video transcripts using [SearchAPI.io](https://searchapi.io/) and producing concise, informative summaries through a summarization chain powered by any LLM provider. This allows users to rapidly access crucial information without manual transcription or detailed watching.
9+
Manually extracting important information from lengthy YouTube videos can be tedious and prone to errors. This workflow streamlines the process by automatically fetching video transcripts using [SearchApi.io](https://www.searchapi.io/) and producing concise, informative summaries through a summarization chain powered by any LLM provider. This allows users to quickly access crucial information without the need for manual transcription or detailed viewing.
1010

1111
### What this workflow does
1212

13-
* Fetches the complete transcript of a YouTube video using SearchAPI.
13+
* Fetches the complete transcript of a YouTube video using SearchApi.
1414
* Combines the retrieved transcript into a single, continuous text.
15-
* Uses a **Summarization Chain** with an LLM (e.g., OpenRouter models) to create a concise summary of the video content.
15+
* Utilizes a **Summarization Chain** with an LLM (e.g., OpenRouter models) to create a concise summary of the video content.
1616

1717
### Setup
1818

19-
1. **API Configuration**:
19+
1. **Install the [SearchApi community node](https://www.npmjs.com/package/@searchapi/n8n-nodes-searchapi)**:
20+
* Open **Settings → Community Nodes** inside your self‑hosted n8n instance.
21+
* Fill **npm Package Name** with `@searchapi/n8n-nodes-searchapi`.
22+
* Accept the risk prompt, and hit **Install**.
23+
* It should now appear as a node when you search for it.
2024

21-
* Set up your [SearchAPI.io](https://searchapi.io/) credentials in n8n.
25+
2. **API Configuration**:
26+
* Set up your [SearchApi.io](https://www.searchapi.io/) credentials in n8n.
2227
* Add your preferred LLM provider credentials (e.g., OpenRouter API).
2328

24-
2. **Input Requirements**:
25-
29+
3. **Input Requirements**:
2630
* Provide the YouTube video ID (e.g., `wBuULAoJxok`).
2731

28-
3. **Connect LLM Integration**:
29-
32+
4. **Connect LLM Integration**:
3033
* Configure the summarization chain with your chosen model and parameters for text splitting.
3134

32-
### How to customize this workflow to your needs
35+
### How to customize this workflow to meet your needs
3336

34-
* Adjust the summarization model or modify text-splitter parameters to handle different lengths and complexities of video transcripts.
35-
* Integrate additional nodes to export summaries directly into your tools of choice, such as Google Drive, Slack, or email.
36-
* Customize prompt templates in the summarization chain to obtain different summary styles (bullet points, paragraphs, etc.).
37-
* Modify the trigger to what works best for you.
37+
* Adjust the summarization model or modify text-splitter parameters to accommodate different lengths and complexities of video transcripts.
38+
* Integrate additional nodes to export summaries directly into your preferred tools, such as Google Drive, Slack, or email.
39+
* Customize prompt templates in the summarization chain to obtain various summary styles (bullet points, paragraphs, etc.).
40+
* Modify the trigger to suit your workflow.
3841

3942
### Example Usage
4043

4144
1. **Input**: YouTube video ID (`wBuULAoJxok`).
42-
2. **Output**: A concise, actionable summary highlighting key ideas, recommendations, and insights from the video.
45+
2. **Output**: A concise, actionable summary that highlights key ideas, recommendations, and insights from the video.

0 commit comments

Comments
 (0)