Ctrlk
Sprinto DashboardAPI Reference

Build and Edit Workflows Using AI Editor

Learn how to build, modify, and manage ingestion workflows in Sprinto using the AI Editor, including workflow generation, entity creation, parameters, providers, credentials, and checks.

Sprinto’s AI Editor helps you create and modify ingestion workflows using natural language prompts.

Instead of manually configuring every workflow step, you can describe what you want Sprinto to build and review the generated workflow before saving or executing it.

The AI Editor can help you:

  • Create ingestion workflows

  • Modify workflow steps

  • Generate entities

  • Configure checks

  • Add parameters

  • Attach providers and credentials

  • Review execution logic

Most custom ingestion workflows can be built directly using AI Editor.

Before You Begin

Ensure that:

  • An ingestion plan already exists

  • You have access to the Ingestion module

  • Required credentials or integration details are available

Open AI Editor

You can open AI Editor from either:

  • The plan overview page

  • The three-dot menu next to a plan

Open AI Editor from a Plan

  1. Go to Ingestion.

  2. Open the Plans tab.

  3. Locate the required plan.

  4. Click the three-dot menu next to plan and click AI Editor .

The AI workspace opens.

Understand the AI Editor Layout

The AI Editor contains:

  • Conversation workspace

  • Workflow tabs

  • Execution controls

  • Revision history access

The editor allows you to manage workflows without leaving the page.

Use Natural Language Prompts

The conversation panel allows you to describe the workflow you want Sprinto to build.

Example prompts:

The AI Editor uses these prompts to generate or modify workflow configuration.

Review Generated Workflow Steps

The Steps tab displays all workflow steps generated for the ingestion plan.

You can review:

  • Step order

  • Processing flow

  • Conditions

  • Entity mappings

  • Workflow logic

The AI Editor may automatically generate:

  • HTTP requests

  • Transform steps

  • Mapping steps

  • Insert entity steps

  • Processing conditions

Understand Step Information

Each workflow step displays:

  • Step name

  • Step type

  • Dependencies

  • Processing indicators

  • Conditional execution markers

This helps you understand how the workflow processes incoming data.

Modify Workflow Logic

You can continue refining the workflow using additional prompts.

Examples include:

The AI Editor updates the workflow automatically.

Review YAML Configuration

The YAML tab displays the underlying workflow configuration.

This helps you:

  • Review generated logic

  • Understand workflow structure

  • Inspect step configuration

The YAML updates automatically when the AI modifies the workflow.

Note

YAML editing is only available for from-scratch plans. Template-based plans support Visual Editor only.

Create and Manage Entities

The Entities tab allows you to create or review entity types used by the workflow.

Entity types define how ingested data is structured inside Sprinto.

Create an Entity Type

To create a new entity type:

  1. Open the Entities tab.

  2. Click Add Entity Type.

  1. Enter the entity details.

  2. Click Add Entity to save the entity type.

Configure Entity Fields

Each entity type can include:

  • Standard fields

  • Custom fields

  • Reference fields

Add Custom Fields

Custom fields allow additional metadata to be stored.

Supported data types include:

  • String

  • Boolean

  • Long

  • Double

  • Timestamp

  • JSON

You can add multiple custom fields.

Allow User Editing

Enable Allow User Editing when users should be able to manually update entity values.

When enabled, you can also define predefined selectable options.

Add Reference Fields

Reference fields create relationships between entities.

Use reference fields when one entity depends on another.

Examples include:

  • Device → User

  • Incident → Asset

  • Resource → Organisation

You can add multiple reference fields.

Manage Parameters

The Parameters tab displays workflow parameters.

Parameters help workflows accept reusable or dynamic input values.

You can use AI prompts to:

  • Add parameters

  • Modify parameter values

  • Update parameter behaviour

Manage Credentials

The Credentials tab allows you to review or attach authentication credentials.

Credentials are required when workflows connect to external systems.

Depending on the integration, credentials may include:

  • API keys

  • Tokens

  • OAuth credentials

  • Secret values

Manage Providers

The Providers tab displays connected integration providers.

Providers represent the external systems associated with the workflow.

You can:

  • Attach/Detach providers

  • Review connected systems

  • Update provider configuration

Configure Checks

The Checks tab allows you to review or create automated checks linked to the ingestion workflow.

Checks help validate:

  • Data quality

  • Security requirements

  • Workflow conditions

  • Monitoring rules

Save or Execute the Workflow

After reviewing the workflow, you can either:

Action
Description

Save

Stores the workflow configuration

Execute

Runs the workflow immediately

Use Execute to validate the workflow after changes are made.

Review Revision History

AI Editor includes access to Revision History.

Revision history helps you:

  • Review previous versions

  • Compare workflow changes

  • Restore earlier configurations

When to Use AI Editor

AI Editor is recommended when:

  • Creating custom workflows

  • Building integrations quickly

  • Modifying ingestion logic

  • Generating entities automatically

  • Reducing manual workflow configuration

For most workflows, AI Editor is the fastest way to build and maintain ingestion logic.

Use Advanced Editors When Needed

If deeper manual configuration is required, you can also use:

  • Visual Editor

  • YAML Editor

These editors are better suited for advanced workflow customisation.

Best Practices

Use the following recommendations when working with AI Editor:

  • Start with simple prompts

  • Review generated workflow steps before execution

  • Validate entity mappings carefully

  • Attach credentials before execution

  • Use Execute to validate changes

  • Review YAML when troubleshooting advanced workflows

  • Save frequently when refining prompts

Related Topics

PreviousGet Started with Ingestion in SprintoNextRun and Debug Ingestion Workflows

Last updated