Get started with Synter

Make your first API call in under 5 minutes

Hosted MCP server

Use this server URL for Claude, Codex, or another client that supports Streamable HTTP and browser OAuth:

https://mcp.synterai.com

Browser OAuth does not require an API key. Follow the MCP configuration guide for your client. The API key steps below apply to direct API and SDK requests.

Installation

pip install synter

Quick start guide

export SYNTER_API_KEY=syn_your_api_key_here

curl -X POST https://synterai.com/api/v1/tools/run \
  -H "Authorization: Bearer $SYNTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "script_name": "google_ads_get_campaigns"
  }'

Java SDK: read Google Ads performance

Use Java 17 or later and version 0.1.1 or later from Maven Central (the full guide, including writes, is on the Java SDK page). Connect your Google Ads account in Synter first, then set SYNTER_API_KEY as shown above. Keep the key on your server, never in browser code.

repositories { mavenCentral() }
dependencies {
    implementation("ai.syntermedia:synter-sdk:0.1.1")
}

import ai.syntermedia.sdk.Synter;
import ai.syntermedia.sdk.SynterException;
import ai.syntermedia.sdk.requests.GetPerformanceRequest;
import java.util.Map;

public class PerformanceReport {
    public static void main(String[] args) {
        Synter synter = Synter.builder()
            .apiKey(System.getenv("SYNTER_API_KEY"))
            .build();

        try {
            Map<String, Object> result = synter.analytics().getPerformance(
                GetPerformanceRequest.builder()
                    .platform("google")
                    .dateRange("LAST_7_DAYS")
                    .build());
            // Process result in your app; do not log raw account data.
            System.out.println("Performance request completed.");
        } catch (SynterException error) {
            System.err.println("Request failed (status " + error.getStatus() + ").");
            System.exit(1);
        }
    }
}

This is a read, not a campaign launch. The SDK sends pull_google_ads with --days 7 to POST /api/v1/tools/run and returns the response as a map. It authenticates with Authorization: Bearer $SYNTER_API_KEY, like every Synter SDK. Which header each surface accepts:

Pause a campaign and change its budget

These change a live campaign. REST takes a platform; the SDK pause and budget methods reach Google Ads only. Per-language code is on each SDK page.

curl -X POST https://api.synterai.com/v1/campaigns/1234567890/pause \
  -H "Authorization: Bearer $SYNTER_API_KEY" \
  -H "Content-Type: application/json" -d '{"platform": "GOOGLE"}'

curl -X PATCH https://api.synterai.com/v1/campaigns/1234567890/budget \
  -H "Authorization: Bearer $SYNTER_API_KEY" \
  -H "Content-Type: application/json" -d '{"platform": "GOOGLE", "daily_budget": 75}'

Log in with the CLI

Prefer the terminal? The Synter CLI can create and store an API key for you with no copy and paste:

npm install -g synter
synter login

Choose the browser login option. The CLI opens synterai.com/cli/login with a one-time device code in the URL and prints a short confirmation code (like ABCD-EFGH) so you can verify you are on the right page. Sign in in the browser, and the page confirms the login automatically. The CLI is polling in the background: it picks up a freshly created API key and stores it locally, so there is nothing to paste.

Frequently asked questions