Skip to main content
Soundlink’s Public API lets partner organizations sync campaigns and metrics into their own tools and data warehouses — and create and manage wallet-funded campaigns programmatically.

​
Get started

Quickstart

Create an API key, verify it with ping, and fetch your first campaign list using curl.

TypeScript SDK

Official soundlink package for Node.js, serverless, and Edge — typed methods, pagination helpers, and JSONL streaming.
Not sure which to pick? See SDK overview for a side-by-side comparison.

​
API guides

Syncing campaigns

List campaigns, pagination, and warehouse join patterns.

Creating campaigns

Create wallet-funded campaigns — strategies, budget rules, creatives, and idempotent retries.

Managing campaigns

Budget increase/decrease, geographic tier updates, and stopping delivery.

Importing videos

Build your video library by URL import and use videoIds in Full Control campaigns.

Understanding metrics

Overview vs breakdown vs engagement — which endpoint to call.

Playlist position

Daily track slots on playlist campaigns from the engagement export.

JSONL exports

Bulk metrics downloads, 90-day windows, and ingest patterns.

API Reference

Full OpenAPI spec, schemas, and interactive playground.

​
Reference

Authentication

Create keys in Settings, API key format, scopes, expiration, and organization isolation.

OAuth Integration

Act on behalf of an organization with Authorization Code + PKCE and Client Credentials.

Errors

Error codes, HTTP status mapping, and pagination limits.

​
API basics

All v1 routes live under /v1/*.
Send your API key on every request:
The legacy x-api-key: sk_<prefix>_<secret> header still works but is deprecated and retires 2026-08-17. See Authentication for scopes and security.
Successful responses:
Errors use the same shape with an error field instead of data. See Errors.
All createdAt and updatedAt fields are UTC (ISO 8601 with Z suffix).v1 covers campaign and metrics reads plus writes: campaign create, budget changes, tier updates, and stop, and video imports.