Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.musique.app/llms.txt

Use this file to discover all available pages before exploring further.

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"
PartDescription
companyPrefixIdentifies the partner company (e.g. msk)
environmentPrefixprod for production, dev for development
hashTokenUnique 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.
1

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

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

MethodPathDescription
GET/audioList all audio files
POST/audioUpload a new MP3 file
GET/audio/{id}Get a specific audio file
DELETE/audio/{id}Delete an audio file
POST/audio/{id}/sendBroadcast audio to devices

​
System

MethodPathDescription
GET/API name, version, and docs URL
GET/healthHealth 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:
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. 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"

​
Support

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