Workflow Tool

Unlike most tools, the call is synchronous: the agent pauses until the workflow finishes running and gets its result back before continuing. This makes it a good fit for multi-step logic (like enrichment, validation, or aggregation across several APIs) that you’d rather maintain once as a workflow than duplicate inside an agent’s instructions.

What is a Workflow Tool?

A Workflow Tool lets you:

✅ Call another workflow from within an agent
✅ Pass custom input to the workflow
✅ Wait for the workflow to complete and get results
✅ Chain multiple workflows together
✅ Reuse workflow logic across agents

Agent Process:

Agent receives request
Calls Workflow Tool
Workflow executes (multiple steps)
Returns result to agent
Agent continues

Use Cases

Lead Processing Workflow

An agent receives a new sales lead and needs to process it:

Agent calls “Lead Processing” workflow
Workflow validates lead data
Enriches lead with additional info
Creates ticket in CRM
Returns processed lead data to agent

Document Processing

An agent receives a document for analysis:

Agent calls “Document Processing” workflow
Workflow extracts text from document
Classifies document type
Stores in database
Returns classification results

Multi-Provider API Integration

An agent needs data from multiple APIs:

Agent calls “Data Aggregation” workflow
Workflow calls API 1 for customer data
Workflow calls API 2 for order history
Workflow calls API 3 for preferences
Returns aggregated data to agent

Configuration

Adding a Workflow Tool to an Agent

Go to Agent Settings

Open the agent where you want to use the Workflow Tool

Open Tools Tab

Navigate to the Tools configuration section

Add New Tool

Click “Add Tool” and select “Workflow”

Configure Tool

Give the tool a descriptive name
Add a description for the agent
No additional parameters needed

Save

The Workflow Tool is now available to the agent

Tool Configuration Options

Name: Process Customer Lead
Description: Trigger the lead processing workflow

Note: Workflow selection happens at invocation time,
not during tool configuration. The agent dynamically
specifies which workflow to call.

How to Use

In Agent Chat

When the agent needs to run a workflow, it will:

Identify the need for a workflow
Call the Workflow Tool with:
- Workflow name or ID
- Input parameters
Receive the workflow result
Continue with its response

Example Agent Prompt:

You are a lead processing agent. When you receive a new lead:
Use the Workflow Tool to call the "Process Lead" workflow
Pass the lead information as input
Review the result and inform the user

Workflow Input Format

The agent can pass data to the workflow:

{
  "workflow_name": "process-customer-lead",
  "input": {
    "customer_name": "John Doe",
    "email": "john@example.com",
    "phone": "+1-555-0100",
    "company": "Acme Corp"
  }
}

Workflow Response

The workflow returns results that the agent can use:

{
  "status": "success",
  "lead_id": "lead_12345",
  "score": 8.5,
  "category": "hot",
  "processed_at": "2024-09-08T14:30:00Z",
  "next_action": "contact_sales"
}

Workflow Tool vs Agent Tool

Aspect	Workflow Tool	Agent Tool
Purpose	Run multi-step workflows	Invoke another agent
Response	Workflow final result	Agent structured output
Use Case	Complex processes	Agent collaboration
Execution	Workflow engine	Agent inference
Steps	Multiple nodes	Single invocation

Best Practices

Clear Naming

Use descriptive workflow names so agents can identify the right one

Input Validation

Design workflows to validate input before processing

Error Handling

Handle workflow failures gracefully in your agent prompt

Monitor Usage

Track workflow executions in project analytics

Example: Agent Calling Workflow

Agent: Customer Support Bot
Tools: Workflow Tool, Email Tool

Scenario: Customer requests account upgrade

1. Agent receives: "I want to upgrade my plan"
2. Agent calls: Workflow Tool
   - Workflow: "Upgrade Account"
   - Input: { user_id, new_plan, email }
3. Workflow executes:
   - Validate account status
   - Check payment method
   - Process upgrade
   - Send confirmation email
