Skip to content

Commit 2d45595

Browse files
committed
docs: every model-searchable page states the current surface
The copilot answers users from these pages (docs search), so a wrong sentence becomes a wrong instruction. Audit fixes: - chat: uploads live under uploads/, not the Files panel; on-demand workspace reach instead of a per-message snapshot; Chat runs Opus 4.8; connectors and deletes/restores as they actually behave; login pages via the shared browser - cli: --select-output works on sync runs (only --async conflicts); runs get takes the same block selectors; secrets set needs --scope; workflows run runs the deployment or --manual; sim profiles honours --output; which groups have no singular alias; the embedded CLI has no profile, login, or config; @path reads the chat sandbox - model defaults are claude-sonnet-5 (guardrails has none); API examples use https://www.sim.ai/api/v2 (apex 301s POSTs into GETs) - quick reference / shortcuts: only affordances that exist (no Deploy tab, no workspace duplicate/export, Mod+B not Mod+E, variables under the ⋯ menu, <variable.name> syntax) - editor read-only rules match round-trip-safety.ts; card links fixed - sim-cli: runs-get selector error and the Settings label match the product; batch delete describes its ids as deleted, not updated; docs/api regenerated
1 parent a1f30da commit 2d45595

37 files changed

Lines changed: 114 additions & 106 deletions

apps/docs/content/docs/agents/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The example throughout is an agent that scores inbound sales leads.
1717

1818
## The Agent block
1919

20-
You set up the reasoning step by giving the Agent block a **model** and a **prompt**. The model is the LLM that powers it; you pick one from the available providers, and the default is `claude-sonnet-4-6`. The prompt is a system message that defines who the agent is and how it should behave, plus a user message that carries the input, usually a reference like `<start.input>`.
20+
You set up the reasoning step by giving the Agent block a **model** and a **prompt**. The model is the LLM that powers it; you pick one from the available providers, and the default is `claude-sonnet-5`. The prompt is a system message that defines who the agent is and how it should behave, plus a user message that carries the input, usually a reference like `<start.input>`.
2121

2222
When it runs, the Agent block reasons, calls any tools it needs, and stores its result under its own name. By default that result is free text in `content`, read by a later block as `<agent.content>`, alongside run details like the model used, token counts, tool calls, and cost. Every setting and output field is in the [Agent block reference](/workflows/blocks/agent).
2323

apps/docs/content/docs/chat/files.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Use this to:
2121
- Drop in a PDF and ask Sim to turn it into a knowledge base document
2222
- Attach a design mockup and ask Sim to describe it or generate code from it
2323

24-
Uploaded files appear in the Files panel in the sidebar and are accessible to all workflows in the workspace. Sim can also fetch a file directly from a URL and save it for you: "Download the JSON at [URL] and save it to the workspace."
24+
An attached file is stored under `uploads/` and readable by Sim for the rest of the conversation, but it does not appear in the Files panel and is not listed for workflows. Ask Sim to save a copy into workspace Files if you need it there. Sim can also fetch a file directly from a URL and save it for you: "Download the JSON at [URL] and save it to the workspace."
2525

2626
## Creating Documents
2727

@@ -116,5 +116,5 @@ When a file opens in the resource panel, you can switch between three views:
116116
{ question: "Can I use files created in Chat in workflows?", answer: "Yes. Workspace files can be referenced in workflows using the File block or by passing them as inputs." },
117117
{ question: "What file types can I upload in Chat?", answer: "You can attach images, PDFs, text files, JSON, XML, and other document formats directly to a message." },
118118
{ question: "What can Sim calculate or process?", answer: "Anything expressible as a short script — parsing JSON, number crunching, string transformations, deduplication, format conversions. Results come back in the chat." },
119-
{ question: "Is there a file size limit for generated files?", answer: "There is no hard limit on generated file size, but very large files may take longer to stream." },
119+
{ question: "Is there a file size limit for generated files?", answer: "Generated files are subject to the workspace file size limit; very large files also take longer to stream." },
120120
]} />

apps/docs/content/docs/chat/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Describe what you want and Sim handles it. Build a workflow, run research, gener
2424

2525
## How It Works
2626

27-
Sim receives a snapshot of your entire workspace with every message — all workflows, tables, knowledge bases, files, credentials, jobs, and integrations. This is why you can refer to things by name without specifying IDs or paths:
27+
Sim can reach everything in your workspace on demand, so you can usually refer to things by name instead of by ID. Attaching a resource with `@` or **+** puts it directly in context:
2828

2929
- "Run the invoice workflow"
3030
- "Add a row to the leads table"
@@ -66,7 +66,7 @@ Chat has two panes. On the left: the chat thread, where your messages and Sim's
6666

