Skip to content

Working with Workflows

This guide explains how to create, configure, and execute workflows in Raikoo. Workflows are the primary way you'll orchestrate AI tasks and automate processes on the platform.

Understanding Workflows

A workflow in Raikoo is a structured sequence of operations designed to accomplish a specific task or process. Workflows enable you to:

  • Combine multiple AI and programmatic operations
  • Define dependencies between operations
  • Process and transform data through multiple steps
  • Maintain context across the entire process

Each workflow operates within a dedicated workspace, which serves as a virtual file system for storing inputs, outputs, and intermediate results.

Creating a New Workflow

To create a new workflow:

  1. Navigate to your project in the Raikoo dashboard
  2. Click on "Workflow Builder" in the main navigation
  3. Click the "New Workflow" button
  4. Enter a name and optional description for your workflow
  5. Click "Create" to open the workflow builder canvas

The Workflow Builder Interface

The Workflow Builder provides a visual interface for designing workflows:

  • Canvas - The central area where you design your workflow by adding and connecting operations
  • Operations Panel - A sidebar listing available operations that can be dragged onto the canvas
  • Properties Panel - Shows configuration options for the currently selected operation
  • Toolbar - Contains actions like save, run, and undo/redo
  • Minimap - Provides a zoomed-out view of your workflow for easier navigation

Adding Operations to a Workflow

To add operations to your workflow:

  1. Browse or search for the desired operation in the Operations Panel
  2. Drag the operation onto the canvas
  3. Position it in the appropriate location in your workflow

Configuring Operations

Each operation has its own set of configuration options. To configure an operation:

  1. Click on the operation in the canvas to select it
  2. Use the Properties Panel to set parameters such as:
  3. Input/Request - The data or prompt for the operation
  4. Output - Where to store the operation's results
  5. Persona - The AI persona to use (for AI-based operations)
  6. Parameters - Additional settings specific to the operation type

Creating Dependencies Between Operations

Dependencies define the execution order of operations in your workflow:

  1. Hover over an operation to see its connection points
  2. Click and drag from an output connection point to an input connection point of another operation
  3. Release to create the dependency

You can also: - Select an operation and use the Properties Panel to explicitly set dependencies - Use the "Auto-arrange" feature to organize operations based on their dependencies

Using Workflow Parameters

Workflow parameters allow you to create reusable workflows with configurable inputs:

  1. Click on the workflow canvas background to select the workflow itself
  2. In the Properties Panel, navigate to the "Parameters" section
  3. Add parameters with:
    • Name - A unique identifier for the parameter
    • Type - The data type (string, number, boolean, etc.)
    • Default Value - An optional default if no value is provided
    • Description - Helpful context for users of the workflow

To use a parameter within an operation, reference it with {{ThreadParameters.ParameterName}} syntax in applicable fields.

Saving and Versioning Workflows

Raikoo provides versioning capabilities for your workflows:

  1. Click the "Save" button in the toolbar to save your current work
  2. Add a descriptive comment about the changes you've made
  3. Use the version history dropdown to:
    • View previous versions
    • Compare changes between versions
    • Restore earlier versions if needed

Executing Workflows

To run a workflow:

  1. Click the "Execute" button in the Workflow Builder toolbar, or
  2. Navigate to the "Execute Workflow" section from the main navigation
  3. Select the workflow you want to run
  4. Provide values for any workflow parameters
  5. Click "Run" to start execution

During execution, you can: - Monitor progress in real-time - View logs and outputs from individual operations - Access the workspace to see generated files and data

Handling Errors and Debugging

When workflows encounter issues:

  1. Review the error message and logs for the failed operation
  2. Check input data and configuration settings
  3. Use the workspace inspector to examine intermediate results
  4. Adjust operation settings or add error handling operations
  5. Re-run the workflow to test your fixes

Sharing and Collaborating on Workflows

Workflows can be shared with team members:

  1. From the Workflow Builder, click the "Share" button
  2. Select the appropriate permission level for collaborators
  3. Add team members or generate a shareable link
  4. Optionally, add comments or instructions for collaborators

Best Practices for Workflow Design

For efficient and maintainable workflows:

  • Start simple - Begin with core functionality before adding complexity
  • Use clear naming - Give operations descriptive names that indicate their purpose
  • Group related operations - Use folders or visual grouping for better organization
  • Build incrementally - Test each section of your workflow before expanding
  • Document your design - Add comments and descriptions to operations and the workflow itself
  • Reuse common patterns - Create reusable sub-workflows for frequently used sequences
  • Plan for failures - Add error handling operations for critical points in your workflow
  • Optimize performance - Use parallel execution where appropriate
  • Monitor resource usage - Be aware of execution time and storage requirements

Next Steps