Skip to main content

Quickstart Guide

This quickstart walks you through building your first working agent in SmythOS. You’ll use the Lead Enrichment Agent template, which gathers public data to enrich lead profiles with actionable insights.

Step 1: Remix a Template

  1. From the Studio, open the Templates section in the top navigation.
  2. Switch to the Sales tab.
  3. Find the Lead Enrichment Agent and click Remix.
Navigate to Templates in SmythOS
Remix the Lead Enrichment Agent

Step 2: Run the Agent with Form Preview

Next, test your agent by providing some input. SmythOS offers several options such as Chat, API, LLM, and MCp. For this guide, we’ll use Form Preview, which lets you enter required fields and run the workflow.

You can open Form Preview in two ways:

Option A: From the top toolbar

  1. Click Test in the top-right toolbar.
  2. Switch to the Form Preview tab.
  3. Enter sample details.
  4. Click Run to execute the workflow.

Option B: From the canvas

  1. Click the Form Preview button on the block you want to test.
Open Form Preview from the canvas
  1. Provide inputs. Provide inputs. You can either enter your own details or use this sample to quickly run the agent:
Sample Lead Enrichment Input
Full name: Aria Smyth Email: [email protected] Company name: SmythOS
Fill in inputs and run the form
  1. Click Run and the agent will return a structured lead profile.
Form Preview showing output
No API Keys Yet?

If your agent includes an API Call component, you can enable Mock Mode to test it with sample data before adding real keys.
This is useful for experimenting without setting up integrations right away.

Step 3: Deploy Your Agent

Once your agent runs successfully, you can deploy it from Studio.

Once your agent runs as expected, deploy it:

  1. Click Deploy in the workspace header.
  2. Choose your environment: Agent Cloud, Enterprise, or Local Runtime.
  3. Use Agent Logs to monitor execution history and debug if needed.

If you want to make your agent accessible under a branded domain, see the Subdomains guide.

What’s Next

You now have a working agent. From here, you can explore the rest of the SmythOS platform:

  • Use Weaver for building agents conversationally from prompts.
  • Switch to Studio Canvas for visual editing and advanced workflows.
  • Learn about the Runtime to see how agents run in production.
  • Review Deployments to publish your agent to users securely.
Need more help?
Have a question or need assistance? Join the SmythOS Discord or reach out via email at [email protected]. We're here to help.