# 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.
*** ## 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.
*** ## Import a YAML File Importing allows you to load an existing configuration. ### Import YAML 1. Open the **YAML Editor**. 2. Click **Import**.
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.
*** ## Open the AI Editor To open the AI Editor: 1. Click **AI Editor**. Sprinto opens the AI workspace.
*** ## 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.
*** ## 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.
*** ## 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**.
3. Configure entity settings. 4. Click **Add Entity** to save the entity.
*** ## Configure Entity Details Entity creation inside AI Editor follows the same schema rules as the Entities module. ### Entity Fields
SectionDescription
NameEntity type name
DescriptionOptional explanation
Standard FieldsSystem-generated fields
Custom FieldsUser-defined fields
Reference FieldsRelationships between entities
*** ## 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
*** ## Attach Credentials The **Credentials** tab allows credential management. You can: * Attach credentials * Review connected integrations * Update authentication dependencies
*** ## Attach Providers The **Providers** tab allows provider management. You can: * Attach providers * Modify associations * Review linked integrations
*** ## Configure Checks The **Checks** tab allows monitoring rule configuration. Checks can be used to: * Validate ingestion conditions * Trigger evaluation logic * Associate monitoring workflows
*** ## 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.
### Execute Runs the workflow directly. Use **Execute** when validating changes immediately.
*** ## YAML vs AI Editor
FeatureYAML EditorAI Editor
Editing StyleManual configurationConversational editing
Workflow UpdatesDirect YAML modificationPrompt-driven updates
Entity ManagementIndirect through YAMLBuilt-in entity creation
Import/ExportSupportedNot primary workflow
ValidationYAML validationAssisted workflow generation
*** ## 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](https://docs.sprinto.com/ingestion/dashboard-actions/create-and-configure-an-ingestion-plan) * [Manage Plan Execution and Version History](https://docs.sprinto.com/ingestion/dashboard-actions/manage-plan-execution-and-version-history) * [Create and Manage Entity Types](https://docs.sprinto.com/ingestion/dashboard-actions/create-and-manage-entity-types) * [Create and Manage Webhooks](https://docs.sprinto.com/ingestion/dashboard-actions/create-and-manage-webhooks) --- # Agent Instructions: 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/dashboard-actions/build-and-edit-plans-using-yaml-and-ai-editor.md?ask= ``` 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.