Guides

Getting Started

Help your customers grow faster with automated marketing through the SymphonyOS API.

SymphonyOS is the automated marketing platform for creators. Our APIs bring that same automated-ads technology to your platform, so you can help your customers grow through smart social ads — with as much or as little engineering as you want.

Two Ways to Integrate

🟣 Ad Box — the fastest way to launch

The Ad Box is our white-label ad-creation tool. Embed it in an iFrame or point a custom domain at Symphony, and your users create and pay for Facebook & Instagram campaigns directly inside your product — under your branding.

  • No engineering required — go live in about two weeks
  • Anonymous checkout — your users don't need a Symphony account
  • Fully branded — your logo, colors, and (optionally) your own domain

Start here if you want ads live fast. → Explore the Ad Box

🟢 Advertising API — full programmatic control

The Advertising API lets you create and manage Meta (Facebook & Instagram) and TikTok campaigns programmatically through a single unified API call. Build your own UI and own the entire flow.

Start here if you want to integrate ads deeply into your own product. → Read the Integration Guide

Both options run on the same Symphony ad infrastructure.

📘

On the roadmap: a Content Generation API (AI-generated images, video, and ad copy) and a Links API (embed our website & presave builder into your app).


Quick Links


API URL

All Advertising API requests go to a single base URL:

https://api.symphonyos.co/api/sym/v2/

Authenticate every request with your x-api-key header. You'll be issued two keys:

  • Sandbox key — for local development and testing. Ads are not set live and no spend occurs.
  • Production key — for live campaigns with real ad spend.

Both use the same base URL — the environment is determined by the key you send.

Tip: Keep the base URL and key in environment variables (e.g. SYMPHONY_API_BASE=https://api.symphonyos.co/api/sym/v2/) so switching between sandbox and production is a one-line change.


Versioning

The API version is part of the path (/sym/v2/). We follow semantic versioning:

  • Major version → breaking changes
  • Minor version → new, backwards-compatible features
  • Patch version → backwards-compatible bug fixes

When we increment the major version you'll receive advance notice via email and the changelog. Minor and patch updates are non-breaking.