Get Started

# Get started with Synter

Make your first API call in under 5 minutes

[

### Playground

Test API calls interactively with $25 of usage credit

](https://docs.syntermedia.ai/playground)[

### MCP Server

Connect your AI assistant directly to your ad accounts

](https://docs.syntermedia.ai/mcp/overview)

## Installation

PythonJavaScriptcURL

```
pip install synter
```

## Quick start guide

1

### Get your API key

Create a free account and generate your API key from the [Developer Portal](https://syntermedia.ai/developer).

[Get API Key](https://syntermedia.ai/developer)

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

Read your Google Ads campaigns. Script names are platform-prefixed, so swap the prefix for another platform: `meta_ads_get_campaigns`, `linkedin_ads_get_campaigns`, `reddit_ads_get_campaigns`, and so on.

bash

```
curl -X POST https://syntermedia.ai/api/v1/tools/run \
  -H "X-Synter-Key: $SYNTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "script_name": "google_ads_get_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](https://syntermedia.ai/developer), where you can revoke them at any time.

Start with $25 of Usage Credit

Every new account gets $25 of usage credit to explore the platform. Use the Playground to test API calls, run reports, and optimize campaigns.

[Try the Playground →](https://docs.syntermedia.ai/playground)

## Frequently asked questions

What platforms are supported?

Synter connects 21 ad platforms: Google Ads, Meta Ads, LinkedIn Ads, X Ads, Reddit Ads, Microsoft Ads, TikTok Ads, Amazon DSP, Amazon Sponsored Ads, Pinterest Ads, Snapchat Ads, Spotify Ads, OpenAI Ads, The Trade Desk, FreeWheel, DV360, CM360, Walmart Connect, Instacart Ads, Target Roundel, and Criteo Commerce Media, plus analytics, CRM, and e-commerce integrations. See the [Integrations](https://docs.syntermedia.ai/integrations) page for the full list and per-platform capabilities.

How do credits work?

Costs are per tool, not a flat 1-credit read tax. `list_campaigns` costs 2 credits. Call `forecast_tool_cost` with the tool name to see the live meter. Some tools like `get_credit_balance` are free.

Is there a free trial?

Plans are SOLO ($20/month), SCALE ($500/month), and CUSTOM. New accounts get usage credit to explore the platform. See billing in the app.

Was this page helpful?

YesNo

[Next Playground](https://docs.syntermedia.ai/playground)

---

Source: https://docs.syntermedia.ai/quickstart
Full docs as one file: https://docs.syntermedia.ai/llms-full.txt