Sign in

v1

latestOpenAPI 3.0.02026-07-26355125.0 KB

Generate Sounds

Used for creating a sound generation task (Sounds Task). It supports settings for looping, tempo (BPM), pitch (Key), as well as lyrics subtitle capture, etc.

User Guide

  • Generate corresponding audio content based on input prompt
  • Supports loop playback for background music and ambient sound scenarios
  • Supports BPM and Key controls for style shaping
  • Optional lyrics subtitle capture after generation
  • Supports async task completion notifications via callback URL
post/api/v1/generate/sounds

Request body

promptstring required

Prompt text for sound generation. Maximum 500 characters.

model'V5' required

Model name. Sounds tasks only support V5.

soundLoopboolean

Whether to enable loop playback for the generated sound.

soundTempointeger nullable

BPM (beats per minute). If omitted, Auto is used.

soundKey'Any' | 'Cm' | 'C#m' | 'Dm' | 'D#m' | 'Em' | 'Fm' | 'F#m' | 'Gm' | 'G#m' | 'Am' | 'A#m' | 'Bm' | 'C' | 'C#' | 'D' | 'D#' | 'E' | 'F' | 'F#' | 'G' | 'G#' | 'A' | 'A#' | 'B'

Pitch key of generated sound. Default is Any.

grabLyricsboolean

Whether to fetch lyric subtitle data after task completion.

callBackUrlstring uri

Callback URL for asynchronous task completion notifications.

Example request

{
  "prompt": "A soft rain ambience with distant thunder and gentle wind",
  "model": "V5",
  "soundTempo": 120,
  "soundKey": "Any",
  "callBackUrl": "https://api.example.com/callback"
}

Response

Request successful

code200 | 400 | 401 | 404 | 405 | 413 | 429 | 430 | 455 | 500

Status Codes

  • ✅ 200 - Request successful
  • ⚠️ 400 - Invalid parameters
  • ⚠️ 401 - Unauthorized access
  • ⚠️ 404 - Invalid request method or path
  • ⚠️ 405 - Rate limit exceeded
  • ⚠️ 413 - Theme or prompt too long
  • ⚠️ 429 - Insufficient credits
  • ⚠️ 430 - Your call frequency is too high. Please try again later.
  • ⚠️ 455 - System maintenance
  • ❌ 500 - Server error
msgstring

Error message when code != 200

Example response

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "a1b2****c3d4"
  }
}