Skip to main content
POST
audio.lyrics.generate

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
mode
enum<string>
default:write

Write a complete song or edit existing lyrics. Default write.

Available options:
write,
edit
prompt
string

Theme, style or editing direction, up to 2000 characters. Omit for a random song.

Required string length: 1 - 2000
title
string

An optional song title to preserve.

Required string length: 1 - 300
lyrics
string

Existing lyrics to edit, up to 3500 characters. Required in edit mode.

Required string length: 1 - 3500

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.