---
title: "Lyria 3"
description: "Lyria 3 writes a music track from a text description. It supports vocals, lyrics and several languages."
url: https://docs.roasos.com/models/music/lyria3
---

# Lyria 3

<Callout>
  Family 

  `music`

   · model 

  `lyria3`

   · catalog 

  `model-catalog@2026-10-06.v5`

   · pricing 

  `customer-pricing@2026-11-05.v15`

  .
</Callout>

## Endpoint

```http
POST https://api.roasos.com/v1/music/lyria3
```

Send your API key as a bearer token. The key needs the scope `api:write`. Every paid request also needs an `Idempotency-Key` header.

The envelope fields `quote_only`, `quote_id`, `webhook_url` and `wait_timeout_seconds` behave the same on each model endpoint. Refer to [Jobs](/concepts/jobs) and [Quotes and credits](/concepts/quotes-and-credits).

## Good at

Score an ad from a written brief. Describe genre, mood, instrumentation, tempo and vocal style; the model writes and performs it. Use it when you want a bed under a voice-over and you do not have a track.

The price is $0.04 per track, flat. There is no duration field, so the quote is exact and nothing reconciles. The endpoint states no output length either, so roasOS publishes none: read the length of the file the job returns.

roasOS states no rights position on the music this model generates. Read the terms of the model and of fal before you publish a track.

## Pricing

The unit is one **track**. Pricing key: `lyria3`.

| Request     | Credits |
| ----------- | ------- |
| `per_track` | 1       |

The credits come from the roasOS pricing table. No other field changes the price. To get the exact price of your request, send it with `quote_only: true` first.

## Modes

* `text-to-music`

Provider endpoints: `fal-ai/lyria3`.

## Request fields

| Field                  | Type    | Required | Default | Rule                              |
| ---------------------- | ------- | -------- | ------- | --------------------------------- |
| `image_url`            | string  | no       | —       | https URL; ≤ 4,096 characters     |
| `prompt`               | string  | yes      | —       | ≥ 1 character; ≤ 5,000 characters |
| `quote_id`             | string  | no       | —       | UUID                              |
| `quote_only`           | boolean | no       | `false` | —                                 |
| `wait_timeout_seconds` | integer | no       | `0`     | 0–60                              |
| `webhook_url`          | string  | no       | —       | https URL; ≤ 4,096 characters     |

The schema is strict. A field that is not in this table gets `400 unsupported_option`. The field names are the roasOS role names. One role has one name in every family.

## Media

This endpoint accepts these media roles:

* `image_url` — first frame (or the single source image)

| Role        | Items | Maximum size | Content types                           | Duration |
| ----------- | ----- | ------------ | --------------------------------------- | -------- |
| `image_url` | ≤ 1   | 10 MB        | `image/jpeg`, `image/png`, `image/webp` | —        |

Every other role is refused: `avatar_id`, `elements`, `product_id`, `product_images`, `references`, `reference_images`, `end_image_url`, `scene_id`, `scene_image`, `video_urls`, `video_url`, `audio_urls`, `audio_url`, `voice_id`. A refused role gets `400 unsupported_option`.

<Callout>
  Each media URL must be an immutable object on 

  `https://cdn.roasos.com`

   that your workspace owns. Any other URL gets 

  `400 reference_media_not_workspace_owned`

  . Refer to 

  [Reference media and uploads](/concepts/reference-media)

   to learn how to put a file there.
</Callout>

## Prompt

Write the brief, not the adjective. Name the genre, the BPM, the instruments, the vocal style and the hook you want. "An energetic electronic dance track with soaring synth leads, punchy four-on-the-floor kick drums and a catchy vocal hook, 128 BPM" beats "upbeat music".

`image_url` is mood inspiration, not a first frame: the model reads the picture's feel, not its contents.

## Not exposed

These catalog entries describe omitted inputs, pinned values and source constraints. They do not imply that the provider accepts every listed field.

* `negative_prompt` — pinned to `provider-deprecated: fal states negative prompting is not supported`.

## Result

The result kind is `audio`. Always present: `url`. Present when the run makes it: `timestamps`.

```json
{
  "data": {
    "id": "gen_…",
    "kind": "audio",
    "model": "lyria3",
    "status": "completed",
    "result": {
      "timestamps": [
        {}
      ],
      "url": "https://cdn.roasos.com/workspaces/ws_01/result"
    }
  }
}
```

The files are immutable objects on `https://cdn.roasos.com`. A result URL is a valid media input for your next request.

## Example

The three steps are always the same: quote, run, poll.

