Skip to main content

Stream Music

POST 

https://api.knoxstudio.ai/v1/music/stream

Same JSON body as POST /v1/music, but the audio is streamed. sign_with_c2pa is not used on the stream path. Billed at $0.20 per generated minute.

Request​

Query Parameters​

NameTypeRequiredDescription
output_formatStringNoDefault auto. Allowed: auto, mp3_48000_128, mp3_48000_192, mp3_48000_240, mp3_48000_320, mp3_22050_32, mp3_24000_48, mp3_44100_32, mp3_44100_64, mp3_44100_96, mp3_44100_128, mp3_44100_192, pcm_8000, pcm_16000, pcm_22050, pcm_24000, pcm_32000, pcm_44100, pcm_48000, ulaw_8000, alaw_8000, opus_48000_32, opus_48000_64, opus_48000_96, opus_48000_128, opus_48000_192.

Request Headers​

NameTypeRequiredDescription
AuthorizationStringYesBearer <token> Knox API key. xi-api-key is also accepted.
Content-TypeStringYesapplication/json.

Request Body​

Same fields as Compose music, except sign_with_c2pa.

cURL Example​

curl -N -X POST "https://api.knoxstudio.ai/v1/music/stream?output_format=mp3_44100_128" \
-H "Authorization: Bearer $KNOXCHAT_API_KEY" \
-H "Content-Type: application/json" \
-o song.mp3 \
-d '{
"model_id": "music_v2_5",
"prompt": "A calm lo-fi beat with rain and soft piano",
"music_length_ms": 45000
}'

Response​

Success Response (200)​

Streaming audio bytes. Content-Type follows output_format.

Error Responses​

Validation uses HTTP 422:

{
"detail": [
{
"loc": ["body", "field"],
"msg": "…",
"type": "value_error"
}
]
}

Other errors use { "detail": "message" }.

StatusWhen
400WebSocket path called without Upgrade: websocket.
401Missing or invalid API key.
402Insufficient credits.
403Token is not allowed to use this model.
404Resource not found.
422Validation error.
429Rate limit exceeded.
500Internal server error.