Get Music

GET /v1/music/{id} View .md

The job's status, estimated progress while it renders, and once completed its outputs, unsigned_urls (index-aligned with outputs) and usage.

Path parameters

id string required

The music job's ID, music_ followed by 24 hex characters.

Responses

application/json · music-job-payload

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

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

import os
import requests

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

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

Response · 200

{
    "id": "music_0123456789abcdef01234567",
    "object": "music",
    "model": "string",
    "task": "string",
    "status": "pending",
    "progress": 0,
    "created_at": 1790000000,
    "polling_url": "string",
    "warnings": [
        {
            "code": "string",
            "field": "string",
            "message": "string"
        }
    ]
}