Developer docs / SDKs

Use a client that explains its next step.

Both reference clients target the API origin https://api.synthcrew.io, send a standard Bearer workspace key, expose a read-only self-test, and require idempotency and run headers for mutations.

Credential boundary

Keep a workspace-scoped agent key on a server or controlled worker. Do not put it in a public browser bundle.

First request

Create a client with the API origin.Pass the workspace key separately; V2 uses the uniform /api/v2/agent prefix.
Run self_test() or selfTest().Confirm authentication, workspace binding, scope filtering, and contract availability before a resource read.
Read the workflow catalog.Choose a route returned for this key instead of guessing from a capability name.

import os
from synthcrew_agent import AgentV2Client
client = AgentV2Client('https://api.synthcrew.io', os.environ['SYNTHCREW_AGENT_KEY'])
self_test = client.self_test()

Choose a client

Python 3.11Dependency-free AgentV2ClientTyped request helpers, bounded retries, problem+json errors, self-test, manifest, and idempotent mutations.Download v2.py ↧Download pyproject.toml ↧

TypeScriptServer-side Node clientTyped V2 envelopes, Bearer auth, workflow discovery, and replay-safe mutations. Never place its key in browser code.Download index.ts ↧Download package.json ↧

Evidence and errors

Self-test passesAuthentication and scopes are usable. This does not prove provider readiness or delivery.

401 / 403Check the key, workspace scope, and human boundary. Do not borrow a broader credential.

429 / 5xxFollow retry headers and reuse the same idempotency key for a safe mutation retry.

Read common errors and next actions ↗ · Browse the route catalog ↗