# Create an agent
Source: https://relevanceai.com/docs/agent/agent-configuration
How to create AI agents with Relevance
## Create an agent
Creating agents involves giving the agent information about who they are, what they are capable of and what is expected of them. You can create a brand new agent, or use one of our existing agent templates.
1. Login to your [Relevance AI](https://relevanceai.com/) account ([app.relevanceai.com](https://relevanceai.com/)).
2. Go to the [Agents](/agent) page (in the sidebar).
3. Click `Build from scratch` in the top right-hand corner of the page.
4. Give your agent a name, description and profile image.
5. Click `Confirm` to save your agent.
[Create your first AI agent!](https://auth.relevanceai.com/signup/)
# Agent profile
Source: https://relevanceai.com/docs/agent/customise-agent/agent-profile
Navigate to **Agents** in the left sidebar and click on `Build agent from scratch`. This will bring you to the **Agent profile** section of the edit agent interface.
Select an image to represent your agent, and give your agent a name. Then write a description for your agent that reflects it's role.
Be specific about it's domain expertise and key tasks.
# Triggers
Source: https://relevanceai.com/docs/agent/customise-agent/agent-triggers
## Understand triggers
Triggers are ways to initiate an agent's task. Relevance AI offers several ways to activate your agent:
Manual Trigger: send a message to your agent via the Relevance AI interface.
Integration Triggers: select from one of our prebuilt integrations triggers.
Webhook Trigger: handle incoming webhooks to trigger your agent.
API Trigger: programmatically initiate tasks using the Relevance AI API.
## Set up triggers
In the left side bar, click **Integrations**. Here, you'll see a list of options to connect. Once you've added an account to your chosen integration, head back to your agent's edit interface.
In **Agent profile** under the **Integrations** section, you'll find available triggers. Select the one you need, and configure the the trigger settings.
You'll be able to customize how and when your agent processes events from this trigger to align with your work habits.
While Relevance has many built in triggers, if you don't see the third party service you want to use in our list of options, you can try using custom webhook, Zapier or API to build your own trigger.
# Bulk scheduling
Source: https://relevanceai.com/docs/agent/customise-agent/bulk-schedule
Bulk Scheduling is a feature available to Team Plus users on the Relevance AI platform. This functionality allows you to set up and schedule multiple tasks for your agent to run automatically.
## How to access bulk scheduling
1. Navigate to your agent's interface.
2. Look for the dropdown menu next to the `+ New Task` button.
3. Select `Schedule in bulk` from the options.
## Setting up a batch schedule
When setting up a batch schedule, you'll need to:
1. Select the knowledge table that contains the data you want your agent to process.
2. Name your batch job.
## Using the agent message template
The Agent Message template is where you define how your agent should interact with each entry in your knowledge table. This is done using a templating system that allows you to dynamically insert values from your table into the agent's instructions.
**Key points:**
* Double Brace Syntax: to insert values from your table, use double braces around the column name.
* Column Names: you can use any column from your selected knowledge table.
* Example Usage: if you have a column named "company" in your table, you could create a template like this: "Please analyze the performance of company based on the provided data."
## Using the cadence contract
A key feature of bulk scheduling is the cadence contract, which allows you to fine-tune how and when tasks are distributed. This ensures that your automated workflows align perfectly with your team's schedule and work patterns.
**Key components:**
* Timezone: Select your preferred timezone to ensure tasks are scheduled according to your local time, for example: Australia - Sydney.
* Work Days: Specify which days of the week tasks should be scheduled.
* Work Hours: Set the time range during which tasks should be executed. You also have the option to select "All day" for 24/7 task execution.
* Task Distribution: Define the number of tasks to be sent per interval. For example, set a specific number of tasks per day. The actual number of tasks your agent can execute may vary due to factors like conflicting contract conditions and rate limiting.
* Override Mode: This give you the option to run all created tasks in override mode, which can be useful for testing or when you need to maintain specific inputs/outputs across all tasks.
### Best practices for cadence contract
* Align with team availability: Set work days and hours that match your team's actual working schedule to ensure timely handling of task outputs.
* Consider task complexity: Adjust the number of tasks per interval based on the complexity of each task and your team's capacity.
* Start conservative: Begin with a lower number of tasks per interval and gradually increase as you assess your team's capacity and the agent's performance.
**In summary**
Once you've configured the cadence contract, hit `Schedule`.
You can check which bulk schedules you have set up by navigating to the three dots in the top right corner of your agent chat interface and selecting “Bulk schedules”.
# Configure template
Source: https://relevanceai.com/docs/agent/customise-agent/configure-template
## Configure template
The **Configure template** feature in Relevance AI is essentially a way to create customizable settings for your agent, similar to how you set up user inputs in the tool builder. This feature makes agent creation and sharing more efficient and user-friendly.
Firstly, it's a time-saver for repetitive information. If you're building an agent that frequently needs to reference certain data - like your company's name or description - you can create template settings for these details. Instead of copying and pasting this information into various places such as the flow builder or core instructions, you can simply reference the template setting. This approach not only saves time but also ensures consistency across your agent's configuration.
Our template feature shines when you want to share your agent with others. By setting up template configurations, you make it easy for other users to customize the agent to their needs. They can simply adjust the template settings to make the agent relevant to their specific use case, without having to dive deep into the agent's core setup.
These template settings are versatile and can be used throughout the agent's configuration - in core instructions, the Flow Builder, and even in tool settings. This flexibility allows for a high degree of customization while maintaining the core functionality of the agent.
# Core instructions
Source: https://relevanceai.com/docs/agent/customise-agent/core-instructions
Core instructions guide your agent's behavior and decision-making process.
When writing instructions, clearly state the agent's role and primary objectives, and outline step-by-step procedures for it's tasks.
It can also be helpful to give your agent examples of scenarios it might encounter, and examples of it's expected responses.
#### Markdown support
We offer markdown support for any area that accepts LLM prompts, like the core instructions, the flow builder and the LLM tool steps.
LLMs are well-trained on markdown and can draw meaning from your headings and bullet points to improve how they interpret your prompt. Using Markdown to create your prompts allows you to create a prompt that is easier for humans to read, and also easier for an LLM to understand.
Here is a table of markdown formatting options you can use when writing your prompts. If you're using windows, replace `Cmd` with `Ctrl` and `Opt` with `Alt`.
| Element | Shortcut | Markdown Syntax |
| --------------- | -------------------- | ---------------------------------------------------------------------------------------- |
| Bold | `Cmd+B` | `**bold text**` |
| Italics | `Cmd+I` | `*italicized text*` |
| Heading 1-6 | `Cmd+1`, ... `Cmd+6` | `# Large heading`, `###### Small heaidng` |
| Bullet Lists | `Cmd+Shift+8` | `- List items start with a dash`, or a `*` or `+`. Nest sub-items with 2 spaces or tabs. |
| Numbered Lists | `Cmd+Shift+7` | `1. List items start with a number` |
| Horizontal Rule | `Cmd+Shift+-` | `---` |
| Code | `Cmd+E` | \`code\` |
| Code Block | `Cmd+Shift+E` | \`\`\` code block \`\`\` |
You can also select variables and reference tools and sub agents:
* Select a variable: Type in `{{` to bring up the variable picker name. Variables appear in your document surrounded in curly braces, like this: `{{selected_variable}}`.
* Reference a tool: Type in `/` to bring up the reference picker. Here you will be able to select tools or agents etc that you want to reference in your prompt.
# Escalate to humans
Source: https://relevanceai.com/docs/agent/customise-agent/escalate
When your agent encounters situations beyond its capabilities or is unsure how to act, it can get in touch with a human member of your team and ask for instructions, giving your agent a direct line to your team's expertise.
This feature acts as a safety net, ensuring that complex or sensitive tasks are handled appropriately, and maintaining the quality of your agent's output.
## Setting up an escalation channels
In the Abilities settings of your agent, you can configure various communication channels for escalation. These include:
**Email:** The agent can send an email to a designated address or team.
**Slack:** Integration with Slack allows the agent to post messages to specific channels or individuals.
# Flow builder
Source: https://relevanceai.com/docs/agent/customise-agent/flowbuilder
Flow Builder is where you can give your agent more guidance about it's tasks by setting up conditional logic with "if-then" statements.
You can create complex, branching decision trees for it to follow, and add specific instructions for different scenarios.
# Give agent tools
Source: https://relevanceai.com/docs/agent/customise-agent/give-agent-tools
Tools enhance your agent's capabilities, allowing it to perform specific tasks or access external resources.
In the edit agent interface, select **Tools** and choose from pre-built templates or add custom tools you've created under `Add new tool`.
You have a few options to configure usage:
**Auto run:** tool runs automatically when used by an agent.
**Approval required:** agent asks for permission before using the tool.
**Let agent decide:** agent determines when to use the tool based on context.
Finally, you can give your agent some guidance about how to use it's tools in it's core instructions and in the Flow Builder.
# Labelling
Source: https://relevanceai.com/docs/agent/customise-agent/labelling
Task labelling allows your agent to categorize and organize its work.
In the **Connected resources** section of your edit agent interface, go to `Label tasks` and add a tag.
Name the tag and give clear descriptions for how the agent should use it.
For example, a blog writing agent might label the first blog it produces 'First draft'.
# Override mode
Source: https://relevanceai.com/docs/agent/customise-agent/override-mode
When developing an AI agent, it's important to test specific scenarios and responses. Override Mode lets you:
**Hard-code inputs:** You can manually set specific inputs for your agent, simulating particular situations or user queries.
**Define outputs:** Predetermined outputs can be set at various stages of the agent's task, allowing you to test how the agent handles specific information or decisions.
This level of control is really valuable when you're troubleshooting issues, verifying the agent's logic, or exploring how it handles edge cases.
Beyond testing, Override Mode offers a practical way to conserve resources:
Lock in inputs and outputs: by predetermining certain inputs and outputs, you prevent the agent from regenerating them repeatedly.
Save credits: this approach can significantly reduce the number of API calls or computations required, thereby saving on usage credits.
This is particularly useful in scenarios where parts of the agent's task remain constant across multiple runs, or when you're working with a limited budget.
## How to use Override Mode
Navigate to the three dots in the top right corner of the agent chat interface and toggle on `Override Mode`.
Select whether you want to clone the task into override mode for testing, or go directly to Override Mode.
Click the gear icon to bring up the edit agent interface, and navigate to **Tools**. If a tool has been added to your agent, you can now toggle on and configure `Override input` or `Override output`.
Specify the inputs or outputs you want to override, then run the task with these overrides in place.
Remember, while in Override Mode, your agent will use the specified inputs and outputs instead of generating them dynamically, and this can affect the agent's normal decision-making process.
# Schedule messages
Source: https://relevanceai.com/docs/agent/customise-agent/schedule-messages
You can give your agent the ability to plan and send messages at specified times in the future.
Enable **Scheduled messages** in the **Abilities** settings, then tell your agent when you want it to send a message in it's core instructions.
# Share your agent
Source: https://relevanceai.com/docs/agent/customise-agent/share-agent
Navigate to the “Share” button in the top right of the agent chat interface.
Relevance AI offers two options for sharing your agents to enable collaboration and wider usage.
1. **Allow others to clone as template:** Toggle this on to let others create their own version of your agent. Users can clone the agent into their own projects.
2. **Allow sharing & embedding of your agent:** Create a shareable and embeddable version of your agent. This allows others to use your agent directly, with usage charged to your Relevance account. It's ideal for adding agents to websites, applications, or shared workspaces.
# Subagents
Source: https://relevanceai.com/docs/agent/customise-agent/subagents
Sometimes one agent isn't enough to handle complex tasks, and that's where subagents come in. Subagents are specialized agents that work under a main 'manager' agent, creating a hierarchical structure that allows for more sophisticated and diverse task handling. This feature in Relevance enables you to build advanced multi-agent systems, mimicking the structure of human teams.
## Why use subagents?
**Specialization:** Just as human teams have members with different expertise, subagents can be designed to excel in specific domains or tasks. For example, you might have one subagent specialized in data analysis, another in customer communication, and a third in scheduling.
**Scalability:** Complex workflows can be broken down into manageable parts, each handled by a different subagent. This modular approach allows you to tackle intricate processes more efficiently and makes it easier to scale your AI operations as needs grow.
**Flexibility:** By combining different subagents, you can create versatile AI systems capable of handling a wide range of tasks without the need to build a single, overly complex agent.
### How to set up subagents
Navigate to the "Subagents" section in your main agent's settings. This is where you'll manage your AI team.
Click "Add Subagent" to select from existing agents. You can choose agents you've already created or build new ones specifically for this purpose.
For each subagent, you have three options for how your manager agent interacts with them:
**Autorun:** The subagent is automatically activated when needed, without requiring approval.
**Approval required:** The manager agent must get permission before activating the subagent.
**Let agent decide:** The manager agent uses its judgment to determine whether to autorun or seek approval.
These options allow you to balance autonomy and control in your multi-agent system.
When adding subagents, consider the following best practices:
* Clearly define the role and responsibilities of each subagent.
* Ensure efficient communication protocols between the manager agent and subagents.
* Regularly review and optimize your agent hierarchy to improve overall performance.
# Task template
Source: https://relevanceai.com/docs/agent/customise-agent/task-template
When you need to modify an agent's behavior for a single task or a specific scenario, you can change the task template settings. This lets you make temporary adjustments without altering the agent's core configuration.
Let's say your agent has a template setting for a 'friendly personality' which generally defines how the agent interacts. This setting probably works for most tasks, but there might be situations where you want to temporarily adjust it. If you need the agent to adopt a more serious tone for a particular task, you can override the 'personality' setting just for that interaction.
This override capability allows you to fine-tune your agent's behavior on the fly without the need to save changes to the overall agent settings. It's like giving your agent a temporary persona or skill set, tailored to the specific requirements of a single task.
Once the task is complete, your agent reverts to its default settings automatically. This means you can experiment with different configurations or respond to unique situations without worrying about permanently altering your agent.
# Introduction to agents
Source: https://relevanceai.com/docs/agent/introduction
Introduction to AI agents and building your AI Workforce!
## What are agents?
Agents are reasoning bots powered by LLMs that plan and complete tasks on autopilot. They are given tools, and decide how to use tools to achieve their goals and complete work.
## Get started with agents
There are a few ways you can get started with building your own agents:
You can use one of our existing agent templates which have been created by domain experts in our own team. Modifying an agent is often easier than creating one from scratch (our help docs aim to reduce that gap).
You can build an agent entirely from scratch. Our agent quickstart guide will get you familiar with all the building blocks that make up building out your agents and multi-agent teams.
## Your AI Agent Workforce
You can scale agents and multi-agent teams up and down to meet demand. Many of our customers experience seasonal fluctuations in demand, with some time periods or regions requiring more support than others (E.g. Education, hospitality and finance industries).
You can use agents to automate repetitive time-consuming tasks, so that your human employees can be freed up to do more engaging work. Our sales customers love that they can spend more time on customer meetings and closing deals instead of spending so much time qualifying leads. Their BDR agent frees let them move most of there efforts further down the funnel.
If your agent cannot answer a question it has been asked by a customer, it can loop in a sales rep or a manager via your preferred communications tool (email, instant chat etc), and store the answer for future use. We send our "I don't know" escalation into a Slack channel. Anyone in our team can just click on the link in there, come into Relevance and give it an answer. Our agent will then rephrase that and answer our customer. You can also insert it into an FAQ knowledge base if you want.
Agents on our platform can complete work end-to-end without you needing to be involved at all. For example, we have an agent that checks for new public tools that have been released on our platform every weekday at 9am, and then produces tool explainer webpages and uploads them to Webflow without needing our input at all. The best use-cases for autopilot agents are those that are low-risk (nothing terrible will happen if something goes wrong).
Agents do not have to respond to tasks in the exact same way ever time like traditional software solutions. They have the ability to choose the most appropriate way to respond on a case-by-case basis. E.g. A customer support agent might be asked to help a customer resolve a billing issue on one day, or to troubleshoot a technical bug on another day.
# Agent templates
Source: https://relevanceai.com/docs/agent/templates
Use our pre-built AI agent templates
## What are agent templates?
Agent templates are pre-built agent team-members that you can use out-of-the box to get specific jobs done. We encourage you to use these as a launch pad to build agents that are more custom and tailored to your own company goals. They're a great place to try out agents and get an idea for what they're capable of.
## Use an agent template
Get started using one of our pre-built agent templates. You can customise every single setting and behaviour so that they work for your specific operating procedures.
To customize an agent template, add or removing tools, adjust core instruction and tweaking settings, then save your changes.
[Try an agent template!](https://relevanceai.com/templates)
## Meet BDR Bosh, our flagship agent!
Besides our template agents, we also have an enterprise-ready BDR agent that really pushes the boundaries of what's possible with AI Agents. Bosh has already generated world class results for many of our enterprise customers.
Leads contacted per month
Faster time to close
More meetings booked
Higher win rate
Faster reply rate
More cost-effective
This is one of our flagship agent templates, BDR Bosh (enterprise only).
# Add Agents
Source: https://relevanceai.com/docs/ai-workforce/build-an-ai-workforce/add-agents
Adding agents to your Workforce allows you to create powerful multi-agent systems where specialized AI agents work together to accomplish complex tasks.
## Adding Agents to Your Workforce
### Prerequisites
Before adding agents to your workforce, ensure you have:
* Created at least two agents in your project
* Access to Workforce
### Step-by-Step Instructions
1. **Access Workforce**
* Select your workforce or create a new one
* Navigate to the "Build" section in your workforce
2. **Add Your First Agent**
* When you first open your workforce, you'll see a manual trigger already in place
* Connect an agent to this trigger by dragging an agent from the sidebar onto the workspace
* This initial connection allows you to message that particular agent (similar to the existing agent flow in Agents)
3. **Add Additional Agents**
* Drag additional agents from the sidebar onto the workspace
* Position them strategically based on your workflow requirements
4. **Connect Agents Together**
* Click and drag from one agent to create a connection line to another agent
* When connecting agents, you'll be prompted to select a connection type:
* **Agent Decide**: The agent makes its own decision on whether to talk to another agent
* **Forced Handover**: An agent will always hand over what it was doing to the next agent, regardless of its finished state
5. **Configure Connection Settings**
* After creating a connection, click on the connecting line to configure edge settings
* For "Let agent decide" connections:
* Complete the "When to call this agent" box with natural language instructions
* Set behavior settings (auto run, approval required, or let agent decide)
* Configure max auto runs as a guardrail
* Choose between 'always start a new task' or 'always continue with one task'
* For "Forced handover" connections:
* Choose between 'always start a new task' or 'always continue with one task'
6. **Save Your Configuration**
* Click the "Save" button to preserve your workforce configuration
## Communication Settings
When connecting agents, you can configure how they communicate with each other:
### Let Agent Decide
Use natural language to explain how the agent should behave. The agent will follow your instructions but will escalate if it needs help or clarification.
* **Communication Settings**: Explain in natural language when this agent should be called. For example, if a manager agent is delegating to another agent, explain the logic for when to delegate to that specific agent.
* **Behavior Settings**:
* **Auto run**: The agent will complete the task without approval
* **Approval required**: The agent will draft the task but ask for approval before completing
* **Let agent decide**: The agent will complete the task if confident, otherwise will ask for approval
* **Max auto runs**: Set a limit on the number of times the agent auto runs
### Forced Handover
This setting forces one agent to pass the task to another agent. The handover must happen regardless of the first agent's state.
## Best Practices for Adding Agents
1. **Define Clear Roles**
* Give each agent a specific role and responsibility within your workforce
* Avoid overlapping responsibilities that could cause confusion
2. **Create Logical Workflows**
* Arrange agents in a way that follows a natural progression of tasks
* Consider the information flow between agents when designing your workforce
3. **Use Descriptive Connection Instructions**
* When using "Let agent decide" connections, provide clear, detailed instructions about when to delegate
* Include specific criteria or conditions that should trigger the handover
4. **Test Incrementally**
* Add and test agents one at a time to ensure each connection works as expected
* Use the Task View to monitor how agents interact with each other
5. **Set Appropriate Approval Levels**
* For critical tasks, use "Approval required" to maintain human oversight
* For routine tasks, consider "Auto run" to maximize efficiency
## Monitoring Your Multi-Agent Workforce
After adding agents to your workforce:
1. Go to the "Task" view to see your workforce in action
2. Here you can trigger your workforce via manual messages/conversation
3. Monitor when specific agents need approvals
4. Observe how agents communicate and hand off tasks to each other
## Related Features
[Workforce Task View](https://relevanceai.com/docs/workforce/task-view) - Learn how to monitor and interact with your multi-agent workforce after it's built.
[Edge Settings](https://relevanceai.com/docs/workforce/edge-settings) - Discover more about configuring the connections between nodes in your workforce.
[Add Tools](https://relevanceai.com/docs/workforce/add-tools) - Explore how to enhance your workforce by adding tools that agents can use.
## Troubleshooting
**Issue**: Agents aren't communicating as expected\
**Solution**: Check the connection settings between agents and ensure the instructions are clear and specific.
**Issue**: Workflow stops unexpectedly\
**Solution**: Check if an agent is waiting for approval in the Task View.
**Issue**: Agent makes incorrect decisions about when to delegate\
**Solution**: Refine the natural language instructions in the "When to call this agent" field.
# Add Conditions
Source: https://relevanceai.com/docs/ai-workforce/build-an-ai-workforce/add-conditions
Conditions in Workforce act as powerful decision-making components that allow you to create intelligent workflows with conditional logic.
## Overview
Conditions enable you to build dynamic, responsive workflows by creating branching paths based on specific criteria. Rather than having a linear workflow where every step always executes in the same order, conditions let you implement decision points that determine which path your workflow should take.
## When to Use Conditions
Conditions are particularly valuable when you need to:
* Process data differently based on specific values or states
* Create branching workflows with different paths for different scenarios
* Implement quality control checks before proceeding to critical steps
* Filter out certain items from further processing
* Execute tools only on specific days, times, or under certain circumstances
## Adding a Condition to Your Workforce
To add a condition to your workforce:
1. Navigate to the "Build" section of your Workforce
2. Locate the "Conditions" option in the node selection panel
3. Drag a condition node onto your workspace
4. Connect the condition to the appropriate tools or agents
## Configuring Conditions
Setting up conditions in Workforce is simple thanks to natural language configuration. Instead of complex technical settings, you can simply describe your condition in plain English:
1. Click on your condition node to open its settings
2. Enter a natural language description of your condition, such as:
* "Go down this path if the day is a weekday"
* "Follow this route if the customer score is above 80"
* "Use this path if the email contains the word 'urgent'"
# Add Tools
Source: https://relevanceai.com/docs/ai-workforce/build-an-ai-workforce/add-tools
Tools are essential components in your AI Workforce that enable agents to perform specific actions and complete tasks.
## What Are Tools in Workforce?
In the Workforce, tools function as independent nodes that can be connected to agents, triggers, and even other tools. Unlike the traditional approach where tools are tightly coupled to specific agents, Workforce allows for a more flexible and modular design:
* Tools exist as standalone components on the workspace
* Multiple agents can access the same tool
* Tools can be connected to other tools to create sequential workflows
* Tools can be easily substituted without having to reconfigure each agent
## How to Add Tools to Your Workforce
Adding tools to your Workforce is a straightforward process:
1. Open your Workforce and navigate to the "Build" section
2. Locate the tools panel in the Workforce interface
3. Drag any tool from your project onto the workspace
4. Position the tool where you want it on the canvas
## Connecting Tools in Your Workforce
Once you've added tools to your workspace, you can create powerful connections:
### Agent to Tool Connections
To connect an agent to a tool:
1. Click on the agent node to reveal connection points
2. Drag a connection line from the agent to your desired tool
3. Configure the connection settings:
* **Let agent decide**: The agent will determine when to use the tool based on natural language instructions
* **Forced handover**: The agent will always use the tool when the connection is triggered
### Tool to Tool Connections
One of the most powerful features of the Workforce Builder is the ability to connect tools to other tools:
1. Click on the source tool to reveal connection points
2. Drag a connection line to the destination tool
3. This creates a workflow where the output of one tool becomes the input for the next
For example, you might connect a tool that sends an email to another tool that summarizes responses, creating an automated follow-up workflow.
## Edge Settings for Tool Connections
When connecting tools in your Workforce, you can configure the following edge settings:
### Communication Style
* **Let agent decide**: Use natural language to explain when the tool should be used
* **Forced handover**: Always execute the tool when the connection is triggered
### Behavior Settings
* **Auto run**: The tool will execute without requiring approval
* **Approval required**: The tool will draft the action but ask for human approval before executing
* **Let agent decide**: The agent will determine whether to auto-run or request approval based on context
* **Max auto runs**: Set limits on how many times a tool can auto-run as a safety guardrail
## Tool to Tool Workflows
The ability to connect tools directly to other tools is what makes the Workforce Builder so powerful. This workflow-style approach allows you to:
1. Create sequential processes where each tool performs a specific function
2. Build complex automations without writing code
3. Easily modify or replace individual components without disrupting the entire workflow
4. Maintain a visual representation of your business processes
For example, after sending an email with one tool, you could automatically hand over to another tool that monitors for responses, and then to a third tool that generates appropriate follow-ups.
## Using Conditions with Tools
For more advanced workflows, you can add conditions to your tool connections:
1. Add a condition node to your workspace
2. Connect a tool to the condition
3. Connect the condition to other tools
4. Configure the condition logic (e.g., "only send email if day of week is weekday")
Conditions act as IF statements in your workflow, allowing for branching logic and more sophisticated automations.
## Best Practices for Tools in Workforce Builder
To get the most out of tools in your Workforce:
1. **Keep tools focused**: Each tool should perform a specific, well-defined function
2. **Use descriptive names**: Name your tools clearly to understand their purpose at a glance
3. **Document connections**: Use the description fields to explain how tools should work together
4. **Test thoroughly**: Before deploying, test your tool connections with various inputs
5. **Monitor performance**: Regularly review how your tools are performing and refine as needed
## Related Features
* [Workforce Task View](https://relevanceai.com/docs/workforce-features-and-capabilities/workforce-task-view): Monitor and manage your workforce tasks and tool executions
* [Edge Settings](https://relevanceai.com/docs/build-an-ai-workforce/edge-settings): Configure how nodes connect and communicate in your workforce
* [Add Conditions](https://relevanceai.com/docs/build-an-ai-workforce/add-conditions): Learn how to add conditional logic to your workforce flows
By effectively utilizing tools in the Workforce Builder, you can create sophisticated, autonomous workflows that handle complex business processes with minimal human intervention.
# Add Triggers
Source: https://relevanceai.com/docs/ai-workforce/build-an-ai-workforce/add-triggers
Triggers are the starting points that initiate workflows in your AI Workforce. They determine when and how your agents begin their work, serving as the entry points to your entire workflow system.
## Understanding Triggers
Triggers are specialized nodes in the Workforce that activate your agents based on specific events or conditions. They function as the initial connection point in your workflow, determining when your AI agents should start performing their tasks.
### Types of Triggers
#### Manual Triggers
When you first create a workforce, a manual trigger is automatically added to your workspace. This allows you to directly initiate your workflow by sending a message to your agent, similar to how you would interact with a standalone agent in Relevance AI.
Manual triggers are ideal for:
* Testing your workflow during development
* On-demand tasks that require human initiation
* Workflows that need to begin with specific human input or context
#### Integration Triggers
Integration triggers connect your workforce to external systems, allowing your agents to automatically respond to events from those systems. These triggers enable your AI Workforce to monitor and react to activities in your connected tools and platforms.
Common integration triggers include:
* Email triggers that activate when new messages arrive
* Calendar triggers that respond to meeting invitations or reminders
* CRM triggers that react to new lead creation or status changes
* Webhook triggers that respond to custom events from any system
## Adding Triggers to Your Workforce
### Adding Your First Trigger
1. When you open your workforce, you'll see a manual trigger already available in your workspace.
2. Connect this trigger to an agent by dragging a line from the trigger to your chosen agent.
3. This connection establishes the entry point for your workflow.
### Adding Additional Triggers
To add more triggers to your workforce:
1. Navigate to the Workforce interface.
2. Locate the "Triggers" section in the node palette.
3. Drag your desired trigger type onto the workspace.
4. Position it appropriately in your workflow diagram.
5. Connect the trigger to the agent that should respond first when the trigger activates.
## Configuring Triggers
Each trigger type has specific configuration options that determine its behavior:
### Manual Trigger Configuration
To trigger your workforce manually:
1. Switch to the "Task" tab in the Relevance AI interface.
2. Use the message input field to send a manual message to your workforce.
3. Provide natural language instructions that will initiate your workflow.
4. Your connected agent will receive this message and begin processing according to your workflow configuration.
This manual interaction allows you to start your workflow with specific context and instructions whenever needed.
### Integration Trigger Configuration
Integration triggers require specific setup to connect with external systems:
1. Select the integration trigger in your workspace.
2. Complete the authentication process for the connected service.
3. Configure trigger conditions (e.g., specific email subjects, calendar event types).
4. Set any filters to ensure the trigger only activates for relevant events.
5. Test the connection to verify proper setup.
## Best Practices for Using Triggers
### Strategic Trigger Placement
* **Start with clarity**: Position triggers at the logical beginning points of your workflows.
* **Minimize redundancy**: Avoid having multiple triggers that serve the same purpose.
* **Consider user experience**: For manual triggers, ensure they're intuitive and provide clear guidance.
### Trigger Maintenance
* Regularly test triggers to ensure they're functioning correctly.
* Monitor trigger activity to identify any performance issues.
* Update trigger configurations when connected systems change.
### Security Considerations
* Review authentication settings for integration triggers regularly.
* Implement appropriate access controls for manual triggers.
* Consider data privacy implications when configuring trigger conditions.
## Troubleshooting Triggers
### Common Issues
* **Trigger not activating**: Verify connection settings and authentication.
* **Duplicate activations**: Check for overlapping trigger conditions.
* **Delayed responses**: Examine workflow complexity and agent configuration.
### Diagnostic Steps
1. Test the trigger in isolation to confirm it's working properly.
2. Verify that connected agents have appropriate permissions.
3. Check system logs for any error messages related to the trigger.
4. Ensure all necessary API keys and credentials are current.
## Related Features
The "Add Triggers" functionality works closely with other components of the Workforce Builder:
* **Edge Settings**: After connecting a trigger to an agent, you can configure how information flows between them using Edge Settings.
* **Agent Configuration**: Ensure your agents are properly configured to handle the input they'll receive from triggers.
* **Conditions**: Use conditions alongside triggers to create more sophisticated workflow logic.
By effectively utilizing triggers in your Workforce, you create the foundation for responsive, event-driven AI systems that can work autonomously while integrating seamlessly with your existing tools and processes.
# Edge Settings
Source: https://relevanceai.com/docs/ai-workforce/build-an-ai-workforce/edge-settings
Edge Settings control how nodes are connected to each other in your AI Workforce.
## Communication Styles
When connecting nodes in your workforce, you can choose between two primary communication styles:
### Let Agent Decide
This option gives your agent autonomy to determine when to use a connection based on natural language instructions.
**Configuration Options:**
* **Communication Settings**: Provide natural language instructions explaining when and how the agent should use this connection. For example, if you're connecting a manager agent to a specialist agent, you might write: "Delegate to this agent when a customer inquiry requires technical expertise about our enterprise product features."
* **Behavior Settings**: Control how the agent executes tasks through this connection:
* **Auto run**: The agent will automatically execute the task without requiring approval.
* **Approval required**: The agent will draft the task but wait for your approval before completing it.
* **Let agent decide**: The agent will complete the task if it has sufficient context and confidence; otherwise, it will ask for human approval or clarification.
* **Max auto runs**: Set a limit on the number of times the agent can automatically execute this connection without human intervention:
* **No limit**: The agent can use this connection as many times as needed.
* **Custom limit**: Specify a maximum number of automatic executions as a guardrail.
* **Task Handling**: Choose how tasks flow through this connection:
* **Always start a new task**: Each time this connection is used, it creates a separate task instance.
* **Always continue with one task**: Maintain continuity by keeping all work within the same task context.
### Forced Handover
This option creates a mandatory connection where one node always passes control to another node when triggered.
**Configuration Options:**
* **Task Handling**: Choose how tasks flow through this forced connection:
* **Always start a new task**: Each handover creates a separate task instance.
* **Always continue with one task**: Maintain continuity by keeping all work within the same task context.
## Practical Applications
### Agent-to-Agent Communication
When connecting agents, edge settings determine how they collaborate:
* **Manager-Specialist Relationship**: Configure a manager agent to delegate specific types of inquiries to specialist agents using "Let agent decide" with clear instructions about when to delegate.
* **Sequential Processing**: Use "Forced handover" to create a workflow where one agent always passes work to another after completing its part, such as having a research agent always pass findings to a content creation agent.
### Agent-to-Tool Communication
Edge settings control how agents interact with tools:
* **Conditional Tool Usage**: With "Let agent decide," an agent can determine when a particular tool is appropriate based on the context.
* **Approval Workflows**: For sensitive operations like sending emails or making purchases, configure "Approval required" to ensure human oversight.
* **Automated Sequences**: Use "Forced handover" to ensure an agent always follows a specific process, such as always logging customer interactions after completing a support conversation.
### Tool-to-Tool Communication
Create sophisticated automation workflows:
* **Data Processing Pipelines**: Connect tools in sequence to transform, analyze, and act on data without requiring agent intervention at each step.
* **Conditional Branching**: Use conditions between tools to create decision trees that process information differently based on specific criteria.
## Best Practices
1. **Start Simple**: Begin with basic connections and gradually increase complexity as you understand how your workforce operates.
2. **Use Clear Instructions**: When using "Let agent decide," provide specific, unambiguous instructions about when and how to use connections.
3. **Implement Guardrails**: Use approval requirements and auto-run limits for critical operations to maintain control while allowing automation.
4. **Test Thoroughly**: Verify that your edge settings produce the expected behavior across different scenarios before deploying to production.
5. **Monitor Performance**: Regularly review how your connections are being used and refine edge settings based on actual performance.
## Limitations
* **One-way Communication**: Currently, connections in the Workforce Builder are limited to one-way communication. Bidirectional communication between nodes is not supported.
* **Decision Complexity**: While conditions can create branching workflows, complex decision trees may require careful planning and potentially multiple condition nodes.
## Related Features
The Edge Settings functionality works closely with other Workforce Builder components:
* **Nodes**: The building blocks (triggers, agents, tools, conditions) that are connected using edges.
* **Configurations**: The specific relationship types between nodes that determine workflow possibilities.
* **Workforce Task View**: Where you can monitor your workforce's operations and approve tasks when required.
## FAQs
**Q: Can I change edge settings after creating a connection?**\
A: Yes, you can modify edge settings at any time by selecting the connection in the Workforce Builder interface.
**Q: How do I know if I should use "Let agent decide" or "Forced handover"?**\
A: Use "Let agent decide" when you want contextual, intelligent routing based on content. Use "Forced handover" when a connection should always occur regardless of context.
**Q: What happens if I set a limit on auto runs and the limit is reached?**\
A: Once the auto run limit is reached, the agent will request human approval before using that connection again.
**Q: Can I create conditional connections based on specific data values?**\
A: Yes, you can use condition nodes to create branches in your workflow based on specific criteria or data values.
# Introduction to Nodes
Source: https://relevanceai.com/docs/ai-workforce/build-an-ai-workforce/introduction-to-nodes
Nodes are the fundamental building blocks of a workforce in Relevance AI. They represent all the components you can place on your workspace to create automated workflows.
## What Are Nodes?
Nodes are the technical term for all the elements you can place and connect in the Workforce interface. They come from graph theory, where a graph consists of nodes (points) and edges (connections between points). In Workforce Builder:
* **Nodes** are the individual components you place on the workspace
* **Edges** are the connections between nodes that define how they interact
## Types of Nodes
There are four main types of nodes in Workforce:
### 1. Triggers
Triggers are the starting points of your workflows. They initiate the execution of your workforce when specific conditions are met.
**Examples of triggers include:**
* Manual triggers (allowing you to message an agent directly)
* Integration triggers (such as when an email is received)
* Scheduled triggers (running at specific times)
Triggers are essential because they determine when and how your workforce begins its work.
### 2. Agents
Agents are AI-powered entities that can reason, make decisions, and complete tasks. In Workforce, agents are the same as those you've configured elsewhere in Relevance AI, but now they can be visually connected to other components.
Agents can:
* Process information from triggers
* Make decisions about next steps
* Use tools to accomplish tasks
* Hand over work to other agents
### 3. Tools
Tools are specific capabilities that perform defined actions. Unlike in the previous system where tools were tightly coupled to specific agents, in Workforce, tools exist independently and can be connected to multiple agents or other tools.
This modular approach offers several advantages:
* One tool can be used by multiple agents
* Tools can be connected to other tools in sequence
* Tools can be easily substituted (e.g., changing from Notion to Confluence) without having to reconfigure each agent
### 4. Conditions
Conditions act as decision points in your workflow, similar to IF statements in programming. They evaluate specific criteria and direct the flow based on whether those criteria are met.
**For example:**
* A condition might check if the current day is a weekday
* If true, it might trigger an email tool
* If false, the workflow might end or take a different path
Conditions help create more sophisticated, branching workflows that respond dynamically to different situations.
## Working with Nodes in Workforce
### Placing Nodes
To add nodes to your workspace:
1. Open your workforce and navigating to "Build"
2. Drag the desired node type (trigger, agent, tool, or condition) from the sidebar onto the workspace
3. Position it where you want it to appear in your workflow
### Connecting Nodes
To establish relationships between nodes:
1. Click on the source node
2. Drag a connection line to the target node
3. Configure the connection settings (such as communication style)
### Node Configuration
Each node type has specific settings that can be configured:
* **Triggers**: Configure when and how they activate
* **Agents**: Set communication preferences, approval requirements, and behavior settings
* **Tools**: Define inputs, steps, and outputs
* **Conditions**: Specify the criteria to evaluate and the paths to take based on results
## Best Practices for Working with Nodes
1. **Start Simple**: Begin with a manual trigger connected to a single agent to test functionality
2. **Plan Your Workflow**: Before adding many nodes, sketch out the desired workflow to understand the necessary components
3. **Use Meaningful Names**: Give your nodes descriptive names that indicate their purpose
4. **Test Incrementally**: Add and test nodes in small batches rather than building the entire workflow at once
5. **Consider Approval Settings**: For critical actions, configure nodes to require human approval before proceeding
## Common Node Configurations
### Trigger → Agent
This is the most basic configuration, where a trigger initiates an agent. For example, a manual trigger allows you to message an agent directly.
### Agent → Agent
This configuration enables one agent to communicate with another. There are two communication styles:
* **Let agent decide**: The agent determines when to involve another agent based on natural language instructions
* **Forced handover**: The first agent always passes the task to the second agent
### Agent → Tool
This allows an agent to use a specific tool to complete a task, such as sending a message in a Slack channel.
### Tool → Tool
This creates a workflow-like sequence where one tool's output becomes another tool's input, without requiring agent intervention between steps.
### Condition → Tool
This setup evaluates a condition before deciding whether to execute a tool, adding logic to your workflows.
## Limitations and Considerations
* Currently, communication between agents is limited to one-way communication. Bidirectional communication is not yet supported.
* When designing complex workflows, consider the approval settings carefully to maintain appropriate human oversight.
* The more nodes in a workflow, the more important it becomes to monitor performance in the Task View.
## Related Features
For more information on how to use nodes effectively in your workforce, refer to these related features:
* [Edge Settings](https://relevanceai.com/docs/) - Configure how nodes connect to each other
* [Workforce Task View](https://relevanceai.com/docs/) - Monitor and manage your workforce's activities
* [Approvals and Escalations](https://relevanceai.com/docs/) - Set up human oversight for your automated workflows
By understanding and effectively utilizing nodes, you can create powerful, flexible workflows that automate complex tasks while maintaining appropriate control and oversight.
# Quick Start Guide
Source: https://relevanceai.com/docs/ai-workforce/introduction/quick-start-guide
Workforce transforms how your agents collaborate by providing a visual canvas where you can design, connect, and monitor teams of specialized agents.
## Creating Visual Workflows
Workforce provides a clear flowchart view of your entire agent ecosystem, eliminating the complexity of nested agent relationships. With the visual workflow builder, you can:
* Design agent teams with intuitive drag-and-drop connections
* Enable specialized agents to work as peers rather than in hierarchies
* Create workflows that are easy to understand, modify, and monitor
## Connection Types
When building your agent workflows, you can choose between different connection types:
### Let Agent Decide
This connection type gives your agent autonomy to determine when to pass control to another agent. The agent evaluates the context and decides if another agent's expertise is needed to complete the task.
### Forced Handover
This connection type creates a mandatory transition between agents. When one agent completes its task, control automatically passes to the next agent in the workflow, ensuring a predictable process flow.
## Tool Integration
Workforce allows you to connect tools directly within your workflow:
* Connect tools directly to agents to enhance their capabilities
* Link tools to other tools to create sophisticated processing chains
* Build complex workflows that combine agent intelligence with specialized tool functionality
## Conditional Logic
Make your workflows smarter with conditional logic:
* Create "if this, then that" rules to determine workflow paths
* Set up decision points that route tasks based on specific criteria
* Build adaptive workflows that respond differently depending on inputs or outcomes
## Getting Started with Workforce
To create your first Workforce:
1. Click on “Workforce” on the left side bar
2. Click on “+ New Workforce” to open the visual canvas
3. Add your agents to the canvas by dragging them from the sidebar
4. Connect your agents by drawing lines between them
5. Configure each connection by selecting the connection type
6. Add tools to your workflow as needed
7. Set up any conditional logic for routing
8. Save your workflow
## Best Practices
For optimal results with Workforce:
* Start with a clear workflow diagram before building in the interface
* Group related agents together visually to improve readability
* Use descriptive names for your connections to document their purpose
* Test your workflow with various inputs to ensure proper routing
* Monitor agent handovers to identify any communication gaps
* Regularly review and optimize your workflow based on performance
## Related Features
[Agent Configuration](https://relevanceai.com/docs/agent/agent-configuration) - Learn how to configure individual agents before adding them to your Workforce.
[Tools](https://relevanceai.com/docs/tool/introduction) - Discover the tools you can integrate into your Workforce workflows.
# Agent to Agent Configuration
Source: https://relevanceai.com/docs/ai-workforce/workforce-features-and-capabilities/agent-to-agent-configuration
Agent to Agent configuration is a powerful capability within Workforce that enables you to create sophisticated multi-agent systems where agents can collaborate, delegate tasks, and work together to solve complex problems.
## How Agent to Agent Configuration Works
When you connect one agent to another in your workforce, you're establishing a relationship that determines how these agents will interact. This connection creates a pathway for information to flow from one agent to another, allowing for specialized handling of different aspects of a task.
## Setting Up Agent to Agent Connections
To create an Agent to Agent connection in your workforce:
1. Navigate to the "Build" section of your workforce
2. Ensure you have at least two agents added to your workspace
3. Click and drag from the output node of the first agent to the input node of the second agent
4. A connection line will appear, and the edge settings panel will open
## Communication Style Options
When configuring Agent to Agent connections, you have two primary communication style options:
### Let Agent Decide
This option gives the first agent autonomy to determine when it should involve the second agent. The agent uses natural language understanding to follow your instructions about when to delegate.
To configure this option:
1. Select "Let agent decide" in the edge settings
2. Complete the "When to call this agent" field with clear instructions
3. For example: "Call this agent when you need specialized knowledge about financial regulations" or "Delegate to this agent when the customer asks about technical product specifications"
#### Behavior Settings
When using "Let agent decide," you can further refine the behavior:
* **Auto run**: The second agent will automatically execute its task without approval
* **Approval required**: The second agent will draft its response but wait for human approval before proceeding
* **Let agent decide**: The second agent will determine whether it has sufficient context to proceed or needs human input
You can also set **Max auto runs** as a guardrail to limit automatic executions.
### Forced Handover
This option creates a mandatory transition from one agent to another. When the first agent completes its work, it will always pass control to the second agent.
To configure this option:
1. Select "Forced handover" in the edge settings
2. Choose between "Always start a new task" or "Always continue with one task"
## Task Continuity Options
For both communication styles, you can specify how the task should be handled:
* **Always start a new task**: The second agent begins a fresh task with its own context
* **Always continue with one task**: The second agent continues within the same task, maintaining context and history
## Best Practices for Agent to Agent Configuration
### When to Use "Let Agent Decide"
* For complex workflows where conditional routing is needed
* When you want the first agent to make intelligent decisions about escalation
* In scenarios where not every interaction requires the specialized knowledge of the second agent
### When to Use "Forced Handover"
* For linear workflows with clear handoff points
* When you want to ensure every interaction passes through a specific sequence of agents
* For quality control processes where a second agent should always review the work
### Creating Effective Agent Instructions
When using "Let agent decide," the quality of your instructions in the "When to call this agent" field is crucial:
* Be specific about the conditions that should trigger delegation
* Include examples of scenarios where the second agent should be involved
* Define clear boundaries of responsibility between agents
## Limitations
* Currently, only one-way communication is supported between agents
* Bidirectional communication (where agents can have back-and-forth conversations) is not yet available
## Example Use Cases
### Customer Support Triage
Connect a general support agent to specialized agents for technical, billing, or account issues. The first agent handles basic inquiries and delegates complex issues to specialists.
### Content Creation Pipeline
Connect a content planning agent to a content writing agent, and then to a content editing agent, creating a streamlined production workflow.
### Research and Analysis
Connect a data collection agent to an analysis agent, where the first agent gathers information and the second performs in-depth analysis of the collected data.
## Troubleshooting
If your Agent to Agent configuration isn't working as expected:
* Verify that the connection line is properly established between agents
* Check that your "When to call this agent" instructions are clear and specific
* Ensure that both agents have the necessary tools and permissions to complete their tasks
* Review the task history in the Workforce Task View to identify where the workflow might be breaking down
By effectively configuring Agent to Agent connections, you can create sophisticated AI workflows that leverage the specialized capabilities of different agents, resulting in more powerful and flexible automation solutions.
# Agent to Tool Configuration
Source: https://relevanceai.com/docs/ai-workforce/workforce-features-and-capabilities/agent-to-tool-configuration
Agent to Tool configuration is a powerful feature within Workforce that enables you to establish connections between your AI agents and the tools they need to complete tasks.
## Understanding Agent to Tool Connections
When you connect an agent to a tool in Workforce, you're creating a pathway for your agent to access specific functionality. This connection allows your agent to:
* Make decisions about when to use particular tools
* Pass relevant information to tools for processing
* Receive and interpret results from tool operations
* Continue workflows based on tool outputs
## Setting Up Agent to Tool Configurations
To configure an Agent to Tool connection in your workforce:
1. Open your workforce in the Workforce interface
2. Locate the agent node you want to connect to a tool
3. Click and drag from the agent's output connector to the input connector of your desired tool
4. Once connected, click on the connecting line (edge) to access configuration settings
## Configuration Options
### Communication Style
When configuring an Agent to Tool connection, you have two primary communication style options:
#### Let Agent Decide
This option gives your agent autonomy to determine when to use the connected tool based on context and need.
* **Communication Settings**: Provide natural language instructions explaining when and how the agent should use this tool. For example: "Use this email tool when you need to send important updates to clients or when follow-up communication is required."
* **Behavior Settings**: Configure how the agent makes decisions about tool usage:
* **Auto run**: The agent will use the tool without requiring approval
* **Approval required**: The agent will draft the tool request but wait for human approval before execution
* **Let agent decide**: The agent will determine whether to auto-run or request approval based on confidence level
* **Max auto runs**: Set limits on how many times the agent can automatically use the tool without intervention
#### Forced Handover
This option creates a mandatory connection where the agent must pass information to the tool as part of the workflow.
* **Task Continuity**: Choose between:
* **Always start a new task**: Each tool execution begins a fresh task instance
* **Always continue with one task**: The tool execution remains part of the original task flow
## Best Practices for Agent to Tool Configuration
### 1. Clear Instructions
When using "Let agent decide" mode, provide specific, unambiguous instructions about when the tool should be used. For example:
> Use this data analysis tool when:
>
> * The user requests statistical insights
> * Raw data needs to be transformed into visualizations
> * Patterns or trends need to be identified in datasets
### 2. Appropriate Permission Levels
Match permission settings to the sensitivity and impact of the tool:
* Use "Approval required" for tools that:
* Make external communications
* Modify important data
* Incur costs or use credits
* Make decisions with business impact
* Use "Auto run" for tools that:
* Perform internal data retrieval
* Execute low-risk, repetitive tasks
* Enhance the agent's knowledge without external effects
### 3. Workflow Optimization
Consider how tool connections affect the overall workflow:
* **Sequential Processing**: Connect tools in a logical sequence when tasks need to follow a specific order
* **Conditional Branching**: Use agent decision points before tools when different scenarios require different tool selections
* **Feedback Loops**: Create connections from tools back to agents when results need evaluation before proceeding
## Troubleshooting Agent to Tool Connections
### Common Issues and Solutions
1. **Agent not using connected tool**
* Check that the connection line is properly established
* Review the communication instructions for clarity
* Ensure the agent has the necessary context to recognize when to use the tool
2. **Tool execution failing**
* Verify the tool's configuration and required inputs
* Check that the agent is passing data in the expected format
* Review tool logs for specific error messages
3. **Excessive tool usage**
* Set appropriate "Max auto runs" limits
* Make instructions more specific about when to use the tool
* Consider changing to "Approval required" mode temporarily
## Advanced Agent to Tool Configurations
### Chaining Multiple Tools
You can create sophisticated workflows by connecting an agent to multiple tools in sequence:
1. Connect your agent to the first tool
2. Connect the output of the first tool to a second agent or directly to another tool
3. Configure each connection with appropriate settings
This approach allows for complex multi-step processes where each tool performs a specific function in the overall workflow.
### Dynamic Tool Selection
When an agent needs to choose between multiple tools based on context:
1. Connect the agent to each potential tool
2. Use "Let agent decide" mode for all connections
3. Provide clear, distinctive instructions for when to use each tool
The agent will evaluate the situation and select the appropriate tool based on your instructions.
## Related Features
* [Trigger to Agent Configuration](https://relevanceai.com/docs/workforce-builder/configurations/trigger-to-agent): Learn how to configure the initial triggers that activate your agents
* [Tool to Tool Configuration](https://relevanceai.com/docs/workforce-builder/configurations/tool-to-tool): Discover how to connect tools directly to other tools for automated workflows
* [Condition to Tool Configuration](https://relevanceai.com/docs/workforce-builder/configurations/condition-to-tool): Explore how to add conditional logic to your tool executions
## Conclusion
Agent to Tool configuration is a fundamental aspect of building effective AI workforces. By thoughtfully designing these connections, you can create intelligent workflows where agents leverage tools appropriately to accomplish complex tasks. Whether you prefer giving your agents autonomy with "Let agent decide" or creating structured processes with "Forced handover," the configuration options in Workforce Builder provide the flexibility to match your specific business needs.
# Approvals and Escalations
Source: https://relevanceai.com/docs/ai-workforce/workforce-features-and-capabilities/approvals-and-escalations
Approvals and escalations are essential components of Workforce that ensure your AI agents operate with appropriate oversight and can effectively handle situations requiring human intervention.
## Overview
The approvals and escalations system in Workforce allows you to:
* Configure when and how agents should seek approval before taking actions
* Establish clear escalation paths when agents encounter situations beyond their scope
* Monitor approval requests through the Workforce Task View
* Set up automated alerts for escalations requiring human attention
By implementing proper approval and escalation processes, you can maintain quality control while allowing your AI workforce to operate with appropriate autonomy.
## Setting Up Approval Modes
When connecting agents to tools or other agents in your workforce, you can configure different approval modes that determine how actions are authorized:
### Auto Run
In this mode, the agent will execute actions automatically without requiring approval. This is ideal for:
* Low-risk, routine tasks
* Well-defined processes with predictable outcomes
* Situations where speed is prioritized over verification
To configure auto run:
1. Select the edge connecting an agent to a tool or another agent
2. In the Edge Settings panel, select "Auto run" under Behavior Settings
3. Optionally, set "Max auto runs" to limit the number of automatic executions
### Approval Required
This mode forces the agent to seek explicit approval before executing an action. Use this for:
* High-stakes decisions
* Actions that commit resources or make external communications
* New workflows that need monitoring before being fully automated
To set up approval required:
1. Select the edge connecting an agent to a tool or another agent
2. In the Edge Settings panel, select "Approval required" under Behavior Settings
3. The agent will now draft its intended action and wait for human approval before proceeding
### Let Agent Decide
This balanced approach allows the agent to determine whether approval is needed based on its confidence and context. The agent will:
* Complete tasks autonomously when it has sufficient context and confidence
* Request approval when facing uncertainty or high-risk situations
* Escalate to humans when it needs clarification or additional information
To implement this mode:
1. Select the edge connecting an agent to a tool or another agent
2. In the Edge Settings panel, select "Let agent decide" under Behavior Settings
3. Complete the "When to call this agent" box with natural language instructions explaining the decision logic
## Monitoring Approvals in Workforce Task View
The Workforce Task View serves as your central dashboard for monitoring and managing approval requests:
1. Navigate to the "Task" view to see your workforce
2. Review pending approval requests from your agents
3. Examine the agent's proposed action and supporting reasoning
4. Choose to approve, reject, or provide additional guidance
5. Track the history of approvals and their outcomes
This interface provides complete visibility into your approval workflow, allowing you to maintain oversight while empowering your AI workforce.
## Implementing Escalation Strategies
Escalations occur when an agent encounters a situation it cannot handle independently. Effective escalation strategies ensure these situations are properly addressed:
### Agent-Initiated Escalations
Agents can be configured to recognize their limitations and escalate appropriately:
1. Configure agent settings under Agent Settings > Abilities
2. Define clear criteria for when an agent should escalate issues
3. Specify the escalation path (to specific human roles or other agents)
4. Provide templates for how the agent should format escalation requests
### Escalation Tools
You can connect agents to specific tools designed for escalation:
1. Create dedicated escalation tools (e.g., Slack notifications, email alerts)
2. Connect these tools to your agents in the Workforce Builder
3. Configure the tools to route escalations to the appropriate team members
4. Include relevant context and information in the escalation
### Escalation Monitoring
Track and manage escalations through:
1. The Workforce Task View, which displays all active escalations
2. Notification systems that alert relevant team members
3. Escalation logs that maintain a history of issues and resolutions
## Best Practices for Approvals and Escalations
To maximize the effectiveness of your approval and escalation processes:
### For Approvals:
* Start with more restrictive approval requirements and gradually relax them as confidence in the agent grows
* Use "Max auto runs" settings as guardrails when transitioning to more autonomous operation
* Provide clear criteria for what constitutes an approvable action
* Review approval patterns regularly to identify opportunities for process improvement
### For Escalations:
* Define clear escalation thresholds based on risk, complexity, and agent capabilities
* Create detailed documentation for human responders to handle escalated issues
* Implement a feedback loop where escalation resolutions inform agent improvements
* Establish service level agreements (SLAs) for responding to different types of escalations
## Related Features
* [Edge Settings](https://relevanceai.com/docs/workforce-builder/edge-settings) - Configure the connections between nodes in your workforce, including approval settings
* [Workforce Task View](https://relevanceai.com/docs/workforce-builder/workforce-task-view) - Monitor and manage your workforce's activities, including approvals and escalations
* [Agent Abilities](https://relevanceai.com/docs/agent/customise-agent/escalate) - Configure how agents handle situations requiring escalation
## FAQs
**Q: Can I set different approval requirements for different tools?**\
A: Yes, approval settings are configured on a per-edge basis, allowing you to require approval for sensitive tools while allowing automatic execution for routine ones.
**Q: What happens if an approval request isn't addressed?**\
A: The task will remain in a pending state until approved or rejected. You can configure timeout actions or notifications for approval requests that remain unaddressed for a specified period.
**Q: Can escalations be routed to specific team members?**\
A: Yes, you can configure escalation tools to direct issues to specific individuals or teams based on the nature of the escalation, time of day, or other factors.
**Q: How do I balance autonomy with oversight?**\
A: Start with higher oversight (approval required) for new workflows, then gradually transition to "let agent decide" and eventually "auto run" as you build confidence in the agent's performance for specific tasks.
# Communication
Source: https://relevanceai.com/docs/ai-workforce/workforce-features-and-capabilities/communication
Communication is a fundamental aspect of Workforce that defines how agents interact with each other within your AI workforce.
## One-way Communication
Currently, Workforce supports one-way communication between agents. This means that when one agent communicates with another, the information flows in a single direction. Bidirectional communication is not yet available in the current version.
### How One-way Communication Works
When you connect two agents in your workforce, the communication follows a unidirectional path:
* The source agent sends information, instructions, or requests to the target agent
* The target agent receives this information and acts upon it
* The target agent cannot automatically send information back to the source agent through the same connection
This one-way communication model creates clear workflows and responsibility chains within your workforce, making it easier to track how information and tasks flow through your system.
## Setting Up Communication Between Agents
When connecting agents in your workforce, you have two communication style options that determine how agents interact with each other:
### Let Agent Decide
This option gives the agent autonomy to determine when to communicate with another agent based on natural language instructions.
**Configuration Steps:**
1. Connect two agents in your workforce
2. Select "Let agent decide" as the communication style
3. Complete the "When to call this agent" field with natural language instructions
4. Configure behavior settings:
**Communication Settings:**
In the "When to call this agent" field, provide clear instructions about when the source agent should delegate to the target agent. For example:
> Call this agent when you need to analyze customer sentiment data or when you need to summarize large volumes of customer feedback. This agent specializes in data analysis and can provide insights that will help with decision-making.
**Behavior Settings:**
Choose one of the following approval modes:
* **Auto run**: The target agent will complete the task without requiring approval
* **Approval required**: The target agent will draft the task but ask for human approval before completing it
* **Let agent decide**: The target agent will complete the task if it has sufficient context and confidence; otherwise, it will ask for human approval or clarification
**Additional Settings:**
* **Max auto runs**: Set a limit on the number of times the agent can auto-run (no limit or a specific number)
* **Task continuation**: Choose between 'always start a new task' or 'always continue with one task'
### Forced Handover
This option creates a mandatory connection where the source agent must pass the task to the target agent.
**Configuration Steps:**
1. Connect two agents in your workforce
2. Select "Forced handover" as the communication style
3. Configure task continuation:
* Choose between 'always start a new task' or 'always continue with one task'
With forced handover, the source agent will always transfer control to the target agent when the connection is triggered, regardless of the context or the agent's assessment of the situation.
## Best Practices for Agent Communication
To maximize the effectiveness of agent communication in your workforce:
1. **Define Clear Responsibilities**: Ensure each agent has well-defined roles and responsibilities to avoid confusion about which agent should handle specific tasks.
2. **Use Descriptive Instructions**: When using "Let agent decide," provide detailed instructions about when and why the source agent should communicate with the target agent.
3. **Create Logical Workflows**: Design your communication paths to follow natural workflows, where information and tasks flow in a logical sequence from one agent to the next.
4. **Balance Autonomy and Control**: Use "Let agent decide" for situations requiring judgment and "Forced handover" for mandatory steps in a process.
5. **Monitor Communication Patterns**: Regularly review how agents are communicating to identify any bottlenecks or inefficiencies in your workforce.
6. **Implement Appropriate Approval Mechanisms**: Use approval settings to maintain quality control while allowing agents to work autonomously when appropriate.
## Related Features
[Edge Settings](https://relevanceai.com/docs/workforce-builder/edge-settings) - Configure the connections between nodes in your workforce, including communication styles and behavior settings.
[Configurations](https://relevanceai.com/docs/workforce-builder/configurations) - Learn about the different types of connections you can create between nodes in your workforce.
[Workforce Task View](https://relevanceai.com/docs/workforce-builder/task-view) - Monitor your workforce's activities, including communication between agents and approval requests.
## FAQs
**Q: Can agents communicate bidirectionally?**\
A: Currently, Workforce Builder only supports one-way communication between agents. Bidirectional communication is planned for future updates.
**Q: How do I know if an agent has communicated with another agent?**\
A: You can monitor agent communication in the Workforce Task View, which shows the timeline of activities and interactions between agents.
**Q: Can I set conditions for when an agent should communicate with another agent?**\
A: Yes, when using the "Let agent decide" communication style, you can provide natural language instructions in the "When to call this agent" field to guide the source agent's decision-making.
**Q: What happens if an agent tries to communicate with another agent but lacks necessary information?**\
A: Depending on your behavior settings, the agent may ask for human approval or clarification before proceeding with the communication.
**Q: Can I create complex communication chains involving multiple agents?**\
A: Yes, you can connect multiple agents in sequence or in parallel to create sophisticated workflows where information passes through several agents.
# Condition to Tool Configuration
Source: https://relevanceai.com/docs/ai-workforce/workforce-features-and-capabilities/condition-to-tool-configuration
Condition to Tool connections in Workforce allow you to create intelligent workflows that execute tools only when specific conditions are met.
## How Condition to Tool Works
A Condition to Tool connection acts as an IF statement in your workforce flow. When a condition evaluates to true, the connected tool executes; when false, the tool is skipped. This creates branching logic in your workflows, making your AI workforce more adaptable and responsive to different scenarios.
## Setting Up a Condition to Tool Connection
To create a Condition to Tool connection in your workforce:
1. Navigate to Workforce and "Build" in the main navigation
2. Add a condition node to your workspace by dragging it from the node palette
3. Write your condition using natural language (e.g., "Go down this path if it's a weekday" or "Follow this route if the customer priority is high")
4. Add a tool node to your workspace
5. Connect the condition node to the tool node by clicking and dragging from the condition's output connector to the tool's input connector
## Condition Examples Using Natural Language
You can create various types of conditions using simple, natural language instructions:
### Time-Based Conditions
* "Go down this path if today is Monday or Tuesday"
* "Follow this route if the current time is between 9 AM and 5 PM"
* "Use this tool if it's a weekday"
### Data-Based Conditions
* "Go down this path if the customer priority is high"
* "Follow this route if the email contains the word 'urgent'"
* "Use this tool if the sentiment score is greater than 0.7"
### Tool Output Conditions
* "Go down this path if the previous tool completed successfully"
* "Follow this route if the data validation passed"
* "Use this tool if we received a response from the API"
## Best Practices for Condition to Tool Connections
1. **Use clear, descriptive language**: Make your conditions easy to understand at a glance
2. **Keep conditions focused**: Each condition should evaluate a single concept for clarity
3. **Be specific**: Provide clear criteria for when the condition should be true
4. **Test thoroughly**: Verify your conditions work as expected with different inputs
5. **Consider edge cases**: Think about unusual scenarios that might affect your condition
## Advanced Condition to Tool Patterns
### Chaining Multiple Conditions
You can create sophisticated decision trees by chaining multiple conditions together:
1. Create several condition nodes that evaluate different aspects of your data
2. Connect each condition to the appropriate tool
3. Tools will only execute when their specific conditions are met
### Parallel Condition Evaluation
For more complex scenarios, you can have multiple conditions evaluating the same data simultaneously:
1. Create several condition nodes that check different aspects of the same data
2. Connect each condition to different tools
3. Multiple tools may execute in parallel depending on which conditions are met
## Practical Use Cases
### Email Routing Based on Content
Create conditions like "Go down this path if the email contains a support request" or "Follow this route if the message mentions billing issues."
### Time-Sensitive Workflows
Build conditions such as "Use this tool only during business hours" or "Go down this path if it's the first day of the month."
### Data Quality Control
Implement conditions like "Follow this route if all required fields are filled" or "Use this tool if the data passes validation."
### Approval Workflows
Design conditions such as "Go down this path if the request has been approved" or "Use this tool if the manager has given permission."
## Troubleshooting Condition to Tool Connections
If your condition to tool connections aren't working as expected:
1. **Review your condition language**: Make sure your natural language condition is clear and specific
2. **Check the flow**: Confirm the connections between nodes are correctly established
3. **Test with simpler conditions**: Try a very basic condition to verify the connection works
4. **Monitor execution**: Watch how the workflow behaves when the condition is evaluated
5. **Refine your language**: If needed, make your condition more explicit or detailed
## Related Features
* **Agent to Tool connections**: Direct connections from agents to tools without conditional logic
* **Tool to Tool connections**: Sequential execution of tools in a workflow
* **Trigger to Agent connections**: Starting points for your workforce flows
By using Condition to Tool connections with natural language in the Workforce Builder, you can create intelligent, adaptive workflows that respond dynamically to changing circumstances, making your AI workforce more efficient and effective.
# Tool to Tool Configuration
Source: https://relevanceai.com/docs/ai-workforce/workforce-features-and-capabilities/tool-to-tool-configuration
Tool to Tool configuration is a powerful feature in Workforce that allows you to connect tools directly to other tools, creating automated workflows without requiring agent intervention.
## How Tool to Tool Connections Work
When you connect tools directly to each other in Workforce, you're establishing a direct pathway for data to flow from one tool to the next. This creates a streamlined process where:
1. The first tool completes its operation
2. Its output is automatically passed to the connected tool
3. The second tool processes this data without requiring human or agent approval (unless configured otherwise)
This approach is particularly valuable for creating multi-step automations that handle routine processes efficiently.
## Setting Up Tool to Tool Connections
### Prerequisites
* At least two tools added to your Workforce Builder canvas
* Understanding of the input/output requirements for each tool
### Step-by-Step Configuration
1. **Add Tools to Your Workspace**: Drag the tools you want to connect from your project onto the Workforce Builder canvas.
2. **Create the Connection**:
* Click on the first tool (source)
* Look for the connection point (usually appears as a dot or node on the edge of the tool)
* Click and drag to create a line to the second tool (destination)
* Release to establish the connection
3. **Configure Connection Settings**:
* After creating the connection, click on the connecting line to access the edge settings
* Choose between "Auto run" or "Approval required" modes:
* **Auto run**: The second tool will automatically execute when it receives data from the first tool
* **Approval required**: The system will wait for human approval before the second tool processes the data
4. **Map Data Fields** (if applicable):
* Some tools may require you to specify how data from the first tool maps to the input fields of the second tool
* Use the mapping interface to connect output fields from the first tool to input fields of the second tool
5. **Save Your Configuration**: Click "Save changes" to apply your Tool to Tool configuration
## Use Cases for Tool to Tool Configuration
### Email Processing Workflow
Connect an "Email Receiver" tool to an "Email Classifier" tool, then to either a "Customer Support" tool or "Sales Lead" tool based on classification results.
### Data Enrichment Chain
Link a "Data Extraction" tool to a "Data Enrichment" tool, followed by a "Database Update" tool to automatically enhance and store information.
### Document Processing Pipeline
Connect a "Document Analyzer" tool to a "Summary Generator" tool, then to a "Notification" tool to alert team members about important documents.
### Conditional Workflows
When combined with condition nodes, Tool to Tool connections can create branching workflows that take different paths based on specific criteria.
## Best Practices
1. **Start Simple**: Begin with straightforward two-tool connections before building more complex chains.
2. **Test Thoroughly**: Always test your Tool to Tool configurations with sample data before deploying them in production.
3. **Consider Approval Points**: For critical operations, insert approval requirements at key points in the workflow.
4. **Document Your Flows**: Create documentation for your Tool to Tool configurations to help team members understand the automated processes.
5. **Monitor Performance**: Regularly check the execution logs to ensure your Tool to Tool connections are functioning as expected.
6. **Error Handling**: Plan for potential failures by considering what should happen if a tool in the chain encounters an error.
## Limitations and Considerations
* **Data Compatibility**: Ensure that the output format of the first tool is compatible with the input requirements of the second tool.
* **Execution Time**: Be aware that complex Tool to Tool chains may take longer to execute, especially if tools perform resource-intensive operations.
* **Debugging Challenges**: Troubleshooting issues in Tool to Tool connections can be more complex than single-tool setups.
* **Versioning Impact**: Updating a tool in a chain may affect downstream tools if the output format changes.
## Related Features
Tool to Tool configuration works seamlessly with other Workforce Builder features:
* **Conditions**: Add conditional logic to determine whether a tool connection should be followed
* **Agent to Tool**: Combine agent decision-making with automated tool chains
* **Triggers**: Initiate Tool to Tool workflows based on external events
## Conclusion
Tool to Tool configuration in the Workforce Builder represents a significant advancement in workflow automation capabilities. By connecting tools directly to each other, you can create sophisticated process chains that handle routine tasks efficiently while maintaining the flexibility to incorporate human oversight where needed. This feature empowers you to build more autonomous, intelligent workflows that save time and reduce the need for manual intervention.
# Trigger to Agent Configuration
Source: https://relevanceai.com/docs/ai-workforce/workforce-features-and-capabilities/trigger-to-agent-configuration
Connecting triggers to agents is a fundamental aspect of building effective AI workforces in Relevance AI.
## Overview
Trigger to Agent configurations define the relationship between a trigger event and the agent that responds to it. This connection is the starting point of any workflow in Workforce, allowing you to specify exactly how your agents are activated and what information they receive.
## Types of Triggers
When connecting triggers to agents, you can utilize several trigger types:
* **Manual Triggers**: Allow you to manually initiate an agent through the Task View interface
* **Scheduled Triggers**: Activate agents at predetermined times or intervals
* **Integration Triggers**: Connect external services (like email, Slack, or CRM systems) to automatically activate agents when specific events occur
## Setting Up a Trigger to Agent Connection
### Basic Setup
1. Open your workforce in the Build section
2. Locate the trigger node you want to connect (or add a new one by dragging it from the sidebar)
3. Click and drag from the trigger node's output point to connect it to your desired agent
4. Configure the connection settings in the panel that appears
### Configuration Options
When establishing a Trigger to Agent connection, you'll need to configure these important settings:
#### Communication Settings
In the connection settings panel, you can specify:
* **Message Format**: Define how the trigger information is formatted before being sent to the agent
* **Context Passing**: Choose what contextual information from the trigger should be included
* **Variable Mapping**: Map specific trigger data fields to variables the agent can use
#### Behavior Settings
Control how the agent responds to the trigger:
* **Auto Run**: Enable the agent to automatically process the trigger without human approval
* **Approval Required**: Require human approval before the agent acts on the trigger
* **Let Agent Decide**: Allow the agent to determine whether it needs approval based on confidence level
#### Task Management
Configure how tasks are created and managed:
* **Always Start New Task**: Each trigger creates a new, separate task
* **Continue with One Task**: Multiple triggers can feed into a single ongoing task
* **Max Auto Runs**: Set limits on how many times an agent can auto-run to prevent infinite loops
## Best Practices
### Effective Trigger to Agent Design
* **Clear Trigger Definition**: Ensure your triggers have well-defined conditions to avoid unintended activations
* **Appropriate Agent Selection**: Match triggers with agents that have the right skills and tools for the triggered task
* **Contextual Information**: Configure triggers to provide sufficient context for the agent to understand the task
* **Error Handling**: Include fallback paths for when triggers fail or agents cannot process the request
### Common Patterns
* **Filtering Triggers**: Use conditions before triggers to filter out unnecessary activations
* **Multi-Agent Dispatch**: Connect a trigger to a dispatcher agent that routes tasks to specialized agents
* **Escalation Paths**: Configure triggers to activate different agents based on priority or complexity
## Example: Email Response Workflow
Here's how a typical email response workflow might be configured:
1. Create an email integration trigger that activates when new emails arrive
2. Connect this trigger to a triage agent
3. Configure the connection to:
* Pass the email subject, body, and sender information
* Allow auto-run for initial triage
* Create a new task for each email
4. The triage agent can then analyze the email and route it to the appropriate specialized agent
## Troubleshooting
### Common Issues
* **Trigger Not Activating**: Verify the trigger conditions and integration settings
* **Agent Not Receiving Context**: Check the connection configuration to ensure proper data mapping
* **Multiple Unintended Activations**: Review trigger conditions and consider adding filters
### Debugging Tips
* Use the Task View to monitor trigger activations and agent responses
* Check connection logs to identify any data transmission issues
* Test triggers manually before enabling auto-run
## Related Features
The Trigger to Agent configuration works seamlessly with other Workforce Builder components:
* [Agent to Agent Configuration](https://relevanceai.com/docs/workforce-builder/configurations/agent-to-agent): Connect agents to create multi-step workflows
* [Agent to Tool Configuration](https://relevanceai.com/docs/workforce-builder/configurations/agent-to-tool): Enable agents to use tools to complete tasks
* [Workforce Task View](https://relevanceai.com/docs/workforce-builder/workforce-task-view): Monitor and manage tasks initiated by triggers
# Workforce Task View
Source: https://relevanceai.com/docs/ai-workforce/workforce-features-and-capabilities/workforce-task-view
The Workforce Task View provides a centralized interface for monitoring, managing, and interacting with your AI workforce.
## Accessing the Workforce Task View
To access the Workforce Task View:
1. Navigate to the "Task" section in your selected Workforce
2. The Task View interface will display all current and recent activities for your selected workforce
## Key Features
### Real-Time Task Monitoring
Track the status and progress of all tasks being handled by your workforce in real time. The Task View provides a comprehensive overview of:
* Active tasks currently being processed
* Completed tasks with timestamps and outcomes
* Tasks awaiting approval or human intervention
* Failed tasks that require attention
### Manual Trigger Activation
Initiate workflows directly from the Task View interface:
1. Locate the manual trigger you want to activate
2. Enter your message or prompt to start the workflow
3. Submit the trigger to activate the associated agent or process
4. Monitor the task's progress as it moves through your workforce
This functionality allows you to test workflows, handle one-off requests, or manually start scheduled processes when needed.
### Approval Management
The Task View serves as your central hub for managing approvals within your workforce:
1. Receive notifications when agents require approval to proceed
2. Review the agent's proposed actions or responses
3. Approve, reject, or modify the agent's work
4. Provide additional context or instructions if needed
This approval system ensures quality control while allowing your workforce to operate autonomously when appropriate.
### Conversation History
Access complete conversation histories and task logs for comprehensive tracking:
* View the full thread of interactions between agents and users
* Examine decision points and tool usage throughout a task
* Reference previous tasks for context or troubleshooting
* Export conversation logs for reporting or analysis
### Task Timeline
The Task View provides a chronological timeline of all activities, giving you visibility into:
* When tasks were initiated
* How long each step in the process took
* Which agents or tools were involved at each stage
* When human intervention occurred
* Final resolution and completion times
## Working with the Task View
### Monitoring Multiple Tasks
The Task View allows you to monitor multiple concurrent tasks across your workforce:
1. Tasks are organized chronologically with the most recent at the top
2. Use filters to focus on specific task types, agents, or statuses
3. Expand individual tasks to see detailed information
4. Toggle between different workforces if you have multiple configured
### Handling Escalations
When agents escalate issues requiring human attention:
1. You'll receive a notification in the Task View
2. The escalated task will be highlighted for visibility
3. Review the agent's reason for escalation and the current task state
4. Provide guidance, additional information, or take over the task as needed
5. Once resolved, the agent can continue processing or the task can be marked complete
### Approval Workflows
For tasks configured to require human approval:
1. The agent will complete its work and submit it for review
2. The task will appear in your approval queue within the Task View
3. Review the agent's work, including any generated content or proposed actions
4. Approve the work to allow the agent to proceed or continue to the next step
5. Reject or request modifications if changes are needed
6. Provide feedback to help improve future performance
## Best Practices
### Organizing Your Task View
* Use clear naming conventions for your triggers and agents to easily identify tasks
* Configure appropriate approval thresholds to balance autonomy and oversight
* Set up notification preferences to stay informed of critical tasks
* Archive completed tasks regularly to maintain a clean interface
### Effective Monitoring
* Check the Task View regularly for items requiring attention
* Use filters to focus on high-priority tasks or specific workflows
* Review completed tasks periodically to identify optimization opportunities
* Monitor task completion times to identify bottlenecks or inefficiencies
### Troubleshooting
If you encounter issues with tasks in the Task View:
1. Check the task's history to identify where the process stalled
2. Review any error messages or agent notes
3. Verify that all connected tools and resources are functioning properly
4. Test the workflow with a manual trigger to reproduce the issue
5. Adjust agent settings or tool configurations as needed
## Related Features
* [Edge Settings](https://relevanceai.com/docs/agent/customise-agent/flowbuilder): Configure how agents communicate and interact with each other in your workforce
* [Approvals and Escalations](https://relevanceai.com/docs/agent/customise-agent/escalate): Set up detailed approval workflows and escalation paths for your agents
* [Workforce Builder](https://relevanceai.com/docs/agent/customise-agent/subagents): Design and configure your multi-agent workforce with visual tools
# Get started
Source: https://relevanceai.com/docs/get-started/introduction
Relevance AI is the home of your AI Workforce.
Relevance AI is a no-code platform where you can build AI agents and multi-agent teams that autonomously complete tasks, much like human employees.
Agents are powered by Large Language Models (LLMs) and equipped with tools. They can reason, make decisions, and follow instructions to get work done.
## Create an account and add members
Once you've [signed-up](http://app.relevanceai.com/) and created a Relevance account, you can add other members to your organisation.
1. Go to Relevance AI and click **[Sign Up](http://app.relevanceai.com/)**.
2. Enter your email and password to create an account, or sign up with your Google account.
3. Follow the sign-up wizard, which includes choosing the [region you want to store you data](https://relevanceai.com/docs/security#regions) in.
4. Click on `Settings` in the hamburger menu.
5. In **Projects**, select the default project, or create a new one for your team.
6. Click on `+ Invite user` and enter the email of the member you want to add to your organisation.
7. Send invite!
Here's a quick demo of how you create an account and invite team members:
### User roles
Members in your organisation can be assigned the following roles: Admin, Editor and Viewer. These roles determine what they can do inside of the platform, and what they can do when using the API.
Has all read and write permissions.
**Has read permissions for:**
* All datasets
* All knowledge sets
* All agents
* Users
**Has write permissions for:**
* All datasets
* All knowledge sets
* All agents
**Other permissions:**
* Can run agents and tools.
**Has read permissions for:**
* All datasets
* All knowledge sets
* All agents
**Other permissions:**
* Can run agents.
## Create an agent
Creating agents involves giving the agent information about who they are, what they are capable of and what is expected of them. You can create a brand new agent, or use one of our existing agent templates.
1. Login to your [Relevance AI](https://relevanceai.com/) account ([app.relevanceai.com](https://relevanceai.com/)).
2. Go to the [Agents](/agent) page (in the sidebar).
3. Click `Build from scratch` in the top right-hand corner of the page.
4. Give your agent a name, description and profile image.
5. Click `Confirm` to save your agent.
[Create your first AI agent!](https://auth.relevanceai.com/signup/)
## Use an agent template
Get started using one of our pre-built agent templates. You can customise every single setting and behaviour so that they work for your specific operating procedures.
[Try an agent template!](https://relevanceai.com/templates)
## Use a tool template
Use one of our pre-built tool templates. You can customize the inputs and steps and configure the outputs for your tool.
[Try a tool template!](https://relevanceai.com/templates)
## Equip your agent with tools
Tools are how you build integrations, LLM prompt chains or other step by step automations. You can build them in our no code tool builder and give them to your agents to help them complete work.
1. Click on the agent you want to equip with tools on the [Agents](/agent) page.
2. Click `Edit Agent` in the top right of your screen to open the edit agent interface.
3. Click `Tools` under “Connected Resources” in the side bar.
4. Click `+ Add tool`. Choose from your tools or select a template. You can also search to find a tool.
5. Click `+ Add` on the tool.
6. Click on the tool and select the approval mode.
7. Click `Save changes`.
[Explore our no-code tools!](https://relevanceai.com/templates)
## Create a multi-agent team
You can equip agents in the manner you equip tools.
1. Click on the agent you want to equip with other agents on the [Agents](/agent) page.
2. Click `Edit Agent` in the top right of your screen to open the edit agent interface.
3. Click `Subagents` under connected resources.
4. Other agents that exist in your project will appear. Select the agent you want to add with `+ Add`.
5. Click `Save changes`.
## Scale your AI Workforce
You can build agents to mirror and enhance the strengths of your team, replicating their workflows, tool usage, response style, and domain expertise.
With multi-agent teams, you have the flexibility to scale up or down based on demand. Many of our customers face seasonal fluctuations, where certain periods or regions require more support than others. Agents help you adapt seamlessly, ensuring efficiency without compromising quality.
[Start building your AI Workforce!](https://auth.relevanceai.com/signup/)
## FAQs
Relevance AI agents are fully customisable. You can configure them to align perfectly with your standard operating procedures.
AI tools and AI agents serve different purposes, and choosing the right one depends on your task. AI tools are best for structured, predictable workflows where every step is clearly defined. They follow exact processes, ensuring precision, consistency, and full control over individual steps. Use them for tasks like automated report generation or processing standardized forms. AI agents excel in dynamic, unpredictable scenarios. They can interpret nuanced information, adjust their strategy on the fly, and engage in human-like conversations. Choose agents when flexibility and real-time decision-making are needed.
The best people to build AI agent team members are the domain experts already performing the tasks you want to delegate. The goal is to free them from repetitive, time-consuming work so they can focus on what they do best. For example, a seasoned sales rep is the ideal person to design an agent for lead qualification — leveraging the same tools and processes they use daily. Once the agent meets their expert standards, they can shift their focus to higher-value tasks, like closing deals and providing more responsive customer engagement.
# Agents
Source: https://relevanceai.com/docs/get-started/key-concepts/agent
Automate tasks with AI agents
## What are AI agents?
Agents are reasoning bots powered by LLMs that plan and complete tasks on autopilot. They are given tools, and decide how to use tools to achieve their goals and complete work.
## What can they do?
**Can can be taught specific roles**
AI agents can be equipped with domain-specific knowledge, allowing them to operate in fields such as marketing, sales, operations or any other area relevant to your business needs.
**Can plan**
When given with a task, AI agents use reasoning skills to analyze the requirements and determine the most effective approach to complete their work. This involves breaking down complex tasks into manageable steps and prioritizing actions.
**Can make decisions**
AI agents are adaptable, much like skilled human workers. They're great at at making smart choices on the fly, using the latest information to pick the best course of action. When things don't go as planned, they can finding new ways to get the job done. This flexibility allows them to juggle multiple goals, seize unexpected opportunities, and learn from their experiences.
**Can use tools**
Agents are capable of using a variety of tools created through Relevance AI's no-code builder. This allows you to extend your agents' capabilities to complete specific tasks.
**Can integrate with other systems**
AI agents integrate with your current business processes and software. They can follow established workflows and use the same applications as your human workforce.
AI agents can be equipped with domain-specific knowledge, allowing them to operate in fields such as marketing, sales, operations or any other area relevant to your business needs.
## How AI agents work
Agents in Relevance AI can operate in different ways:
* **Autopilot** - They complete tasks independently.
* **Human in the loop** - Asking humans for input or approval when needed.
You can trigger agents to start work with:
* **Pre-built integrations** - Seamlessly connect with existing tools.
* **API access** - Use them in your applications.
* **User interface** - Run agents directly from our platform.
## Links
On the sidebar, you have access to
* [Tools](/get-started/key-concepts/tools): build integrations, LLM prompt chains or other step by step automations
* [Knowledge](/get-started/key-concepts/knowledge): our Retrieval Augmented Generation solution
* [API keys](/get-started/key-concepts/api-keys): enter your own API key(s) for the many supported vendors
# API keys
Source: https://relevanceai.com/docs/get-started/key-concepts/api-keys
Use your own API keys
## API keys and third party integration

At Relevance, you can use the provided API keys or use your own for the many available
supported third parties.
Go to API keys from the side-bar, locate the third party and enter the corresponding API key in the
form.
You can also create Relevance API Keys by using the ` + Create new secret key` button.
## Relevance Keys
### Region and URL endpoints
## Links
On the sidebar, you have access to
* [Home](/get-started/key-concepts): your home page on Relevance
* [Agent](/get-started/key-concepts/agent): your own AI assistant powered by LLMs and tools
* [Tools](/get-started/key-concepts/tools): analysis tools/flows powered by LLMs
* [Knolwedge](/get-started/key-concepts/knowledge): sources of truth provided by you in variety of acceptable formats such as PDF, CSV, Audio
* [Templates](/templates): variety of analysis tools / flows built and maintained by Relevance
# Knowledge
Source: https://relevanceai.com/docs/get-started/key-concepts/knowledge
Give your agents context
## What is knowledge?
Knowledge is our RAG solution in Relevance AI, which allows you to provide additional context and relevant information to your agents and tools.
## How do I create knowledge?
How do I create knowledge?
Creating knowledge in Relevance AI is simple and flexible. You can:
**Manually input data** - Start with an empty table and enter information directly.
**Upload structured and unstructured data** - Import files such as CSV, PDF, Excel, JSON, or even audio files.
**Extract content from a website** - Fetch text and relevant information from URLs.
**Connect third-party integrations** - Sync data from external platforms.
## Links
On the sidebar, you have access to
* [Tools](/get-started/key-concepts/tools): build integrations, LLM prompt chains or other step by step automations
* [Agents](/get-started/key-concepts/agent): reasoning bots powered by LLMs that plan and complete tasks
* [API keys](/get-started/key-concepts/api-keys): enter your own API key(s) for the many supported vendors
# Tools
Source: https://relevanceai.com/docs/get-started/key-concepts/tools
Give your agents tools to complete tasks
## What are tools?
Tools are how you build integrations, LLM prompt chains or other step by step automations. You can build them in our no code tool builder. You can then share them as a form, run them in bulk on knowledge tables, or give them to your agents to help them complete work.
The possibilities are vast. You can tap into any API, choose from our extensive library of third-party integrations, or even incorporate custom code into your tools.
## How do they work?
**Receive inputs**
Inputs define the data that a tool will process and act upon. Tools accept various types of inputs, such as text or numbers. These inputs can be provided manually by users or agents, or passed from other tools.
**Chain together steps**
Steps are the core actions that a tool performs. They can include operations like LLM prompts, API calls, or custom code execution.
Steps are arranged in a logical sequence, with each step potentially using outputs from previous steps.
**Generate outputs**
After processing the inputs through its chain of steps, the tool produces one or more outputs.
Outputs can be in various formats, such as text, links or HTML.
These outputs can be displayed to users, stored in databases, or passed to other tools or agents for further processing.
## Links
* [Agents](/get-started/key-concepts/agent): reasoning bots powered by LLMs that plan and complete tasks
* [Knowledge](/get-started/key-concepts/knowledge): our Retrieval Augmented Generation solution
* [API keys](/get-started/key-concepts/api-keys): enter your own API key(s) for the many supported vendors
# Plans and credits
Source: https://relevanceai.com/docs/get-started/plans
Different user plans at Relevance
## Understanding credits
Relevance provides a variety of plans enabling you to choose the best option according to your needs.
Each plan supports a certain number of users, credits per execution, specific data size and certain Large Language Models.
Below is a brief overview of the available plans and their specification.
For the most updated list, please visit Relevance's [pricing](https://relevanceai.com/pricing) page.
Note that it is always possible to upgrade or downgrade your plan based on your usage and workload.
## Base credits costs
The base cost for running any tool or agent is 4 credits. However, this cost varies depending on your plan.
| Plan | Credits per run |
| ---------- | --------------- |
| Free | 4 |
| Pro | 4 |
| Team | 3 |
| Business | 2 |
| Enterprise | 2 |
### What affects total credit cost?
Your total credit consumption depends on several factors:
#### Tool steps
* When using integrations without your own API key, additional credits are charged since you're using our API keys.
* If you provide your own API key, no additional credits are charged for integrations.
#### Large Language Model selection
* Different models have different credit costs.
* Specific costs can be found in the `model` selector within the platform.
#### Knowledge sync
* Knowledge is our RAG (Retrieval-Augmented Generation) solution that enables you to provide additional context to your agents and tools.
* When syncing knowledge, yourdata is vectorized to enable search capabilities.
* Knowledge sync operations have the same base credit cost as a tool run.
## Credit allocation and reset
### Reset schedule
* **Free Plan:** Credits reset daily.
* **Paid Plans:** Credits reset monthly.
### Purchasing additional credits
* Only available for paid plan users (because on a free plan credits reset daily).
* Extra credits do not roll over to the next billing cycle.
* When a new cycle begins, credits reset to your plan's default amount.
* Pricing: 1000 credits = \$2USD
* Minimum purchase: 4000 credits (\$4USD)
* This minimum exists due to Stripe transaction fees.
Here is how you can manage your plan and purchase credits:
### Monitoring credit usage
To check your credit consumption:
1. Click "Manage organization" in the settings menu.
2. Navigate to Plan & Billing.
# System quotas
Source: https://relevanceai.com/docs/get-started/system-limits
Maximum system resource allocations
Relevance provides a variety of resources from space to temporarily or permanently store data to in-cloud analysis resources.
Below is a brief overview of maximum system resource allocations:
## Maximum allowed file size
| Resource | Quota |
| ------------------------------------------- | ------ |
| Upload space | 100 MB |
| Upload space for CSV file - number of rows | 50 K |
| Upload space for raw text size as knowledge | 10 MB |
## Maximum allowed run time
| Resource | Quota |
| ----------------------------- | ---------- |
| Tools (15 minutes) | 15 minutes |
| Tools (24 hour) | 24 hours |
| Tools (deprecated) | 15 minutes |
| Agents after each user action | 15 minutes |
| Bulk run | 24 hours |
# Add Integrations
Source: https://relevanceai.com/docs/integrations/add-integrations
Integrations transform your AI agents into powerful workflow automation tools by connecting them with external services and platforms.
## Setting Up Integrations
To begin using integrations with your AI agents:
1. Navigate to the Integrations page from the left-hand menu of your Relevance AI account.
2. Browse the available integrations and select the service you want to connect.
3. Follow the authentication steps to authorize the connection.
4. Once connected, the integration will appear in your list of available connections.
## Adding Triggers to Agents
Triggers allow your agents to automatically activate when specific events occur in connected platforms:
1. Go to the Agent Settings page for the agent you want to configure.
2. Select Agent Profile from the menu.
3. Locate the Triggers section.
4. Click "Add Trigger" and select from the available trigger options.
5. Configure the trigger settings according to your needs.
6. Save your changes.
## Popular Integrations
### Slack Integration
Connect your agents to Slack to enable them to:
* Monitor channels for specific messages or keywords.
* Send notifications or updates to designated channels.
* Respond to direct messages or mentions.
* Perform actions based on Slack events.
### Google Calendar Integration
Link your agents with Google Calendar to:
* Schedule meetings and appointments.
* Send calendar invites to participants.
* Check availability before scheduling.
* Provide reminders for upcoming events.
### HubSpot Integration
Connect to HubSpot to allow your agents to:
* Create and update contact records.
* Track customer interactions.
* Manage deals and opportunities.
* Access customer data for personalized responses.
# Freshdesk
Source: https://relevanceai.com/docs/integrations/agent-integrations/freshdesk
Interact with your Freshdesk with Relevance.
# Freshdesk Integration
Connect your Freshdesk customer support platform with Relevance AI to supercharge your support operations with intelligent automation. The Freshdesk integration enables your AI agents to handle support tickets, respond to customer inquiries, and streamline your customer service workflow.
## Overview
The Freshdesk integration allows you to connect your Freshdesk account with Relevance AI, enabling your AI agents to interact with your customer support platform. This powerful connection transforms how you handle support tickets by automating responses, categorizing issues, and providing intelligent assistance to both customers and support teams.
With this integration, you can build AI agents that monitor your Freshdesk tickets, respond to common inquiries automatically, escalate complex issues to human agents, and maintain a seamless support experience across your organization.
## Connecting the Integration
To connect the Freshdesk integration with Relevance AI:
1. Navigate to your Relevance AI dashboard and select "Integrations" from the main menu.
2. Find and select "Freshdesk" from the available integrations.
3. Click "Connect" to begin the authorization process.
4. Enter your Freshdesk domain (e.g., yourcompany.freshdesk.com).
5. Provide your Freshdesk API key:
* Log in to your Freshdesk account.
* Go to your profile settings.
* Find your API key in the "API Settings" section.
* Copy the API key.
6. Paste your API key into the Relevance AI connection form.
7. Click "Authorize" to establish the connection.
8. Once connected, you'll see a confirmation message indicating successful integration.
## Setting Up Triggers
The Freshdesk integration supports various triggers that can initiate your AI agent workflows. These triggers allow your agents to respond automatically to specific events in your Freshdesk environment.
### Available Triggers
# Gmail
Source: https://relevanceai.com/docs/integrations/agent-integrations/gmail
Interact with your HubSpot CRM with Relevance.
## Overview
Connect your Gmail account to Relevance AI and supercharge your email workflow with AI agents that can read, respond to, and take action on your emails. The Gmail integration enables you to automate email-related tasks, create powerful workflows, and save valuable time.
## Connect the integration
Setting up the Gmail integration with Relevance AI is straightforward:
1. Go to the "Integrations" page in the sidebar of your Relevance AI dashboard.
2. Click on "Gmail" from the available integrations.
3. Click the "Add Integration" button.
4. In the pop-up window, sign into your Gmail account and authorize Relevance AI to access your emails.
5. Follow any additional prompts to complete the connection process.
6. Once connected, you'll see your Gmail account listed under connected integrations.
## Setting up triggers
The Gmail integration allows you to set up triggers that automatically activate your AI agents when specific email events occur. This enables your agents to respond to emails in real-time without manual intervention.
To set up Gmail as a trigger:
1. Create or edit an agent in Relevance AI.
2. Navigate to the "Triggers" section in “Agent Profile”.
3. Select "Gmail" as the trigger source.
4. Configure the trigger conditions based on your needs:
* **New Email**: Trigger when any new email arrives in your inbox
* **Emails with Specific Labels**: Trigger only for emails with certain Gmail labels
* **Emails from Specific Senders**: Trigger for emails from particular email addresses
* **Emails with Specific Subject Lines**: Trigger based on keywords in subject lines
* **Unread Emails**: Trigger only for unread messages
5. Set the frequency of checking for new emails (e.g., immediately, every 5 minutes, hourly).
6. Save your trigger configuration.
Once set up, your agent will automatically start working whenever the specified email conditions are met, allowing for seamless email automation.
## Tools & Tool Steps
The Gmail integration provides a rich set of actions that your AI agents can use to interact with your email account. These actions can be incorporated into your agent's workflow to perform various email-related tasks.
Here are some of the key Gmail actions available:
### Read Emails
* **Get Email Content**: Retrieve the full content of specific emails
* **Search Emails**: Find emails matching specific criteria
* **Get Email Attachments**: Access files attached to emails
* **Get Email Metadata**: Extract information like sender, recipients, date, etc.
* **Get Email Thread**: Retrieve entire conversation threads
### Compose and Send Emails
* **Send Email**: Create and send new emails
* **Reply to Email**: Respond to existing email threads
* **Forward Email**: Forward messages to other recipients
* **Draft Email**: Create draft emails without sending
* **Schedule Email**: Compose emails to be sent at a later time
### Email Management
* **Apply Labels**: Organize emails with Gmail labels
* **Mark as Read/Unread**: Change the read status of emails
* **Archive Email**: Move emails out of the inbox
* **Move to Folder**: Organize emails into different folders
* **Delete Email**: Remove unwanted emails
* **Star/Flag Email**: Mark important emails for follow-up
### Advanced Actions
* **Extract Information**: Parse email content for specific data
* **Analyze Sentiment**: Determine the tone and sentiment of emails
* **Categorize Emails**: Automatically sort emails by type or priority
* **Set Reminders**: Create follow-up reminders for important emails
* **Create Tasks**: Generate tasks based on email content
These are just some examples of the many actions available. The Gmail integration is highly versatile, allowing your agents to perform virtually any task you would normally do manually in your Gmail account.
## Use the integration's API tool step (advanced)
For more advanced use cases, you can leverage the Gmail API directly using the Gmail API Call tool step:
1. Create a new tool in Relevance AI.
2. Scroll down to Tool-steps.
3. Add the Gmail API tool-step.
4. Select your connected Gmail account in the dropdown.
With the Gmail API tool step, you can:
1. **Access Advanced Gmail Features**: Utilize Gmail API endpoints not covered by standard actions
2. **Custom Email Processing**: Create specialized workflows for unique email handling requirements
3. **Batch Operations**: Perform actions on multiple emails simultaneously
4. **Complex Filtering**: Implement sophisticated email filtering logic
5. **Integration with Other Services**: Connect your email workflows with other tools and platforms
### Example: Custom Email Processing with Gmail API
Here's an example of using the Gmail API tool step to implement a custom email processing workflow:
```json
// Example of using Gmail API to process emails with specific criteria
{
"method": "GET",
"endpoint": "users/me/messages",
"params": {
"q": "is:unread from:important-client@example.com",
"maxResults": 10
}
}
```
This API call retrieves up to 10 unread emails from a specific sender, which your agent can then process according to your business rules.
## Related Features
[Outlook Integration](https://relevanceai.com/docs/integrations/outlook) - Similar to Gmail integration, the Outlook integration allows you to connect your Microsoft email account to Relevance AI for automated email processing.
[Email Warmups](https://relevanceai.com/docs/integrations/email-warmups) - Complement your Gmail integration with email warmup capabilities to improve email deliverability for your outreach campaigns.
[HubSpot Integration](https://relevanceai.com/docs/integrations/hubspot) - Connect your email workflows with your CRM to create seamless customer communication processes.
## FAQs
### What permissions does Relevance AI need for the Gmail integration?
Relevance AI requires permission to read, send, and manage your emails to provide full functionality. You can review these permissions during the connection process.
### Can I use multiple Gmail accounts with Relevance AI?
Yes, you can connect multiple Gmail accounts to Relevance AI and configure different agents to work with specific accounts.
### Is my email data secure?
Yes, Relevance AI maintains strict security protocols. Your email data is encrypted and only accessed as needed for the functions you authorize.
### Can I limit which emails my agent can access?
Yes, you can configure triggers and actions to work only with specific labels, senders, or other criteria to limit the scope of emails your agent processes.
### Will my agent's actions appear in my sent folder?
Yes, emails sent by your agent will appear in your Gmail sent folder, maintaining a complete record of all communications.
# Google Calendar
Source: https://relevanceai.com/docs/integrations/agent-integrations/google-calendar
Connect to Google Calendar from Relevance AI.
## Overview
The Google Calendar integration allows you to seamlessly connect your AI agents with your Google Calendar, enabling powerful automation for scheduling, event management, and calendar-based workflows. This integration bridges the gap between your AI agents and your calendar, allowing for intelligent scheduling assistance, automated event creation, and calendar-based decision making.
## Connecting the Google Calendar Integration
To connect the Google Calendar integration to Relevance AI:
1. Select "Integrations" from the left sidebar
2. Find and click on "Google Calendar" in the integrations directory
3. Click "Connect"
4. You'll be redirected to Google's authentication page
5. Select the Google account you want to connect
6. Review and approve the requested permissions
7. Once authenticated, you'll be redirected back to Relevance AI with your Google Calendar now connected
Your Google Calendar integration will now be available for use with your AI agents. You can connect multiple Google Calendar accounts if needed, and manage all connections from the Integrations dashboard.
## Setting Up Triggers with Google Calendar
Google Calendar can serve as a powerful trigger for your AI agents, initiating workflows based on calendar events. Here's how to set up calendar-based triggers:
1. Navigate to your Agent Profile
2. In the trigger section, select "Google Calendar"
3. Configure trigger settings:
* Select which calendar(s) to monitor
* Set any filtering criteria (e.g., only events with specific keywords)
* For time-based triggers, specify the advance notice period
4. Save your trigger configuration
Once set up, your AI agent will automatically activate when the specified calendar events occur, enabling workflows like:
* Sending meeting preparation materials before scheduled calls
* Following up after appointments with summary notes
* Blocking focus time when calendar shows you're busy
* Rescheduling conflicting appointments
## Tools & Tool Steps
The Google Calendar integration provides a rich set of actions that your AI agents can use throughout their workflows. These actions allow your agents to interact with your calendar in sophisticated ways:
### Event Management Actions
* **Create Event**: Schedule new events on your calendar with customizable details
* **Update Event**: Modify existing events (time, location, description, etc.)
* **Delete Event**: Remove events from your calendar
* **Get Event Details**: Retrieve comprehensive information about specific events
### Calendar Query Actions
* **List Events**: Retrieve events within a specified date range
* **Find Available Time**: Identify open slots in your calendar for scheduling
* **Check Availability**: Determine if a specific time period is free or busy
* **Search Events**: Find events matching specific criteria (keywords, attendees, etc.)
### Attendee Management
* **Add Attendees**: Invite participants to calendar events
* **Remove Attendees**: Update event guest list
* **Check Attendee Responses**: View who has accepted, declined, or not responded
### Calendar Management
* **List Calendars**: View all calendars in your Google account
* **Create Calendar**: Set up new calendars for specific purposes
* **Update Calendar Settings**: Modify calendar properties and sharing settings
These actions can be combined in powerful ways to create sophisticated calendar management workflows. For example, your agent could:
* Find available time slots, create a meeting, and send invitations
* Reschedule conflicting appointments based on priority rules
* Create follow-up tasks after calendar events conclude
* Generate meeting agendas based on event descriptions and attendees
## Using the Google Calendar API Tool Step (Advanced)
For advanced use cases requiring deeper integration with Google Calendar, you can leverage the Google Calendar API directly:
1. Create a new tool in your agent profile
2. Scroll down to Tool-steps
3. Add "Google Calendar API" tool-step
4. Select your connected Google Calendar account from the dropdown
5. Configure the API request:
* Specify the API endpoint (e.g., `/calendars/{calendarId}/events`)
* Set the HTTP method (GET, POST, PUT, DELETE)
* Define request parameters and body as needed
* Configure response handling
This approach gives you full access to the Google Calendar API capabilities, allowing for custom implementations beyond the standard actions. Some advanced use cases include:
* Creating recurring events with complex patterns
* Setting up conference solutions (Google Meet, Zoom) with custom parameters
* Managing calendar resources and room bookings
* Implementing custom notification schemes
* Working with secondary calendars and calendar groups
## Best Practices
* **Permission Management**: Only request the minimum calendar permissions needed for your agent's functionality
* **Error Handling**: Implement robust error handling for calendar conflicts and availability issues
* **User Confirmation**: For critical calendar changes, consider adding user confirmation steps
* **Time Zone Awareness**: Always account for time zone differences when scheduling across regions
* **Privacy Considerations**: Be mindful of calendar data sensitivity and implement appropriate safeguards
## Related Features
[Email Integrations](https://relevanceai.com/docs/integrations/email) - Combine email and calendar workflows to create comprehensive meeting management solutions, including sending calendar invites via email and following up on scheduled events.
[Slack Integration](https://relevanceai.com/docs/integrations/slack) - Connect your calendar events with Slack notifications to keep teams informed about upcoming meetings and schedule changes.
[Task Management Integrations](https://relevanceai.com/docs/integrations/task-management) - Link calendar events with task management systems to automatically create follow-up tasks based on meeting outcomes.
# HubSpot
Source: https://relevanceai.com/docs/integrations/agent-integrations/hubspot
Interact with your HubSpot CRM with Relevance.
## Overview
HubSpot is designed to help your manage and grow your customer relationships through a wide range of tools for marketing, sales and customer service. With Relevance AI, your agents can interact with HubSpot much like your human team would.
Below, we'll show you how to get started with the HubSpot integration, including how to connect your HubSpot account, how to trigger agentic workflows based on HubSpot workflow triggers, and how to complete common HubSpot activities with your agents.
## Connecting the Hubspot integration
To add HubSpot as an integration, all you need to do is sign-into your HubSpot account via the integrations page:
1. Go to the "Integrations" page in the sidebar.
2. Click on "HubSpot".
3. Click on the Add Integration button.
4. In the pop-up window, sign-into your HubSpot account.
## 2. Setup HubSpot as an Agent Trigger
A trigger is an event that triggers your agent to start working. Once you have create a new agent, you can add HubSpot as a trigger:
### 2.1. Trigger your agent to start working from a HubSpot workflow
Next, we need to create a workflow in HubSpot, which will send a message to your connected agent every time an event you care about happens.
There are three parts to this process:
1. Create a HubSpot workflow.
2. Create a HubSpot trigger.
3. Create an action which sends a message to your Relevance AI agent.
**Step 1: Create a HubSpot workflow.**
In HubSpot, a workflow is made up of a series of automated actions that are perform every time a specific event happens. In this example, we'll create a Contact-based workflow which sends a message to your agent when a new contact added to your HubSpot CRM meets some criteria you define (HubSpot trigger).
Let's create a contact-based workflow:
**Step 2: Create a HubSpot workflow trigger.**
A HubSpot trigger is an event or condition that starts the automated workflow. In the case of a contact-based workflow, a trigger is a condition related to a contact. It can be based on a contact filling out a form, clicking a link in an email, acheiving a specific lead score, or one of their properties being updated. It's entirely up to you.
**Step 3: Add Relevance AI Trigger action.**
Once your workflow and trigger is setup, you can add an action that will send a message to your agent from HubSpot (triggering your agentic workflow):
## 3. Get your agent to complete common HubSpot activities
Besides triggering your agent to start working from HubSpot, you can also use the HubSpot API call step in the Tool builder. This tool step allows your agent to complete HubSpot-specific activities, like managing Contacts, Notes, Tasks and more.
### 3.0. Use HubSpot API tool-step
You can build custom tools that perform HubSpot activities, by using the HubSpot API Call tool-step:
1. Create a new tool.
2. Scroll down to Tool-steps.
3. Add HubSpot API tool-step.
4. Select your connected HubSpot account in the dropdown.
Below are examples of common HubSpot activities your agents can perform.
### 3.1. Get an existing Contact's details.
### 3.2. Update a contact's properties.
### 3.4. Create a note (e.g. lead qual research).
### 3.5. Create a task
### 3.6. Mark a task as complete
### 3.7. Retrieve HubSpot engagements (all activities a customer has performed)
## 4. Remove HubSpot integration
You can remove HubSpot as a Trigger in your agent settings, by clicking the three dots next to your connected account, and then "Remove".
If you want to remove the HubSpot integration completely, you can:
1. Go to the "Integrations" page from the sidebar.
2. Select Zoom from the list.
3. Click "..." on the account you want to remove.
4. Click remove.
# Outlook
Source: https://relevanceai.com/docs/integrations/agent-integrations/outlook
Adding support for recieving and responding to Outlook emails.
## Overview
The Outlook integration allows your agent to emails that are received to a specific Outlook account. For customer support agents that handle email equiries, we recommend setting up a dedicated email account for them, much like you would for a human employee.
## How to connect your agent to Outlook?
In the agent settings page, you can add Outlook as a trigger by clicking on the Outlook button under "Integrations > Triggers", and following the process to connect your Outlook account.
After that, you can choose whether or not you want to filter emails that are sent to your agent from your Outlook account. Without a search filter, your agent will receive every single email that is sent to your connected account.
### Filter options
If you don't add a search filter, your agent will receive every email that is sent to the connected Outlook account, which might be what you want if your agent has a dedicated email account.
Below is a table of different search filters you can use, which is also how you filter emails in your Outlook search field. Full docs for this can be found in Microsoft's [Search Query Parameter page](https://learn.microsoft.com/en-us/graph/search-query-parameter?tabs=http):
This is how you would use them in the Relevance Filter emails by search field:
* "subject: ask us anything" - The subject line contains the phrase "ask us anything".
* "body: book a demo" - The body of the email contains the phrase "book a demo".
* "from:\*apple.com" - Only emails sent from the apple.com domain.
* "hasAttachments: true" - Only emails that have attachments.
* "received: 07/23/2018" - Only emails received on this date.
## How to respond to emails received from Outlook?
Once your agent has started receiving emails (it can take up to half an hour for the first one to come through), you can build a tool that uses the built-in "Send Email (Outlook)" tool to get your agent to start responding to them.
Once you have created this tool, equip your agent with it by opening your agent settings, clicking on "Tools" -> "Add tools", then search for the send email tool you created and add it.
We recommend setting the tool permissions to "approval mode" so that your agent always asks for permission before it sends a message to your customers. You can set it to autopilot once you're happy with how it responds, which will usually take a few rounds of prompt iteration.
### Tell your agent how it should respond
Once your agent is receiving emails, and has been equipped with your custom "Send email" tool, it's time for you to tell your agent how you want it to respond. You can do this by writing a prompt in the "core instructions" section of your agent settings.
This is an example of a prompt that guides our agent to handle customer questions over email, using four custom tools we built:
You can use the "/" command to reference specific tools you want your agent to use within your prompt.
This entire FAQ follow-up email agent is available for you to [clone as a template, or build from scratch here](https://relevanceai.com/agent-templates/email-faq-follow-up-agent).
## How to remove the integration?
You can remove the Outlook integration by opening your agent settings, clicking the 3 dots menu next to your connected Outlook trigger, and clicking "Remove". Once you've done that, your agent will no longer receive emails.
# LinkedIn
Source: https://relevanceai.com/docs/integrations/agent-integrations/premium-triggers/linkedin
Interact with your LinkedIn account with Relevance.
# LinkedIn Integration
Connect your LinkedIn account to Relevance AI and supercharge your networking, prospecting, and engagement capabilities with AI-powered automation. The LinkedIn Integration enables your agents to interact with LinkedIn much like a human team member would, creating a seamless bridge between your AI workforce and one of the world's most valuable professional networks.
## Connect the integration
Getting started with the LinkedIn Integration is straightforward:
1. Navigate to the "Integrations" page in the sidebar of your Relevance AI dashboard
2. Click on "LinkedIn" from the available integrations
3. Click the "Add Integration" button
4. In the pop-up window, sign into your LinkedIn account and authorize the connection
5. Once authorized, your LinkedIn account will appear in the connected accounts list
## Setting up triggers
The LinkedIn Integration offers powerful trigger capabilities that can initiate your AI agents based on specific LinkedIn events. This allows your agents to respond automatically to important network activities.
### Available LinkedIn triggers
Set up your agents to start working when:
* **New connection request received** - Your agent can automatically evaluate and respond to connection requests
* **New message received** - Trigger your agent when someone sends you a direct message on LinkedIn
* **New post engagement** - Activate your agent when someone comments on or reacts to your posts
* **New profile view** - Have your agent respond when someone views your LinkedIn profile
* **New job posting match** - Trigger workflows when jobs matching specific criteria are posted
### How to set up a LinkedIn trigger
1. Create or edit an agent in Relevance AI
2. Navigate to the "Agent Profile" and select "LinkedIn" from the available trigger options
3. Choose your connected LinkedIn account
4. Select the specific trigger event (e.g., "New message received")
# Telegram
Source: https://relevanceai.com/docs/integrations/agent-integrations/premium-triggers/telegram
Interact with your Telegram account with Relevance.
# Telegram Integration
Connect your AI agents with Telegram to automate conversations and workflows directly through the popular messaging platform. The Telegram integration allows your agents to receive messages, respond intelligently, and execute actions based on user interactions.
## Connect the integration
Setting up the Telegram integration with Relevance AI is straightforward:
1. Go to the "Integrations" page in the sidebar of your Relevance AI dashboard
2. Click on "Telegram" from the available integrations
3. Click the "Add Integration" button
4. You'll be prompted to authenticate with your Telegram account
5. Follow the on-screen instructions to authorize the connection
6. Once connected, you'll see your Telegram account listed under connected accounts
## Setting up triggers
The Telegram integration can be configured as a trigger for your AI agents, allowing them to automatically respond when messages are received.
### Create a Telegram trigger
1. Navigate to your agent's profile page and "Triggers"
2. Choose "Telegram" from the list of available triggers
3. Select your connected Telegram account
4. Configure the trigger settings:
* **Chat Type**: Choose between private chats, group chats, or both
* **Message Filter**: Optionally set up filters to only trigger on specific message types or content
* **Response Mode**: Select whether your agent should respond automatically or require approval
### Common trigger use cases
* **Customer Support**: Automatically respond to customer inquiries received via Telegram
* **Lead Qualification**: Trigger an agent to qualify leads that reach out through Telegram
* **Information Requests**: Set up an agent to provide information when users ask specific questions
* **Appointment Scheduling**: Allow users to schedule appointments through Telegram conversations
* **Order Processing**: Process orders and transactions initiated through Telegram messages
## Tools & Tool Steps
The Telegram integration provides several powerful actions that your agents can use as part of their workflows. These actions enable your agents to interact with Telegram in various ways.
### Available Telegram actions
* **Send Message**: Send a text message to a specific chat or user
* **Send Photo**: Share images with optional captions
* **Send Document**: Share files and documents of various formats
* **Send Location**: Share geographical locations
* **Create Poll**: Create and send polls to gather feedback
* **Get Chat Information**: Retrieve details about a specific chat
* **Get User Profile**: Retrieve information about a Telegram user
* **Pin Message**: Pin important messages in a chat
* **Delete Message**: Remove messages from a conversation
* **Forward Message**: Forward messages between chats
* **Create Chat Invite Link**: Generate invitation links for groups or channels
These are just some of the many actions available. The Telegram integration offers a comprehensive set of tools that allow your agents to leverage the full functionality of the Telegram platform.
### Example workflow
Here's an example of how you might use Telegram actions in a customer support workflow:
1. **Trigger**: Agent is triggered by an incoming Telegram message
2. **Analysis**: Agent analyzes the message content to determine the customer's intent
3. **Response**: Agent uses the "Send Message" action to respond with an appropriate greeting
4. **Information Gathering**: If additional information is needed, agent asks follow-up questions
5. **Resolution**: Once the issue is understood, agent provides a solution
6. **Documentation**: Agent uses "Send Document" action to share relevant documentation if needed
7. **Follow-up**: Agent schedules a follow-up message for later if the issue requires monitoring
## Use the integration's API tool step (advanced)
In addition to the pre-built actions, advanced users can access the full Telegram API for custom functionality:
1. Create a new tool
2. Scroll down to Tool-steps
3. Add Telegram API tool-step
4. Select your connected Telegram account in the dropdown
5. Configure the API endpoint and parameters according to your needs
The Telegram API tool step gives you access to all Telegram Bot API methods, allowing for highly customized interactions beyond the standard actions.
### Example API usage
```json
{
"method": "sendMessage",
"chat_id": "{{chatId}}",
"text": "This is a custom formatted message with *bold* and _italic_ text",
"parse_mode": "Markdown"
}
```
## Premium Trigger Information
Telegram Integration is available as a **Premium Trigger** exclusively for Teams and Business plan users. As a premium integration:
* This trigger is only accessible on Teams and Business plans
* Each connected Telegram account in your organization incurs an additional 5000 credits per month
## Related Features
* [Outlook Integration](https://relevanceai.com/docs/integrations/outlook): Connect your agents with email communications for a comprehensive messaging strategy that spans both email and instant messaging platforms.
* [WhatsApp Personal Integration](https://relevanceai.com/docs/integrations/whatsapp-personal): Extend your messaging capabilities to WhatsApp alongside Telegram for a multi-channel communication approach.
* [Knowledge Base Access](https://relevanceai.com/docs/knowledge/access-knowledge): Enhance your Telegram-connected agents by giving them access to your organization's knowledge base for more informed responses.
## FAQs
**Q: Can I connect multiple Telegram accounts to Relevance AI?**\
A: Yes, you can connect multiple Telegram accounts, but each connection will incur additional credits as per the premium trigger pricing.
**Q: Does the Telegram integration work with both personal and business Telegram accounts?**
A: Yes, the integration works with both personal accounts and business accounts on Telegram.
**Q: Can my agent respond to messages in Telegram groups?**\
A: Yes, your agent can be configured to respond to messages in private chats, groups, or both, depending on your trigger settings.
**Q: Is there a limit to how many messages my agent can process through Telegram?**\
A: Message processing is counted against your overall credit usage. The specific limits depend on your subscription plan.
**Q: Can I customize how my agent appears in Telegram conversations?**\
A: Yes, you can customize the name and profile picture of your Telegram bot that represents your agent in conversations.
# WhatsApp Personal
Source: https://relevanceai.com/docs/integrations/agent-integrations/premium-triggers/whatsapp
Connect your WhatsApp account to Relevance AI and enable your agents to communicate directly with customers through one of the world's most popular messaging platforms.
## Connect the integration
Connecting your WhatsApp account to Relevance AI is a straightforward process:
1. Go to the "Integrations" page in the sidebar.
2. Click on "WhatsApp".
3. Click on the "Add Integration" button.
4. In the pop-up window, add your phone number.
5. Once connected, you'll see your WhatsApp phone number account listed under active integrations.
## Setting up triggers
WhatsApp Integration can be configured as a trigger for your AI agents, allowing them to automatically respond when messages are received through WhatsApp.
To set up WhatsApp as a trigger:
1. Create a new agent or edit an existing one.
2. Navigate to the "Triggers" section in "Agent Profile".
3. Select "WhatsApp" from the available triggers.
4. Choose the WhatsApp account you want to connect to this agent.
5. Configure trigger conditions (optional):
* Respond to all incoming messages
* Respond only to specific contacts or groups
* Respond based on message content filters
6. Save your trigger configuration.
Once set up, your agent will automatically activate when new WhatsApp messages that match your trigger conditions are received, enabling real-time customer engagement.
## Tools & Tool Steps
WhatsApp integration provides powerful tools and actions that your agents can use to engage with customers. These actions can be incorporated into your agent's workflow at any point, not just as triggers.
Here are some of the key WhatsApp actions available:
### Send WhatsApp Message
Send text messages to individual contacts or groups.
Input parameters:
* Recipient phone number or group ID
* Message content
* Optional: Attachments
### Send WhatsApp Media
Share images, documents, or other media files with your contacts.
Input parameters:
* Recipient phone number or group ID
* Media type (image, document, audio, video)
* Media URL or file
* Optional: Caption
### Send WhatsApp Template Message
Use pre-approved message templates for business communications.
Input parameters:
* Recipient phone number
* Template name
* Template parameters
### Get WhatsApp Conversation History
Retrieve previous messages from a specific conversation.
Input parameters:
* Contact phone number
* Optional: Time range
### Mark WhatsApp Message as Read
Update the read status of messages.
Input parameters:
* Message ID
These are just a few examples of the many WhatsApp actions available. Your agents can leverage these tools to create sophisticated customer engagement workflows, from automated support responses to personalized marketing campaigns.
## Use the integration's API tool step (advanced)
In addition to the tools and actions available in the directory, you can build custom tools that perform WhatsApp activities by using the WhatsApp API Call tool step:
1. Create a new tool.
2. Scroll down to Tool-steps.
3. Add WhatsApp API tool-step.
4. Select your connected WhatsApp account in the dropdown.
This advanced approach gives you direct access to the WhatsApp Business API, allowing for more complex and customized interactions:
### Example API call:
```json
{
"endpoint": "/messages",
"method": "POST",
"body": {
"to": "{{recipient_number}}",
"type": "text",
"text": {
"body": "{{message_content}}"
}
}
}
```
## Premium Trigger Information
WhatsApp Integration is available as a **Premium Trigger** exclusively for Teams and Business plan users. As a premium integration:
* This trigger is only accessible on Teams and Business plans
* Each connected WhatsApp account in your organization incurs an additional 5000 credits per month
## Related Features
[Outlook Integration](https://relevanceai.com/docs/integrations/outlook) - Use WhatsApp alongside email communications for a comprehensive customer engagement strategy. Coordinate messaging across both channels for consistent customer experiences.
[HubSpot Integration](https://relevanceai.com/docs/integrations/hubspot) - Connect your WhatsApp conversations with your CRM to maintain customer context across all touchpoints. Track WhatsApp interactions in your customer records for better relationship management.
## FAQs
### What types of WhatsApp accounts are supported?
Relevance AI supports WhatsApp Business accounts. Personal WhatsApp accounts are not supported for this integration.
### Are there message volume limitations?
Message volumes are subject to WhatsApp's own policies and rate limits. The Relevance AI platform itself doesn't impose additional limits beyond your plan's credit allocation.
### Can I use WhatsApp for bulk messaging?
Yes, but you must comply with WhatsApp's business policies regarding bulk messaging and ensure you have proper opt-ins from recipients.
### How secure are WhatsApp conversations through Relevance AI?
All WhatsApp communications maintain end-to-end encryption. Relevance AI adheres to strict security protocols to ensure your conversation data remains protected.
### Can multiple agents use the same WhatsApp account?
Yes, you can connect multiple agents to the same WhatsApp account, but you should configure triggers carefully to avoid conflicts.
# Salesforce
Source: https://relevanceai.com/docs/integrations/agent-integrations/salesforce
Interact with your Salesforce CRM with Relevance.
Salesforce is designed to help businesses manage their sales pipeline, primarily through customer relationship tracking activities. With Relevance AI, your agents can interact with Salesforce much like your human sales team would.
Below, we'll show you how to get started with the Salesforce integration, including how to connect your Salesforce account, how to trigger agentic workflows based on Salesforce events, and how to complete common CRM activities with your agents.
## 1. How to connect your Salesforce account
To add Salesforce as an integration, all you need to do is sign-into your Salesforce account via the integrations page:
1. Go to the "Integrations" page in the sidebar.
2. Click on "Salesforce".
3. Click on the Add Integration button.
4. Sign-in to your Salesforce account.
5. Click "Allow access" to Relevance AI.
## 2. Setup Salesforce as an Agent Trigger
A trigger is an event that triggers your agent to start working. In the case of Salesforce, a trigger might be new leads added to your CRM, demos have been booked, a lead has moved down the sales funnel (e.g. Prospect -> Qualified lead) or other events unique to your sales workflows.
### Add a Salesforce trigger to your agent.
After you have created a new agent, you can add Salesforce as a trigger:
1. Open your agent settings (Agent profile tab).
2. Scroll down to Integrations > Triggers.
3. Click on Salesforce.
4. Select your connected Salesforce account, or sign-in if not already added via the integrations page (previous section).
5. Click "Allow access" to Relevance AI.
6. Write an SOQL query to retrieve the data you want to pull in from your Salesforce account.
Here is an example on an SOQL query that pulls in new leads:
**Pull in New Leads**
The following SOQL query pulls in Lead objects with the selected properties, where the "Relevance\_Outreached\_\_c" custom object has been set to "true".
```SOQL
SELECT Id, Name, Email, Phone, AccountId, Account.Name, Title
FROM Lead
WHERE Relevance_Outreached__c = true
```
Now, any new Leads that are added to the CRM since the last time we checked that meet the query conditions, will be sent to the agent.
Make sure that you are writing [Salesforce Object Query Language (SOQL) queries](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm), and not SQL queries here. SQL queries that use order-by statements for example, will fail.
7. Advanced option (Optional): Specify a frequency, which is how often you want to fetch data from Salesforce. If you don't specify a frequency, it'll check every 1 minute.
8. Set a Cadence (Optional): Specificy a cadence, which is how often one of the items fetched from Salesforce triggers the agent (if 100 new leads are added, you might not want your agent to outreach to them all the same day, especially if you're in the middle of warming up your inboxes). The rest will wait in a queue.
## 3. Get your agent to complete common Salesforce activities
Once your account is connected, you can use the Salesforce API call step in the Tool builder. This tool step allows you to complete Salesforce-specific activities, like managing Leads, Contacts, Notes, Tasks and more.
### 3.0. Use Salesforce API tool-step
You can build custom tools that perform Salesforce activities, by using the Salesforce API Call tool-step:
1. Create a new tool.
2. Scroll down to Tool-steps.
3. Add Salesforce API tool-step.
4. Select your connected Salesforce account in the dropdown.
Below are examples of common Salesforce activities your agents can perform.
### 3.1. Get an existing Contact's details.
### 3.2. Create a new Lead.
### 3.3. Create a note (e.g. lead qual research).
### 3.4. Create a task
### 3.5. Mark a task as complete
## 4. Remove Salesforce integration
You can remove Salesforce as a Trigger in your agent settings, by clicking the three dots next to your connected account, and then "Remove".
If you want to remove the Salesforce integration completely, you can:
1. Go to the "Integrations" page from the sidebar
2. Select Zoom from the list
3. Click "..." on the account you want to remove
4. Click remove
# Whatsapp for Business
Source: https://relevanceai.com/docs/integrations/agent-integrations/whatsapp-for-business
Interact with your WhatsApp Business account with Relevance.
# WhatsApp For Business Integration
Connect your AI agents with WhatsApp Business to engage with customers directly through one of the world's most popular messaging platforms. The WhatsApp Business integration enables your agents to handle customer inquiries, provide support, and deliver personalized experiences through WhatsApp's familiar interface.
## Connect the integration
Setting up the WhatsApp Business integration with Relevance AI is straightforward:
1. Navigate to the "Integrations" page in the sidebar of your Relevance AI dashboard
2. Locate and click on "WhatsApp Business"
3. Click the "Add Integration" button
4. Follow the authentication flow to connect your WhatsApp Business account
5. Once connected, you'll see your WhatsApp Business account listed under active integrations
## Setting up triggers
The WhatsApp Business integration allows you to create powerful triggers that automatically activate your AI agents when specific events occur. This enables seamless customer engagement without manual intervention.
To set up a WhatsApp trigger:
1. Go to your agent's profile page
2. Under "Triggers", select "WhatsApp Business"
3. Configure the trigger settings:
* **Trigger on new messages**: Activate your agent when a customer sends a message to your WhatsApp Business number
* **Trigger on specific keywords**: Set your agent to respond only when certain keywords or phrases are detected
* **Trigger based on customer attributes**: Configure triggers based on customer data or conversation context
Once configured, your agent will automatically engage with customers through WhatsApp when the trigger conditions are met.
## Tools & Tool Steps
The WhatsApp Business integration provides a rich set of actions that your agents can use to interact with customers. These actions can be incorporated into your agent's workflow to create sophisticated conversation flows and deliver exceptional customer experiences.
Here are some of the key actions available:
### Send Message
Send text messages to customers through WhatsApp. This action supports rich text formatting, allowing your agent to send well-structured, easy-to-read messages.
### Send Media
Share images, documents, videos, or audio files with customers. This is perfect for sending product catalogs, instructional materials, or visual content to enhance the conversation.
### Send Template Message
Utilize pre-approved message templates for common scenarios like welcome messages, order confirmations, appointment reminders, and more. Templates ensure compliance with WhatsApp's policies while maintaining consistent communication.
### Send Interactive Messages
Create interactive experiences with buttons, list messages, and reply buttons that guide customers through specific flows or help them make selections without typing lengthy responses.
### Get Customer Profile
Retrieve customer profile information to personalize interactions based on available data, such as name, profile picture, or previous interaction history.
### Mark Messages as Read
Update message status to "read" to provide customers with confirmation that their messages have been received and processed.
### Create Groups
Create WhatsApp groups for specific purposes, such as product launches, support communities, or team discussions.
### Manage Contacts
Add, update, or retrieve contact information to maintain an accurate customer database.
These are just a few examples of the many actions available through the WhatsApp Business integration. The platform offers numerous additional capabilities to support complex business workflows and customer engagement strategies.
## Use the integration's API tool step (advanced)
For advanced users who need more customized functionality, Relevance AI provides direct access to the WhatsApp Business API through a dedicated API tool step:
1. Create a new tool in your Relevance AI dashboard
2. Scroll down to Tool-steps
3. Add the WhatsApp Business API tool-step
4. Select your connected WhatsApp Business account from the dropdown
With the API tool step, you can build custom tools that leverage the full power of the WhatsApp Business API, including:
### Custom Message Formatting
Create highly customized message formats with advanced formatting options not available through standard actions.
### Batch Operations
Send messages to multiple recipients simultaneously or perform bulk operations on conversations.
### Advanced Media Handling
Implement sophisticated media processing workflows, such as image analysis or document processing before sending responses.
### Integration with External Systems
Connect WhatsApp conversations with external databases, CRMs, or business systems to create unified customer experiences.
### Custom Analytics
Build specialized analytics tools to track conversation metrics, customer engagement patterns, or agent performance.
The API tool step gives you complete flexibility to extend the capabilities of the WhatsApp Business integration to meet your specific business requirements.
## Related Features
* [Outlook Integration](https://relevanceai.com/docs/integrations/outlook) - Connect your agents with email communications to create a unified messaging strategy across multiple channels.
* [Knowledge Base](https://relevanceai.com/docs/knowledge/create-knowledge) - Enhance your WhatsApp conversations by giving your agents access to your organization's knowledge base for accurate and consistent responses.
* [Agent Templates](https://relevanceai.com/docs/agent/templates) - Explore pre-built agent templates designed specifically for customer support and engagement through messaging platforms.
## FAQs
### What are the requirements for using the WhatsApp Business integration?
You need a WhatsApp Business account and must comply with WhatsApp's Business Policy. Your account must be verified and in good standing.
### Can I use the integration with multiple WhatsApp Business numbers?
Yes, you can connect multiple WhatsApp Business numbers to Relevance AI and configure different agents to work with specific numbers.
### How does the integration handle media files?
The integration supports sending and receiving various media types including images, documents, audio files, and videos, with size limitations as specified by WhatsApp's policies.
### Is the integration compliant with WhatsApp's messaging policies?
Yes, the integration is designed to comply with WhatsApp's Business Messaging Policy. However, it's your responsibility to ensure that your messaging practices adhere to these policies and local regulations.
# Zoominfo
Source: https://relevanceai.com/docs/integrations/agent-integrations/zoominfo
Interact with your Salesforce CRM with Relevance.
# ZoomInfo Integration
ZoomInfo is a powerful B2B database and intelligence platform that provides comprehensive company and contact information to help sales and marketing teams identify and connect with their ideal prospects. With the Relevance AI ZoomInfo integration, you can leverage this valuable data directly within your AI agents' workflows, enabling more effective prospecting, lead qualification, and account-based marketing initiatives.
## 1. Connect the integration
Connecting ZoomInfo to Relevance AI is a straightforward process that gives your agents access to valuable B2B data:
1. Go to the "Integrations" page in the sidebar.
2. Click on "ZoomInfo".
3. Click on the Add Integration button.
4. In the pop-up window, sign into your ZoomInfo account.
5. Authorize Relevance AI to access your ZoomInfo data.
6. Once connected, you'll see your ZoomInfo account listed under connected accounts.
## 2. Setting up triggers
ZoomInfo can serve as a powerful trigger for your AI agents, automatically initiating workflows when specific events occur in your ZoomInfo account. This is particularly valuable for sales teams who want to act quickly on intent signals and prospect activities.
### Set up ZoomInfo as an Agent Trigger
1. Create a new agent or edit an existing one.
2. Navigate to the "Triggers" section in the “Agent profile”.
3. Select "ZoomInfo" from the available triggers.
4. Configure your trigger settings based on the ZoomInfo events you want to monitor:
* **Intent Topics**: Trigger your agent when ZoomInfo detects buying intent for specific topics relevant to your business.
* **New Prospects**: Activate your agent when new prospects matching your criteria are added to ZoomInfo.
* **Account Updates**: Start workflows when there are significant updates to target accounts in your ZoomInfo instance.
For example, you could create a trigger that activates your agent whenever ZoomInfo detects new buying intent signals for "data analytics" from companies in your target market. Your agent can then automatically research these companies, prepare personalized outreach, and even initiate contact through your preferred channels.
## 3. Tools & Tool Steps
The ZoomInfo integration provides a rich set of actions (tool steps) that your agents can use to access and leverage B2B data. These actions can be incorporated into your agent's workflows to automate prospecting, enrichment, and research tasks.
### Common ZoomInfo Actions
Your agents can perform a wide range of ZoomInfo-related tasks, including:
* **Search Companies**: Find companies matching specific criteria such as industry, size, location, or technologies used.
* **Search Contacts**: Identify decision-makers and key stakeholders at target accounts.
* **Get Company Details**: Retrieve comprehensive information about a specific company, including firmographics, technographics, and recent news.
* **Get Contact Details**: Access detailed information about specific contacts, including job roles, contact information, and professional background.
* **Track Intent Signals**: Monitor buying intent signals for specific topics across your target accounts.
* **Export Lists**: Create and export lists of companies or contacts for use in marketing campaigns or sales outreach.
* **Update Records**: Keep your ZoomInfo data current by updating records with new information.
These are just a few examples of the many ZoomInfo actions available. The integration provides a comprehensive set of tools that allow your agents to leverage the full power of ZoomInfo's B2B intelligence platform.
### How to Add ZoomInfo Actions to Your Agent
1. Create or edit a tool in your Relevance AI workspace.
2. Add a new tool step.
3. Search for "ZoomInfo" in the tool step library.
4. Select the desired ZoomInfo action from the available options.
5. Configure the action parameters according to your needs.
6. Connect this tool to your agent to enable ZoomInfo data access.
## 4. Use the ZoomInfo API tool step (advanced)
In addition to the pre-built actions available in the tool library, advanced users can create custom ZoomInfo integrations using the ZoomInfo API Call tool step:
1. Create a new tool.
2. Scroll down to Tool-steps.
3. Add ZoomInfo API tool-step.
4. Select your connected ZoomInfo account in the dropdown.
5. Configure the API endpoint, parameters, and authentication details.
This approach gives you maximum flexibility to create custom ZoomInfo integrations tailored to your specific business needs. You can access any endpoint available in the ZoomInfo API, allowing for advanced use cases beyond what's available in the standard action library.
### Example: Custom Company Enrichment
Here's an example of how you might use the ZoomInfo API tool step to create a custom company enrichment workflow:
```json
{
"endpoint": "/companies/enrich",
"method": "POST",
"body": {
"company_name": "{{input.company_name}}",
"domain": "{{input.domain}}",
"include_attributes": ["industry", "revenue", "employee_count", "technologies", "location"]
}
}
```
This custom API call would retrieve specific company attributes that are most relevant to your qualification process, allowing your agent to make more informed decisions about prospect fit.
## Related Features
* [HubSpot Integration](https://relevanceai.com/docs/integrations/hubspot) - Combine ZoomInfo's rich B2B data with HubSpot's CRM capabilities to create powerful sales and marketing workflows that leverage both platforms.
* [Salesforce Integration](https://relevanceai.com/docs/integrations/salesforce) - Enrich your Salesforce records with ZoomInfo data and trigger automated workflows based on changes in either system.
# Email warmups
Source: https://relevanceai.com/docs/integrations/integration-use-case/email-warmups
Use case: Warm up your email before starting your email marketing campaigns.
## Why do you need to warmup your email inbox?
Email warmups refer to the process of gradually increasing the volume of emails sent from a new or unused email account to build a positive sender reputation with internet service providers (ISPs).
A warmedup email inbox helps you to avoid spam filters and ensure better deliverability rates.
We recommend that you create an email account especially for your email inbox manager agents. So warming up their inbox before sending out emails from their account will help your email marketing/inbox management campaigns start successfully.
## How to warmup your emails?
The process usually involvesn sending a small number of emails initially and slowly increasing the quantity over time. Start by sending a few emails to active, engaged recipients like colleagues who are likely to open and interact with your agent's emails.
We recommend starting with 4-8 warm-up emails per day per account with a target reply rate of 30%. After two weeks, you can increase the warm-up volume to 20-30 emails per day per account, with a higher target reply rate of 70% when engaging in outreach.
The maximum recommended warm-up email volume is 50 emails per day, with a reply rate of a max of 60%.
## Add email warmup integration to your Relevance account
You can use an in-built Relevance integration to warm up your chosen email account, by activating the email warmup integration.
Here is a video walking you through the process of doing this:
This is one of our flagship agent templates, BDR Bosh (enterprise only).
Step-by-step-process:
1. On the "Integrations" page.
2. Click on the "Google (Gmail, calendar & API)" integration.
3. Click on the 3 dot menu next to the email you want to warm up, then click on "Email Warmup Settings".
* Sender name: This is who all your email warmup emails are going to come from. This could be your name, or just be a name you use to be able to classify the email warmup emails in your inbox.
* App password, get it from the documentation link. When you click on that, make sure you’re in the right account first. Setup 2fa. Create and manage app passwords. Create a new password, call it Email Warmup. Copy paste the app password.
4. Click on 3 dots next to your email account, and click on "Email warmup settings" again.
You will now see basic statistics on how your email warmup is going.
You can start and stop your email warmups at any time.
# Introduction
Source: https://relevanceai.com/docs/integrations/introduction
Connect your AI agents with external tools and services to create powerful, automated workflows across your entire tech stack.
## Overview
Integrations serve as bridges between your AI agents and the external services you rely on daily. By establishing these connections, you can create seamless workflows that span across multiple platforms, allowing your agents to access data from and perform actions within your entire digital ecosystem.
For new users, it's important to understand that integrations enable four key capabilities:
1. **Connecting external services** to your Relevance AI account
2. **Setting up triggers** that automatically activate your agents based on external events
3. **Using pre-built actions** that allow your agents to interact with external platforms
4. **Creating custom API calls** for advanced integration scenarios
Let's explore each of these capabilities in detail.
## 1. Connecting Integrations
The first step in leveraging integrations is connecting your external services to Relevance AI:
1. Navigate to the **Integrations** page from the left-hand menu of your Relevance AI account
2. Browse the available integrations and select the service you want to connect
3. Click on the integration card to begin the connection process
4. Follow the authentication steps to authorize the connection (typically involves logging into the service or providing API credentials)
5. Once connected, the integration will appear as "Connected" in your list of available integrations
Each integration may have specific configuration options depending on the service. The platform guides you through the necessary steps to establish a secure and functional connection.
### Connecting LLM Accounts
A particularly valuable integration option is connecting your own Large Language Model (LLM) accounts:
1. Go to the **Integrations** page in the left-hand menu
2. Look for the LLM provider you want to connect (such as OpenAI, Anthropic, or Google)
3. Click on the provider and enter your API key
4. Once connected, you can use your own LLM account with your agents
This capability allows you to leverage your existing LLM subscriptions and manage usage under your own account, giving you greater control over your AI resources and potentially reducing costs.
## 2. Setting Up Triggers
Triggers are events from integrated platforms that automatically activate your agents. This transforms your agents from reactive tools that wait for instructions into proactive assistants that respond to events in your digital environment.
### How to Set Up Triggers:
1. Go to the **Agent Settings** page for the agent you want to configure
2. Select **Agent Profile** from the menu
3. Locate the **Triggers** section
4. Click **"Add Trigger"** and select from the available trigger options
5. Configure the trigger settings according to your needs
6. Save your changes
### Common Trigger Examples:
* **Email Integrations (Gmail, Outlook)**: Trigger an agent when you receive an email matching specific criteria
* **CRM Integrations (HubSpot, Salesforce)**: Activate an agent when a new contact is created or a deal stage changes
* **Support Integrations (Freshdesk, Zendesk)**: Start an agent workflow when a new support ticket is created
* **Messaging Integrations (Slack, WhatsApp Business)**: Trigger an agent when a message is received in a specific channel
For example, with the HubSpot integration, you could set up a trigger that activates your sales assistant agent whenever a new lead is created in your CRM. The agent could then automatically research the lead, prepare a personalized outreach message, and schedule a follow-up task.
## 3. Tools & Tool Steps (Actions)
This is where integrations truly shine! Once connected, integrations provide a library of pre-built actions that your agents can use to interact with external platforms. These actions can be incorporated into your agent's workflows at any point, not just as triggers.
### How to Add Integration Actions to Your Agent:
1. Go to the **Agent Settings** page for your agent
2. Select **Tools** under "Connected Resources" in the sidebar
3. Click **"+ Add tool"** to open the tool library
4. Search for the integration name (e.g., "HubSpot" or "Slack")
5. Browse the available actions for that integration
6. Select the action you want to add and click **"+ Add"**
7. Configure any required parameters for the action
8. Save your changes
### Examples of Powerful Integration Actions:
**Slack Integration Actions:**
* Send a message to a specific channel
* Create a new channel
* Search for messages
* Update a message
* Upload a file
* Create a poll
* And many more!
**Google Calendar Integration Actions:**
* Create a new event
* Check availability
* Update an existing event
* Send calendar invites
* Get upcoming events
* Delete events
* And many more!
**HubSpot Integration Actions:**
* Create or update contacts
* Add notes to contact records
* Create deals
* Update deal stages
* Create tasks
* Search for contacts
* Get contact properties
* And many more!
**Notion Integration Actions:**
* Create a new page
* Update page content
* Search for pages
* Create databases
* Add items to databases
* Comment on pages
* And many more!
These actions are the building blocks of powerful workflows. For example, your agent could use the HubSpot "Get Contact" action to retrieve customer information, then use the "Create Task" action to set up a follow-up, and finally use the Slack "Send Message" action to notify your sales team.
The beauty of these actions is that they can be used in any combination and at any point in your agent's workflow. You're not limited to a predefined sequence - you can create custom workflows that perfectly match your business processes.
## 4. Using the Integration's API Tool Step (Advanced)
For advanced users who need more flexibility than the pre-built actions provide, Relevance AI offers direct API access to your connected integrations:
1. Create a new tool in the **Tools** section
2. Scroll down to **Tool Steps**
3. Click **"+ Add Step"**
4. Search for and select the integration's API tool step (e.g., "HubSpot API")
5. Select your connected account from the dropdown
6. Configure the API endpoint, method, and parameters
7. Save your tool
This advanced capability allows you to access any functionality exposed by the integration's API, even if there isn't a pre-built action for it yet. It's perfect for custom workflows that require specialized interactions with your external services.
## Creating Powerful Cross-Platform Workflows
The true power of integrations comes from combining multiple actions across different platforms into cohesive workflows. Here's an example of how you might use integrations to automate a lead nurturing process:
1. A new lead is created in HubSpot (trigger)
2. Your agent uses the Google Search action to research the lead's company
3. The agent uses the HubSpot action to add research notes to the contact record
4. The agent uses the Gmail action to send a personalized introduction email
5. The agent uses the Google Calendar action to schedule a follow-up task
6. The agent uses the Slack action to notify the sales team about the new lead
All of this happens automatically, without any manual intervention required. These workflows can dramatically increase efficiency, reduce human error, and ensure consistent execution of your business processes.
## Best Practices for Using Integrations
To get the most out of your integrations:
1. **Start with clear goals**: Define what you want to achieve with each integration before setting it up
2. **Begin with simple workflows**: Start with basic trigger-action combinations before building complex multi-step processes
3. **Test thoroughly**: Always test your integration workflows with sample data before deploying them
4. **Monitor performance**: Regularly check that your integrations are functioning as expected
5. **Secure your credentials**: Follow security best practices when connecting integrations, especially when using API keys
6. **Document your workflows**: Keep track of how data flows between systems for easier troubleshooting and optimization
## Related Features
[Agent Triggers](https://relevanceai.com/docs/agent/customise-agent/triggers) - Learn more about setting up events that automatically activate your agents based on specific conditions or actions.
[Tools](https://relevanceai.com/docs/tool/introduction) - Discover how to enhance your agents with specialized tools that extend their capabilities and allow them to perform specific tasks.
[Agent Configuration](https://relevanceai.com/docs/agent/agent-configuration) - Explore the complete process of setting up and customizing your AI agents to work with integrations and other features.
## FAQs
**Q: How many integrations can I connect to my Relevance AI account?**\
A: There is no hard limit on the number of integrations you can connect. You can connect as many services as you need to support your workflows.
**Q: Can I connect multiple accounts from the same service?**
A: Yes, you can connect multiple accounts from the same service. This is useful if you need to work with different accounts for different purposes or clients.
**Q: What happens if an integration temporarily fails?**\
A: The system will attempt to reconnect and, if unsuccessful, will notify you of the issue. Your agents will continue to function with their other capabilities while the integration is being restored.
**Q: Can I create custom integrations if what I need isn't available?**\
A: While Relevance AI continually expands its integration library, you can also use webhook integrations or API tool steps to connect with services that don't have dedicated integrations yet.
# MCP Server Integration
Source: https://relevanceai.com/docs/integrations/popular-integrations/Model-context-protocol
Connect your Relevance AI tools to Claude, Cursor, and other AI clients that support MCP servers. This integration creates a bridge between your Relevance AI workspace and external AI assistants, allowing you to leverage your custom tools across multiple platforms.
## Overview
The MCP Server integration enables you to use your Relevance AI tools in external AI clients that support the MCP (Model Control Protocol) standard. This powerful feature creates a seamless connection between your Relevance AI workspace and popular AI assistants like Claude and development environments like Cursor.
With MCP Server integration, you maintain a single source of truth for your tools while extending their availability across your entire AI ecosystem. This means the specialized tools you've built in Relevance AI can now be accessed and utilized by your favorite AI assistants outside our platform.
## Benefits
* **Extended tool availability**: Use your Relevance AI tools in Claude, Cursor, and other MCP-compatible AI clients
* **Centralized tool management**: Update tools in one place and have changes reflect everywhere
* **Customizable integration**: Select exactly which tools to expose to external clients
* **Simple configuration**: Generate MCP server settings with just a few clicks
* **Seamless workflow integration**: Access your specialized tools wherever you work with AI
## How It Works
The MCP Server integration creates a secure bridge between your Relevance AI workspace and external AI clients. When you configure the integration, you select which tools from your workspace you want to make available to external clients. The system then generates the necessary configuration settings that you can copy into your preferred MCP-compatible client.
Once configured, your external AI assistant can access and execute the selected Relevance AI tools as if they were native to that platform. This creates a consistent experience across your entire AI workflow, regardless of which interface you're using.
## Setting Up MCP Server Integration
Setting up the MCP Server integration is straightforward:
1. Go to your Relevance AI workspace
2. Under "Tools", navigate to "Export Tools" → "MCP Server"
3. Select the tools you want to share with external clients
4. Click "Generate MCP Server Configuration"
5. Copy your MCP configuration into your preferred client:
For Cursor: Open Cursor settings → MCP tab → "Add new MCP server" → Paste into your mcp.json file
## Client-Specific Setup
### Cursor
To use your Relevance AI tools in Cursor:
1. Open Cursor settings
2. Navigate to the MCP tab
3. Click "Add new MCP server"
4. Paste your generated MCP configuration into your mcp.json file
5. Save the configuration
### Claude
To use your Relevance AI tools in Claude:
1. Access Claude's settings
2. Look for the tool or API integration section
3. Add a new MCP server
4. Paste your generated MCP configuration
5. Save the settings
## Best Practices
* **Select tools strategically**: Only expose tools that would be useful in external contexts
* **Test the integration**: After setting up, test each tool to ensure it works as expected
* **Update regularly**: When you update tools in Relevance AI, regenerate your MCP configuration
* **Monitor usage**: Keep track of how your tools are being used across different platforms
## Security Considerations
The MCP Server integration maintains the security of your tools while making them accessible to external clients. Authentication is handled through secure tokens, ensuring that only authorized users can access your tools. All communication between Relevance AI and external clients is encrypted to protect your data.
## Troubleshooting
If you encounter issues with the MCP Server integration:
* Verify that your MCP configuration is correctly copied into the external client
* Ensure the external client supports the MCP standard
* Check that the selected tools are compatible with the external client
* Confirm your authentication credentials are valid
* Regenerate the MCP configuration if necessary
## Related Features
[Tool Templates](https://relevanceai.com/docs/tool/templates) - Create powerful tools that can be used both within Relevance AI and through the MCP Server integration.
[Create a Tool](https://relevanceai.com/docs/tool/create-a-tool) - Learn how to build custom tools that can be shared across your AI ecosystem.
[Customize Tools](https://relevanceai.com/docs/tool/customize-tool/tool-style-guide) - Optimize your tools for better performance across different AI clients.
## Conclusion
The MCP Server integration represents a significant step forward in creating a unified AI ecosystem. By allowing your Relevance AI tools to be used in external AI clients, you can maintain consistency across platforms while leveraging the unique strengths of each environment. This integration maximizes your investment in tool development and ensures that your specialized capabilities are available wherever you work with AI.
# Canva
Source: https://relevanceai.com/docs/integrations/popular-integrations/canva
Elevate your visual content creation capabilities with the Canva integration for Relevance AI.
## Connect the Integration
Setting up the Canva integration with Relevance AI is straightforward:
1. Navigate to the Integrations section in your Relevance AI dashboard
2. Find and select "Canva" from the available integrations
3. Click "Connect"
4. You'll be redirected to Canva to authorize the connection
5. Log in to your Canva account (or create one if needed)
6. Review and approve the permissions requested
7. Once authorized, you'll be redirected back to Relevance AI with the integration active
After connecting, your Relevance AI agents will be able to interact with your Canva account, accessing templates, creating designs, and managing your Canva projects.
## Setting up Triggers
The Canva integration can be configured as a trigger for your AI agents, allowing them to automatically respond to events in your Canva account. This creates powerful workflows where design activities can initiate AI-driven processes.
To set up a Canva trigger *(coming soon)*:
1. Navigate to your agent's configuration page (”Agent profile”)
2. Under "Triggers" choose "Canva" from the available trigger sources
3. Select the specific event you want to trigger your agent:
* New design created
* Design shared with you
* Design comment added
* Design published
4. Configure any additional trigger parameters
5. Save your trigger configuration
With triggers properly configured, your agent can automatically perform tasks like:
* Generating social media copy when a new social post design is created
* Notifying team members when designs are ready for review
* Creating documentation when marketing materials are finalized
* Scheduling content distribution when designs are published
## Tools & Tool Steps
The Canva integration provides a rich set of actions that your agents can use to interact with Canva. These actions can be incorporated into your agent's workflows to automate design-related tasks.
### Available Canva Actions
Your agents can leverage numerous Canva actions, including:
* **Create Design**: Generate new designs from templates or from scratch
* **Edit Design**: Modify existing designs with new text, images, or elements
* **Export Design**: Download designs in various formats (PNG, JPG, PDF)
* **List Templates**: Browse available Canva templates by category
* **Add Brand Kit**: Upload and manage brand assets like logos and colors
* **Schedule Posts**: Plan social media content publication
* **Manage Folders**: Organize designs into project folders
* **Share Design**: Collaborate with team members on designs
* **Add Comments**: Provide feedback on designs
* **Search Elements**: Find graphics, photos, and other design elements
These actions give your agents the ability to handle complex design workflows without manual intervention. For example, an agent could:
1. Create a new social media post from a template
2. Customize it with your brand colors and logo
3. Add text based on marketing copy it generated
4. Export the design in multiple formats
5. Share it with your marketing team for approval
The integration supports a wide range of design types including social media posts, presentations, flyers, business cards, infographics, and many more. Your agents can work with any design format supported by Canva.
## Use the Integration's API Tool Step (Advanced)
For advanced users who need more customized functionality, the Canva API tool step provides direct access to Canva's API capabilities:
1. Create a new tool in Relevance AI
2. Scroll down to Tool-steps
3. Add "Canva API" tool-step
4. Select your connected Canva account in the dropdown
5. Configure the API request with the appropriate endpoint, method, and parameters
6. Test and save your custom tool
Using the API directly allows for more sophisticated interactions with Canva, such as:
* Batch processing multiple designs
* Creating custom design workflows
* Implementing advanced design automation
* Integrating with other services in your workflow
## Related Features
[Knowledge Base Integration](https://relevanceai.com/docs/knowledge/create-knowledge) - Store design guidelines, brand assets, and marketing strategies that your agents can reference when creating Canva designs.
[Slack Integration](https://relevanceai.com/docs/integrations/slack) - Connect your design workflow to Slack for seamless team collaboration. Agents can notify team members when designs are ready for review or automatically share completed designs in relevant channels.
[Email Integration](https://relevanceai.com/docs/integrations/outlook) - Enable your agents to send designs directly to clients or team members via email, streamlining the approval and delivery process.
## Best Practices
* **Maintain Brand Consistency**: Store your brand guidelines in a knowledge base for your agents to reference when creating designs
* **Template Organization**: Create and categorize templates in Canva for different use cases to help your agents select the right starting point
* **Clear Instructions**: When requesting designs, provide specific details about the intended audience, purpose, and key messages
* **Approval Workflows**: Set up multi-step approval processes for important designs
* **Asset Management**: Keep your brand assets organized in Canva for easy access by your agents
By integrating Canva with Relevance AI, you can automate design workflows, maintain brand consistency, and scale your visual content creation—all while leveraging the intelligence of your AI agents to deliver compelling visual communications.
# Confluence
Source: https://relevanceai.com/docs/integrations/popular-integrations/confluence
Confluence is a powerful collaboration platform that helps teams organize, create, and share knowledge.
# Confluence Integration
Confluence is a powerful collaboration platform that helps teams organize, create, and share knowledge. With Relevance AI's Confluence integration, you can seamlessly connect your Confluence workspace to your AI agents, enabling them to access, create, and update Confluence content, making your knowledge management workflows more efficient and intelligent.
## 1. Connect the integration
Connecting your Confluence account to Relevance AI is a straightforward process:
1. Go to the "Integrations" page in the sidebar of your Relevance AI dashboard.
2. Click on "Confluence" from the available integrations.
3. Click on the "Add Integration" button.
4. In the pop-up window, sign into your Atlassian account.
5. Grant the necessary permissions for Relevance AI to access your Confluence workspace.
6. Once authenticated, your Confluence account will appear as a connected integration.
## 2. Setting up triggers
You can configure your AI agents to be triggered by specific events in Confluence, allowing them to respond automatically to changes in your knowledge base.
### Create a Confluence trigger *(coming soon)*
1. Create a new agent or select an existing one you want to connect to Confluence.
2. Navigate to the "Triggers" section in your agent's settings ("Agent profile").
3. Select "Confluence" from the list of available triggers.
4. Configure the trigger conditions based on Confluence events such as:
* Page created
* Page updated
* Comment added
* Space created
* Content labeled
5. Specify any additional filters to narrow down when your agent should be triggered (e.g., only trigger for pages in a specific space or with certain labels).
6. Save your trigger configuration.
Now, whenever the specified event occurs in your Confluence workspace, your agent will be automatically triggered to perform its designated tasks.
## 3. Tools & Tool Steps
The Confluence integration provides a rich set of actions that your agents can use to interact with your Confluence workspace. These actions can be incorporated into your agent's workflows as tool steps, enabling sophisticated knowledge management capabilities.
### Common Confluence actions
Here are some of the powerful actions available through the Confluence integration:
* Create Page: Create new pages in your Confluence workspace with specified content, title, and space.
* Update Page: Modify existing pages with new or updated content.
* Get Page Content: Retrieve the content of a specific page for analysis or reference.
* Search Content: Find relevant pages, blogs, or comments based on keywords or criteria.
* Add Comment: Add comments to pages or blogs.
* Get Comments: Retrieve comments from a specific page.
* Create Blog Post: Publish blog posts to your Confluence workspace.
* Get Space Information: Retrieve details about a specific Confluence space.
* List Spaces: Get a list of all available spaces in your Confluence instance.
* Add Labels: Apply labels to Confluence content for better organization.
* Get Labels: Retrieve labels associated with specific content.
* Get Page History: Access the revision history of a page.
These are just a few examples of the many actions available. The Confluence integration offers extensive capabilities to manage and interact with your Confluence content programmatically through your AI agents.
### Example use cases
Here are some ways you can leverage the Confluence integration with your agents:
1. Documentation Assistant: Create an agent that automatically updates technical documentation in Confluence when new features are released or code changes are made.
2. Knowledge Summarizer: Build an agent that monitors specific Confluence spaces and creates executive summaries of new content added during the week.
3. Content Organizer: Deploy an agent that automatically adds appropriate labels to new Confluence pages based on their content analysis.
4. Meeting Notes Processor: Create an agent that takes meeting notes, formats them according to your team's template, and posts them to the relevant Confluence space.
5. Knowledge Gap Identifier: Build an agent that analyzes your Confluence content and identifies areas where documentation is missing or outdated.
## 4. Use the integration's API tool step (advanced)
In addition to the pre-built actions available in the tool directory, you can build custom tools that perform Confluence-specific activities using the Confluence API Call tool step:
1. Create a new tool in Relevance AI.
2. Scroll down to Tool-steps.
3. Add the Confluence API tool-step.
4. Select your connected Confluence account in the dropdown.
5. Configure the API endpoint, method, and parameters according to your needs.
This advanced approach gives you full access to the Confluence REST API, allowing you to implement custom functionality beyond what's available in the standard actions.
### Example: Custom API call to retrieve page restrictions
```json
{
"method": "GET",
"endpoint": "/wiki/rest/api/content/{pageId}/restriction",
"parameters": {
"pageId": "{{page_id}}"
}
}
```
## Related Features
* Knowledge Integration - Use Confluence as a knowledge source for your agents, enabling them to access and reference your team's documentation when responding to queries.
* Slack Integration - Combine Confluence and Slack integrations to create powerful workflows where agents can update documentation and notify team members about changes.
* Document Processing - Leverage document processing tools alongside Confluence integration to extract, analyze, and organize information from various sources into your knowledge base.
## FAQs
**Q: What permissions does the Confluence integration require?**\
A: The integration requires permissions to read and write content, access spaces, and manage page properties in your Confluence workspace. You can review the specific permissions during the authentication process.
**Q: Can I restrict my agent to only access certain spaces in Confluence?**\
A: Yes, you can configure your tools and triggers to only interact with specific spaces by setting the appropriate filters and parameters.
# Google Sheets
Source: https://relevanceai.com/docs/integrations/popular-integrations/google-sheets
Connect to Google Sheets from Relevance AI.
## Overview
The Google Sheets integration allows you to connect your Relevance AI agents with Google Sheets, enabling powerful data workflows between your spreadsheets and AI agents. This integration empowers you to automate data extraction, analysis, and manipulation tasks directly from your Google Sheets documents, as well as use spreadsheet data to trigger agent workflows.
## Connecting the Google Sheets Integration
To connect the Google Sheets integration with Relevance AI:
1. Click on "Integrations" in the left sidebar
2. Find and select "Google Sheets" from the available integrations
3. Click "Connect"
4. You'll be redirected to Google's authentication page
5. Grant Relevance AI permission to access your Google Sheets
6. Once authenticated, you'll be redirected back to Relevance AI with the integration now connected
## Setting Up Triggers with Google Sheets *(coming soon)*
The Google Sheets integration can be configured to trigger your AI agents based on specific spreadsheet events or conditions:
### Trigger Types
* **New Row Added**: Activate your agent when a new row is added to a specified sheet
* **Cell Value Changed**: Trigger your agent when values in specific cells or columns are modified
* **Threshold Reached**: Start your agent when a numeric value in your sheet crosses a defined threshold
* **Scheduled Updates**: Configure your agent to process sheet data at regular intervals
### Setting Up a Trigger
1. Navigate to your agent's profile
2. Select "Google Sheets" from the trigger options
3. Choose the specific Google Sheet you want to monitor
4. Select the trigger type (e.g., New Row Added)
5. Configure any additional parameters specific to your chosen trigger
6. Save your trigger configuration
Your agent will now automatically activate when the specified condition is met in your Google Sheets document.
## Tools & Tool Steps
The Google Sheets integration provides a variety of powerful actions that your agents can perform. These actions can be incorporated into your agent's workflow as tool steps, allowing for seamless interaction with your spreadsheet data.
### Available Actions
* **Read Sheet Data**: Extract data from specific sheets, ranges, or cells
* **Write to Sheet**: Add or update data in your spreadsheets
* **Create New Sheet**: Generate new spreadsheets with specified data
* **Format Cells**: Apply formatting to cells based on conditions or data analysis
* **Create Charts**: Generate visual representations of your data
* **Apply Formulas**: Insert Google Sheets formulas based on AI analysis
* **Filter Data**: Extract specific information based on custom criteria
* **Sort Data**: Organize spreadsheet information in meaningful ways
* **Append Rows**: Add new rows of data to existing sheets
* **Delete Data**: Remove specific cells, rows, or columns
These actions represent just a small sample of what's possible with the Google Sheets integration. The tool library contains many more specialized actions to help you build powerful data workflows.
### Using Google Sheets Actions in Your Workflow
1. In your agent's workflow, add a new tool step
2. Search for "Google Sheets" in the tool library
3. Browse the available actions and select the one you need
4. Configure the action parameters (sheet ID, range, data to write, etc.)
5. Connect this action to other steps in your workflow
## Using the Google Sheets API Tool Step (Advanced)
For advanced users who need custom functionality beyond the pre-built actions, you can leverage the Google Sheets API directly:
1. Create a new tool in your agent's workflow
2. Scroll down to Tool-steps
3. Add "Google Sheets API" tool-step
4. Select your connected Google Sheets account from the dropdown
5. Specify the API endpoint and parameters for your custom request
6. Configure how the response data should be processed
This approach gives you full access to the Google Sheets API capabilities, allowing for highly customized interactions with your spreadsheet data.
## Use Cases
### Data Analysis and Reporting
* Extract data from multiple sheets for comprehensive analysis
* Generate automated reports based on spreadsheet data
* Create visualizations and summaries of key metrics
### Data Collection and Management
* Automatically organize and categorize incoming data
* Clean and standardize information across multiple sheets
* Maintain data integrity through automated validation
### Workflow Automation
* Trigger notifications when important spreadsheet values change
* Automatically update related systems when data is modified
* Create approval workflows based on spreadsheet entries
### Customer and Lead Management
* Track customer interactions in spreadsheets and trigger follow-ups
* Analyze lead data to prioritize high-value prospects
* Generate personalized communications based on spreadsheet data
## Best Practices
* **Use Descriptive Names**: When setting up Google Sheets actions, use clear names that describe what the action does
* **Handle Errors Gracefully**: Configure error handling for cases where sheets might be unavailable or data formats unexpected
* **Limit Data Access**: Only request access to the specific sheets and data ranges your agent needs
* **Test Thoroughly**: Before deploying in production, test your Google Sheets integration with sample data
* **Monitor Usage**: Keep track of API usage to stay within Google's rate limits
## Related Features
[Data Visualization Tools](https://relevanceai.com/docs/features/data-visualization) - Combine Google Sheets data with powerful visualization capabilities to create compelling visual representations of your insights.
[Workflow Automation](https://relevanceai.com/docs/features/workflow-automation) - Learn how to build complex workflows that incorporate Google Sheets data alongside other integrations.
[Data Processing](https://relevanceai.com/docs/features/data-processing) - Discover techniques for cleaning, transforming, and analyzing data from Google Sheets within your AI workflows.
# Notion
Source: https://relevanceai.com/docs/integrations/popular-integrations/notion
Seamlessly connect your AI agents with Notion workspaces to automate document creation, information retrieval, and workspace management.
## Connecting the Integration
To connect the Notion integration with Relevance AI:
1. Navigate to the Integrations section in your Relevance AI dashboard
2. Select "Notion" from the available integrations
3. Click "Connect"
4. You'll be redirected to Notion to authorize the connection
5. Select the Notion workspace you want to connect
6. Review the permissions requested and click "Allow access"
7. You'll be redirected back to Relevance AI with the integration now connected
Once connected, your Notion workspace will be available for your agents to access through various tools and actions.
## Notion API Authentication
To use Notion tools with your agent, you'll need to:
1. Create a Notion integration at [https://www.notion.so/my-integrations](https://www.notion.so/my-integrations)
2. Generate an API key for your integration
3. Share specific pages or databases with your integration
4. Provide the API key when configuring Notion tools in Relevance AI
### Creating a Notion Integration
1. Go to [https://www.notion.so/my-integrations](https://www.notion.so/my-integrations)
2. Click "New integration"
3. Enter a name for your integration (e.g., "Relevance AI Assistant")
4. Select the workspace where you want to use the integration
5. Upload an icon (optional)
6. Configure the capabilities your integration needs:
* Read content: Required for retrieving information from Notion
* Update content: Required for modifying existing pages
* Insert content: Required for creating new pages or database entries
7. Click "Submit" to create your integration
### Generating and Managing API Keys
After creating your integration:
1. Navigate to the "Secrets" tab in your integration settings
2. You'll see your "Internal Integration Token" (API key)
3. Copy this token to use with Relevance AI tools
4. For security, you can regenerate this token at any time if needed
### Sharing Pages with Your Integration
For your integration to access specific Notion content:
1. Open the Notion page or database you want to share
2. Click the "..." menu in the top-right corner
3. Select "Add connections"
4. Find and select your integration from the list
5. Click "Confirm" to grant access
Remember that you must explicitly share each page or database you want your integration to access. Parent pages do not automatically grant access to child pages.
## Setting Up Triggers
The Notion integration can be configured to trigger your AI agents when specific events occur in your Notion workspace. This allows your agents to respond automatically to changes in your documentation.
To set up a Notion trigger *(coming soon)*:
1. Navigate to your "agent's profile" page
2. Under "Triggers", select "Notion"
3. Choose the trigger type:
* New Page Created
* Page Updated
* Database Entry Added
* Comment Added
* Mention in Page
4. Configure the specific conditions for the trigger (e.g., which database to monitor)
5. Save your trigger configuration
With triggers configured, your agent will automatically activate when the specified events occur in your Notion workspace, allowing for real-time responses to documentation changes.
## Tools & Tool Steps
The Notion integration provides a rich set of tools and actions that your agents can use to interact with your Notion workspace. These actions can be incorporated into your agent's workflows to automate various documentation tasks.
### Available Notion Actions
Your agents can leverage these powerful Notion actions:
* **Create Notion Page**: Generate new pages with formatted content, including headings, lists, tables, and more
* **Update Notion Page**: Modify existing page content while preserving structure
* **Get Notion Page Content**: Retrieve and analyze the content of specific pages
* **Create Database Entry**: Add new items to Notion databases with structured properties
* **Query Database**: Search and filter database entries based on specific criteria
* **Get Database Structure**: Retrieve the schema of a database to understand its properties
* **Add Comments**: Post comments on pages for collaborative feedback
* **Create To-Do Items**: Generate actionable tasks within Notion pages
* **Get User Details**: Retrieve information about Notion workspace members
* **Search Notion**: Find relevant content across your entire workspace
And many more! These actions can be combined in powerful ways to create sophisticated documentation workflows.
### Example Use Cases
Here are some examples of how your agents can use Notion actions:
* **Meeting Documentation**: Automatically create meeting notes in Notion after calendar events
* **Knowledge Base Management**: Update documentation when new information becomes available
* **Project Tracking**: Create and update project status pages based on progress
* **Content Creation**: Generate draft documents for review based on specific requirements
* **Research Compilation**: Gather information from various sources and organize it in Notion pages
## Using the Notion API Tool Step (Advanced)
For advanced users who need more customized functionality, the Notion API tool step provides direct access to the Notion API. This allows you to build custom tools that perform specialized Notion operations beyond the standard actions.
To use the Notion API tool step:
1. Create a new tool in Relevance AI
2. Scroll down to Tool-steps
3. Add "Notion API" tool-step
4. Select your connected Notion account in the dropdown
5. Configure the API endpoint, method, and parameters
6. Test your custom API call
7. Save your tool configuration
The Notion API tool step gives you the flexibility to create highly customized Notion interactions tailored to your specific needs.
## Best Practices
To get the most out of the Notion integration:
* **Structure Your Workspace**: Organize your Notion workspace with clear hierarchies to make it easier for agents to navigate
* **Use Templates**: Create templates for common document types to ensure consistency
* **Set Clear Permissions**: Configure appropriate access levels for your agents in Notion
* **Monitor Activity**: Regularly review the actions your agents are taking in your Notion workspace
* **Start Simple**: Begin with basic documentation tasks before implementing more complex workflows
* **Secure Your API Keys**: Store your Notion API keys securely and rotate them periodically
* **Test Thoroughly**: Always test your integration in a controlled environment before deploying to production
## Troubleshooting
**Connection Issues**
* Ensure your Notion authorization hasn't expired
* Verify you've granted all necessary permissions
* Check that your Notion workspace is accessible
* Confirm your API key is valid and has not been revoked
**Content Creation Problems**
* Review the formatting in your agent's instructions
* Ensure the agent has access to the parent pages where content is being created
* Check for any API rate limits that might be affecting performance
**Trigger Reliability**
* Verify that your trigger conditions are correctly configured
* Ensure the monitored pages or databases are accessible to the integration
* Check that webhook notifications are enabled in your Notion workspace settings
**API Authentication Errors**
* Verify that your API key is correctly entered in the tool configuration
* Ensure the pages you're trying to access have been shared with your integration
* Check that your integration has the necessary capabilities enabled
For additional assistance, contact Relevance AI support or consult the detailed API documentation.
## Related Features
[Knowledge Integration](https://relevanceai.com/docs/knowledge/create-knowledge) - Connect your Notion workspace as a knowledge source for your agents, allowing them to reference your documentation when responding to queries.
[Document Processing Tools](https://relevanceai.com/docs/tool/templates) - Combine Notion integration with document processing capabilities to extract, analyze, and organize information from various sources.
[Workflow Automation](https://relevanceai.com/docs/agent/customise-agent/flowbuilder) - Create sophisticated workflows that incorporate Notion actions alongside other integrations for end-to-end process automation.
# Slack
Source: https://relevanceai.com/docs/integrations/popular-integrations/slack
Slack Integration allows you to connect your Relevance AI agents with Slack, enabling seamless communication between your AI workforce and your team's Slack workspace.
## Connect the integration
To add Slack as an integration, follow these simple steps:
1. Go to the "Integrations" page in the sidebar of your Relevance AI dashboard.
2. Click on "Slack" from the available integrations.
3. Click on the "Add Integration" button.
4. In the pop-up window, sign into your Slack workspace and authorize Relevance AI to access your Slack account.
5. Select the channels you want to grant access to.
6. Click "Allow" to complete the connection.
Once connected, your Slack integration will be available for use with your agents and tools.
## Setting up triggers
You can configure your agents to be triggered by specific Slack events, allowing them to respond automatically to messages or actions in your Slack workspace.
### Create a Slack trigger for your agent *(coming soon):*
1. Navigate to the "Agents" page and select the agent you want to configure.
2. Click "Edit Agent" and go to the "Triggers" section.
3. Select "Slack" from the list of available triggers.
4. Configure the trigger settings:
* Channel: Select the Slack channel(s) where you want your agent to be active.
* Event Type: Choose what events should trigger your agent (e.g., direct messages, channel messages, mentions, reactions).
* Keywords: Optionally specify keywords that will activate your agent when mentioned in messages.
5. Click "Save" to activate the trigger.
With this setup, your agent will automatically start working whenever the specified Slack events occur, such as when someone mentions your agent in a channel or sends it a direct message.
## Tools & Tool Steps
Slack integration provides a variety of powerful actions that your agents can use to interact with your Slack workspace. These actions can be incorporated into your agent's workflow to automate communication and information sharing.
### Common Slack actions available:
1. Send Message to Channel: Post messages to specific Slack channels.
* Channel: #general
* Message: "The weekly report is now available. You can view it here: \[link]"
2. Send Direct Message: Send private messages to specific Slack users.
* User: @johndoe
* Message: "Your requested analysis is complete. Here are the results..."
3. Create a Thread Reply: Respond to existing messages in a thread.
* Channel: #support
* Thread TS: "1647359102.003200"
* Message: "I've looked into this issue and found a solution..."
4. Upload File: Share files directly to Slack channels.
* Channel: #reports
* File: quarterly\_results.pdf
* Comment: "Here's the quarterly financial report"
5. React to Message: Add emoji reactions to messages.
* Channel: #ideas
* Message TS: "1647359102.003200"
* Reaction: "thumbsup"
6. Create Slack Poll: Generate interactive polls in channels.
* Channel: #team
* Question: "When should we schedule the next team meeting?"
* Options: \["Monday 2pm", "Tuesday 10am", "Wednesday 3pm"]
7. Get Channel History: Retrieve recent messages from a channel.
* Channel: #project-alpha
* Count: 10
8. Search Messages: Find specific messages across channels.
* Query: "budget approval"
These are just a few examples of the many Slack actions available. Your agents can combine these actions with their reasoning capabilities to create sophisticated workflows that enhance team communication and productivity.
## Use the integration's API tool step (advanced)
In addition to the pre-built actions available in the tool directory, you can build custom tools that perform Slack-specific activities using the Slack API Call tool step:
1. Create a new tool in the Tool Builder.
2. Scroll down to Tool-steps.
3. Add "Slack API" tool-step.
4. Select your connected Slack account in the dropdown.
5. Configure the API endpoint and parameters based on your specific needs.
This advanced approach allows you to access the full range of Slack API capabilities, enabling custom integrations tailored to your organization's unique requirements.
### Example: Custom Slack API call to create a channel
```json
{
"method": "POST",
"endpoint": "conversations.create",
"params": {
"name": "project-{{project_name}}",
"is_private": false
}
}
```
### Example: Custom Slack API call to invite users to a channel
```json
{
"method": "POST",
"endpoint": "conversations.invite",
"params": {
"channel": "{{channel_id}}",
"users": "{{user_ids}}"
}
}
```
## Related Features
* Outlook Integration - Combine Slack and Outlook integrations to create comprehensive communication workflows that span both platforms.
* HubSpot Integration - Connect your Slack communications with your CRM data to provide context-aware responses and updates.
* Knowledge Base - Import Slack conversations into your knowledge base to train your agents on your team's communication patterns and frequently discussed topics.
## Remove Slack integration
If you need to remove the Slack integration:
1. Go to the "Integrations" page from the sidebar.
2. Select Slack from the list.
3. Click "..." on the account you want to remove.
4. Click "Remove" and confirm your choice.
This will disconnect your Slack workspace from Relevance AI, and your agents will no longer be able to interact with Slack until you reconnect the integration.
# Zoom
Source: https://relevanceai.com/docs/integrations/popular-integrations/zoom
Adding support for generating Zoom meeting links
Zoom offers the ability to create cloud web meetings.
### How to add integration?
1. Go to the "Integrations" page from the sidebar
2. Select Zoom from the list
3. Click "+ Integration"
4. Complete OAuth flow by logging into Zoom account
### How to use?
Once your account is connected, you can use Zoom steps in the Tool builder. You will have access to a "Zoom API Call" step which you will be able to use to create a meeting, update a meeting, delete a meeting, and more. You can run that step with the required API call for scheduling a meeting.
### How to remove integration?
1. Go to the "Integrations" page from the sidebar
2. Select Zoom from the list
3. Click "..." on the account you want to remove
4. Click remove
# Remove Integrations
Source: https://relevanceai.com/docs/integrations/removing-integrations
Manage your connected services by removing integrations that are no longer needed.
## Overview
While integrations enhance your AI agents' capabilities by connecting them to external services, there may be times when you need to remove these connections. Whether you're switching service providers, or simply cleaning up unused connections, Relevance AI provides a straightforward process for removing integrations.
## How to Remove Integrations
Follow these steps to remove an integration from your Relevance AI account:
1. Navigate to the **Integrations** page from the left-hand menu of your Relevance AI account.
2. Locate the integration you want to remove in your list of connected services.
3. Click on the integration to expand its details.
4. Click the three dots settings button and click the **Remove** button.
Once disconnected, the integration will no longer appear in your list of available connections, and your AI agents will no longer have access to that service.
## Important Considerations
Before removing an integration, consider the following:
### Impact on Agents
* **Check Dependencies**: Verify which agents are currently using the integration before removing it.
* **Update Agent Workflows**: Agents that rely on the removed integration may need reconfiguration to prevent workflow disruptions.
* **Tool Availability**: Tools that depend on the removed integration will no longer function properly.
## Reconnecting Integrations
If you need to reconnect an integration after removing it:
1. Navigate to the **Integrations** page.
2. Browse the available integrations and select the service you want to reconnect.
3. Follow the authentication steps to reauthorize the connection.
4. Once reconnected, the integration will appear in your list of available connections.
## FAQs
**Q: How do I know which agents are using a particular integration?**\
A: Before removing an integration, go to each agent's settings and check the "Connected Resources" or "Tools" section to see which integrations they're using.
# Knowledge
Source: https://relevanceai.com/docs/knowledge/advanced-knowledge-retrieval
Advanced knowledge retrieval
## Better knowledge retrieval
Relevance provides a knowledge search step in our tool builder, but advanced users may want more control over the process to achieve more precise results.
For more advanced knowledge retrieval, you can implement a series of steps in your tool.
* **Query Refinement:** add a LLM step and give it a prompt that asks it to refine a user's free-form query into a more effective search query. This process removes filler words and focuses on the core intent of the question.
* **Vector Search:** Add a knowledge search step where the refined query can be used in a vector search of a knowledge table. Vector search goes beyond simple text matching, looking for semantic similarities. This allows for more flexible and intelligent matching of queries to relevant information.
* **Result Validation and Summarization:** Add a final LLM step to process to validate and summarize the search results. This filters out irrelevant information that might have been returned by the vector search, and synthesizes the relevant information into a coherent answer. You can also provide instructions for handling cases where no relevant information is found.
This advanced technique addresses a key limitation of vector search: while vector search is excellent at finding semantically similar content, it always returns results, even if none are truly relevant. The validation step ensures that the final output is both relevant and accurate.
By implementing this multi-step process, you can create AI tools capable of handling complex queries with high accuracy, even when dealing with ambiguous user inputs or incomplete knowledge bases. This reduces the risk of irrelevant or hallucinated responses.
# Knowledge
Source: https://relevanceai.com/docs/knowledge/create-knowledge
Our Retrieval Augmented Generation (RAG) solution
# Create and Organize Knowledge
Knowledge in Relevance AI serves as the foundation for your AI agents' intelligence, enabling them to access relevant information when responding to queries or performing tasks. This guide will walk you through the process of creating and organizing knowledge in Relevance AI, empowering your agents with the context they need to deliver accurate, helpful responses.
## Understanding Knowledge in Relevance AI
Knowledge in Relevance AI is a powerful Retrieval Augmented Generation (RAG) solution that provides your AI agents with access to specific information beyond their pre-trained knowledge. By creating well-organized knowledge bases, you can:
* Ground your agents' responses in factual information
* Reduce hallucinations and inaccuracies
* Provide domain-specific expertise to your agents
* Keep your agents updated with the latest information
Knowledge in Relevance AI can take many forms - from small snippets of information that guide your agents on what "good" looks like, to comprehensive databases of support FAQs, to connections with external tools and integrations that retrieve information from specific websites or documentation.
## Creating Knowledge Sources
Relevance AI offers multiple flexible approaches to create knowledge, accommodating various information types and sources:
### Manual Input
When you have specific information that isn't contained in existing documents, you can manually create and structure your knowledge:
1. Navigate to the Knowledge section in your Relevance AI dashboard
2. Click "Create Knowledge"
3. Select "Empty Table" as your source
4. Name your knowledge base
5. Add columns to structure your information (e.g., Question, Answer, Category)
6. Enter your information directly into the table
7. Click "Create" to save your knowledge base
This approach gives you complete control over the structure and content of your knowledge base, allowing you to create precisely tailored information resources.
### Upload Documents
When your information already exists in document form, you can quickly import it:
1. Navigate to the Knowledge section
2. Click "Create Knowledge"
3. Select "Upload Files" as your source
4. Choose the file(s) you want to upload (supported formats include CSV, PDF, Excel, JSON, and audio files)
5. Configure parsing options if needed
6. Name your knowledge base
7. Click "Create" to process and import your documents
Relevance AI automatically processes these documents, extracting the relevant information and making it searchable for your agents.
### Extract Website Content
To incorporate information from websites:
1. Navigate to the Knowledge section
2. Click "Create Knowledge"
3. Select "Website" as your source
4. Enter the URL(s) you want to extract content from
5. Configure crawling options (depth, specific pages, etc.)
6. Name your knowledge base
7. Click "Create" to fetch and process the website content
This method is perfect for incorporating information from your company website, documentation sites, or other online resources without manually copying information.
### Connect Third-Party Integrations
To sync data from external platforms:
1. Navigate to the Knowledge section
2. Click "Create Knowledge"
3. Select "Integrations" as your source
4. Choose the integration you want to use
5. Authenticate and configure the connection
6. Select the data you want to import
7. Name your knowledge base
8. Click "Create" to establish the connection and import data
By connecting to third-party platforms, you ensure your agents have access to the most current information across your entire technology stack.
## Organizing Your Knowledge
Effective knowledge organization is crucial for ensuring your agents can quickly find and use the right information. Here are strategies for organizing your knowledge in Relevance AI:
### Structured Tables
For FAQ-style knowledge or structured data:
1. Create clear column headers that describe the information (e.g., "Question," "Answer," "Category")
2. Use consistent formatting within each column
3. Include metadata columns to help with filtering and organization
4. Consider adding tags or categories to group related information
### Document Chunking
When importing documents:
1. Configure appropriate chunking settings to break down large documents into manageable pieces
2. Balance chunk size - too small may lose context, too large may dilute relevance
3. Consider overlapping chunks to maintain context across sections
4. Use metadata to maintain relationships between chunks from the same source
### Knowledge Collections
Group related knowledge bases into collections:
1. Create separate knowledge bases for different domains or purposes
2. Use consistent naming conventions for your knowledge bases
3. Consider the scope of each knowledge base - more focused bases often yield more precise results
4. Document the purpose and contents of each knowledge base for team reference
## Enhancing Knowledge Quality
To maximize the effectiveness of your knowledge bases:
### Metadata Enrichment
Add contextual metadata to your knowledge entries:
1. Include creation and update dates to track freshness
2. Add author information for accountability
3. Tag entries with relevant categories or topics
4. Include confidence scores or verification status where applicable
### Knowledge Verification
Implement processes to ensure accuracy:
1. Regularly review and update your knowledge bases
2. Set up workflows for subject matter experts to verify information
3. Track usage patterns to identify frequently accessed or potentially problematic entries
4. Implement version control for important knowledge bases
### Semantic Organization
Enhance retrievability with semantic approaches:
1. Use consistent terminology throughout your knowledge bases
2. Consider adding synonyms or alternative phrasings for important concepts
3. Structure information in a question-answer format where appropriate
4. Include examples and use cases to illustrate concepts
## Connecting Knowledge to Agents
Once your knowledge is created and organized, connect it to your agents:
1. Navigate to your agent's configuration page
2. Go to the "Connected Resources" section
3. Select "Knowledge"
4. Click "+ Add knowledge"
5. Select the knowledge base(s) you want to connect to your agent
6. Configure retrieval settings (number of results, relevance threshold, etc.)
7. Save your changes
Your agent can now access this knowledge when responding to queries or performing tasks.
## Advanced Knowledge Configuration
Fine-tune how your agents interact with knowledge:
### Retrieval Settings
Adjust how your agent searches for information:
1. Configure the number of results returned for each query
2. Set relevance thresholds to ensure only highly relevant information is used
3. Adjust search algorithms between keyword-based and semantic approaches
4. Configure whether the agent should use knowledge for all queries or only specific types
### Knowledge Prioritization
When using multiple knowledge bases:
1. Set priority levels for different knowledge sources
2. Configure fallback behavior when information isn't found in primary sources
3. Set up rules for resolving conflicts between different knowledge sources
4. Consider creating specialized knowledge bases for specific query types
### Query Transformation
Enhance retrieval effectiveness:
1. Configure query preprocessing to improve match quality
2. Set up query expansion to include related terms
3. Implement query classification to route different types of questions to appropriate knowledge bases
4. Use feedback loops to improve retrieval quality over time
## Best Practices for Knowledge Management
To maintain effective knowledge bases over time:
1. **Regular Updates**: Schedule periodic reviews to keep information current
2. **Version Control**: Track changes to your knowledge bases, especially for critical information
3. **Usage Analytics**: Monitor how your agents use knowledge to identify gaps or improvement opportunities
4. **Feedback Integration**: Create processes to incorporate user feedback into your knowledge bases
5. **Documentation**: Maintain clear documentation about your knowledge structure and organization
6. **Quality Control**: Implement validation processes for new knowledge entries
7. **Scalable Structure**: Design your knowledge organization to accommodate growth
## Related Features
* [Access Knowledge](https://relevanceai.com/docs/knowledge/access-knowledge): Learn how to configure how your agents and tools access and use your knowledge bases.
* [Enrich with Tool](https://relevanceai.com/docs/knowledge/enrich-with-tool): Discover how to enhance your knowledge bases with additional context using tools.
* [Advanced Knowledge Retrieval](https://relevanceai.com/docs/knowledge/advanced-knowledge-retrieval): Explore advanced techniques for optimizing how your agents retrieve and use knowledge.
# Enrich with tool
Source: https://relevanceai.com/docs/knowledge/enrich-with-tool
Enrich your knowledge base with tools
When setting up an enrichment, try it on the first few [rows](/tool/single-run) first to confirm the output
and behavior is as expected. Then apply the analysis to your whole table.
Enriching with tools allows you to update your knowledge base using AI tools.
Select the knowledge table you want to enrich, click on `Enrich with Tool` and choose the tool your want to use from the library.
Configure how the tool should process and add information to your table by mapping outputs to columns, then run the enrichment.
# Find and Use Knowledge
Source: https://relevanceai.com/docs/knowledge/find-and-use-knowledge
Knowledge is the foundation of intelligent AI agents in Relevance AI.
## Understanding Knowledge in Relevance AI
Knowledge in Relevance AI refers to any information that your agents can access and reference when responding to queries or performing tasks. This information can come in various forms:
* **Factual information** stored in knowledge bases
* **Contextual examples** that demonstrate desired outputs
* **External data sources** connected through integrations
* **Website content** extracted from specific URLs
Think of knowledge as the reference material your agents consult before formulating responses. Just as a human expert might refer to documentation, databases, or examples before answering a question, your AI agents can leverage knowledge to ground their responses in factual information.
## Finding Knowledge
There are several ways to find and access knowledge within Relevance AI:
### Navigating to the Knowledge Section
1. Log into your Relevance AI dashboard
2. Click on "Knowledge" in the main navigation menu
3. Browse existing knowledge bases or create new ones
### Searching for Specific Knowledge
Within the Knowledge section, you can:
* Use the search bar to find specific knowledge bases by name or content
* Filter knowledge bases by type, creation date, or other attributes
* Sort knowledge bases to quickly locate what you need
### Exploring Knowledge Categories
Knowledge bases in Relevance AI are typically organized into categories based on their purpose:
* **Reference Knowledge**: Comprehensive information repositories like FAQs, product details, or company policies
* **Example Knowledge**: Samples of desired outputs that demonstrate "what good looks like"
* **Procedural Knowledge**: Step-by-step instructions for completing specific tasks
* **External Knowledge**: Information retrieved from integrated tools and services
## Using Knowledge with Your Agents
Once you've found the knowledge you need, there are several ways to use it with your agents:
### Connecting Knowledge Bases to Agents
1. Navigate to the agent you want to enhance
2. Select "Knowledge" from the agent configuration options
3. Choose the knowledge base(s) you want to connect
4. Configure retrieval settings to determine how the agent accesses the knowledge
### Providing Contextual Examples
For tasks where you want to guide your agent's output style or format:
1. Create a knowledge base with exemplary outputs
2. Connect this knowledge base to your agent
3. Include instructions that direct the agent to follow these examples
For instance, if you want your agent to write case studies in a specific format, provide examples of well-crafted case studies in a knowledge base.
### Leveraging Knowledge in Agent Prompts
When designing agent prompts, you can explicitly instruct the agent to reference specific knowledge:
> Before responding, please check the knowledge base for information about \[specific topic].
This ensures your agent actively seeks relevant information rather than relying solely on its pre-trained knowledge.
## Knowledge Retrieval Methods
Relevance AI offers several methods for retrieving knowledge:
### Semantic Search
Semantic search finds information based on meaning rather than exact keyword matches. This allows agents to retrieve relevant information even when queries use different terminology than what's in the knowledge base.
To optimize for semantic search:
* Structure your knowledge with clear, descriptive content
* Include synonyms and alternative phrasings for important concepts
* Organize related information together for better contextual understanding
### Hybrid Search
Hybrid search combines semantic search with keyword matching for more precise results. This is particularly useful when your knowledge base contains specific terminology or unique identifiers.
### Filtered Retrieval
You can set up filters to narrow down knowledge retrieval based on specific attributes:
1. Navigate to the knowledge base settings
2. Configure retrieval filters based on metadata fields
3. Apply these filters to ensure agents only access relevant information
## Knowledge Types and Their Uses
Different types of knowledge serve different purposes:
### Snippet Knowledge
Small pieces of information that provide specific guidance or examples:
* Use for: Style guides, tone examples, formatting templates
* Best for: Shaping how agents respond rather than what they respond with
* Example: "This is what a professional email response should look like..."
### Database Knowledge
Comprehensive collections of information organized in a structured format:
* Use for: FAQs, product catalogs, support documentation
* Best for: Providing detailed, factual information on a wide range of topics
* Example: A table of product specifications and features
### Integration Knowledge
Information retrieved from external tools and services:
* Use for: Real-time data, website content, third-party databases
* Best for: Ensuring agents have access to the most current information
* Example: Documentation pulled from your company website
## Best Practices for Knowledge Management
To get the most out of knowledge in Relevance AI:
### Organize Knowledge Strategically
* Create separate knowledge bases for different topics or departments
* Use clear, descriptive names for easy identification
* Add metadata to help with filtering and organization
### Update Knowledge Regularly
* Schedule regular reviews of your knowledge bases
* Update information as products, policies, or procedures change
* Remove outdated information to prevent confusion
### Monitor Knowledge Usage
* Review which knowledge bases are being accessed most frequently
* Identify gaps where agents might need additional information
* Refine knowledge based on actual usage patterns
### Balance Comprehensiveness with Relevance
* Include enough detail for accurate responses
* Avoid overwhelming knowledge bases with unnecessary information
* Focus on quality over quantity
## Troubleshooting Knowledge Retrieval
If your agents aren't effectively using knowledge:
### Check Knowledge Connection
Ensure the knowledge base is properly connected to the agent and that retrieval settings are configured correctly.
### Review Knowledge Content
Examine whether the knowledge base contains the information the agent needs in a format it can effectively use.
### Adjust Retrieval Settings
Modify search parameters, result limits, or relevance thresholds to improve retrieval accuracy.
### Test with Sample Queries
Use the testing interface to see how the agent retrieves and uses knowledge for specific questions.
## FAQs
**Q: How much knowledge can I add to my agents?**
A: Relevance AI supports extensive knowledge bases, but for optimal performance, focus on providing relevant, well-structured information rather than simply maximizing volume.
**Q: Can I use multiple knowledge bases with a single agent?**
A: Yes, you can connect multiple knowledge bases to one agent. The agent will search across all connected knowledge bases when responding to queries.
**Q: How do I know if my agent is using the knowledge effectively?**
A: Use the agent testing interface to see which knowledge sources are being retrieved for specific queries. You can also review conversation logs to see how knowledge is being incorporated into responses.
**Q: Can I prioritize certain knowledge over others?**
A: Yes, you can configure retrieval settings to prioritize specific knowledge bases or types of information based on relevance scores or metadata attributes.
**Q: What's the difference between knowledge and tools?**
A: Knowledge provides information for agents to reference, while tools enable agents to perform actions or access external systems. Knowledge informs what agents know, while tools expand what agents can do.
# Use Snippets for Quick Access
Source: https://relevanceai.com/docs/knowledge/use-snippets-for-quick-access
Snippets transform how you manage shared text across your Relevance AI workspace.
## Overview
This powerful feature provides a centralized way to store and reference reusable text variables that can be used throughout your tools and agents. By creating a single source of truth for commonly used text elements, Snippets eliminate redundant updates and streamline your workflow.
Whether you're managing company names, standard greetings, or complex message templates, Snippets make your text management more efficient and consistent across your entire AI ecosystem.
## Key Benefits
Snippets deliver several important advantages that enhance your workflow:
* **Centralized Text Management** – Store common strings (company names, greetings, standard messages) in one accessible location.
* **Universal Availability** – Use snippets anywhere a variable is accepted, including agents and tool inputs.
* **Single-Source Updates** – Edit once and update everywhere, eliminating the need to manually change the same text across multiple tools.
* **Simplified Architecture** – Eliminate 'prop-drilling' by making shared text easily accessible throughout your workspace.
## How It Works
Snippets integrate seamlessly into your existing workflow:
1. **Define a Snippet**: Create a named text variable in the Snippets section.
2. **Reference in Tools and Agents**: Use the `snippets.` prefix followed by your snippet name to reference it anywhere variables are accepted.
3. **Update Centrally**: When you need to change the text, update it once in the Snippets section, and the change propagates everywhere it's used.
For example, you can reference a snippet using this syntax: `{{ snippets.company_name }}`
## Getting Started
Accessing and using Snippets is straightforward:
1. Navigate to the Snippets section in the left sidebar of your Relevance AI workspace
2. Click "Create New Snippet"
3. Provide a descriptive name and the text content for your snippet
4. Save your snippet
5. Reference your snippet in tools and agents using the `{{ snippets.your_snippet_name }}` syntax
## Best Practices
To get the most out of Snippets, consider these recommended practices:
* **Use Descriptive Names**: Choose clear, intuitive names that indicate the snippet's purpose (e.g., `company_name`, `support_email`, `legal_disclaimer`).
* **Categorize Related Snippets**: Use naming conventions to group related snippets (e.g., `email_header`, `email_signature`).
* **Document Usage**: Add comments within your tools and agents to indicate where snippets are being used.
* **Audit Regularly**: Periodically review your snippets to ensure they contain up-to-date information.
* **Consider Scope**: Create snippets for text that appears in multiple places or might need updating across tools.
## Use Cases
Snippets are particularly valuable in these scenarios:
* **Brand Consistency**: Maintain consistent company names, taglines, and messaging across all AI interactions.
* **Contact Information**: Store email addresses, phone numbers, and URLs that might change over time.
* **Standard Messages**: Create reusable templates for common responses, greetings, or disclaimers.
* **Compliance Text**: Manage legal disclaimers, privacy statements, or terms of service that must be consistent.
* **Personalization Elements**: Store reusable personalization templates that can be combined with dynamic data.
## Implementation Examples
### Example 1: Company Information
```
// Define snippets
snippets.company_name = "Acme Corporation"
snippets.support_email = "support@acmecorp.com"
snippets.company_tagline = "Innovating for tomorrow, today."
// Use in agent prompt
"Thank you for contacting {{ snippets.company_name }}.
Our mission is {{ snippets.company_tagline }}
For additional support, please email {{ snippets.support_email }}."
```
### Example 2: Email Templates
```
// Define snippets
snippets.email_greeting = "Hello and thank you for reaching out,"
snippets.email_signature = "Best regards,\\nThe Customer Success Team\\nAcme Corporation"
// Use in email tool
"{{ snippets.email_greeting }}
[Personalized response goes here]
{{ snippets.email_signature }}"
```
## Related Features
[Agent Settings](https://relevanceai.com/docs/agent-settings) - Centralize your agent configurations for easier management, complementing snippets by providing a single source of truth for agent details.
[Tool Version Control](https://relevanceai.com/docs/tool-version-control) - Save and track changes to your tools, working alongside snippets to create more maintainable and professional tool experiences.
## FAQs
**Q: Can snippets contain formatting like bold or italics?**
A: Yes, snippets can contain Markdown formatting that will be rendered appropriately when used.
**Q: Is there a size limit for snippets?**
A: While there's no strict character limit, snippets are designed for reusable text elements rather than entire documents.
**Q: Can I use variables within snippets?**
A: Snippets are primarily for static text, but you can combine them with other variables in your tools and agents.
**Q: How many snippets can I create?**
A: There's no practical limit to the number of snippets you can create in your workspace.
**Q: Can I organize snippets into folders or categories?**
A: Currently, snippets are organized in a flat structure, but you can use naming conventions to create logical groupings.
# Security overview
Source: https://relevanceai.com/docs/security
Relevance AI is SOC 2 Type II compliant and works with trusted vendors.
This page provides a security overview of our product and its key features. We are committed to ensuring the security and privacy of our users' data, and we are proud to be a SOC 2 Type II compliant company.
## SOC2 compliant and multi-region
Relevance AI is compliant with strict enterprise-grade security and governance standards. Relevance AI is SOC 2 type 2 compliant, and we operate in a multi-region environment. As part of SOC 2, only executive management has any kind of visibility into your customer data.
You are free to voluntarily invite our success team to help you check that the messaging is okay and escalations are working okay, with freedom to revoke that access at any time.
### Regions
Relevance AI is available in three regions to cater to users around the world:
* US (N. Virginia)
* EU (London)
* AU (Sydney)
You can choose the region that best suits your needs when setting up your Relevance AI account.
## Self-hosted models that are also multi-region
We don't train any models on your data, ever. Similarly, usually when you access API endpoints for LLMs, the processing agreement states that they don't train on that data. We take it one step further and host our own OpenAI models, and open source ones like LAMA and fireworks that we host within our own AWS and Azure environments which are multi-region as well.
## Key Features
Relevance AI offers three key features: Tools, Agents, and Data. Each feature has its own data retention and storage policies, which we will explain in detail below.
### Tools
Tools in Relevance AI are powerful workflows that allow you to transform and process input data. It's important to note that neither the input nor the output of these tools is logged by Relevance AI. However, some steps within the tools may require the use of external vendors for processing. For example, LLM steps utilize different vendors depending on the specific model being used.
### Agents
Agents in Relevance AI enable conversations and maintain a history of interactions for the benefit of the user. These conversations are private to your project and can be deleted at any time by you. Conversations are stored securely within the same region you have chosen for your Relevance AI account.
### Knowledge
Knowledge is a feature in Relevance AI that allows you to store data in a table, enabling bulk runs of tools on entire datasets. You have full control over your stored data and can delete it at any time. Similar to agents, your data is stored securely within the region you have selected for your Relevance AI account.
### LLM Models
Relevance AI offers a number of LLM models to enhance your AI applications. Our GPT models are hosted on our own Azure OpenAI deployment within the same region you have chosen. It's important to note that no data is stored or trained on in this process.
If you provide an OpenAI API Key, it will be passed through OpenAI's API service. No data is stored or trained on during this process. You can review the Data Processing Agreement (DPA) on our website for more information.
Anthropic models are offered through their API, and once again, no data is stored or trained on during this process. You can review the DPA on our website for further details.
The below table describes the LLM models available in Relevance AI and their respective vendors when no API key is provided.
| LLM Model | Vendor | Data Logged | Used for Training | DPA |
| --------- | --------- | ----------- | ----------------- | --- |
| GPT | Azure | No | No | Yes |
| Claude | Anthropic | No | No | Yes |
## Security Questions
We offer security questionnaire completion for business plans and above.
# Create a tool
Source: https://relevanceai.com/docs/tool/create-a-tool
Create your first tool
## Create a tool
Navigate to **Tools** in the left sidebar and click `Build from scratch`.
Give your tool a name and description, then click on `Edit agent prompt` and provide some information about how an agent should use the tool.
# Inputs
Source: https://relevanceai.com/docs/tool/customize-tool/inputs
Inputs for tools
## Inputs
Inputs are the data that your tool needs to perform its action. They're provided by the user of the tool, be that a human, an agent or another tool.
### Types
An input has a content 'type'. For example you may want an 'age' input to be a number or a 'name' input to be text.
**Text input:** This is a basic text field. Use this for short answers, names, or simple queries. Think of it as a single-line text box.
**Long text input:** Use this for paragraphs, like detailed descriptions or long-form content.
**Options dropdown:** A classic dropdown menu. Great for when you want users to pick from a predefined list of options.
**Numeric input:** For when you need numbers. It might look like a text input, but it'll only accept digits.
**Checkbox:** This is a yes/no, true/false, on/off input. Perfect for simple toggles or confirmations.
**Text list:** This allows users to input multiple text items, usually one per line.
**JSON:** This accepts JSON-formatted data, great for structured information.
**List of JSONs:** For when you need multiple JSON objects in a list format.
**File to text:** This takes a file upload and converts its content to text. Handy for processing document contents.
**File to URL:** Upload a file, get a URL. It's like giving your file a web address.
**Multiple files to URLs:** Same as above, but for multiple files. Each file gets its own URL.
**Table:** This input type allows for structured data in rows and columns, like a spreadsheet.
**API key:** A secure way to input API keys.
**Knowledge table:** A way to input or select from predefined knowledge bases.
**OAuth account:** For when you need to connect to other services securely. It handles the 'Allow access' dance with other platforms.
To create an input select an input type. Give your input a name and a description, and variable name.
### Using default values to create constants
In the Relevance Tool Builder, default values allow you to pre-set inputs for your tools, offering a way to establish constants, streamline testing, and improve overall tool efficiency.
**What are default values?**
Default values are predetermined inputs that you can set for any parameter in your tool. When a tool runs, these values will be automatically filled in unless explicitly overridden.
**Key uses of default values**
Establishing constants: Create values that remain consistent across multiple tool runs. This is useful for API keys, base URLs, or any standard parameters your tool frequently uses.
Providing example inputs: Set up realistic sample data for testing purposes. This helps in quickly demonstrating how the tool works without manual input each time.
Setting up frequently used values: Streamline tool usage by pre-filling common inputs. This reduces the chance of user error in repetitive tasks.
**Setting default values**
In the Tool Builder interface, locate the input field you want to set a default for. Enter or select the desired default value, then click set “Set value as default”.
# Outputs
Source: https://relevanceai.com/docs/tool/customize-tool/outputs
Outputs for tools
## Outputs
Outputs are the data that your tool returns. They're the result of your tool's actions.
By default, what you see will be the output of the last step in the tool, however you can also configure this.
A common reason to configure tool outputs is to control your agent's context, as everything your tool outputs will enter the context of your agent - it's a good idea to manually configure tool to only output what matters.
For example, if your tool returns the results of a Google search step, you probably don't want to dilute your agent's context with suggested searches and 'people also ask', so you should probably configure a manual output to return the results output only.
# Steps
Source: https://relevanceai.com/docs/tool/customize-tool/steps
Steps for tools
## Steps
Steps are the individual actions that your tool performs to generate outputs. They're the building blocks of your tool's functionality.
### Adding steps
Click the `Add Step` button to insert a new action in your tool's workflow.
### Naming steps
Give each step a descriptive name for easy reference.
### Referencing steps
Use variables to reference outputs from previous steps in subsequent actions.
### Running steps
Test individual steps to ensure they're working correctly.
### Moving steps up or down
Rearrange the order of steps by moving them within the chain.
### Duplicating steps
Copy existing steps to create similar actions quickly.
# Tool style guide
Source: https://relevanceai.com/docs/tool/customize-tool/tool-style-guide
Make tools perform better with agents
## Tool style guide
**Workflow considerations**
Single responsibility - each tool should perform one task exceptionally well.
**Tool naming conventions**
The names you give your tools are crucial, as they are added to the LLM prompt that powers the agent using your tool. Names significantly impact performance, as agents consider these strongly when deciding how and when to use your tools.
**Best practices**
Use clear, concise and descriptive names.
Focus on the intent of the tool, not its implementation or how it performs its action.
Be specific about the tool's purpose.
Include an action and object, and system if using an integration.
**Good examples**
'Get LinkedIn company posts'
'Summarize Glassdoor interviews'
**Bad examples**
'Search LinkedIn' (too vague)
'LinkedIn scraper' (implementation-focused)
**Tool description guidelines**
Tool descriptions should let users know what a tool will do.
Purpose statement: Clearly describe the tool's objective using active voice. Explain what the tool does, not how it does it. Include the primary use case or purpose of your tool.
**Good examples**
"Get a set of recent LinkedIn posts by a company or person."
"Scrape and summarize company interview reviews from a provided Glassdoor interview review URL."
**Using LLMs to optimize tool names and descriptions**
If you're unsure how to create the optimal name and description for your tool, we recommend that you use ChatGPT-4o to help you write.
Enter what you currently have for a tool name and description and provide some information about the agent that will use your tool.
Example prompt: "You are being provided a tool name and description that might be used by an AI agent to perform research on various prospects.
Tool name: Google search
Description: Search the internet
When given the tool name and description, provide a better name and description that will allow the agent to use this tool correctly. The tool searches Google for given a query.
The tool name needs to be more action based and focused."
**Agent prompt**
The agent prompt for your tool serves as a crucial guide to help AI agents use it effectively, as agents are powered by LLMs.
It is vitally important you include an agent prompt when setting up your tool.
**Best practices for agent prompts**
Explain usage: Clearly outline when and how the agent should use the tool.
Provide context: Include any necessary background information or assumptions the agent might need to make informed decisions.
**Good example of an agent prompt**
Tool name: Get LinkedIn company posts
Tool description: Get a set of recent LinkedIn posts by a company or person.
**Prompt for agent to use:**
"Use this tool when the user requests information about recent LinkedIn activity for a specific company or person. Provide accurate results by ensuring you input a valid LinkedIn profile URL and only return posts from the past three months."
**Variables**
There are three key places you will use variables in Tool Builder:
Inputs
Steps
Referencing outputs
**Naming conventions**
Descriptive and concise: Names should describe the variable's purpose or content. Avoid vague or overly long names.
Use snake\_case: Use a consistent format across all tools (e.g., recent\_posts).
Avoid generic terms: Replace terms like data, info, or results with more specific identifiers.
**Good examples**
company\_name – Identifies the target company for a query.
blog\_post\_titles – A collection of titles extracted from a blog, indicating the specific content being stored.
**Bad examples:**
name – Too vague.
link – Does not specify the type of link.
**Input parameters**
There are three things to consider when creating inputs:
* Input names
* Input descriptions
* Input variables
**Input names**
Use clear, actionable, and descriptive input names. The input name should be self-explanatory, enabling users or agents to understand what the input is for.
**Input descriptions**
When writing input descriptions, make sure they provide clear, concise and actionable guidance for the user or agent. Good input descriptions should reflect:
Context: Explain how the input is relevant to the tool's goal.
Example: "Provide the URL of the blog page to extract content from."
Requirements: Specify what format or type of input is needed.
Example: "Enter a full URL, including https\://, to ensure proper parsing."
Scope: Define the boundaries or constraints for the input.
Example: "Include only URLs from the company’s official domain."
Purpose: Indicate why the input is essential and what it will achieve.
Example: "This helps identify the blog content relevant to your analysis."
**Input variables**
Input variables should be written in snake\_case, matching the input name closely to ensure consistency. The variable name should be:
Descriptive: A clear, concise representation of the input it corresponds to.
Example: If the input name is Company name , the variable would be company\_name.
Readable and Scalable: It should be easy to read, maintain, and scale, especially when you have multiple inputs.
Example
You want to scrape the latest blog post content, titles and publication dates from a tech company’s blog page to track their content strategy trends.
**Tool setup**
Tool name: Scrape website content
Description: Extract website content as markdown including title and publication date given a specific website url.
Input parameters:
Input name: Blog URL
Description: The official blog URL of the company you’re analyzing.
Variable: blog\_url
Input name: Objective of scraping
Description: Extract content, titles and publication dates of all blog posts published in the last six months. Ignore promotional or sponsored articles.
Variable: objective\_of\_scraping
**Steps**
Step names act as function identifiers. You should prioritize clarity and simplicity. Like tool names, include an action and object, and system if using an integration.
**Good examples**
Send email via Gmail
Create new Notion page
**Benefits of standardized step names**
Clarity and readability: Immediately understand the workflow purpose.
Consistency: Create a cohesive experience.
Easy debugging and documentation: Troubleshooting and self-documentation become simpler.
**Step variable naming**
Step variables should be descriptive and use snake\_case.
**Good example:**
Step name: Send email via Gmail
Variable: send\_email
# Introduction to tools
Source: https://relevanceai.com/docs/tool/introduction
Build tools for AI agents
## What are tools?
Tools are how you build integrations, LLM prompt chains or other step by step automations. You can build them in our no code tool builder. You can then share them as a form, run them in bulk on knowledge tables, or give them to your agents to help them complete work.
The possibilities are vast. You can tap into any API, choose from our extensive library of third-party integrations, or even incorporate custom code into your tools.
## Getting started
The Relevance **Tool Builder** consists of three tabs:
1. Use
2. Build
3. Logs
### Use
Use provides you with an interface that allows you to run and test a tool as a shareable app.
### Build
The builder is where you create your tool.
You can define the inputs expected of the tool, for example, a file input and a text input.
Then, select from a library of steps and add them to your tool.
Each step can be ran individually, which is useful for testing and debugging your tool.
### Logs
The Logs tab is where you can view the logs of your tool, which is useful for reviewing executions.
### Share a tool
When building a tool, as the owner of the tool, you have full control over how you want it to be shared with
your colleagues or teammates.
By default, your tool is only accessible by you and your agents. Click on `Share` to:
1. Create a sharable link for your tool.
2. Get an embeddable iframe for your tool.
3. Allow others to clone a copy of your tool.
# Tool Templates
Source: https://relevanceai.com/docs/tool/templates
Ready-to-use tools
## What are tool templates?
Tool templates are pre-built tools made by the Relevance team and our builder community. We encourage you to use these as a starting point when creating agents and equipping them with tools to complete tasks.
## Use a tool template
You can clone a tool template to make a copy of the desired template in your account, where you can modify it to better suit your needs.
Go to **Templates** and select the tool you want to clone.
# Customer support
Source: https://relevanceai.com/docs/use-cases/customer-support
# Enrichment
Source: https://relevanceai.com/docs/use-cases/enrichment
# Lifecycle marketing
Source: https://relevanceai.com/docs/use-cases/lifecycle-marketing
# Prospect research
Source: https://relevanceai.com/docs/use-cases/prospect-research