For the complete documentation index, see llms.txt. This page is also available as Markdown.

Flow inputs, outputs, and variables

Define the data a flow accepts, returns, and shares across tasks.

Flow I/O defines a flow's contract. Variables supply shared values and protect credentials used during a run.

Define inputs and outputs

Open Flow I/O to configure the schemas: the request parameters and the expected response format.

The Flow I/O dialog on the Input Schema tab, with Basic and Advanced modes, a Key, Type, Description and Required table with an Add button, and Save
Flow I/O, on the Input Schema tab.
Schema
Defines
Example

Input Schema

Values supplied when the flow starts.

documentId, text, required.

Output Schema

Values returned when the flow completes.

extracted_data, object, required.

Choose an editing mode:

Basic

Add fields in a table. Set Key, Type, Description, and Required.

Supported types: Text, Number, Boolean, Object, Array, and Dropdown.

Advanced

Edit the schema as JSON Schema. Use this mode when you need direct schema control.

Select Save after editing. Input fields also appear on the Global Variables tab as read-only entries.

Use variables

Variables declared in a flow are available to all tasks. Open them with Variables on the builder's rail.

Type
Use for
Reference

Secrets

API keys, tokens, and other credentials.

$secret.{variable_name}

Global Variables

Values shared across tasks, such as a document ID.

$global.{variable_name}

Add a secret

  1. Select Add Secret.

  2. Enter a required Name and Value.

  3. Choose String or JSON for Type.

  4. Select Secured when appropriate, then select Save.

Add a global variable

  1. Select Add Variable.

  2. Enter a required Key.

  3. Choose a type and add a description.

  4. Select Required when the flow cannot run without it.

  5. Select Save.

Task configuration can map a global variable to an input. It can also map a task output to an output variable.


Maintained by Abhishek Paul AI-assisted, human-approved

Last updated

Was this helpful?