> ## Documentation Index
> Fetch the complete documentation index at: https://docs.magnific.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lyria 3 - Generate music from text

> Generate original music tracks from text descriptions using Lyria 3, with optional image references to guide mood and style.

Describe the genre, mood, instruments, and tempo you want, and optionally attach reference images that inform the atmosphere of the composition. Ideal for video production, games, podcasts, and multimedia projects.

**Tips for effective prompts:**
- Include genre: "cinematic", "jazz", "electronic", "ambient"
- Describe mood: "dramatic", "playful", "tense", "peaceful"
- Mention instruments: "grand piano", "saxophone", "synth pads", "percussion"
- Add tempo hints: "andante", "fast-paced", "steady groove"




## OpenAPI

````yaml post /v1/ai/music-generation/lyria-3
openapi: 3.0.0
info:
  description: >-
    The Magnific API is your gateway to a vast collection of high-quality
    digital resources for your applications and projects. As a leading platform,
    it offers a wide range of graphics, including vectors, photos,
    illustrations, icons, PSD templates, and more, all curated by talented
    designers from around the world.
  title: Magnific API
  version: 1.0.0
servers:
  - description: B2B API Production V1
    url: https://api.magnific.com
security:
  - magnificApiKey: []
paths:
  /v1/ai/music-generation/lyria-3:
    post:
      tags:
        - music-generation
      summary: Lyria 3 - Generate music from text
      description: >
        Generate original music tracks from text descriptions using Lyria 3,
        with optional image references to guide mood and style.


        Describe the genre, mood, instruments, and tempo you want, and
        optionally attach reference images that inform the atmosphere of the
        composition. Ideal for video production, games, podcasts, and multimedia
        projects.


        **Tips for effective prompts:**

        - Include genre: "cinematic", "jazz", "electronic", "ambient"

        - Describe mood: "dramatic", "playful", "tense", "peaceful"

        - Mention instruments: "grand piano", "saxophone", "synth pads",
        "percussion"

        - Add tempo hints: "andante", "fast-paced", "steady groove"
      operationId: create_lyria_3_task
      requestBody:
        content:
          application/json:
            examples:
              basic:
                summary: Basic music generation
                value:
                  prompt: >-
                    Cinematic ambient track with warm synth pads, soft piano,
                    and a gentle build
              pro_with_reference:
                summary: Pro model with a reference image
                value:
                  prompt: >-
                    Dramatic orchestral cue with rising strings and deep
                    percussion
                  model: pro
                  reference_images:
                    - image: https://example.com/mood-reference.jpg
                      mime_type: image/jpeg
            schema:
              $ref: '#/components/schemas/request_17'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                success - created task:
                  $ref: '#/components/examples/200-task-created'
                success - in progress task:
                  $ref: '#/components/examples/200-task-in-progress'
                success - completed task:
                  $ref: '#/components/examples/200-task-completed'
                success - failed task:
                  $ref: '#/components/examples/200-task-failed'
              schema:
                $ref: >-
                  #/components/schemas/_v1_ai_text_to_image_hyperflux_post_200_response
          description: OK - The task exists and the status is returned
        '400':
          content:
            application/json:
              examples:
                invalid_page:
                  summary: Parameter 'page' is not valid
                  value:
                    message: Parameter 'page' must be greater than 0
                invalid_query:
                  summary: Parameter 'query' is not valid
                  value:
                    message: Parameter 'query' must not be empty
                invalid_filter:
                  summary: Parameter 'filter' is not valid
                  value:
                    message: Parameter 'filter' is not valid
                generic_bad_request:
                  summary: Bad Request
                  value:
                    message: Parameter ':attribute' is not valid
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_400_response'
            application/problem+json:
              examples:
                invalid_page:
                  summary: Parameter 'page' is not valid
                  value:
                    message: Validation error
                    invalid_params:
                      - field: page
                        reason: Parameter 'page' must be greater than 0
                      - field: per_page
                        reason: Parameter 'per_page' must be greater than 0
              schema:
                $ref: >-
                  #/components/schemas/get_all_style_transfer_tasks_400_response_1
          description: >-
            Bad Request - The server could not understand the request due to
            invalid syntax.
        '401':
          content:
            application/json:
              examples:
                invalid_api_key:
                  summary: API key is not valid
                  value:
                    message: Invalid API key
                missing_api_key:
                  summary: API key is not provided
                  value:
                    message: Missing API key
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_400_response'
          description: >-
            Unauthorized - The client must authenticate itself to get the
            requested response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_500_response'
          description: >-
            Internal Server Error - The server has encountered a situation it
            doesn't know how to handle.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_503_response'
          description: Service Unavailable
