Skip to main content
POST
/
api
/
{audioId}
/
send
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",
    "volume": 80
  }'

{
  "sendId": "snd_abc123def456",
  "audioId": "aud_9x8y7z6w5v4u3t",
  "destinations": [
    {
      "externalId": "store_001",
      "userId": 4348,
      "status": "queued"
    }
  ],
  "scheduled": false,
  "scheduleAt": null,
  "status": "sent"
}
Send an audio file to one or more Raspberry Pi devices. Supports both single location sends and broadcasts to multiple locations.
Single vs Broadcast:
  • Single: One external ID in array → sends to specific location
  • Broadcast: Multiple external IDs → sends to all locations simultaneously
Broadcasts are atomic: either all destinations receive the audio or none do.

​
Request

​
Headers

​
X-API-Key
string
required
Your API authentication token

​
Path Parameters

​
audioId
string
required
ID of the audio file to send

​
Body Parameters

​
externalIds
array
required
Array of external IDs for target locations. Single ID for specific location, multiple IDs for broadcast.
​
scheduleAt
string
ISO 8601 timestamp for scheduled playback. Omit for immediate playback.
​
priority
string
default:"normal"
Playback priority: low, normal, high, urgent. High/urgent interrupt current playback.
​
repeat
number
default:"1"
Number of times to play the audio (1-10)
​
volume
number
default:"100"
Playback volume percentage (0-100)

​
Response

​
sendId
string
Unique identifier for this send operation
​
audioId
string
ID of the audio file sent
​
destinations
array
Array of destination objects with external IDs and user IDs
​
scheduled
boolean
Whether the audio is scheduled for future playback
​
scheduleAt
string | null
Scheduled playback time or null for immediate
​
status
string
Send status: queued, scheduled, sent, failed
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",
    "volume": 80
  }'

{
  "sendId": "snd_abc123def456",
  "audioId": "aud_9x8y7z6w5v4u3t",
  "destinations": [
    {
      "externalId": "store_001",
      "userId": 4348,
      "status": "queued"
    }
  ],
  "scheduled": false,
  "scheduleAt": null,
  "status": "sent"
}

​
Priority Levels

PriorityBehavior
lowQueued after other audio
normalStandard playback queue
highPlays after current audio finishes
urgentInterrupts current playback immediately