API Reference - Musique App

The Musique Partner API lets you programmatically upload audio, schedule broadcasts, and manage your audio library across all your locations — built for retailers, franchises, and multi-unit businesses. Base URL

https://api.musique.app/api/v1/integration

Authentication

All requests require an X-API-Key header. Each user within a company receives a unique token with three parts:

{companyPrefix}_{environmentPrefix}_{hashToken}

For example: msk_prod_1234567890abcdef — where msk is the company prefix, prod is the environment, and 1234567890abcdef is the unique hash.

curl https://api.musique.app/api/v1/integration/audio \
  -H "X-API-Key: msk_prod_1234567890abcdef"

Part	Description
`companyPrefix`	Identifies the partner company (e.g. `msk`)
`environmentPrefix`	`prod` for production, `dev` for development
`hashToken`	Unique hash per user

API tokens are issued by the Musique team. Contact support@musique.app to get yours.

Explore the API

Audio Endpoints

Upload, retrieve, send, and delete audio files across all your locations.

System Monitoring

Check API health, version info, and current service status.

Quick Start

Get up and running in two steps.

Upload an audio file

curl -X POST https://api.musique.app/api/v1/integration/audio \
  -H "X-API-Key: msk_live_1234567890abcdef" \
  -F "file=@announcement.mp3"

Response includes an id you’ll use to send the file to devices.

Broadcast to devices

curl -X POST https://api.musique.app/api/v1/integration/audio/{id}/send \
  -H "X-API-Key: msk_live_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{"externalIds": ["store_001", "store_042"]}'

externalIds maps to your internal store or location identifiers.

Endpoints

Audio

Method	Path	Description
`GET`	`/audio`	List all audio files
`POST`	`/audio`	Upload a new MP3 file
`GET`	`/audio/{id}`	Get a specific audio file
`DELETE`	`/audio/{id}`	Delete an audio file
`POST`	`/audio/{id}/send`	Broadcast audio to devices

System

Method	Path	Description
`GET`	`/`	API name, version, and docs URL
`GET`	`/health`	Health check and service status

Response Format

All successful responses return JSON. Error responses 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 error codes and handling examples.

Rate Limits

Coming soon — Detailed rate limit documentation and per-key usage endpoints are still under development. View the Rate Limits page for planned specs.

Standard limits are enforced per API key:

Window	Limit
Per minute	100 requests
Per hour	1,000 requests
Per day	10,000 requests

Responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers. On limit exceeded, you’ll receive 429 Too Many Requests with a Retry-After header.

SDKs

Official SDKs are coming soon. Use any HTTP client in the meantime.

curl https://api.musique.app/api/v1/integration/audio \
  -H "X-API-Key: msk_live_1234567890abcdef"

const res = await fetch('https://api.musique.app/api/v1/integration/audio', {
  headers: { 'X-API-Key': 'msk_live_1234567890abcdef' }
});
const data = await res.json();

import requests

res = requests.get(
  'https://api.musique.app/api/v1/integration/audio',
  headers={'X-API-Key': 'msk_live_1234567890abcdef'}
)
data = res.json()

Support

Questions or need a token? Reach us at support@musique.app or read the Partner API Integration Guide.

​Authentication

​Explore the API

Audio Endpoints

System Monitoring

​Quick Start

​Endpoints

​Audio

​System

​Response Format

​Rate Limits

​SDKs

​Support

Authentication

Explore the API

Quick Start

Endpoints

Audio

System

Response Format

Rate Limits

SDKs

Support