Skip to main content
The Musique Partner API gives you programmatic control over your audio environment — built for retailers, franchises, and multi-unit businesses. Authenticate once with an API key and access two integration surfaces:

Ads

Upload MP3 files and broadcast them to specific locations or your entire network using External IDs.

Playlists

Fetch curated playlists with CDN-served audio URLs for direct playback in your application.

Getting Started

1. Request Integration Access

Contact Musique support to request Partner API access. Provide:
  • Your company name and use case
  • Your External ID scheme (how you identify your locations internally)
You’ll receive an API token directly from the Musique team.
Store your API token securely. Never expose it in client-side code or public repositories. Use environment variables or a secret manager.

2. Verify Your Connection

Test your token with a health check:
curl https://api.musique.app/api/v1/integration/health \
  -H "X-API-Key: msk_prod_1234567890abcdef"

3. Explore the Integration Surfaces

Ads

Upload and broadcast audio files to your locations.

Playlists

Stream curated background music playlists.

Authentication

All requests must include your API token in the X-API-Key header:
X-API-Key: msk_prod_1234567890abcdef
Token format Tokens are structured as {companyPrefix}_{environmentPrefix}_{hashToken}. Each user within a company gets a unique token.
PartDescription
companyPrefixIdentifies the partner company (e.g. msk)
environmentPrefixprod for production, dev for development
hashTokenUnique hash per user
  • Tokens are hashed in the database — Musique never stores the plaintext value
  • Each token is scoped to your company and External IDs
  • Tokens do not expire by default
  • If a token is compromised, contact support@musique.app immediately to revoke it

System Endpoints

API Info

Get API name, version, and documentation URL.

Health Check

Check API health and service status.

Validate Token

Confirm your API key is valid and retrieve company and user details.

Rate Limits

Coming soon — Rate limit documentation and per-key usage endpoints are under development. See the Rate Limits page for planned specs.
Standard limits per API key:
WindowLimit
Per minute100 requests
Per hour1,000 requests
Per day10,000 requests
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers. Exceeding the limit returns 429 Too Many Requests with a Retry-After header.

Response Format

All responses return JSON. Errors follow a consistent structure:
{
  "error": {
    "code": "invalid_token",
    "message": "Invalid or expired API token",
    "type": "authentication_error"
  }
}
See the Errors page for a full list of codes and handling examples.

Best Practices

Error Handling

Handle all error types explicitly. See the Errors guide for per-status examples.

Rate Limiting

Implement exponential backoff on 429 responses. Start at 1 second and double each retry.

Token Security

Store tokens in environment variables or a secret manager. Rotate immediately if exposed.

OpenAPI Spec

Interactive playground and full spec available in the API Reference.

Support

Questions or need a token? Contact support@musique.app. When reporting an issue, include your External ID, the timestamp, and the error message.

API Reference

Full endpoint docs with interactive playground.

Quick Messages Guide

Learn how to create and manage audio content in the Musique dashboard.