Sonilo Text to Audio Serverless API

Commercial-safe music and sound effects from text prompts.

POST /v2/sonilo-text-to-audio · submit + poll
 1# pip install "segmind>=1.1.0"
 2# export SEGMIND_API_KEY="YOUR_API_KEY"
 3import segmind
 4
 5# Async (v2): submit to the queue and block until COMPLETED.
 6# run() returns the final result dict (600s deadline, 1.0s poll by default).
 7result = segmind.run(
 8    "sonilo-text-to-audio",
 9    prompt="warm lofi hip hop beat, mellow piano chords, soft vinyl crackle, gentle bassline and relaxed boom-bap drums, cozy late-night study vibe",
10    sound_type="music",
11    duration=30,
12    output_format="wav",
13    music_segments=[],
14)
15print(result["status"])                      # COMPLETED
16print(result.get("output"))                  # model output (e.g. media URL)
17print(result["metrics"]["inference_time"])   # server compute seconds
18
19# --- Or submit + poll manually (track request_id, control the cadence) ---
20from segmind import SegmindClient, InferenceFailed, InferenceTimeout
21
22client = SegmindClient()                      # reads SEGMIND_API_KEY
23payload = {
24    "prompt": "warm lofi hip hop beat, mellow piano chords, soft vinyl crackle, gentle bassline and relaxed boom-bap drums, cozy late-night study vibe",
25    "sound_type": "music",
26    "duration": 30,
27    "output_format": "wav",
28    "music_segments": [],
29}
30job = client.submit_async("sonilo-text-to-audio", **payload)
31print(job.request_id)                         # available immediately
32try:
33    result = job.wait(timeout=600, interval=1.0)
34except InferenceTimeout as e:
35    print("still running:", e.request_id)
36except InferenceFailed as e:
37    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/sonilo-text-to-audio

Parameters

promptrequired
string

Describes the music or sound effect to generate.

durationoptional
integer

music: 5-360 seconds. sfx: 1-180 seconds.

Default: 30Range: 1 - 360
music_segmentsoptional
object[]

Timed music prompts (music only). Starts must be >= 5s apart and the last must start >= 5s before the end.

Array items:
startrequired
number
promptrequired
string
Max length: 200
output_formatoptional
string

music: m4a or wav. sfx: wav, mp3, aac or flac.

Default: "wav"
Allowed values :
"wav""m4a""mp3""aac""flac"
sound_typeoptional
string

Which soundtrack to generate.

Default: "music"
Allowed values :
Music"music"
Sound Effects"sfx"

Response Type

Returns: Audio

Asynchronous requests (v2)

Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.

  1. 1
    POST /v2/sonilo-text-to-audio

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • A FAILED request is served as HTTP 422 — the body still carries the error detail.
  • An unknown or expired request_id returns HTTP 404.
  • Results are retained for 1 hour, then expire.
  • Content / RAI blocks surface as FAILED, not a separate state.
  • Track completion by polling the status endpoint.

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out