> For the complete documentation index, see [llms.txt](https://docs.sprinto.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinto.com/ingestion/get-started-with-ingestion-in-sprinto/build-and-edit-workflows-using-ai-editor.md).

# Build and Edit Workflows Using AI Editor

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** .

<figure><img src="/files/zh1oit27piEx7qmsZoYS" alt="" width="563"><figcaption></figcaption></figure>

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:

```
Create a workflow that syncs employee records from our HR system every 6 hours.
```

```
Add a webhook workflow that processes security alerts from our monitoring platform.
```

```
Create entities for failed login attempts and add checks for repeated failures.
```

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

<figure><img src="/files/FDKoyBFfVRvKjiFBu07j" alt="" width="563"><figcaption></figcaption></figure>

***

## 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:

```
Filter inactive users before inserting entities.
```

```
Add a step that enriches records with organisation metadata.
```

```
Create additional checks for failed MFA validation.
```

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.

<figure><img src="/files/DCj3rLAF7ycF6nf8NYes" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="info" %}

#### Note

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

***

## 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**.

<figure><img src="/files/ZTgQHX2Ste5F6oqJ382F" alt="" width="563"><figcaption></figcaption></figure>

3. Enter the entity details.
4. Click Add Entity to save the entity type.

<figure><img src="/files/zoM01uXn689ZBsSiyzPa" alt="" width="318"><figcaption></figcaption></figure>

***

## 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

<figure><img src="/files/T3LC6JsaVjTC4OZpVASu" alt="" width="563"><figcaption></figcaption></figure>

***

## 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

<figure><img src="/files/nWra8W8xf3bIv8hSPCaC" alt="" width="563"><figcaption></figcaption></figure>

***

## 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

<figure><img src="/files/ggET323UMG1nCEsQ8kvd" alt="" width="563"><figcaption></figcaption></figure>

***

## 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

<figure><img src="/files/I9MvSDCWAEFrmjAoQLRB" alt="" width="563"><figcaption></figcaption></figure>

***

## Save or Execute the Workflow

After reviewing the workflow, you can either:

<table><thead><tr><th width="121.01171875">Action</th><th width="297.6484375">Description</th></tr></thead><tbody><tr><td>Save</td><td>Stores the workflow configuration</td></tr><tr><td>Execute</td><td>Runs the workflow immediately</td></tr></tbody></table>

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

<figure><img src="/files/frQNKfcM2YQQv1fUKPjx" alt="" width="563"><figcaption></figcaption></figure>

***

## 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

* [Get Started with Ingestion in Sprinto](/ingestion/get-started-with-ingestion-in-sprinto.md)
* [Run and Debug Ingestion Workflows](/ingestion/get-started-with-ingestion-in-sprinto/run-and-debug-ingestion-workflows.md)
* [Review Ingested Data and Entity Records](/ingestion/get-started-with-ingestion-in-sprinto/review-ingested-data-and-entity-records.md)
* [Create and Manage Webhooks](/ingestion/get-started-with-ingestion-in-sprinto/create-and-manage-webhooks.md)
* [Edit Workflows Using YAML Editor](/ingestion/get-started-with-ingestion-in-sprinto/edit-workflows-using-yaml-editor.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sprinto.com/ingestion/get-started-with-ingestion-in-sprinto/build-and-edit-workflows-using-ai-editor.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.