mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-09 06:58:07 -05:00
67 lines
3.2 KiB
Plaintext
67 lines
3.2 KiB
Plaintext
---
|
|
title: Getting Started
|
|
description: Build, test, and optimize your agentic workflows
|
|
---
|
|
|
|
import { Card, Cards } from 'fumadocs-ui/components/card'
|
|
import { Steps, Step } from 'fumadocs-ui/components/steps'
|
|
import { Callout } from 'fumadocs-ui/components/callout'
|
|
import { Files, Folder, File } from 'fumadocs-ui/components/files'
|
|
import { Tabs, Tab } from 'fumadocs-ui/components/tabs'
|
|
import { AgentIcon, ApiIcon, ConditionalIcon, CodeIcon, ChartBarIcon, ConnectIcon, GmailIcon, PerplexityIcon, NotionIcon, ExaAIIcon, FirecrawlIcon, SlackIcon } from '@/components/icons'
|
|
|
|
Sim Studio is a powerful, user-friendly platform for building, testing, and optimizing your agentic workflows. This documentation will help you understand how to use the various components of Sim Studio to create sophisticated agent-based applications.
|
|
|
|
<Callout type="info">
|
|
This guide will walk you through the essential concepts and help you get started building your first workflow.
|
|
</Callout>
|
|
|
|
## Core Components
|
|
|
|
Sim Studio is built around two primary components:
|
|
|
|
### Blocks
|
|
|
|
Blocks are the fundamental building elements of your workflows. Each block serves a specific purpose:
|
|
|
|
<Files>
|
|
<File name="Agent Block" icon={<AgentIcon className="w-4 h-4" />} annotation="Create AI agents using any LLM provider" />
|
|
<File name="API Block" icon={<ApiIcon className="w-4 h-4" />} annotation="Connect to external services and APIs" />
|
|
<File name="Condition Block" icon={<ConditionalIcon className="w-4 h-4" />} annotation="Add conditional branching to your workflows" />
|
|
<File name="Function Block" icon={<CodeIcon className="w-4 h-4" />} annotation="Execute custom JavaScript/TypeScript code" />
|
|
<File name="Evaluator Block" icon={<ChartBarIcon className="w-4 h-4" />} annotation="Assess responses against defined criteria" />
|
|
<File name="Router Block" icon={<ConnectIcon className="w-4 h-4" />} annotation="Direct workflow execution based on input analysis" />
|
|
</Files>
|
|
|
|
### Tools
|
|
|
|
Tools extend the capabilities of agents. They provide additional functionality for agents by enabling you to interface with your favorite data sources and take action (e.g posting on X, sending an email)
|
|
|
|
<Files>
|
|
<File name="Gmail Tool" icon={<GmailIcon className="w-4 h-4" />} />
|
|
<File name="Firecrawl Tool" icon={<FirecrawlIcon className="w-4 h-4" />} />
|
|
<File name="Perplexity Tool" icon={<PerplexityIcon className="w-4 h-4" />} />
|
|
<File name="Notion Tool" icon={<NotionIcon className="w-4 h-4" />} />
|
|
<File name="Exa AI Tool" icon={<ExaAIIcon className="w-4 h-4" />} />
|
|
<File name="Slack Tool" icon={<SlackIcon className="w-4 h-4" />} />
|
|
</Files>
|
|
|
|
## Getting Started
|
|
|
|
<Steps>
|
|
<Step title="Create a new workflow">
|
|
Start by creating a new workflow in the Sim Studio dashboard.
|
|
</Step>
|
|
<Step title="Add your first block">
|
|
Drag and drop a block from the sidebar onto the canvas.
|
|
</Step>
|
|
<Step title="Configure the block">
|
|
Set up the block's parameters and inputs according to your needs.
|
|
</Step>
|
|
<Step title="Connect blocks">
|
|
Create connections between blocks to define the flow of data and execution.
|
|
</Step>
|
|
<Step title="Test your workflow">
|
|
Run your workflow with test inputs to verify its behavior.
|
|
</Step>
|
|
</Steps> |