<CodeBlockTabs defaultValue="cURL">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="cURL">
      cURL
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="JavaScript">
      JavaScript
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="Python">
      Python
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="cURL">
    ```bash
    # 1. Quote. Nothing is spent.
    curl -X POST https://api.roasos.com/v1/music/lyria3 \
      -H "Authorization: Bearer roasos_sk_live_..." \
      -H "Idempotency-Key: 0f1c9e2a-lyria3-0001" \
      -H "Content-Type: application/json" \
      -d '{"quote_only":true,"prompt":"A woman holds the bottle at eye level in a bright kitchen, morning light, static camera."}'
    # 200 { "data": { "kind": "quote", "quote_id": "q_7Hk...", "credits": 1, "expires_at": "...",
    #        "confirmation": { "model": "lyria3", "example": "per_track" } } }

    # 2. Run. Same body, same Idempotency-Key, quote_id in place of quote_only.
    curl -X POST https://api.roasos.com/v1/music/lyria3 \
      -H "Authorization: Bearer roasos_sk_live_..." \
      -H "Idempotency-Key: 0f1c9e2a-lyria3-0001" \
      -H "Content-Type: application/json" \
      -d '{"quote_id":"q_7Hk...","prompt":"A woman holds the bottle at eye level in a bright kitchen, morning light, static camera."}'
    # 201 { "data": { "id": "gen_...", "status": "queued", "credits_reserved": 1 } }

    # 3. Poll, then read the result.
    curl https://api.roasos.com/v1/jobs/gen_.../status -H "Authorization: Bearer roasos_sk_live_..."
    curl https://api.roasos.com/v1/jobs/gen_.../result -H "Authorization: Bearer roasos_sk_live_..."
    ```
  </CodeBlockTab>

  <CodeBlockTab value="JavaScript">
    ```javascript
    const key = process.env.ROASOS_API_KEY;
    const url = "https://api.roasos.com/v1/music/lyria3";
    const idempotencyKey = "0f1c9e2a-lyria3-0001";
    const input = {
      "prompt": "A woman holds the bottle at eye level in a bright kitchen, morning light, static camera."
    };

    const post = (payload) =>
      fetch(url, {
        method: "POST",
        headers: {
          Authorization: `Bearer ${key}`,
          "Idempotency-Key": idempotencyKey,
          "Content-Type": "application/json",
        },
        body: JSON.stringify(payload),
      }).then((response) => response.json());

    // 1. Quote. Nothing is spent.
    const quote = await post({ quote_only: true, ...input });
    console.log(quote.data.credits);

    // 2. Run.
    const job = await post({ quote_id: quote.data.quote_id, ...input });

    // 3. Poll, then read the result.
    let status = "queued";
    while (status !== "completed" && status !== "failed" && status !== "canceled") {
      await new Promise((done) => setTimeout(done, 3000));
      const poll = await fetch(`${url.split("/v1")[0]}/v1/jobs/${job.data.id}/status`, {
        headers: { Authorization: `Bearer ${key}` },
      }).then((response) => response.json());
      status = poll.data.status;
    }

    const result = await fetch(`${url.split("/v1")[0]}/v1/jobs/${job.data.id}/result`, {
      headers: { Authorization: `Bearer ${key}` },
    }).then((response) => response.json());
    console.log(result.data.result);
    ```
  </CodeBlockTab>

  <CodeBlockTab value="Python">
    ```python
    import os, time, requests

    key = os.environ["ROASOS_API_KEY"]
    url = "https://api.roasos.com/v1/music/lyria3"
    headers = {
        "Authorization": f"Bearer {key}",
        "Idempotency-Key": "0f1c9e2a-lyria3-0001",
    }
    payload = {
        "prompt": "A woman holds the bottle at eye level in a bright kitchen, morning light, static camera."
    }

    # 1. Quote. Nothing is spent.
    quote = requests.post(url, headers=headers, json={"quote_only": True, **payload}).json()
    print(quote["data"]["credits"])

    # 2. Run.
    job = requests.post(url, headers=headers, json={"quote_id": quote["data"]["quote_id"], **payload}).json()
    job_id = job["data"]["id"]

    # 3. Poll, then read the result.
    jobs = "https://api.roasos.com/v1/jobs"
    status = "queued"
    while status not in ("completed", "failed", "canceled"):
        time.sleep(3)
        status = requests.get(f"{jobs}/{job_id}/status", headers=headers).json()["data"]["status"]

    result = requests.get(f"{jobs}/{job_id}/result", headers=headers).json()
    print(result["data"]["result"])
    ```
  </CodeBlockTab>
</CodeBlockTabs>

## Today

The endpoint is `POST /v1/music/lyria3`.

It is live.

## See also

* [`llms.txt` for this model](https://docs.roasos.com/models/music/lyria3/llms.txt) — the same facts as one plain-text file for an agent.
* `GET https://api.roasos.com/v1/catalog/lyria3` — the machine-readable form: enums, defaults, limits and prices. Refer to the [API reference](/api-reference/overview).
* [Jobs](/concepts/jobs) — how to poll a job and read its result.
* Provider endpoints: `fal-ai/lyria3`.