---
title: "Getting Started with the Build Agent"
slug: "getting-started-with-the-build-agent"
tags: ["build-agent", "unqorkai"]
status: "update"
updated: 2026-11-03T17:34:18Z
published: 2026-11-03T17:34:18Z
canonical: "docs.unqork.io/getting-started-with-the-build-agent"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started with the Build Agent

The Build Agent is the UnqorkAI platform's AI assistant for building Unqork modules. You describe what you want in plain language, and the agent creates a plan for your review. Once approved, the agent builds the components, generates tests, and shows you the result.

This guide walks you through your first interaction with the Build Agent.

## Before You Begin

The Build Agent is available to Creators with access to the Module Builder. If you do not see the **Build Agent** panel in your UnqorkAI platform, contact your environment administrator.

## Step 1: Open the Build Agent

1. Open any module in the Module Builder.
2. Locate the **Build Agent** panel in the left panel.
3. Click the tab to open the agent.

## Step 2: Send Your First Prompt

A clear, specific prompt produces the best results. Try the following:

> Create a contact form with fields for first name, last name, and email address. Set all fields as required. Add a Submit button that collects the form data.

The agent analyzes your request and creates a plan before building anything. The plan opens in the canvas area and includes the following:

- **Analysis**: A summary of the current module state and what the agent intends to build.
- **Detailed Component Specifications**: The components the agent plans to create, including types, Property IDs, and validation rules.
- **Tests**: Test cases the agent will run to verify the form works correctly.
- **Execution Plan**: The steps the agent will follow to build the module.

## Step 3: Review and Approve the Plan

After generating the plan, the agent asks for your approval before proceeding.

Review the plan in the canvas area. To leave feedback, highlight any text in the plan and add a comment. When the plan looks correct, click **Build Plan** to proceed. If you want changes before building, click **Request Changes**. The agent revises the plan based on your comments.

> [!NOTE]
> The chat input is not available during plan review. All feedback goes through inline plan comments before clicking **Request Changes**.

## Step 4: Review the Results

Once the agent finishes building, it runs the test cases from the plan automatically. It then displays a summary of what it built and a **Task Plan completed** message. Review the summary to confirm the components and logic match what you requested.

If anything looks incorrect, refine your prompt and send another message to continue.

## Step 5: Preview the Result

Preview the module to confirm it behaves as expected. Two options are available:

- **UI View**: Displays the module rendered live in the canvas.
- **Play button**: Opens the module in Express in a new browser tab. For modules inside an application, the menu offers **View in App** or **View Module Only**.

## Step 6: Continue Building

Once the agent finishes, you have the following options:

- **Continue Building**: Send another prompt in the **Build Agent** panel.
- **Start a New Task**: Select the ![icon](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/api_upload_20261021_145011_1cd6dab74263433ab8c521a67dde6a29.svg?sv=2026-02-06&spr=https&st=2026-11-04T08%3A55%3A17Z&se=2026-11-04T09%3A55%3A17Z&sr=c&sp=r&sig=K0%2BlOHtgp6Xa56ixO1mDALyegrfeHL%2FoSWQy64gydws%3D) **New Task** button at the top of the **Build Agent** panel.
- **Rollback**: Click **Rollback** at any checkpoint in the **Build Agent** panel to revert all changes the agent made after that point.

---

**Changelog**

| Date | Change |
| --- | --- |
| 2026-10-20 | Corrected the New Task step in Continue Building. |
| 2026-09-12 | Plan review: add inline comments + Request Changes flow; fix completion message to "Task Plan completed"; remove incorrect auto-save step; Preview Mode → UI View; fix Rollback scope; remove unverified capability claims. |
| — | Initial publication. |

Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

The Unqork front-end application framework that delivers Creator-built applications to end-users. Express is the layer end-users interact with—the published forms, screens, and navigation built in the Module Builder. Express is distinct from Express View, which is a Creator-facing preview tool in the IDE.