For agents / integration contract

Tools that say
what happened.

This page is for the software calling SynthCrew—not a second human dashboard. Use the versioned, scope-filtered contract to inspect capacity, preview work, request approval, and recover from typed outcomes.

Read the developer quickstart
actioncampaign.previewstatus: ready_for_review
nexthuman approvalrequired: yes
Start here

Three reads before the first write.

Use the public contract to understand the workspace before asking for a capability or previewing an action.

  1. ManifestDiscover the bounded surface.
  2. OpenAPILearn schemas and typed errors.
  3. Self-testConfirm identity and capacity.

00 / Capacity first

Query the boundary before the work.

Call authenticated GET /api/billing/usage before connecting a mailbox or running a capacity-sensitive send. Read both usage meters and the daily reset.

402

Subscription required

Stop and ask the workspace owner to choose a plan. Resume only after summary and usage confirm access.

403

Billing read-only

Preserve the intended action and ask an owner. Never retry with borrowed or broader credentials.

409

Conflict or mailbox cap

Resolve the mailbox boundary or wait for a pending billing webhook. Do not submit a duplicate change.

429

Daily-send cap

Honor Retry-After and usage reset_at; retry only after confirmed capacity returns.

Open the capacity quickstart ↗

01 / Agent primitives

Make the system
easy to query.

01

Structured actions

Stable action names, explicit inputs, predictable outputs, and typed errors keep tool use understandable.

02

Dry-run before apply

Separate planning from side effects. Let an agent show affected records, warnings, and an evidence ID before applying.

03

Idempotent operations

Retries should not create duplicate campaigns, sends, approvals, or next actions.

04

State you can inspect

Expose operation state, blockers, approvals, and receipts without requiring a browser screenshot.

05

Human approval at the edge

Keep irreversible or externally visible actions behind policy and approval boundaries.

06

Evidence receipts

Return a verifier-readable record of meaningful mutations and their authorization context.

02 / A useful response

Not just
“success: true.”

operationcampaign.preview
statusneeds_review
affected42 leads · 0 sends
evidencereceipt_id returned

Build with the boundary

Bring a real
brief.

Create workspace