Skip to main content
POST
audio.music.inpaint

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
fileId
string
required

Id of an uploaded file holding the input music, MP3 or WAV, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
prompt
string
required

Describe the desired music, up to 10000 characters.

Required string length: 1 - 10000
startSeconds
number
required

Start of the section to replace, in seconds.

Required range: 0 <= x <= 380
endSeconds
number
required

End of the section to replace, in seconds; after startSeconds and within durationSeconds.

Required range: 0 <= x <= 380
durationSeconds
number
default:190

Output duration, 1 to 380 seconds. Default 190.

Required range: 1 <= x <= 380
format
enum<string>
default:mp3

Output audio format. Default mp3.

Available options:
mp3,
wav
steps
integer
default:8

Sampling steps, 4 to 8. Default 8.

Required range: 4 <= x <= 8
guidance
number
default:1

How strictly to follow the prompt, 1 to 25. Default 1.

Required range: 1 <= x <= 25
seed
integer

Random seed; omit or use 0 for a random seed.

Required range: 0 <= x <= 4294967294

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.