Agent setup / five clear steps

Connect your AI to SynthCrew

No sends. No billing changes. No provider calls.

Create one scoped credential, start the supported MCP server, verify the connection, and choose a task. The AI can prepare work; a person still owns billing, mailbox consent, and approval.

Run the real campaign workflow

Create the campaign, prospects, and sequence; stop for owner approval; then verify the real launch receipt.

Before you start

You need an active workspace and an owner or administrator who can create Agent API keys. Use Node.js 20 or newer for the MCP server.

Open Agent setup ↗

1. Create the smallest key that works

  1. Open Activation & Agent API.The page is available only after workspace billing is active.
  2. Choose Read-only first.Expand permissions only when the intended workflow requires them.
  3. Copy the key once.SynthCrew stores only its hash and cannot show the secret again.

2. Keep the key outside the AI prompt

Set exactly one credential source on the controlled machine. The file option avoids storing the key in an AI-client configuration.

install -m 600 /dev/null ~/.config/synthcrew-agent-key
printf '%s' 'PASTE_KEY_ONCE' > ~/.config/synthcrew-agent-key
export SYNTHCREW_AGENT_KEY_FILE=~/.config/synthcrew-agent-key

Never place the key in a URL, repository, public browser bundle, screenshot, support ticket, or model prompt.

3. Start the supported MCP server

The local stdio server exposes only tools allowed by the key. It contains no billing, mailbox-consent, or human-approval tool.

npx --yes \
  --package=https://synthcrew.io/downloads/synthcrew-mcp-2.1.0.tgz \
  synthcrew-mcp

Download package · SHA-256

Your AI client should launch that command over stdio and inherit SYNTHCREW_AGENT_KEY_FILE. SynthCrew never edits the client configuration automatically.

4. Run the read-only self-test

Call synthcrew_connection_check from MCP when you chose the key-file setup. The HTTP example below instead expects SYNTHCREW_AGENT_KEY in the controlled process environment:

curl --fail-with-body https://api.synthcrew.io/api/v2/agent/self-test \
  -H "Authorization: Bearer $SYNTHCREW_AGENT_KEY" \
  -H "X-API-Version: 2"

Continue only when data.status is ready. The test makes no provider call, sends no mail, and changes no billing state.

5. Choose a workflow instead of guessing

Call synthcrew_list_workflows, then synthcrew_get_workflow. Each workflow returns prerequisites, exact steps, required human action, and a completion signal. Begin with a read.

AgentReads, prepares, previews, executes an already-approved fingerprint, and retains receipts.
PersonChooses billing, grants mailbox OAuth consent, and approves or rejects immutable previews.
ProofA durable terminal receipt—not a successful HTTP status—establishes completion.

Use HTTP or an SDK instead

Every Agent API V2 action uses the same prefix: https://api.synthcrew.io/api/v2/agent. Python exposes AgentV2Client; TypeScript exposes AgentV2Client. Existing V1 clients remain supported.