Components manual

This guide explains how to configure and implement components using the Arkus platform.

Configuring components

After adding a component to a flow, you can configure its parameters and connect it to other components to define data flow and execution logic. Each component includes inputs, outputs, parameters, and controls specific to its purpose.

Component settings

To access a component’s settings, click the component in your workspace.

In the component’s header menu, you will find:

Component header menu

  • Code: Defines the core logic of the component. This section contains the Python code that runs when the component is executed, including how inputs are processed and how outputs are generated. Changes made here directly affect the component’s behavior.
  • Controls: Defines the configurable parameters of the component. Controls are the fields exposed to the user—such as text inputs, dropdowns, toggles, or sliders—that allow customization without modifying the underlying code.
  • Tool Mode: Determines whether the component can be used as a callable tool by an agent or LLM. When enabled, the component exposes its inputs and outputs in a structured format so the agent can invoke it during execution.
  • Additional actions: Delete, Duplicate, Copy, or Minimize are available when clicking the “…” icon in the component header.

In the component’s side or footer menu, you will find:

Component footer menu

  • Response: Defines how the component’s output is returned and formatted. This setting controls what data is exposed to downstream components or to the user, ensuring the response is clear, structured, and usable within the flow.
  • Inputs: Specifies the data the component expects to receive from previous components. Inputs define the type, structure, and naming of incoming values used during execution.
  • Outputs: Defines the data produced by the component after execution. Outputs can be connected to other components in the flow and are essential for chaining logic across nodes.

Component connections

Components are connected by linking the output of one component to the input of another, defining how data flows through the flow. To create a connection, click and drag from an output port of a component to a compatible input port on another component.

Connecting components

To remove a connection, click the connection line to select it, then press the Delete key on your keyboard.

List of components

Every component in the platform does one job and connects to others to build a flow. The list below links to each one with a short description.