SynterSynterDocs
Get API Key
API Reference

Authentication

All API requests require authentication using an API key

Get your API key

Generate an API key from the Developer Portal. Each key is tied to your account and has access to your connected ad platforms.

Get API Key

Using your API key

Include your API key in the X-Synter-Key header with every request:

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

Key format

API keys follow this format:

syn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Error responses

CodeStatusDescription
401UnauthorizedAPI key is missing or invalid
402Payment RequiredInsufficient credits for this operation
403ForbiddenAPI key doesn't have permission for this action
429Rate LimitedToo many requests, implement backoff

Security best practices

Use environment variables

Never hardcode API keys in your source code

Rotate keys regularly

Generate new keys periodically and revoke old ones

Keep your API key secure

Never expose your API key in client-side code, commit it to version control, or share it publicly. Use server-side requests to protect your key.
Was this page helpful?
PreviousBest PracticesNext Run Script