Skip to main content

Builder - Flow Designer

Build AI Employee conversation flows in the Flow Designer's three-panel editor.

The Flow Designer is the core editor for building AI Employee conversation flows. It provides a three-panel workspace where you write skill scripts, configure event subscriptions, define states, and publish flows to the runtime.

Note: The Flow Designer is available in organizations on the earlier Projects layout, where a project's detail page has an Agents tab. On the newer layout, a project opens as versions and files instead. See Builder - Projects.

Access the Flow Designer

  1. Open the Builder and go to the Projects page.

  2. Click Manage on a project to open its detail page.

  3. In the Agents tab, expand an agent and click a flow name.

The Flow Designer opens in a three-panel layout.

Layout overview

Panel

Position

Contents

Left panel

Left side

Skills list, Event Subscriptions list, Flow Settings

Center panel

Center

Script Editor (Monaco editor)

Right panel

Right side

Skill Settings (read-only), States, Parameters

All three panels are resizable by dragging the divider between them.

Skills

Skills are the building blocks of a flow. Each skill contains a script that defines how the AI Employee responds to a specific event or conversation step.

Skill fields

Field

Required

Description

Skill Idn

Yes

Unique identifier for the skill.

Skill title

No

Optional display name.

Runner type

Yes

The script language. Options: nsl, guidance.

Model

No

The AI model used by the skill. Defaults to openai/gpt4. Format: provider_idn/model_idn.

Create a skill

  1. In the left panel under Skills, click the + button.

  2. Fill in the skill fields.

  3. Click Create.

The new skill appears in the left panel. Click it to load its script into the center editor.

Edit skill settings

  1. In the right panel under Skill settings, click the edit icon.

  2. Modify the fields and click Update.

Delete a skill

Click the delete icon next to the skill name in the left panel and confirm.

Script Editor

The center panel contains a Monaco code editor. When you select a skill in the left panel, its prompt_script loads in the editor.

The editor language is determined by the skill's runner type:

Runner type

Editor language

nsl

Twig

guidance

Handlebars

Editor features:

  • Word wrap enabled

  • Minimap disabled

  • Changes are tracked locally until you click Save

Events

Events define which external signals trigger a skill. Each event subscription routes an incoming event to a specific skill, either directly or through a state value.

Event fields

Field

Required

Description

Event Idn

Yes

Identifier for the event. Autocomplete populated from the selected integration's outgoing events.

Integration

No

The integration that fires this event. Clearable. A system option is always available.

Connector

No

The connector within the integration. Disabled until an integration is selected.

Skill selector

Yes

How the target skill is determined. Options: skill_idn (direct), skill_idn_from_state (read from a state).

Skill name

Yes (when selector is skill_idn)

The skill to run when the event fires. Searchable dropdown.

State name

Yes (when selector is skill_idn_from_state)

The state whose value contains the target skill idn. Searchable dropdown.

Interrupt mode

Yes

How the event interacts with an in-progress skill. Options: interrupt, queue, cancel.

Event description

No

Optional description text.

For a detailed explanation of interrupt modes, see Event subscription interrupt modes.

Create an event subscription

  1. In the left panel under Event Subscription, click the + button.

  2. Fill in the event fields.

  3. Click Create.

Edit or delete an event

Click the edit or delete icon next to the event name in the left panel.

Flow Settings

Flow Settings define the default configuration for the entire flow.

Flow settings fields

Field

Description

Title

Display name for the flow.

Idn

Unique identifier (read-only in the settings display).

Default model

The default AI model for skills that do not specify their own. Defaults to openai/gpt4.

Runner type

The default runner type for new skills. Options: nsl, guidance.

Description

Optional description of the flow's purpose.

To edit flow settings, click the edit icon in the left panel under Flow settings, make changes, and click Update.

States

States are variables that persist across skill executions within a flow. Use them to store user input, track conversation progress, or pass values between skills.

State fields

Field

Required

Description

State Idn

Yes

Unique identifier for the state.

State title

No

Optional display name.

State scope

No

Determines where the state persists. Options: user, agent, flow.

State default value

No

The initial value when the state is first accessed.

State scopes

Scope

Description

user

Persists per user across sessions.

agent

Persists per agent instance.

flow

Persists within the current flow execution.

States are grouped by scope in the right panel with headings: user states, agent states, flow states.

Create a state

  1. In the right panel under States, click the + button.

  2. Fill in the state fields.

  3. Click Create.

Parameters

Parameters let you pass configurable values into a skill. They appear in the right panel below States. Click the + button to add a parameter, or click an existing parameter to edit or delete it.

Header actions

The Flow Designer header bar contains the following controls:

Control

Description

AKB

Opens the AKB (knowledge base) page for the agent's persona. Disabled if no persona is linked.

Sandbox: On/Off

Toggles the Sandbox chat panel for live testing. See Builder - Sandbox.

Save

Saves all modified skill scripts to the server. Disabled when no unsaved changes exist.

Publish Flow

Saves scripts and publishes the flow as a live deployment.

Save vs. Publish

Save persists your script changes to the server without deploying them. The flow continues to run its previously published version.

Publish Flow first saves all pending script changes, then deploys the flow as the live version (version 1.0, type public). After publishing, the new scripts are active in production.

Important: Always save your scripts before publishing. If you click Publish Flow with unsaved changes, the system saves them automatically as part of the publish process.

Save conflict resolution

When two users edit the same flow simultaneously, a conflict can occur. If the server has a newer version of the flow when you try to save, a conflict dialog appears with two options:

  • Upload and replace the server version with my local copy: Overwrites the server scripts with your local changes.

  • Download the version from the server (my local copy will be deleted): Discards your local changes and loads the latest server version into the editor.

Choose the option that preserves the correct scripts, then continue editing.

Did this answer your question?