API reference›Music

List Music

GET /v1/music View .md

Your music jobs, newest first.

Query parameters

limit integer

default 20range 1–100
after string

A job id from the previous page (last_id); returns the jobs created before it.

Responses

application/json · music-list-payload

5 fields

object string

list
data array of objects
18 fields
- id string required
- object string required
  
  music
- model string required
- task string required
- status string required
  
  pendingin_progresscompletedfailedcancelledexpired
- progress integer required
  
  Estimated percent while rendering.
- created_at integer required
- completed_at integer
- expires_at integer
  
  When the audio is deleted (7 days after completion).
- polling_url string required
- stream_url string
  
  While pending or in_progress on a model that streams (streaming.progressive): the song as WAV as it renders, from its first byte (GET /v1/music/{id}/stream; ?index=N for another output). Send your API key.
- queue_position integer
  
  Jobs ahead of this one for the same model, while pending.
- outputs array of objects
  11 fields
  - index integer
    
    Its place in outputs and in unsigned_urls; GET /v1/music/{id}/content?index=N.
  - kind string
  - role string
    
    What the audio is; mix is the whole song.
  - candidate integer
    
    Which of the n songs it belongs to.
  - content_type string
  - format string
  - duration_seconds number
  - sample_rate integer
  - channels integer
  - seed integer
  - metadata object
- unsigned_urls array of strings
  
  outputs[N] is at unsigned_urls[N]; send your API key.
- warnings array of objects required
  3 fields
  - code string
    
    advisory_control (a hint the model may not follow exactly), ignored_parameter (accepted and not used) or unknown_parameter (not a music request field).
  - field string
  - message string
- usage object
  4 fields
  - cost number
    
    Dollars, billed_seconds times the model's price.
  - duration_seconds number
  - billed_seconds integer
  - outputs integer
- error string
  
  The failure, when failed.
- error_code string
first_id string
last_id string
has_more boolean

curl https://api.vultrinference.com/v1/music \
  -H "Authorization: Bearer $VULTR_INFERENCE_API_KEY"

import os
import requests

response = requests.get(
    "https://api.vultrinference.com/v1/music",
    headers={"Authorization": f"Bearer {os.environ['VULTR_INFERENCE_API_KEY']}"},
)
print(response.json())

const response = await fetch("https://api.vultrinference.com/v1/music", {
  headers: {
    Authorization: `Bearer ${process.env.VULTR_INFERENCE_API_KEY}`,
  },
});
console.log(await response.json());

Response · 200

{
    "object": "list",
    "data": [
        {
            "id": "music_0123456789abcdef01234567",
            "object": "music",
            "model": "string",
            "task": "string",
            "status": "pending",
            "progress": 0,
            "created_at": 1790000000,
            "polling_url": "string",
            "warnings": [
                {}
            ]
        }
    ],
    "first_id": "string",
    "last_id": "string",
    "has_more": false
}