6767
<FAQ items={[
6868
{ question: "How is Chat different from working inside a single workflow?", answer: "Inside a workflow, Sim is scoped to that workflow — it helps you build and edit that one thing. In Chat, Sim has access to your entire workspace and can build workflows, manage data, run research, schedule jobs, take actions across integrations, and more." },
69-
{ question: "What model does Sim use?", answer: "Sim always uses Claude Opus 4.6. There is no model selector." },
69+
{ question: "What model does Sim use?", answer: "Chat runs on Claude Opus 4.8. There is no model selector." },
7070
{ question: "How do I reference an existing workflow or table?", answer: "Type @ followed by the name in the input, use the + menu, or drag the item from the sidebar into the chat." },
7171
{ question: "How long can a Chat task run?", answer: "Up to one hour. For tasks that exceed that, set up a scheduled job or break the work into steps." },
7272
{ question: "Can Sim work on multiple things at once?", answer: "Sim processes one message at a time. You can queue messages — they will be processed in order." },

apps/docs/content/docs/chat/knowledge.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ Ask Sim a question and it searches the specified knowledge base to answer:
4747

4848
For knowledge bases that should stay current automatically, connectors sync content from external services on a schedule — no manual uploads needed. New content is added, changed content is re-processed, and deleted content is removed on every run.
4949

50-
Connectors are configured through the knowledge base settings, not through Chat. Once connected, all synced content is immediately searchable by Sim and by any Agent block with the knowledge base attached.
50+
Connectors are usually configured in the knowledge base settings. Sim can also create, update, and sync them for you. Once connected, all synced content is immediately searchable by Sim and by any Agent block with the knowledge base attached.
5151

52-
Sim ships with 49 built-in connectors, including Notion, Google Drive, Slack, GitHub, Confluence, HubSpot, Salesforce, Gmail, and more.
52+
Sim ships with 65 built-in connectors, including Notion, Google Drive, Slack, GitHub, Confluence, HubSpot, Salesforce, Gmail, and more.
5353

5454
Examples of what you can sync:
5555

apps/docs/content/docs/chat/research.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ When you need a structured, saved document rather than a chat answer, ask Sim to
3939

4040
<FAQ items={[
4141
{ question: "Does Sim have access to real-time information?", answer: "Yes. Sim queries live internet data. Results reflect current information, not a training cutoff." },
42-
{ question: "Can Sim read pages that require login?", answer: "No. Sim can only read publicly accessible pages." },
42+
{ question: "Can Sim read pages that require login?", answer: "Stateless fetching (web_fetch, web_search, crawling) reaches only publicly accessible pages. Sim can also drive a live browser session you share — anything you sign into there, Sim can read." },
4343
{ question: "Where are research reports saved?", answer: "Reports are saved as files in your workspace and opened in the resource panel. You can find them in the Files section of the sidebar." },
4444
]} />

apps/docs/content/docs/chat/tasks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Custom tools appear in the workflow editor and are callable from any Agent block
125125
{ question: "What's the difference between a scheduled job and a deployed workflow?", answer: "A scheduled job runs a Chat prompt on a cron schedule — Sim decides what to do each time based on current workspace state. A deployed workflow runs a fixed, deterministic graph of blocks. Use jobs when you want Sim to reason and adapt; use workflows when you want predictable, auditable execution." },
126126
{ question: "Can a scheduled job trigger a workflow?", answer: "Yes. Include it in the job prompt: 'Run the invoice sync workflow and then post the results to Slack.'" },
127127
{ question: "How do I know what integrations are connected?", answer: "Ask Sim: 'What integrations are connected to this workspace?' or check the Integrations page." },
128-
{ question: "Can direct actions be undone?", answer: "No. Actions like sending emails, posting to Slack, or creating records are immediate and irreversible. Confirm the details before asking Sim to act." },
128+
{ question: "Can direct actions be undone?", answer: "External actions — emails, Slack posts, third-party records — cannot be undone. Workspace changes (workflows, tables, knowledge bases) are archived and restorable. Confirm the details before asking Sim to act." },
129129
{ question: "Are environment variables visible to all workflows?", answer: "Yes. Environment variables are workspace-scoped and available to every workflow via {{ENV_VAR}} syntax." },
130130
{ question: "What's the difference between MCP servers and custom tools?", answer: "MCP servers expose a set of tools from an external service over the MCP protocol — you connect an existing MCP-compatible server. Custom tools are single HTTP endpoints you define manually — useful for internal APIs that don't have an MCP server." },
131131
]} />

apps/docs/content/docs/chat/workflows.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Describe what the workflow should do — what triggers it, what it should do, wh
2828
Open an existing workflow with `@workflow-name` or the **+** menu, then describe the change. Sim reads the current structure before modifying it — you don't need to explain what already exists.
2929

