Skip to main content
POST
ACE Music Tasks

Authorizations

Authorization
string
header
required

Body

application/json

Page and page_size cannot be mixed with limit or offset. The resulting offset must not exceed 10000. Missing or foreign task IDs return 404 on retrieve and are omitted from batch results.

action
enum<string>
required
Available options:
retrieve
id
string
required
ids
string[]
Required array length: 1 - 100 elements
page
integer
default:1
Required range: 1 <= x <= 10001
page_size
integer
default:20
Required range: 1 <= x <= 100
type
enum<string>

Optional history type filter.

Available options:
audios,
lyrics
limit
integer

Alternative history page size; use page/page_size or limit/offset consistently.

Required range: 1 <= x <= 100
offset
integer
Required range: 0 <= x <= 10000
created_at_min
number

Inclusive creation-time lower bound, Unix seconds.

Required range: x >= 0
created_at_max
number

Inclusive creation-time upper bound, Unix seconds.

Required range: x >= 0

Response

Request accepted or result available. Inspect the task state before treating generation as complete.

id
string
required
state
string
status
string
created_at
number
finished_at
number | null
request
object

The caller-owned public creation parameters.

response
object
type
enum<string>

Audio tasks include generate, upload, cover and mashup. Lyrics tasks use lyrics.

Available options:
audios,
lyrics
trace_id
string
started_at
number
elapsed
number
Required range: x >= 0