For the complete documentation index, see llms.txt. This page is also available as Markdown.

Pathway Basic Nodes

The goal of this overview page is to provide details on the notion of basic nodes in voicehub.

Default Node

Overview

The Default Node is a basic node that does not perform any actions. It is used to control the flow and manage how the agent responds to the user.

When to Use

• As the starting point of a flow to begin the conversation. • When you want the agent to reply to the user without triggering any action. • Before Action Nodes to ensure all required data is collected and ready.

Example Usage & How to Use

Use case: Use the Default Node to start the conversation with a greeting and guide the user to share their intent.

How to use:

• Inside the Prompt section, define the starting message for the agent. • Example prompt: “Start a conversation by greeting the user and asking for their intent.”

Knowledge Base Node

Overview

The Knowledge Base Node retrieves relevant information from selected knowledge bases and uses it to generate responses within the flow. It performs semantic search on the knowledge base, retrieves and returns relevant document chunks, and uses this data to generate accurate responses.

When to Use

• When the agent needs to answer based on stored documents or internal data. • When accurate, data-driven answers are required.

Example Usage & How to Use

Use case: FAQ systems where the agent answers user questions based on stored knowledge.

How to use:

• Prompt the node with clear instructions on how it should respond to user queries. • Configure the node to use specific knowledge bases or all knowledge bases in the workspace. • Optionally set the number of chunks to retrieve for generating answers. • Optionally enable including sources in the response for better transparency. • For more details please check here.

Table Retrieval Node

Overview

The Table Retrieval Node allows the flow to query structured data from either an uploaded Excel (.xlsx) knowledge base or a live Google Sheets spreadsheet. It uses an SQL-based engine to read and query the data during the call, and is designed as a read-only node with built-in safety and performance limits.

When to Use

• When you need to retrieve structured data during a conversation. • To query information from Excel files or Google Sheets. • When the agent needs to look up dynamic data (e.g., users, records, pricing, availability). • When working with tabular data instead of unstructured text.

Features

• Supports two data sources:  • Excel File (KB):   • Only .xlsx files are supported.   • File must be fully indexed (status: Done).  • Google Sheets:   • Requires a full spreadsheet URL.   • Must be shared as “Anyone with the link can view”.   • URL is validated before saving. • Uses an SQL-based engine to:  • Automatically detect table structure.  • Identify columns and relationships.  • Execute efficient queries. • Built with safety and performance constraints:  • Read-only (SELECT queries only).  • Maximum of 50 rows per query result.  • Designed to prevent large or expensive operations.

Example Usage & How to Use

Use case: Query structured data such as pricing tables, reports, or customer records from Excel files or Google Sheets during a conversation.

How to use:

• Prompt the node with clear instructions on what data to retrieve and how to use it. • Select a data source type:  • Excel File (KB).  • Google Sheets. • If Excel File (KB) is selected:  • Choose an .xlsx file from the knowledge base.  • Only fully indexed files (status: Done) are selectable. • If Google Sheets is selected:  • Enter the full Google Sheets URL.  • Ensure the sheet is shared as “Anyone with the link can view”. • For more details please check here.

Agent Transfer Node

Overview

The Agent Transfer Node is used to transfer an ongoing conversation from one agent to another. It enables seamless transitions between agents while preserving the conversation context, allowing different agents to handle different parts of the flow.

When to Use

• When you need to handoff the conversation to another agent. • In multi-agent workflows (e.g., Support → Billing → Sales). • When a specific agent is responsible for a specialized task. • To split logic across multiple agents for better organization.

Example Usage & How to Use

Use case: Transfer a conversation from one agent to another (e.g., from a general support agent to a specialized billing or technical agent).

How to use:

• Prompt the node with what the agent should say before transferring the conversation. • Select the target agent (workspace) from the dropdown.

Agent Transfer Return Node

Overview

The Agent Transfer Return Node returns the conversation back to the previous agent after a transfer. It enables structured back-and-forth transitions between agents while preserving execution context, ensuring the flow continues from where it originally transferred.

When to Use

• When you want to return control to the previous agent after completing a task. • In multi-agent workflows that require back-and-forth transitions. • After handling a specialized task in another agent (e.g., billing, verification). • When you want to resume the original flow after a temporary transfer.

Example Usage & How to Use

Use case: Handle multi-step conversations across specialized agents (e.g., support and billing).

Example flow:

• Support Agent → Billing Agent → Support Agent • Billing agent completes the required task (e.g., payment handling). • Uses the Agent Return Node to return the conversation back to the Support agent.

How to use:

• Prompt the node with what the agent should say before transferring. • The Agent Return Node will automatically return control back to the original agent.

Transfer Call Node

Overview

The Transfer Call Node is used to transfer the ongoing conversation to a real (human) agent. It allows the system to hand off the call from the AI agent to a live representative when human intervention is required.

The transfer node can only be used in VoIP calls. Transferring webcalls, text calls and avatar calls is currently not supported.

When to Use

• When the user requests to speak with a human agent. • When human verification or support is needed.

Example Usage & How to Use

Use case: Transfer an ongoing call from the AI agent to a real human agent when escalation is required (e.g., when the user explicitly requests a human).

How to use: • Prompt the node with what the agent should say before transferring the call. • Add one or more valid transfer phone numbers.

Hint: This node can be configured as a global node, allowing the agent to transfer the user to a human at any point in the call when needed.

End Call Node

Overview

The End Call Node is used to terminate the current call. It marks the end of the interaction, ensuring the session is properly closed after the agent has completed its task.

When to Use

• When the conversation has reached its natural conclusion. • When the user indicates they are done or no longer need help.

Example Usage & How to Use

Use case: End the conversation once the user’s request has been fully resolved or when the user indicates they no longer need assistance.

How to use: • Place the node at the final step of the call flow to terminate the conversation. • Ensure the agent provides a closing message before ending the call.

Last updated