Skip to main content

​
Welcome to Musique Partner API

The Musique Partner API allows you to programmatically upload audio files, send them to Raspberry Pi devices, and manage your audio library. Built for retailers, franchises, and businesses with multiple locations.

Authentication

Generate tokens, test access, and manage API credentials

Audio Endpoints

Upload, send, and manage audio files across devices

System Monitoring

Health checks, usage logs, and rate limit tracking

Getting Started

Quick start guide and core concepts

​
API Overview

​
Base URL

All API requests should be made to: 
https://api.musique.app

​
Authentication

All endpoints require authentication using an API token in the X-API-Key header: 
curl https://api.musique.app/api/audio \
  -H "X-API-Key: msk_live_1234567890abcdef"
Learn how to generate your API token.

​
Rate Limits

Standard Limits:
  • 100 requests per minute
  • 1,000 requests per hour
  • 10,000 requests per day
All responses include rate limit headers: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 77
X-RateLimit-Reset: 1705762440

​
Response Format

All successful responses follow this format: 
{
  "data": { ... },
  "timestamp": "2026-01-16T10:30:00Z"
}
All error responses follow this format: 
{
  "error": {
    "code": "error_code",
    "message": "Human readable error message",
    "type": "error_type"
  }
}

​
Available Endpoints

​
Authentication

​
POST /api/integration/auth
endpoint
Generate a new API authentication token
​
POST /api/integration/test
endpoint
Test if your API token is valid
​
DELETE /api/integration/auth
endpoint
Revoke an existing API token
View Authentication Documentation →

​
Audio Management

​
POST /api/audio
endpoint
Upload a new audio file
​
POST /api/{audioId}/send
endpoint
Send audio to one or more devices (single or broadcast)
​
GET /api/audio
endpoint
List all audio files with pagination
​
GET /api/audio/{audioId}
endpoint
Get details for a specific audio file
​
DELETE /api/{audioId}
endpoint
Delete an audio file permanently
View Audio Documentation →

​
System Monitoring

​
GET /api/integration/health
endpoint
Check API health and service status
​
GET /api/integration
endpoint
Get API version and integration details
​
GET /api/integration/logs
endpoint
Retrieve usage logs with filtering
​
GET /api/integration/limits
endpoint
Check current rate limit consumption
View System Documentation →

​
Quick Start Example

Here’s a complete workflow to upload and send audio:
1

Generate API Token

curl -X POST https://api.musique.app/api/integration/auth \
  -H "Content-Type: application/json" \
  -d '{"externalId": "store_001", "companyToken": "comp_abc123"}'
2

Upload Audio File

curl -X POST https://api.musique.app/api/audio \
  -H "X-API-Key: msk_live_1234567890abcdef" \
  -F "[email protected]" \
  -F "name=Store Announcement"
3

Send to Device

curl -X POST https://api.musique.app/api/aud_9x8y7z6w5v4u3t/send \
  -H "X-API-Key: msk_live_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{"externalIds": ["store_001"], "priority": "high"}'

​
SDKs and Libraries

Official SDKs coming soon. For now, use standard HTTP clients in your preferred language.

Node.js

Use fetch or axios for HTTP requests

Python

Use requests library for API calls

PHP

Use cURL or Guzzle HTTP client

​
Support

Email Support

Get help from our support team

Partner API Guide

Read the complete integration guide

​
Next Steps

Ready to integrate? Start with these resources:
  1. Authentication Guide - Generate your first API token
  2. Audio Endpoints - Learn how to upload and send audio
  3. Partner API Overview - Understand core concepts