List Music Models

GET /v1/music/models View .md

The music models currently served, each with what it honours, so a client can adapt without code changes. false or [] means unsupported. Requests are checked against these entries before they are queued. A model without a valid capability spec is not listed.

Responses

application/json · music-models-payload

1 field

data array of objects
21 fields
- id string
- name string
- canonical_slug string
- hugging_face_id string or null
- description string
- created integer
- output_modalities array of strings
- interaction string
  
  job: submit and poll.
- tasks array of objects
  
  What the model does, each with the input roles it requires ({role, min, max}) and the settings it reads.
- duration object
  
  {semantics, min, max, default} in seconds; semantics is exact (the song is that long) or max (the song may end sooner).
- lyrics string
  
  requiredoptional
- prompt_max_length integer
- controls object
  
  bpm, key, time_signature the model takes, each {mode}: native (enforced) or advisory (a hint written into the caption).
- outputs object
  
  max_n, kinds, roles, formats, default_format, sample_rates, channels.
- seed boolean
- adapters boolean
- streaming object
  
  progressive: a job on this model has a stream_url to hear the song as it renders.
  1 field
  - progressive boolean
- allowed_passthrough_parameters array of strings
- parameters object
- attribution string or null
  
  The name the model's license asks to be shown beside it.
- pricing_skus object
  
  {generate_per_second} in dollars per second of audio produced; {} for an unpriced model.

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

import os
import requests

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

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

Response · 200

{
    "data": [
        {
            "id": "string",
            "name": "string",
            "canonical_slug": "string",
            "hugging_face_id": "string",
            "description": "string",
            "created": 0,
            "output_modalities": [
                null
            ],
            "interaction": "string",
            "tasks": [
                {}
            ],
            "duration": {},
            "lyrics": "required",
            "prompt_max_length": 0,
            "controls": {},
            "outputs": {},
            "seed": false,
            "adapters": false,
            "streaming": {
                "progressive": null
            },
            "allowed_passthrough_parameters": [
                null
            ],
            "parameters": {},
            "attribution": "string",
            "pricing_skus": {}
        }
    ]
}