Getting Started

Quick Start

Get up and running with ConvoFlow in minutes.

This guide will walk you through creating your first chatbot workflow in ConvoFlow.

Prerequisites

Make sure you have ConvoFlow installed and running. If not, follow the Installation Guide first.

Step 1: Create a New Workflow

  1. Open ConvoFlow in your browser (typically http://localhost:3000)
  2. Click the "New Workflow" button or start with an empty canvas
  3. You'll see the workflow builder interface with a node sidebar

Step 2: Add Nodes

Every workflow needs at least two nodes:

  • QueryNode: Entry point for user input (required)
  • ResponseNode: Exit point that returns the final response (required)

Tip: Click the "+" button or open the node sidebar to see all available nodes.

Adding a QueryNode

  1. Click "Add Node" or open the node sidebar
  2. Find "QueryNode" in the "I/O" category
  3. Click on it to add it to the canvas
  4. Click on the node to configure it - set a default query like "Hello!"

Adding a Language Model Node

  1. Add a "LanguageModelNode" from the "AI & Language Models" category
  2. Configure it:
    • Select a service (OpenAI, Groq, etc.)
    • Choose a model
    • Optionally set a system prompt

Adding a ResponseNode

  1. Add a "ResponseNode" from the "I/O" category
  2. This node will output the final response

Step 3: Connect Nodes

Connect nodes to create a flow:

  1. Hover over the QueryNode - you'll see output handles
  2. Click and drag from the "query" output to the LanguageModelNode's "query" input
  3. Connect the LanguageModelNode's "response" output to the ResponseNode's "response" input

Your workflow should look like this:

Basic workflow with sidebar showing node connections

Step 4: Configure API Keys

If you're using AI services, make sure to configure API keys. Here's the credentials page where you can manage all your API keys:

Credentials page for configuring API keys
  1. Go to Settings (usually in the top navigation)
  2. Navigate to "Credentials" or "API Keys"
  3. Add your API keys (OpenAI, Groq, etc.)
  4. Save the configuration

Note: You can also set API keys via environment variables in your .env file.

Step 5: Execute the Workflow

  1. Click the "Execute" or "Run" button in the workflow builder
  2. Watch as nodes execute in order (you'll see visual indicators)
  3. Check the ResponseNode to see the final output

Step 6: Save Your Workflow

Save your workflow for later use:

  1. Click "Save Workflow" or use the save icon
  2. Give your workflow a name and description
  3. Your workflow is now saved and can be loaded later

Next Steps

Now that you've created your first workflow, explore more advanced features:

Congratulations! 🎉

You've successfully created your first ConvoFlow workflow! Explore the documentation to learn about more advanced features and customization options.

Was this page helpful?