Get API Key Get API
Docs

Sound effect generation

- Generate a sound effect from a description.

  • Async task: submitting returns a task_id; poll GET /v1/music/tasks/:task_id for the result

Request example

curl -X POST https://api.openveer.com/v1/music/generations/sounds \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  --data '{
    "model": "suno",
    "prompt": "A thunderstorm with distant bells"
  }'

Response example

{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01K8SGYNNNVBQTXNR4MM964S7K"
    }
  ]
}

Authorizations

Authorization string

All endpoints require authentication using a Bearer Token

Get an API Key:

Visit the API Key management page to get your API Key

Add the following to the request headers when using it:

Authorization: Bearer YOUR_API_KEY

Body

model string

Audio model. Currently pass suno (defaults to suno if omitted).

version string

Public version: v6 / v6-wild / v6-mini; omitted by default: v6.

prompt string

Sound effect text description. If missing, a 400 is returned at submission time (no charge). Prefer English prompts for the best results.

type string

Sound effect type: one-shot (default, single hit) / loop (loopable).

bpm integer

Tempo, 1–300; out-of-range values return 400 directly at submission time.

key string

Musical key enum: major keys C / C# / D / D# / E / F / F# / G / G# / A / A# / B; minor keys append m (Cm / C#m / … / Bm). Only sharp (#) notation is supported; flats (Db / Eb, etc.) and B# return 400 (key param error).

audio_format string

Output audio format: mp3 / m4a / wav.

Note

This interface does not support custom models, Max, variety, or the target duration field.

Note

Get Result: This API is an asynchronous task. After submission, get task_id and poll GET /v1/music/tasks/{task_id} every 3–5s until status is completed or failed (status may be pending or processing, and progress should be a whole number between 0 and 100, not guaranteed to change at fixed intervals). Once completed, get data.result.music[] for audio_url. If it fails, data.error.message contains the reason, and the deducted amount is automatically refunded.

Response

code integer

Response status code

data array
Returned data array
status string

Task status

  * submitted - Submitted
task_id string

Unique task identifier (used to poll GET /v1/music/tasks/{task_id} for the result)

This documentation is built and hosted on Mintlify, a developer documentation platform.