Skip to main content
POST
/
audios
/
lyria-3
Generate music with Lyria 3
curl --request POST \
  --url https://api.budgetpixel.com/v1/audios/lyria-3 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "images": [
    "<string>"
  ],
  "lyrics": "<string>"
}
'
import requests

url = "https://api.budgetpixel.com/v1/audios/lyria-3"

payload = {
    "prompt": "<string>",
    "images": ["<string>"],
    "lyrics": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({prompt: '<string>', images: ['<string>'], lyrics: '<string>'})
};

fetch('https://api.budgetpixel.com/v1/audios/lyria-3', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.budgetpixel.com/v1/audios/lyria-3",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => '<string>',
    'images' => [
        '<string>'
    ],
    'lyrics' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.budgetpixel.com/v1/audios/lyria-3"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"lyrics\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.budgetpixel.com/v1/audios/lyria-3")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"lyrics\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.budgetpixel.com/v1/audios/lyria-3")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"<string>\",\n  \"images\": [\n    \"<string>\"\n  ],\n  \"lyrics\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "aud_a1b2c3d4e5f6",
  "message": "<string>",
  "model": "<string>"
}
{
  "error": {
    "code": "model_not_available",
    "message": "<string>",
    "type": "invalid_request_error"
  }
}
{
  "error": {
    "code": "model_not_available",
    "message": "<string>",
    "type": "invalid_request_error"
  }
}
{
  "error": {
    "code": "model_not_available",
    "message": "<string>",
    "type": "invalid_request_error"
  }
}
{
  "error": {
    "code": "model_not_available",
    "message": "<string>",
    "type": "invalid_request_error"
  }
}

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Body

application/json
prompt
string
required

Description of the music to generate (10-2000 characters).

images
string[]

Optional reference images (up to 10) to condition the track's mood/theme. Each item is a public image URL, a data URI, raw base64, or an uploaded-file URL from POST /v1/uploads.

Maximum array length: 10
lyrics
string

Optional lyrics (up to 3000 characters).

Response

Job accepted.

id
string

Opaque job id — use it to poll status.

Example:

"aud_a1b2c3d4e5f6"

message
string
model
string
status
enum<string>

Lifecycle state. succeeded/failed/timeout are terminal.

Available options:
pending,
starting,
processing,
completing,
succeeded,
failed,
timeout