Source: https://atomic-works-test.docs-staging.pageloop.ai/ingestion/dashboard-actions/build-and-edit-plans-using-yaml-and-ai-editor

# Build And Edit Plans Using Yaml And Ai Editor

---
description: >-
  Learn how to build and edit ingestion plans in Sprinto using the YAML editor
  and AI Editor, including importing YAML, editing workflows, managing entities,
  and saving plan changes.
---

# Build and Edit Plans Using YAML and AI Editor

Sprinto provides two advanced editing methods for ingestion plans:

* **YAML Editor** for direct configuration editing
* **AI Editor** for conversational workflow creation and modification

Both editors allow you to configure ingestion logic beyond the standard visual editor.

Use these editors when you need:

* Greater control over workflow configuration
* Faster editing of complex workflows
* Direct YAML-based modifications
* AI-assisted workflow creation
* Entity and step management in a single workspace

These editors are accessible from the plan overview page.

***

## Before You Begin

Ensure that:

* A plan already exists
* You have access to edit ingestion plans
* Required credentials and providers are available
* Entities are understood before modifying workflow mappings

***

## Open YAML or AI Editor

To access advanced editors:

1. Log in to the Sprinto dashboard.
2. Go to **Ingestion**.
3. Open the **Plans** tab.
4. Click **View** to select a plan.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 16.38.55.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Use the YAML Editor

The YAML editor allows you to directly edit ingestion workflow configuration.

YAML provides a structured representation of the plan.

1. Click Edit Plan.
2. Open the **YAML Editor** tab.

You can use YAML to:

* Edit steps
* Configure processing logic
* Update mappings
* Modify workflow structure
* Import reusable configurations

{% hint style="warning" %}
#### Important

YAML Editor is locked for template-based plans. To edit YAML directly, create a from-scratch plan or duplicate the template into a custom plan before making changes.
{% endhint %}

***

## YAML Editor Layout

The YAML editor includes:

* YAML editing workspace
* Validation feedback
* Import option
* Copy option
* Download option
* Save Changes button

***

## Edit YAML Configuration

The YAML workspace displays the full ingestion configuration.

You can directly modify:

* Plan metadata
* Parameters
* Providers
* Credentials
* Workflow steps
* Output definitions

Changes are validated before saving.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 16.44.36.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Import a YAML File

Importing allows you to load an existing configuration.

### Import YAML

1. Open the **YAML Editor**.
2. Click **Import**.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 16.47.37.png" alt="" width="563"><figcaption></figcaption></figure>

3. Select a YAML file.
4. Review the imported configuration.
5. Save changes.

Imported YAML replaces the current editor contents.

***

## Copy YAML

You can copy YAML directly from the editor.

### Copy YAML Configuration

1. Open the **YAML Editor**.
2. Click **Copy**.

The YAML content is copied to the clipboard.

***

## Download YAML

Downloading allows you to export the workflow configuration.

### Download YAML

1. Open the **YAML Editor**.
2. Click **Download**.

Sprinto downloads the YAML file locally.

Downloaded YAML can be used for:

* Backups
* Migration
* Version comparison
* External editing

***

## YAML Validation

Sprinto validates YAML configuration before saving.

Validation may identify:

* Missing required steps
* Invalid configuration
* Formatting issues
* Schema mismatches

Errors appear inline within the editor.

You must resolve validation issues before saving.

***

## Save YAML Changes

After editing:

1. Review the configuration.
2. Click **Save Changes**.

Sprinto validates and stores the updated plan.

***

## Use the AI Editor

The AI Editor provides a conversational interface for editing ingestion plans.

You can describe workflow changes using natural language.

The AI Editor helps with:

* Creating ingestion logic
* Modifying workflow behaviour
* Managing entities
* Adding providers and credentials
* Editing YAML-backed configuration
* Generating processing logic

To access the AI Editor:

1. Log in to the Sprinto dashboard.
2. Go to **Ingestion**.
3. Open the **Plans** tab.
4. Click **View** to select a plan.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 16.38.55.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Open the AI Editor

To open the AI Editor:

1. Click **AI Editor**.

Sprinto opens the AI workspace.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 16.53.20.png" alt="" width="563"><figcaption></figcaption></figure>

***

## AI Editor Layout

The AI Editor contains:

* Conversation panel
* Workflow editing tabs
* Entity management tools
* YAML reference view
* Save and Execute actions

The editor allows configuration without leaving the workspace.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 16.59.57.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Use Conversational Editing

The conversation panel allows you to describe required changes.

Examples include:

* Add a new workflow step
* Update entity mapping
* Attach a provider
* Create a field
* Adjust processing logic

The AI uses your prompts to generate workflow updates.

***

