Skip to main content
POST
Music

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255
x-sigmora-quote-only
string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json
prompts
object[]
required

One to ten weighted descriptions of the music to generate.

Required array length: 1 - 10 elements
projectId
string
required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200
durationMs
integer
default:30000

Track length in milliseconds. 5,000 to 180,000; defaults to 30,000 (30 seconds).

Required range: 5000 <= x <= 180000
bpm
integer

Tempo in beats per minute. 60 to 200; omit to let the model choose.

Required range: 60 <= x <= 200
density
number

How busy the arrangement should be, from 0 (sparse) to 1 (dense).

Required range: 0 <= x <= 1

Response

Success.

success
boolean
required
credits
number
required

What this call actually cost, which is not always what was quoted.

Example:

300

music
object
required
blocks
number
required

What was billed: 5-second blocks of audio.

projectId
string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance
number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}
any