Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion apps/docs/components/icons.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
import type { SVGProps } from 'react'
import { useId } from 'react'

export function EnrichmentIcon(props: SVGProps<SVGSVGElement>) {
return (
<svg
{...props}
viewBox='0 0 24 24'
fill='currentColor'
role='img'
xmlns='http://www.w3.org/2000/svg'
>
<path d='M12 2.5l1.9 4.6 4.6 1.9-4.6 1.9L12 15.5l-1.9-4.6L5.5 9l4.6-1.9L12 2.5z' />
<path d='M18.5 14l.95 2.3 2.3.95-2.3.95L18.5 20.5l-.95-2.3-2.3-.95 2.3-.95.95-2.3z' />
<path d='M5.5 14.5l.7 1.7 1.7.7-1.7.7-.7 1.7-.7-1.7-1.7-.7 1.7-.7.7-1.7z' />
</svg>
)
}

export function AgentMailIcon(props: SVGProps<SVGSVGElement>) {
return (
<svg {...props} viewBox='0 0 350 363' fill='none' xmlns='http://www.w3.org/2000/svg'>
Expand Down Expand Up @@ -4731,7 +4747,7 @@ export function ZoomInfoIcon(props: SVGProps<SVGSVGElement>) {
return (
<svg
{...props}
viewBox='0 0 65 65'
viewBox='0.272461 0.272461 64 64'
fill='none'
xmlns='http://www.w3.org/2000/svg'
aria-hidden='true'
Expand Down
5 changes: 3 additions & 2 deletions apps/docs/components/ui/icon-mapping.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import {
AshbyIcon,
AthenaIcon,
AttioIcon,
AzureDevOpsIcon,
AzureIcon,
BoxCompanyIcon,
BrainIcon,
Expand Down Expand Up @@ -53,6 +52,7 @@ import {
ElasticsearchIcon,
ElevenLabsIcon,
EmailBisonIcon,
EnrichmentIcon,
EnrichSoIcon,
EvernoteIcon,
ExaAIIcon,
Expand Down Expand Up @@ -232,7 +232,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
ashby: AshbyIcon,
athena: AthenaIcon,
attio: AttioIcon,
azure_devops: AzureDevOpsIcon,
azure_devops: AzureIcon,
box: BoxCompanyIcon,
brandfetch: BrandfetchIcon,
brightdata: BrightDataIcon,
Expand Down Expand Up @@ -265,6 +265,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
elevenlabs: ElevenLabsIcon,
emailbison: EmailBisonIcon,
enrich: EnrichSoIcon,
enrichment: EnrichmentIcon,
evernote: EvernoteIcon,
exa: ExaAIIcon,
extend: ExtendIcon,
Expand Down
95 changes: 0 additions & 95 deletions apps/docs/content/docs/de/copilot/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -246,98 +246,3 @@ Die Copilot-Nutzung wird pro Token des zugrunde liegenden LLM abgerechnet. Wenn
<Callout type="info">
Siehe die [Seite zur Kostenberechnung](/execution/costs) für Abrechnungsdetails.
</Callout>
## Copilot MCP

Sie können Copilot als MCP-Server in Ihrem bevorzugten Editor oder AI-Client verwenden. Damit können Sie Sim-Workflows direkt aus Tools wie Cursor, Claude Code, Claude Desktop und VS Code erstellen, testen, bereitstellen und verwalten.

### Generieren eines Copilot-API-Schlüssels

Um sich mit dem Copilot-MCP-Server zu verbinden, benötigen Sie einen **Copilot-API-Schlüssel**:

1. Gehen Sie zu [sim.ai](https://sim.ai) und melden Sie sich an
2. Navigieren Sie zu **Einstellungen** → **Copilot**
3. Klicken Sie auf **API-Schlüssel generieren**
4. Kopieren Sie den Schlüssel – er wird nur einmal angezeigt

Der Schlüssel sieht aus wie `sk-sim-copilot-...`. Sie werden ihn in der folgenden Konfiguration verwenden.

### Cursor

Fügen Sie Folgendes zu Ihrer `.cursor/mcp.json` (Projektebene) oder den globalen Cursor-MCP-Einstellungen hinzu:

```json
{
"mcpServers": {
"sim-copilot": {
"url": "https://www.sim.ai/api/mcp/copilot",
"headers": {
"X-API-Key": "YOUR_COPILOT_API_KEY"
}
}
}
}
```

Ersetzen Sie `YOUR_COPILOT_API_KEY` durch den oben generierten Schlüssel.

### Claude Code

Führen Sie den folgenden Befehl aus, um den Copilot MCP-Server hinzuzufügen:

```bash
claude mcp add sim-copilot \
--transport http \
https://www.sim.ai/api/mcp/copilot \
--header "X-API-Key: YOUR_COPILOT_API_KEY"
```

Ersetzen Sie `YOUR_COPILOT_API_KEY` durch Ihren Schlüssel.

### Claude Desktop

Claude Desktop benötigt [`mcp-remote`](https://www.npmjs.com/package/mcp-remote), um sich mit HTTP-basierten MCP-Servern zu verbinden. Fügen Sie Folgendes zu Ihrer Claude Desktop-Konfigurationsdatei hinzu (`~/Library/Application Support/Claude/claude_desktop_config.json` unter macOS):

```json
{
"mcpServers": {
"sim-copilot": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://www.sim.ai/api/mcp/copilot",
"--header",
"X-API-Key: YOUR_COPILOT_API_KEY"
]
}
}
}
```

Ersetzen Sie `YOUR_COPILOT_API_KEY` durch Ihren Schlüssel.

### VS Code

Fügen Sie Folgendes zu Ihrer VS Code `settings.json` oder Workspace `.vscode/settings.json` hinzu:

```json
{
"mcp": {
"servers": {
"sim-copilot": {
"type": "http",
"url": "https://www.sim.ai/api/mcp/copilot",
"headers": {
"X-API-Key": "YOUR_COPILOT_API_KEY"
}
}
}
}
}
```

Ersetzen Sie `YOUR_COPILOT_API_KEY` durch Ihren Schlüssel.

<Callout type="info">
Für selbst gehostete Deployments ersetzen Sie `https://www.sim.ai` durch Ihre selbst gehostete Sim-URL.
</Callout>
84 changes: 0 additions & 84 deletions apps/docs/content/docs/en/copilot/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,90 +50,6 @@ For complex requests, Copilot may show its reasoning in an expandable thinking b

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.

## Copilot MCP

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.

### Generating a Copilot API Key

1. Go to [sim.ai](https://sim.ai) and sign in
2. Navigate to **Settings** → **Copilot**
3. Click **Generate API Key**
4. Copy the key — it is only shown once

The key will look like `sk-sim-copilot-...`.

### Cursor

Add to `.cursor/mcp.json`:

```json
{
"mcpServers": {
"sim-copilot": {
"url": "https://www.sim.ai/api/mcp/copilot",
"headers": {
"X-API-Key": "YOUR_COPILOT_API_KEY"
}
}
}
}
```

### Claude Code

```bash
claude mcp add sim-copilot \
--transport http \
https://www.sim.ai/api/mcp/copilot \
--header "X-API-Key: YOUR_COPILOT_API_KEY"
```

### Claude Desktop

Claude Desktop requires [`mcp-remote`](https://www.npmjs.com/package/mcp-remote). Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:

```json
{
"mcpServers": {
"sim-copilot": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://www.sim.ai/api/mcp/copilot",
"--header",
"X-API-Key: YOUR_COPILOT_API_KEY"
]
}
}
}
```

### VS Code

Add to `settings.json` or `.vscode/settings.json`:

```json
{
"mcp": {
"servers": {
"sim-copilot": {
"type": "http",
"url": "https://www.sim.ai/api/mcp/copilot",
"headers": {
"X-API-Key": "YOUR_COPILOT_API_KEY"
}
}
}
}
}
```

<Callout type="info">
For self-hosted deployments, replace `https://www.sim.ai` with your self-hosted Sim URL.
</Callout>

<FAQ items={[
{ 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." },
{ 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." },
Expand Down
7 changes: 4 additions & 3 deletions apps/docs/content/docs/en/tools/apollo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ Update an existing contact in your Apollo database
| `mobile_phone` | string | No | Mobile phone number |
| `home_phone` | string | No | Home phone number |
| `other_phone` | string | No | Alternative phone number |
| `typed_custom_fields` | json | No | Custom field values keyed by custom field ID \(accepted by Apollo but not officially documented for PATCH /contacts/\{id\}\) |
| `typed_custom_fields` | json | No | Custom field values keyed by custom field ID |

#### Output

Expand Down Expand Up @@ -440,16 +440,17 @@ Update up to 1000 existing accounts at once in your Apollo database (higher limi
| `account_ids` | array | No | Array of account IDs to update with the same values \(max 1000\). Use with name/owner_id for uniform updates. Use either this OR account_attributes. |
| `name` | string | No | When using account_ids, apply this name to all accounts |
| `owner_id` | string | No | When using account_ids, apply this owner to all accounts |
| `account_stage_id` | string | No | When using account_ids, apply this account stage to all accounts |
| `account_attributes` | json | No | Array of account objects with individual updates \(each must include id\). Example: \[\{"id": "acc1", "name": "Acme", "owner_id": "u1", "account_stage_id": "s1", "typed_custom_fields": \{"field_id": "value"\}\}\] |
| `async` | boolean | No | When true, processes the update asynchronously. Only supported when using account_ids; returns 422 if used with account_attributes. |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `accounts` | json | Updated accounts \(synchronous response, ≤100 accounts\): \[\{id, account_stage_id, ...\}\] |
| `accounts` | json | Updated accounts \(synchronous response\): \[\{id, account_stage_id, ...\}\] |
| `account_ids` | json | IDs of accounts that were updated |
| `entity_progress_job` | json | Async job descriptor \(&gt;100 accounts or async=true\) |
| `entity_progress_job` | json | Async job descriptor \(when async=true is passed with account_ids\) |
| `job_id` | string | Async job ID extracted from entity_progress_job |
| `message` | string | Optional confirmation message from Apollo |

Expand Down
13 changes: 2 additions & 11 deletions apps/docs/content/docs/en/tools/enrichment.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Enrichment
title: Data Enrichment
description: Enrich data with a Sim enrichment
---

Expand Down Expand Up @@ -31,18 +31,9 @@ Run a Sim enrichment (e.g. Work Email, Phone Number) and return its outputs

#### Output

The exact fields depend on which enrichment ran. `matched` and `provider` are always present.

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `matched` | boolean | Whether the enrichment found a result |
| `provider` | string | Provider whose result was returned (e.g. "Hunter", "People Data Labs"); `null` on no match |
| `email` | string | Work email address (Work Email enrichment) |
| `phone` | string | Phone number (Phone Number enrichment) |
| `domain` | string | Website domain (Company Domain enrichment) |
| `industry` | string | Industry (Company Info enrichment) |
| `employeeCount` | number | Employee count (Company Info enrichment) |
| `foundedYear` | number | Founded year (Company Info enrichment) |
| `description` | string | Company description (Company Info enrichment) |
| `provider` | string | Provider whose result was returned \(e.g. "Hunter", "People Data Labs"\) |


27 changes: 20 additions & 7 deletions apps/docs/content/docs/en/tools/resend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,19 @@ Retrieve details of a previously sent email by its ID
| --------- | ---- | ----------- |
| `id` | string | Email ID |
| `from` | string | Sender email address |
| `to` | json | Recipient email addresses |
| `to` | array | Recipient email addresses |
| `subject` | string | Email subject |
| `html` | string | HTML email content |
| `text` | string | Plain text email content |
| `cc` | json | CC email addresses |
| `bcc` | json | BCC email addresses |
| `replyTo` | json | Reply-to email addresses |
| `cc` | array | CC email addresses |
| `bcc` | array | BCC email addresses |
| `replyTo` | array | Reply-to email addresses |
| `lastEvent` | string | Last event status \(e.g., delivered, bounced\) |
| `createdAt` | string | Email creation timestamp |
| `scheduledAt` | string | Scheduled send timestamp |
| `tags` | json | Email tags as name-value pairs |
| `tags` | array | Email tags as name-value pairs |
| ↳ `name` | string | Tag name |
| ↳ `value` | string | Tag value |

### `resend_create_contact`

Expand Down Expand Up @@ -126,7 +128,13 @@ List all contacts in Resend

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `contacts` | json | Array of contacts with id, email, first_name, last_name, created_at, unsubscribed |
| `contacts` | array | Array of contacts |
| ↳ `id` | string | Contact ID |
| ↳ `email` | string | Contact email address |
| ↳ `first_name` | string | Contact first name |
| ↳ `last_name` | string | Contact last name |
| ↳ `created_at` | string | Contact creation timestamp |
| ↳ `unsubscribed` | boolean | Whether the contact is unsubscribed |
| `hasMore` | boolean | Whether there are more contacts to retrieve |

### `resend_get_contact`
Expand Down Expand Up @@ -203,7 +211,12 @@ List all verified domains in your Resend account

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domains` | json | Array of domains with id, name, status, region, and createdAt |
| `domains` | array | Array of domains |
| ↳ `id` | string | Domain ID |
| ↳ `name` | string | Domain name |
| ↳ `status` | string | Domain verification status |
| ↳ `region` | string | Region the domain is configured in |
| ↳ `createdAt` | string | Domain creation timestamp |
| `hasMore` | boolean | Whether there are more domains to retrieve |


2 changes: 1 addition & 1 deletion apps/docs/content/docs/en/tools/wiza.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Enrich a company by name, domain, LinkedIn ID, or LinkedIn slug with detailed fi
| `company_region` | string | State/region |
| `company_postal_code` | string | Postal code |
| `company_country` | string | Country |
| `credits` | json | Credits deducted for this enrichment \(api_credits: \{ total, email_credits, phone_credits, scrape_credits \}\) |
| `credits` | json | Credits deducted for this enrichment \(api_credits: \{ total, company_credits \}\) |

### `wiza_start_individual_reveal`

Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/docs/en/tools/zoominfo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Enrich up to 25 companies in one request with detailed firmographics, industry,
| `clientId` | string | Yes | ZoomInfo OAuth client ID |
| `clientSecret` | string | Yes | ZoomInfo OAuth client secret |
| `matchCompanyInput` | string | Yes | JSON array \(1-25 items\) of company matching criteria, e.g. \[\{"companyName":"Acme","companyWebsite":"acme.com"\}\] |
| `outputFields` | string | No | JSON array or comma-separated list of fields to return \(e.g. \["id","name","website","revenue","employeeCount"\]\) |
| `outputFields` | string | No | JSON array or comma-separated list of fields to return \(e.g. \["id","name","website","revenue","employeeCount"\]\). Defaults to a standard firmographic set if omitted. |

#### Output

Expand All @@ -138,7 +138,7 @@ Enrich up to 25 contacts in one request with verified emails, phone numbers, job
| `clientId` | string | Yes | ZoomInfo OAuth client ID |
| `clientSecret` | string | Yes | ZoomInfo OAuth client secret |
| `matchPersonInput` | string | Yes | JSON array \(1-25 items\) of contact matching criteria, e.g. \[\{"firstName":"Jane","lastName":"Doe","companyName":"Acme"\}\] |
| `outputFields` | string | No | JSON array or comma-separated list of fields to return \(e.g. \["id","firstName","email","phone","jobTitle"\]\) |
| `outputFields` | string | No | JSON array or comma-separated list of fields to return \(e.g. \["id","firstName","email","phone","jobTitle"\]\). Defaults to a standard contact set if omitted. |
| `requiredFields` | string | No | JSON array or comma-separated list of fields that must exist in results \(e.g. \["email"\]\) |

#### Output
Expand Down
Loading
Loading