3030
- "Add a condition that routes to a different branch if the confidence score is below 0.7"
31-
- "Replace the GPT-4o model with Claude Opus 4.6 on the summarizer block"
31+
- "Replace the GPT-4o model with Claude Opus 5 on the summarizer block"
3232
- "Add a Slack notification at the end that includes the output"
3333

3434
## Running Workflows
@@ -70,7 +70,7 @@ Sim can deploy a workflow as any of the three deployment types:
7070

7171
| Deployment type | What it creates |
7272
|----------------|----------------|
73-
| **API** | A REST endpoint at `https://sim.ai/api/workflows/{id}/execute` |
73+
| **API** | A REST endpoint at `https://www.sim.ai/api/v2/workflows/{id}/execute` |
7474
| **Chat** | A hosted conversational interface with a shareable URL |
7575
| **MCP tool** | An MCP server that exposes the workflow as a tool |
7676

@@ -114,5 +114,5 @@ Variables set this way are available via `<variable.VARIABLE_NAME>` syntax insid
114114
{ question: "Can Sim edit a workflow while it's deployed?", answer: "Yes. Editing a workflow does not affect the live deployment. The deployed version is a snapshot — you need to ask Sim to redeploy to push changes to production." },
115115
{ question: "Can I run a workflow with specific inputs from Chat?", answer: "Yes. Describe the inputs in your message and Sim passes them to the workflow's start block." },
116116
{ question: "How does Sim know what my workflow does?", answer: "When you reference a workflow, Sim loads its full structure — every block, connection, and configuration — before acting on it." },
117-
{ question: "What happens to a workflow's deployment when I delete it?", answer: "The workflow and all its deployments are permanently removed. Any API endpoints, chat URLs, or MCP tools that pointed to that workflow will stop working." },
117+
{ question: "What happens to a workflow's deployment when I delete it?", answer: "The workflow is archived and its API endpoints, chat URLs, and MCP tools stop working immediately. It can be restored (sim workflows restore, or ask Sim) until it is purged." },
118118
]} />

apps/docs/content/docs/cli/authentication.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ description: Sign in from the terminal, authenticate CI with an API key, and kee
55

66
import { Callout } from 'fumadocs-ui/components/callout'
77

8+
<Callout>
9+
These settings apply to the CLI you install locally. When Sim runs a `sim`
10+
command for you inside Chat, it uses your session identity — there is no profile,
11+
no `sim login`, and no config file.
12+
</Callout>
13+
814
The CLI authenticates with a Sim API key. `sim login` mints and stores one; in CI
915
you supply one through the environment instead.
1016

@@ -98,7 +104,7 @@ removed, so it cannot leave dangling references.
98104

99105
<Callout type="warn">
100106
`sim logout` removes the key from disk but does **not** revoke it. Revoke keys in
101-
Sim under **Settings → API keys**.
107+
Sim under **Settings → Sim API keys**.
102108
</Callout>
103109

104110
## Authenticating CI
@@ -113,7 +119,7 @@ export SIM_WORKSPACE="2f6d0b1c-8a34-4d92-b7e5-31c8a0f45d67"
113119
sim workflows run 3a9e21d8-5f47-4c0b-b2ea-91d7c6034ef8 --input '{"source":"nightly"}' --output json
114120
```
115121

116-
Create the key in Sim under **Settings → API keys**. Store it as a secret in your
122+
Create the key in Sim under **Settings → Sim API keys**. Store it as a secret in your
117123
CI provider — never commit it.
118124

119125
`SIM_CONFIG_DIR` relocates both files if you need them somewhere other than

apps/docs/content/docs/cli/commands.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ Every `sim` command follows the same shape:
1111
sim <resource> [sub-resource] <verb> [arguments] [options]
1212
```
1313

14-
Resource groups are plural, and each one also accepts its singular spelling —
15-
`sim workflow get` and `sim workflows get` are the same command. `knowledge`
16-
additionally answers to `kb`.
14+
Most resource groups also accept a singular spelling (`sim workflow get` =
15+
`sim workflows get`); `knowledge` answers to `kb`. `blocks`, `tools`,
16+
`chat-deployments`, `connector-types`, `meta`, `billing`, and
17+
`workflow-mcp-servers` have no alias.
1718

1819
## Global options
1920

apps/docs/content/docs/cli/configuration.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Configuration
33
description: Profiles, config files, environment variables, and how each setting is resolved
44
---
55

6+
These settings apply to the CLI you install locally. When Sim runs a `sim`
7+
command for you inside Chat, it uses your session identity — there is no profile,
8+
no `sim login`, and no config file.
9+
610
The CLI has four settings: **endpoint**, **API key**, **workspace**, and **output
711
format**. Each resolves independently, so a saved default can still be overridden
812
for a single command.

0 commit comments

Comments
 (0)