4. Workflow returns: { status: "success", upgrade_id }
5. Agent responds: "Your upgrade is complete!"

Troubleshooting

Workflow not found

Symptoms: Workflow Tool can’t locate the workflowSolutions:

Verify workflow name is spelled correctly
Ensure workflow is in the same project
Check workflow is published/active
Review agent prompt for workflow reference

Workflow fails during execution

Symptoms: Workflow starts but encounters an errorSolutions:

Check workflow input matches expected schema
Review workflow logs for specific errors
Verify all workflow dependencies are available
Test workflow directly before adding to agent

Timeout waiting for workflow

Symptoms: Workflow takes too long to completeSolutions:

Check workflow step performance
Optimize slow steps or API calls
Increase timeout if appropriate
Consider breaking workflow into smaller steps

Agent doesn't call workflow

Symptoms: Agent has tool but doesn’t use itSolutions:

Review agent prompt - it should mention when to use workflow
Check if input clearly triggers workflow usage
Add examples to agent prompt
Test with explicit instruction to use workflow

Advanced Usage

Conditional Workflow Execution

Agent Prompt Example:

"You are an order processing agent.

When a customer wants to:
- Check order status: Use "Check Order" workflow
- Cancel order: Use "Cancel Order" workflow (requires confirmation)
- Modify order: Use "Modify Order" workflow
- Track shipment: Use "Track Shipment" workflow

Always provide clear feedback after workflow execution."

Chaining Multiple Workflows

Process:
Agent calls Workflow A (data validation)
If result is valid, agent calls Workflow B (processing)
If processing succeeds, agent calls Workflow C (notification)
Agent reports final status to user

Using Workflow Results in Agent Logic

Agent Prompt:

"After calling a workflow, analyze the result:
- If status is 'success', proceed with next step
- If status is 'error', explain the error to user
- If status is 'pending', inform user and check back later
- Always pass relevant results to subsequent workflows"

Next Steps

Workflows Documentation - Understand workflow design
Agent Tools - Learn about agent-to-agent communication
Agent Configuration - Add tools to agents
Create Your First Agent - Get started with agents

Getting Started

Concepts

Agents

Tools

Datasources

Workflows

Jobs

Triggers

Monitor

What is a Workflow Tool?

Use Cases

Lead Processing Workflow

Document Processing

Multi-Provider API Integration

Configuration

Adding a Workflow Tool to an Agent

Tool Configuration Options

How to Use

In Agent Chat

Workflow Input Format

Workflow Response

Workflow Tool vs Agent Tool

Best Practices

Clear Naming

Input Validation

Error Handling

Monitor Usage

Example: Agent Calling Workflow

Troubleshooting

Advanced Usage

Conditional Workflow Execution

Chaining Multiple Workflows

Using Workflow Results in Agent Logic

Next Steps

​What is a Workflow Tool?

​Use Cases

​Lead Processing Workflow

​Document Processing

​Multi-Provider API Integration

​Configuration

​Adding a Workflow Tool to an Agent

​Tool Configuration Options

​How to Use

​In Agent Chat

​Workflow Input Format

​Workflow Response

​Workflow Tool vs Agent Tool

​Best Practices

Clear Naming

Input Validation

Error Handling

Monitor Usage

​Example: Agent Calling Workflow

​Troubleshooting

​Advanced Usage

​Conditional Workflow Execution

​Chaining Multiple Workflows

​Using Workflow Results in Agent Logic

​Next Steps

What is a Workflow Tool?

Use Cases

Lead Processing Workflow

Document Processing

Multi-Provider API Integration

Configuration

Adding a Workflow Tool to an Agent

Tool Configuration Options

How to Use

In Agent Chat

Workflow Input Format

Workflow Response

Workflow Tool vs Agent Tool

Best Practices

Example: Agent Calling Workflow

Troubleshooting

Advanced Usage

Conditional Workflow Execution

Chaining Multiple Workflows

Using Workflow Results in Agent Logic

Next Steps