Get Started

Get started with Synter

Make your first API call in under 5 minutes

Installation

pip install synter

Quick start guide

1

Get your API key

Create a free account and generate your API key from the Developer Portal.

Get API Key
2

Set your environment variable

Store your API key as an environment variable for secure access.

bash
export SYNTER_API_KEY=syn_your_api_key_here
3

Make your first request

Pull campaign data from your connected ad accounts.

bash
curl -X POST https://api.syntermedia.ai/v1/tools/run \
  -H "X-Synter-Key: $SYNTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "script_name": "list_campaigns"
  }'

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:

bash
npm install -g synter
synter login

Choose the browser login option. The CLI opens syntermedia.ai/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.

Login links expire after 10 minutes

If the link expires before you finish signing in, run synter login again. Keys created this way appear as "CLI Login" in the Developer Portal, where you can revoke them at any time.

Start with 200 Free Credits

Every new account gets 200 free credits to explore the platform. Use the Playground to test API calls, run reports, and optimize campaigns.

Frequently asked questions

Synter connects 20+ platforms: paid search (Google Ads, Microsoft Ads), paid social (Meta, LinkedIn, Reddit, TikTok, X, Pinterest, Snapchat), programmatic DSPs (The Trade Desk, Amazon DSP, Display & Video 360, StackAdapt), retail media (Amazon Ads), audio (Spotify), and local (Nextdoor), plus analytics, CRM, and e-commerce integrations. See the Integrations page for the full list and per-platform capabilities.
Read operations (like listing campaigns or pulling metrics) cost 1 credit. Write operations (like pausing campaigns or updating budgets) cost 5 credits. Some tools like get_credit_balance are free.
Yes! Every new account gets 200 free credits to explore the platform. 14-day free trial on all paid plans.
Was this page helpful?