Skip to main content

MusicListResponse

One page of this API node's music jobs.

objectObject (string)
Constant value: list
Default value: list
data object[]required

Music jobs in newest-first order.

  • Array [
    • idId (string)required

    Music job identifier.

    objectObject (string)
    Constant value: music
    Default value: music
    modelModel (string)required

    Selected model card.

    promptPrompt (string)required

    Submitted musical description.

    secondsSeconds (integer)required

    Requested target or budget in seconds.

    statusStatus (string)required

    Current job state.

    Possible values: [queued, in_progress, completed, failed, cancelled]

    created_atCreated At (integer)required

    Creation time in Unix seconds.

    completed_at objectrequired

    Terminal time in Unix seconds.

    anyOf
    integer
    expires_at objectrequired

    WAV expiry time in Unix seconds.

    anyOf
    integer
    error objectrequired

    Failure detail, if any.

    anyOf
    string
    output objectrequired

    Actual WAV duration, sample rate, channels, size, and digest.

    anyOf
    content_typeContent Type (string)
    Constant value: audio/wav
    Default value: audio/wav
    size_bytesSize Bytes (integer)required

    Exact WAV size.

    Possible values: >= 1 and <= 67108864

    sha256Sha256 (string)required

    SHA-256 of the WAV.

    Possible values: Value must match regular expression ^[0-9a-f]{64}$

    duration_secondsDuration Seconds (number)required

    Actual measured WAV duration.

    Possible values: > 0

    sample_rateSample Rate (integer)required

    Samples per second in the WAV.

    Possible values: >= 1

    channelsChannels (integer)required

    PCM channel count in the WAV.

    Possible values: >= 1 and <= 2

  • ]
    • first_id objectrequired

    First job id on this page.

    anyOf
    string
    last_id objectrequired

    Last job id on this page.

    anyOf
    string
    has_moreHas More (boolean)required

    Whether another page is available.

    MusicListResponse
    {
      "object": "list",
      "data": [
        {
          "id": "string",
          "object": "music",
          "model": "string",
          "prompt": "string",
          "seconds": 0,
          "status": "queued",
          "created_at": 0,
          "completed_at": 0,
          "expires_at": 0,
          "error": "string",
          "output": {
            "content_type": "audio/wav",
            "size_bytes": 0,
            "sha256": "string",
            "duration_seconds": 0,
            "sample_rate": 0,
            "channels": 0
          }
        }
      ],
      "first_id": "string",
      "last_id": "string",
      "has_more": true
    }