## Manage Workflow Steps in AI Editor

The **Steps** tab displays configured workflow steps.

You can:

* Review step configuration
* Add steps
* Modify execution logic
* Update processing order

Workflow changes become part of the plan once saved.

***

## View YAML in AI Editor

The YAML tab allows you to inspect the underlying configuration.

This helps you:

* Understand generated logic
* Compare workflow output
* Validate YAML-backed configuration

Changes made in the AI Editor update the YAML configuration automatically.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.00.48.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Create or Manage Entity Types

The AI Editor includes entity management.

You can create and modify entities without leaving the editor.

### Add an Entity Type

1. Open the **Entities** tab.
2. Click **Add Entity Type**.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.01.14.png" alt="" width="563"><figcaption></figcaption></figure>

3. Configure entity settings.
4. Click **Add Entity** to save the entity.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.02.23.png" alt="" width="317"><figcaption></figcaption></figure>

***

## Configure Entity Details

Entity creation inside AI Editor follows the same schema rules as the Entities module.

### Entity Fields

<table><thead><tr><th width="167.8515625">Section</th><th width="269.875">Description</th></tr></thead><tbody><tr><td>Name</td><td>Entity type name</td></tr><tr><td>Description</td><td>Optional explanation</td></tr><tr><td>Standard Fields</td><td>System-generated fields</td></tr><tr><td>Custom Fields</td><td>User-defined fields</td></tr><tr><td>Reference Fields</td><td>Relationships between entities</td></tr></tbody></table>

***

## Add Custom Fields

Custom fields extend entity schemas.

When creating a custom field, configure:

* Field name
* Data type
* Description
* Allow user editing

Supported data types include:

* String
* Boolean
* Long
* Double
* Timestamp
* JSON

You can add multiple custom fields.

***

## Allow User Editing

When enabled, users can manually update field values.

Additional predefined options may also be configured.

***

## Add Reference Fields

Reference fields create relationships between entities.

When configuring a reference field, define:

* Field name
* Reference type
* Target entity
* Target field
* Description

You can add multiple reference fields.

***

## Manage Parameters

The **Parameters** tab allows parameter management.

You can:

* Add parameters
* Modify parameter types
* Update defaults
* Configure required values

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.03.56.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Attach Credentials

The **Credentials** tab allows credential management.

You can:

* Attach credentials
* Review connected integrations
* Update authentication dependencies

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.04.13.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Attach Providers

The **Providers** tab allows provider management.

You can:

* Attach providers
* Modify associations
* Review linked integrations

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.04.37.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Configure Checks

The **Checks** tab allows monitoring rule configuration.

Checks can be used to:

* Validate ingestion conditions
* Trigger evaluation logic
* Associate monitoring workflows

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.05.04.png" alt="" width="563"><figcaption></figcaption></figure>

***

## Save or Execute Changes

After making changes in AI Editor, you can either:

### Save

Stores the updated workflow configuration.

Use **Save** when you want to retain edits without immediately running the workflow.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.05.29.png" alt="" width="563"><figcaption></figcaption></figure>

### Execute

Runs the workflow directly.

Use **Execute** when validating changes immediately.

<figure><img src="../../.gitbook/assets/Screenshot 2026-04-24 at 17.06.15.png" alt="" width="563"><figcaption></figcaption></figure>

***

## YAML vs AI Editor

<table><thead><tr><th width="191.42578125">Feature</th><th width="235.30078125">YAML Editor</th><th width="268.19921875">AI Editor</th></tr></thead><tbody><tr><td>Editing Style</td><td>Manual configuration</td><td>Conversational editing</td></tr><tr><td>Workflow Updates</td><td>Direct YAML modification</td><td>Prompt-driven updates</td></tr><tr><td>Entity Management</td><td>Indirect through YAML</td><td>Built-in entity creation</td></tr><tr><td>Import/Export</td><td>Supported</td><td>Not primary workflow</td></tr><tr><td>Validation</td><td>YAML validation</td><td>Assisted workflow generation</td></tr></tbody></table>

***

## Best Practices

Use the following recommendations when working with advanced editors:

* Use YAML Editor for direct control
* Use AI Editor for faster workflow iteration
* Validate YAML after importing
* Save frequently during editing
* Review generated entities before saving
* Confirm provider and credential mappings
* Use Execute for rapid validation
* Review YAML output after AI modifications

***

### Related Information

* [Create and Configure an Ingestion Plan](create-and-configure-an-ingestion-plan.md)
* [Manage Plan Execution and Version History](manage-plan-execution-and-version-history.md)
* [Create and Manage Entity Types](create-and-manage-entity-types.md)
* [Create and Manage Webhooks](create-and-manage-webhooks.md)
