Developer docs

Use the Agent API without guesswork.

Start with one authenticated self-test, make a read-only request, then follow the preview-and-receipt workflow. Every page names the base URL, auth header, scopes, expected evidence, and next action.

Start here: first request

Use the quickstart to set https://api.synthcrew.io, send a Bearer workspace key, and check GET /api/v2/agent/self-test before choosing a route.

Connect an agent

Choose a task

I am connecting an AIConnect the agentBase URL, auth, scopes, headers, a copyable self-test, common errors, and safe next actions.Start integrating ↗I operate a workspaceSet up the human boundaryBilling, Google consent, mailbox readiness, campaign review, and durable receipts.Set up a workspace ↗

What the API is for

Inspect

Read leads, campaigns, inbox state, mailbox status, capabilities, and receipts within one workspace.

Prepare

Create drafts and previews with explicit scopes, bounded payloads, and replay-safe mutation headers.

Act with a boundary

High-impact work remains visible to a person. Preview first, approve the exact action, execute, and keep the receipt.

What remains human

Owner or adminBilling, API-key administration, Google OAuth, mailbox consent, and key rotation.

AgentScoped reads, preparation, previews, approved operations, and receipt polling.

Never bypassedPasswords, MFA, provider consent, suppression, workspace boundaries, or plan limits.

Reference and downloads

Run real agent workflowsPersist campaign work, stop for owner approval, and verify the launch receipt.API referenceSearch the canonical routes by task, method, scope, and human boundary.Errors & retriesKeep request IDs, reuse idempotency keys, and recover without duplicating a mutation.Rendered SDK guideChoose the Python or TypeScript client, inspect its self-test, and download the source files.Capability statusRead the dated capability matrix instead of inferring support from a marketing claim.Download catalog JSON ↧Raw JSON download, clearly labeled; the page does not replace the docs view.Download contract Markdown ↧Raw Markdown download for local review.