Getting Started

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

SymphonyOS is the go-to automated marketing platform for creators. With our APIs, we're bringing our automated ads tech to anyone looking to help their customers grow through smart social ads.

We have a set of offerings we've launched, and a few on the roadmap:

  1. 📣 Automated Ads API [LIVE]: Launch automated social ads with an API Call: https://docs.symphonyos.co/docs/integration-guide#/
  2. (Est: Q2 2025) 📹 Content Generation API: Generate AI-powered images, videos, ad copy, & more at scale.
  3. (Est: Q3 2025) 💿 Links API: Embed our website & presave builder into your app.

Quick Links:


API URLs

Symphony offers three separate environments so you can develop, test, and run production campaigns with complete safety:

EnvironmentBase URLPurpose
Productionhttps://partner.symphonyos.co/api/v1/Live traffic and real ad spend. Use this in Production apps.
Sandboxhttps://sandbox.partner.symphonyos.co/api/v1/Fully isolated test bed that simulates the ad-buying flow without billing. Ideal for local development, CI pipelines, and staging.
Developmenthttps://development.partner.symphonyos.co/api/v1/Bleeding-edge preview of upcoming features. Access requires explicit whitelisting by the Symphony team.

All three environments share the same path structure and semantics—only the hostname changes—so you can point your integration at Sandbox first, then flip a few env variables when you’re ready for Production.


Versioning

We follow semantic versioning and expose it in the URL path (/api/v1/):

  • 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.

Tip: Keep your base URL in a config or env variable (e.g., SYMPHONY_API_BASE=https://sandbox.partner.symphonyos.co/api/v1/) so switching environments is a one-line change.