components:
  schemas:
    request_17:
      properties:
        prompt:
          description: >
            Text description of the music you want to generate with Lyria 3.

            Be specific about genre, mood, instruments, and tempo for best
            results.


            **Tips for effective prompts:**

            - Include genre: "cinematic", "jazz", "electronic", "ambient"

            - Describe mood: "dramatic", "playful", "tense", "peaceful"

            - Mention instruments: "grand piano", "saxophone", "synth pads",
            "percussion"

            - Add tempo hints: "andante", "fast-paced", "steady groove"
          example: >-
            Cinematic ambient track with warm synth pads, soft piano, and a
            gentle build
          maxLength: 2000
          minLength: 10
          type: string
        model:
          default: clip
          description: |
            Lyria 3 generation model variant.

            **Available models:**
            - `clip`: Faster generation optimized for short clips (default)
            - `pro`: Higher-fidelity generation for professional-quality tracks
          enum:
            - clip
            - pro
          example: clip
          type: string
        reference_images:
          description: >
            Optional reference images to guide the mood and style of the
            generated music.

            Each entry must include the image URL and its MIME type.


            **Image requirements:**

            - Publicly accessible URLs or GCS format

            - Supported formats: PNG, JPEG, WebP
          example:
            - image: https://example.com/mood-reference.jpg
              mime_type: image/jpeg
          items:
            $ref: '#/components/schemas/request_17_reference_images_inner'
          type: array
        webhook_url:
          description: >
            Optional callback URL that will receive asynchronous notifications
            whenever the task changes status. The payload sent to this URL is
            the same as the corresponding GET endpoint response, but without the
            data field.
          example: https://www.example.com/webhook
          format: uri
          type: string
      required:
        - prompt
      type: object
    _v1_ai_text_to_image_hyperflux_post_200_response:
      example:
        data:
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: CREATED
          generated:
            - https://openapi-generator.tech
            - https://openapi-generator.tech
      properties:
        data:
          $ref: '#/components/schemas/task-detail_1'
      required:
        - data
      type: object
    get_all_style_transfer_tasks_400_response:
      example:
        message: message
      properties:
        message:
          type: string
      type: object
    get_all_style_transfer_tasks_400_response_1:
      properties:
        problem:
          $ref: >-
            #/components/schemas/get_all_style_transfer_tasks_400_response_1_problem
      type: object
    get_all_style_transfer_tasks_500_response:
      example:
        message: Internal Server Error
      properties:
        message:
          example: Internal Server Error
          type: string
      type: object
    get_all_style_transfer_tasks_503_response:
      example:
        message: Service Unavailable. Please try again later.
      properties:
        message:
          example: Service Unavailable. Please try again later.
          type: string
      type: object
    request_17_reference_images_inner:
      properties:
        image:
          description: Image URL (publicly accessible URL or GCS format)
          example: https://example.com/reference-image.jpg
          type: string
        mime_type:
          description: MIME type of the reference image
          enum:
            - image/png
            - image/jpeg
            - image/webp
          example: image/jpeg
          type: string
      required:
        - image
        - mime_type
      type: object
    task-detail_1:
      allOf:
        - $ref: '#/components/schemas/task'
        - properties:
            generated:
              items:
                description: URL of the generated image
                format: uri
                type: string
              type: array
          required:
            - generated
          type: object
      example:
        task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        status: CREATED
        generated:
          - https://openapi-generator.tech
          - https://openapi-generator.tech
    get_all_style_transfer_tasks_400_response_1_problem:
      properties:
        message:
          example: Validation error
          type: string
        invalid_params:
          items:
            $ref: >-
              #/components/schemas/get_all_style_transfer_tasks_400_response_1_problem_invalid_params_inner
          type: array
      required:
        - invalid_params
        - message
      type: object
    task:
      example:
        task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        status: CREATED
      properties:
        task_id:
          description: Task identifier
          format: uuid
          type: string
        status:
          description: Task status
          enum:
            - CREATED
            - IN_PROGRESS
            - COMPLETED
            - FAILED
          type: string
      required:
        - status
        - task_id
      type: object
    get_all_style_transfer_tasks_400_response_1_problem_invalid_params_inner:
      properties:
        name:
          description: Name of the invalid parameter.
          example: page
          type: string
        field:
          description: Field of the invalid parameter. Mirrors `name`.
          example: page
          type: string
        reason:
          example: Parameter 'page' must be greater than 0
          type: string
      required:
        - field
        - name
        - reason
      type: object
  examples:
    200-task-created:
      summary: Success - Task created
      value:
        data:
          generated: []
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: CREATED
    200-task-in-progress:
      summary: Success - Task in progress
      value:
        data:
          generated: []
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: IN_PROGRESS
    200-task-completed:
      summary: Success - Task completed
      value:
        data:
          generated:
            - https://ai-statics.freepik.com/completed_task_image.jpg
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: COMPLETED
    200-task-failed:
      summary: Success - Task failed
      value:
        data:
          generated: []
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: FAILED
  securitySchemes:
    magnificApiKey:
      description: >
        Your Magnific API key. Required for authentication. [Learn how to obtain
        an API key](https://docs.magnific.com/quickstart)
      in: header
      name: x-magnific-api-key
      type: apiKey

````