View as Markdown
SDK

Synter SDKs

Typed clients for the same REST tools endpoint used by the published local MCP server. The hosted remote MCP at mcp.synterai.com exposes the full tool catalog.

Install

pip install synter

Authenticate

Every SDK takes the key in its constructor and sends Authorization: Bearer syn_…. Confirm a key with GET https://api.synterai.com/v1/me.

SurfaceEndpointAcceptedUse
REST tools endpointPOST https://synterai.com/api/v1/tools/runAuthorization: Bearer syn_…, X-Synter-Key: syn_…, X-API-Key: syn_…Authorization: Bearer syn_…
REST resource endpointshttps://api.synterai.com/v1/… (campaigns, me, credits, tools/pending)Authorization: Bearer syn_…, X-Synter-Key: syn_…Authorization: Bearer syn_…
SDKs (Python, TypeScript, Rust, Java, Go) and the synter CLIPOST /api/v1/tools/runThe SDK sets the header for youPass the key to the client. Every SDK sends Authorization: Bearer syn_…
Local stdio MCP (npm @synterai/mcp-server)POST https://synterai.com/api/v1/tools/runSet SYNTER_API_KEY in the server's env blockThe package sends Authorization: Bearer syn_…
Hosted MCPhttps://mcp.synterai.comBrowser OAuth (the client sends Authorization: Bearer <OAuth access token>), or X-Synter-Key: syn_… for headless clientsOAuth. Headless: X-Synter-Key. Do not put an API key in Authorization on this host.

Keys start with syn_ (sandbox keys with syn_test_). Create one at synterai.com/developer, keep it in SYNTER_API_KEY or a secret store, and send one header per request. On the hosted MCP endpoint, the Authorization header is reserved for the OAuth token the client gets from browser sign-in, so a failed key there shows up as a sign-in prompt rather than a key error. Use X-Synter-Key when you connect a hosted MCP client with a key. Details: Authentication.

Writes

Each SDK page shows how to pause a campaign and change a daily budget, and what comes back when the safety gate holds a write. The SDK pause and budget methods only reach Google Ads today; the REST pause and budget endpoints take a platform. Who approves what: Approval model and safety controls.

Two surfaces

The SDKs and @synterai/mcp-server wrap about 25 convenience tools that POST to /api/v1/tools/run, plus an execute() escape hatch for any whitelisted script. Hosted MCP at https://mcp.synterai.com is the full tool surface. See MCP tool reference.

Credits

Tool costs are metered per name. list_campaigns costs 2 credits. Look up any tool with the hosted MCP forecast_tool_cost call before you run it. get_credit_balance and get_connection_status have no credit charge.

Was this page helpful?