You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copilot is your in-editor assistant that helps you build and edit workflows. It can:
10
+
Copilot is the AI assistant built into every workflow editor. It is scoped to the workflow you have open — it reads the current structure, makes changes directly, and saves checkpoints so you can revert if needed.
11
11
12
-
-**Explain**: Answer questions about Sim and your current workflow
13
-
-**Guide**: Suggest edits and best practices
14
-
-**Build**: Add blocks, wire connections, and configure settings
15
-
-**Debug**: Analyze execution issues and optimize performance
12
+
For workspace-wide tasks (managing multiple workflows, running research, working with tables, scheduling jobs), use [Mothership](/mothership).
16
13
17
14
<Callouttype="info">
18
-
Copilot is a Sim-managed service. For self-hosted deployments:
19
-
1. Go to [sim.ai](https://sim.ai) → Settings → Copilot and generate a Copilot API key
20
-
2. Set `COPILOT_API_KEY` in your self-hosted environment
15
+
Copilot is a Sim-managed service. For self-hosted deployments, go to [sim.ai](https://sim.ai) → Settings → Copilot, generate a Copilot API key, then set `COPILOT_API_KEY` in your self-hosted environment.
21
16
</Callout>
22
17
23
-
## Modes
24
-
25
-
Switch between modes using the mode selector at the bottom of the input area.
Creates a step-by-step implementation plan for your workflow without making any changes. Helps you think through the approach before building.
62
-
</div>
63
-
</Card>
64
-
</Cards>
65
-
66
-
## Models
67
-
68
-
Select your preferred AI model using the model selector at the bottom right of the input area.
69
-
70
-
**Available Models:**
71
-
- Claude 4.6 Opus (default), 4.5 Opus, Sonnet, Haiku
72
-
- GPT 5.2 Codex, Pro
73
-
- Gemini 3 Pro
74
-
75
-
Choose based on your needs: faster models for simple tasks, more capable models for complex workflows.
76
-
77
-
## Context Menu (@)
78
-
79
-
Use the `@` symbol to reference resources and give Copilot more context:
80
-
81
-
| Reference | Description |
82
-
|-----------|-------------|
83
-
|**Chats**| Previous copilot conversations |
84
-
|**Workflows**| Any workflow in your workspace |
85
-
|**Workflow Blocks**| Blocks in the current workflow |
86
-
|**Blocks**| Block types and templates |
87
-
|**Knowledge**| Uploaded documents and knowledge bases |
88
-
|**Docs**| Sim documentation |
89
-
|**Templates**| Workflow templates |
90
-
|**Logs**| Execution logs and results |
91
-
92
-
Type `@` in the input field to open the context menu, then search or browse to find what you need.
93
-
94
-
## Slash Commands (/)
95
-
96
-
Use slash commands for quick actions:
97
-
98
-
| Command | Description |
99
-
|---------|-------------|
100
-
|`/fast`| Fast mode execution |
101
-
|`/research`| Research and exploration mode |
102
-
|`/actions`| Execute agent actions |
103
-
104
-
**Web Commands:**
105
-
106
-
| Command | Description |
107
-
|---------|-------------|
108
-
|`/search`| Search the web |
109
-
|`/read`| Read a specific URL |
110
-
|`/scrape`| Scrape web page content |
111
-
|`/crawl`| Crawl multiple pages |
112
-
113
-
Type `/` in the input field to see available commands.
114
-
115
-
## Chat Management
116
-
117
-
### Starting a New Chat
118
-
119
-
Click the **+** button in the Copilot header to start a fresh conversation.
120
-
121
-
### Chat History
18
+
{/* TODO: Screenshot of the workflow editor with the Copilot panel open on the right side — showing a conversation with a workflow change applied. Ideally shows a message from the user, a response from Copilot, and the checkpoint icon visible on the message. */}
122
19
123
-
Click **History** to view previous conversations grouped by date. You can:
124
-
- Click a chat to resume it
125
-
- Delete chats you no longer need
20
+
## What Copilot Can Do
126
21
127
-
### Editing Messages
22
+
Copilot can read and modify the workflow you are currently editing:
128
23
129
-
Hover over any of your messages and click **Edit** to modify and resend it. This is useful for refining your prompts.
24
+
- Add, configure, and connect blocks
25
+
- Edit existing block configurations
26
+
- Delete blocks and connections
27
+
- Debug failures by reading execution logs
28
+
- Answer questions about the workflow or how Sim works
130
29
131
-
### Message Queue
30
+
##Chat History
132
31
133
-
If you send a message while Copilot is still responding, it gets queued. You can:
134
-
- View queued messages in the expandable queue panel
135
-
- Send a queued message immediately (aborts current response)
136
-
- Remove messages from the queue
32
+
Click **History** (clock icon) in the Copilot header to see past conversations for this workflow. Click any chat to resume it, or click **+** to start a new one.
137
33
138
34
## File Attachments
139
35
140
-
Click the attachment icon to upload files with your message. Supported file types include:
141
-
- Images (preview thumbnails shown)
142
-
- PDFs
143
-
- Text files, JSON, XML
144
-
- Other document formats
36
+
Click the attachment icon in the input to upload files alongside your message. Copilot can read images, PDFs, and text-based files as context.
145
37
146
-
Files are displayed as clickable thumbnails that open in a new tab.
38
+
## Checkpoints
147
39
148
-
## Checkpoints & Changes
40
+
When Copilot modifies a workflow, it saves a checkpoint of the previous state.
149
41
150
-
When Copilot makes changes to your workflow, it saves checkpoints so you can revert if needed.
42
+
To revert: hover over a Copilot message and click the checkpoints icon, then click **Revert** on the state you want to restore. Reverting cannot be undone.
151
43
152
-
### Viewing Checkpoints
44
+
##Thinking
153
45
154
-
Hover over a Copilot message and click the checkpoints icon to see saved workflow states for that message.
46
+
For complex requests, Copilot may show its reasoning in an expandable thinking block before responding. The block shows how long the thinking took and collapses after the response is complete.
155
47
156
-
### Reverting Changes
48
+
##Usage
157
49
158
-
Click **Revert** on any checkpoint to restore your workflow to that state. A confirmation dialog will warn that this action cannot be undone.
50
+
Copilot usage is billed per token and counts toward your plan's credit usage. If you reach your limit, enable on-demand billing from Settings → Subscription.
159
51
160
-
### Accepting Changes
161
-
162
-
When Copilot proposes changes, you can:
163
-
-**Accept**: Apply the proposed changes (`Mod+Shift+Enter`)
164
-
-**Reject**: Dismiss the changes and keep your current workflow
165
-
166
-
## Thinking Blocks
167
-
168
-
For complex requests, Copilot may show its reasoning process in expandable thinking blocks:
169
-
170
-
- Blocks auto-expand while Copilot is thinking
171
-
- Click to manually expand/collapse
172
-
- Shows duration of the thinking process
173
-
- Helps you understand how Copilot arrived at its solution
174
-
175
-
## Options Selection
176
-
177
-
When Copilot presents multiple options, you can select using:
178
-
179
-
| Control | Action |
180
-
|---------|--------|
181
-
|**1-9**| Select option by number |
182
-
|**Arrow Up/Down**| Navigate between options |
183
-
|**Enter**| Select highlighted option |
184
-
185
-
Selected options are highlighted; unselected options appear struck through.
186
-
187
-
## Keyboard Shortcuts
188
-
189
-
| Shortcut | Action |
190
-
|----------|--------|
191
-
|`@`| Open context menu |
192
-
|`/`| Open slash commands |
193
-
|`Arrow Up/Down`| Navigate menu items |
194
-
|`Enter`| Select menu item |
195
-
|`Esc`| Close menus |
196
-
|`Mod+Shift+Enter`| Accept Copilot changes |
197
-
198
-
## Usage Limits
199
-
200
-
Copilot usage is billed per token from the underlying LLM and counts toward your plan's credit usage. If you reach your usage limit, enable on-demand billing from Settings → Subscription to continue using Copilot beyond your plan's included credits.
201
-
202
-
<Callouttype="info">
203
-
See the [Cost Calculation page](/execution/costs) for billing and plan details.
204
-
</Callout>
205
52
## Copilot MCP
206
53
207
-
You can use Copilot as an MCP server in your favorite editor or AI client. This lets you build, test, deploy, and manage Sim workflows directly from tools like Cursor, Claude Code, Claude Desktop, and VS Code.
54
+
You can use Copilot as an MCP server to build, test, and manage Sim workflows from external editors — Cursor, Claude Code, Claude Desktop, and VS Code.
208
55
209
56
### Generating a Copilot API Key
210
57
211
-
To connect to the Copilot MCP server, you need a **Copilot API key**:
212
-
213
58
1. Go to [sim.ai](https://sim.ai) and sign in
214
59
2. Navigate to **Settings** → **Copilot**
215
60
3. Click **Generate API Key**
216
61
4. Copy the key — it is only shown once
217
62
218
-
The key will look like `sk-sim-copilot-...`. You will use this in the configuration below.
63
+
The key will look like `sk-sim-copilot-...`.
219
64
220
65
### Cursor
221
66
222
-
Add the following to your `.cursor/mcp.json` (project-level) or global Cursor MCP settings:
67
+
Add to `.cursor/mcp.json`:
223
68
224
69
```json
225
70
{
@@ -234,24 +79,18 @@ Add the following to your `.cursor/mcp.json` (project-level) or global Cursor MC
234
79
}
235
80
```
236
81
237
-
Replace `YOUR_COPILOT_API_KEY` with the key you generated above.
238
-
239
82
### Claude Code
240
83
241
-
Run the following command to add the Copilot MCP server:
242
-
243
84
```bash
244
85
claude mcp add sim-copilot \
245
86
--transport http \
246
87
https://www.sim.ai/api/mcp/copilot \
247
88
--header "X-API-Key: YOUR_COPILOT_API_KEY"
248
89
```
249
90
250
-
Replace `YOUR_COPILOT_API_KEY` with your key.
251
-
252
91
### Claude Desktop
253
92
254
-
Claude Desktop requires [`mcp-remote`](https://www.npmjs.com/package/mcp-remote) to connect to HTTP-based MCP servers. Add the following to your Claude Desktop config file (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
93
+
Claude Desktop requires [`mcp-remote`](https://www.npmjs.com/package/mcp-remote). Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
255
94
256
95
```json
257
96
{
@@ -270,11 +109,9 @@ Claude Desktop requires [`mcp-remote`](https://www.npmjs.com/package/mcp-remote)
270
109
}
271
110
```
272
111
273
-
Replace `YOUR_COPILOT_API_KEY` with your key.
274
-
275
112
### VS Code
276
113
277
-
Add the following to your VS Code `settings.json` or workspace`.vscode/settings.json`:
114
+
Add to `settings.json` or `.vscode/settings.json`:
278
115
279
116
```json
280
117
{
@@ -292,21 +129,14 @@ Add the following to your VS Code `settings.json` or workspace `.vscode/settings
292
129
}
293
130
```
294
131
295
-
Replace `YOUR_COPILOT_API_KEY` with your key.
296
-
297
132
<Callouttype="info">
298
133
For self-hosted deployments, replace `https://www.sim.ai` with your self-hosted Sim URL.
299
134
</Callout>
300
135
301
-
import { FAQ } from'@/components/ui/faq'
302
-
303
136
<FAQitems={[
304
-
{ question: "What is the difference between Ask, Build, and Plan mode?", answer: "Copilot has three modes. Ask mode is a read-only Q&A mode for explanations, guidance, and suggestions without making any changes to your workflow. Build mode allows Copilot to actively modify your workflow by adding blocks, wiring connections, editing configurations, and debugging issues. Plan mode creates a step-by-step implementation plan for your request without making any changes, so you can review the approach before committing. Use Ask when you want to learn or explore ideas, Plan when you want to see a proposed approach first, and Build when you want Copilot to make changes directly." },
305
-
{ question: "Does Copilot have access to my full workflow when answering questions?", answer: "Copilot has access to the workflow you are currently editing as context. You can also use the @ context menu to reference other workflows, previous chats, execution logs, knowledge bases, documentation, and templates to give Copilot additional context for your request." },
306
-
{ question: "How do I use Copilot from an external editor like Cursor or VS Code?", answer: "You can use Copilot as an MCP server from external editors. First, generate a Copilot API key from Settings > Copilot on sim.ai. Then add the MCP server configuration to your editor using the endpoint https://www.sim.ai/api/mcp/copilot with your API key in the X-API-Key header. Configuration examples are available for Cursor, Claude Code, Claude Desktop, and VS Code." },
307
-
{ question: "Can I revert changes that Copilot made to my workflow?", answer: "Yes. When Copilot makes changes in Build mode, it saves checkpoints of your workflow state. You can hover over a Copilot message and click the checkpoints icon to see saved states, then click Revert on any checkpoint to restore your workflow. Note that reverting cannot be undone, so review the checkpoint before confirming." },
308
-
{ question: "How does Copilot billing work?", answer: "Copilot usage is billed per token from the underlying LLM and counts toward your plan's credit usage. More capable models like Claude Opus cost more per token than lighter models like Haiku. If you reach your usage limit, you can enable on-demand billing from Settings > Subscription to continue using Copilot." },
309
-
{ question: "What do the slash commands like /research and /search do?", answer: "Slash commands trigger specialized behaviors. /fast enables fast mode execution, /research activates a research and exploration mode, and /actions executes agent actions. Web commands like /search, /read, /scrape, and /crawl let Copilot interact with the web to search for information, read URLs, scrape page content, or crawl multiple pages to gather context for your request." },
310
-
{ question: "How do I set up Copilot for a self-hosted deployment?", answer: "For self-hosted deployments, go to sim.ai > Settings > Copilot and generate a Copilot API key. Then set the COPILOT_API_KEY environment variable in your self-hosted environment. Copilot is a Sim-managed service, so the self-hosted instance communicates with Sim's servers to process requests." },
137
+
{ question: "How is Copilot different from Mothership?", answer: "Copilot is scoped to the workflow you have open — it reads and edits that workflow's blocks and connections. Mothership has access to your entire workspace and can build workflows, manage tables, run research, schedule jobs, and take actions across integrations." },
138
+
{ question: "Can Copilot access other workflows or workspace data?", answer: "Copilot is scoped to the current workflow. For tasks that span multiple workflows or require workspace-level context, use Mothership." },
139
+
{ question: "Can I revert changes Copilot made?", answer: "Yes. Copilot saves a checkpoint before each change. Hover over the message and click the checkpoints icon to see saved states, then click Revert to restore one. Reverting cannot be undone." },
140
+
{ question: "How does Copilot billing work?", answer: "Copilot usage is billed per token and counts toward your plan's credit usage. If you reach your limit, enable on-demand billing from Settings → Subscription." },
141
+
{ question: "How do I set up Copilot for a self-hosted deployment?", answer: "Go to sim.ai → Settings → Copilot and generate a Copilot API key. Set the COPILOT_API_KEY environment variable in your self-hosted environment. Copilot runs on Sim's infrastructure regardless of where you host the application." },
0 commit comments