Naar inhoud springen
API-referentie
API-referentie

Producer tekst naar muziek

Genereer FUZZ-muziek uit een prompt, met exacte songtekst of een instrumentale modus.

Markdown bekijken
01

Overzicht

Gebruik het eindpunt voor tekst naar muziek met een ondersteund model. Gebruik de geretourneerde taak-ID om de status op te halen, of geef callback_url op voor de hieronder gedocumenteerde leveringen.

Snelstart

  1. Maak een API-sleutel aan en stel deze in als RUNAPI_API_KEY.
  2. Kies een ondersteund model en stuur een POST-verzoek waarvan de body overeenkomt met het schema van dat model.
  3. Sla de geretourneerde taak-ID op en poll vervolgens totdat een eindstatus is bereikt, of verwerk de hieronder gedocumenteerde callbacks.

Eindpunt

POST /api/v1/producer/text_to_music
Basis-URL
https://runapi.ai
API-versie
v1
Authenticatie
Authorization: Bearer YOUR_API_TOKEN
02

Ondersteunde modellen

Open een modelpagina voor actuele prijzen, snelheidslimieten en details over commercieel gebruik.

03

Verzoekschema

JSON-body

Velden en toegestane waarden zijn afhankelijk van het geselecteerde model. Indien opgegeven, ontvangt callback_url de hieronder gedocumenteerde taakaflevering.

fuzz-0.86 velden
callback_urlstring
Optioneel

Webhook-URL voor asynchrone meldingen.

lyricsstring
Optioneel

Exacte songteksten om te zingen.

modelstring
Verplicht

Model-slug.

promptstring
Verplicht

Muziekstijl en productiebriefing.

Bereik: 1 - 200
titlestring
Optioneel

Muziekitel.

vocal_modestring
Verplicht

Vocale generatiemodus.

Toegestane waarden: exact_lyrics, instrumental
fuzz-1.06 velden
callback_urlstring
Optioneel

Webhook-URL voor asynchrone meldingen.

lyricsstring
Optioneel

Exacte songteksten om te zingen.

modelstring
Verplicht

Model-slug.

promptstring
Verplicht

Muziekstijl en productiebriefing.

Bereik: 1 - 200
titlestring
Optioneel

Muziekitel.

vocal_modestring
Verplicht

Vocale generatiemodus.

Toegestane waarden: exact_lyrics, instrumental
fuzz-1.0-pro6 velden
callback_urlstring
Optioneel

Webhook-URL voor asynchrone meldingen.

lyricsstring
Optioneel

Exacte songteksten om te zingen.

modelstring
Verplicht

Model-slug.

promptstring
Verplicht

Muziekstijl en productiebriefing.

Bereik: 1 - 200
titlestring
Optioneel

Muziekitel.

vocal_modestring
Verplicht

Vocale generatiemodus.

Toegestane waarden: exact_lyrics, instrumental
fuzz-1.16 velden
callback_urlstring
Optioneel

Webhook-URL voor asynchrone meldingen.

lyricsstring
Optioneel

Exacte songteksten om te zingen.

modelstring
Verplicht

Model-slug.

promptstring
Verplicht

Muziekstijl en productiebriefing.

Bereik: 1 - 200
titlestring
Optioneel

Muziekitel.

vocal_modestring
Verplicht

Vocale generatiemodus.

Toegestane waarden: exact_lyrics, instrumental
fuzz-1.1-pro6 velden
callback_urlstring
Optioneel

Webhook-URL voor asynchrone meldingen.

lyricsstring
Optioneel

Exacte songteksten om te zingen.

modelstring
Verplicht

Model-slug.

promptstring
Verplicht

Muziekstijl en productiebriefing.

Bereik: 1 - 200
titlestring
Optioneel

Muziekitel.

vocal_modestring
Verplicht

Vocale generatiemodus.

Toegestane waarden: exact_lyrics, instrumental
fuzz-2.06 velden
callback_urlstring
Optioneel

Webhook-URL voor asynchrone meldingen.

lyricsstring
Optioneel

Exacte songteksten om te zingen.

modelstring
Verplicht

Model-slug.

promptstring
Verplicht

Muziekstijl en productiebriefing.

Bereik: 1 - 200
titlestring
Optioneel

Muziekitel.

vocal_modestring
Verplicht

Vocale generatiemodus.

Toegestane waarden: exact_lyrics, instrumental
fuzz-2.0-pro6 velden
callback_urlstring
Optioneel

Webhook-URL voor asynchrone meldingen.

lyricsstring
Optioneel

Exacte songteksten om te zingen.

modelstring
Verplicht

Model-slug.

promptstring
Verplicht

Muziekstijl en productiebriefing.

Bereik: 1 - 200
titlestring
Optioneel

Muziekitel.

vocal_modestring
Verplicht

Vocale generatiemodus.

Toegestane waarden: exact_lyrics, instrumental
fuzz-2.0-raw6 velden
callback_urlstring
Optioneel

Webhook-URL voor asynchrone meldingen.

lyricsstring
Optioneel

Exacte songteksten om te zingen.

modelstring
Verplicht

Model-slug.

promptstring
Verplicht

Muziekstijl en productiebriefing.

Bereik: 1 - 200
titlestring
Optioneel

Muziekitel.

vocal_modestring
Verplicht

Vocale generatiemodus.

Toegestane waarden: exact_lyrics, instrumental

Voorwaardelijke regels

Deze vereisten zijn van toepassing wanneer alle vermelde voorwaarden overeenkomen.

  1. Wanneer vocal_mode = exact_lyrics
    Vereist
    lyrics
    Niet geaccepteerd
  2. Wanneer vocal_mode = instrumental
    Vereist
    Niet geaccepteerd
    lyrics
04

Acceptatie aanmaken

HTTP 202

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    },
    "task_replayed": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "id": "tsk_reference_demo",
  "status": "processing"
}
05

Pollen bezig

HTTP 200

GET /api/v1/producer/text_to_music/:id

Responsschema
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "id": "tsk_reference_demo",
  "status": "processing"
}
06

Pollen voltooid

HTTP 200

GET /api/v1/producer/text_to_music/:id

Responsschema
JSON 
{
  "properties": {
    "audios": {
      "items": {
        "properties": {
          "audio_url": {
            "type": "string",
            "x-runapi-generated-media": true
          },
          "duration_seconds": {
            "type": "number"
          },
          "id": {
            "type": "string"
          },
          "image_url": {
            "type": "string",
            "x-runapi-generated-media": true
          },
          "lyrics": {
            "type": "string"
          },
          "model_name": {
            "type": "string"
          },
          "title": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "audio_url",
          "model_name"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    },
    "generation_stage": {
      "enum": [
        "all_audios_ready"
      ],
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "usage": {
      "properties": {
        "cost": {
          "type": "number"
        }
      },
      "required": [
        "cost"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  },
  "required": [
    "id",
    "status",
    "generation_stage",
    "audios",
    "usage"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "audios": [
    {
      "audio_url": "https://file.runapi.ai/reference-audio.mp3",
      "duration_seconds": 78.36,
      "id": "audio_reference",
      "image_url": "https://cdn.runapi.ai/public/samples/image.jpg",
      "lyrics": "[Instrumental]",
      "model_name": "fuzz-2.0",
      "title": "Soft Piano"
    }
  ],
  "generation_stage": "all_audios_ready",
  "id": "tsk_reference_demo",
  "status": "completed",
  "usage": {
    "cost": 0.05
  }
}
07

Pollen mislukt

HTTP 200

GET /api/v1/producer/text_to_music/:id

Responsschema
JSON 
{
  "properties": {
    "error": {
      "type": "string"
    },
    "generation_stage": {
      "enum": [
        "failed"
      ],
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error",
    "generation_stage"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Task processing failed.",
  "generation_stage": "failed",
  "id": "tsk_reference_demo",
  "status": "failed"
}
08

Callback van klant: voltooid

HTTP 200

POST callback_url

Responsschema
JSON 
{
  "properties": {
    "audios": {
      "items": {
        "properties": {
          "audio_url": {
            "type": "string",
            "x-runapi-generated-media": true
          },
          "duration_seconds": {
            "type": "number"
          },
          "id": {
            "type": "string"
          },
          "image_url": {
            "type": "string",
            "x-runapi-generated-media": true
          },
          "lyrics": {
            "type": "string"
          },
          "model_name": {
            "type": "string"
          },
          "title": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "audio_url",
          "model_name"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    },
    "generation_stage": {
      "enum": [
        "all_audios_ready"
      ],
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "usage": {
      "properties": {
        "cost": {
          "type": "number"
        }
      },
      "required": [
        "cost"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  },
  "required": [
    "id",
    "status",
    "generation_stage",
    "audios",
    "usage"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "audios": [
    {
      "audio_url": "https://file.runapi.ai/reference-audio.mp3",
      "duration_seconds": 78.36,
      "id": "audio_reference",
      "image_url": "https://cdn.runapi.ai/public/samples/image.jpg",
      "lyrics": "[Instrumental]",
      "model_name": "fuzz-2.0",
      "title": "Soft Piano"
    }
  ],
  "generation_stage": "all_audios_ready",
  "id": "tsk_reference_demo",
  "status": "completed",
  "usage": {
    "cost": 0.05
  }
}
09

Callback van klant: mislukt

HTTP 200

POST callback_url

Responsschema
JSON 
{
  "properties": {
    "error": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "properties": {
            "code": {
              "type": "string"
            },
            "limit_cents": {
              "type": "integer"
            },
            "message": {
              "type": "string"
            },
            "reset_at": {
              "format": "date-time",
              "type": [
                "string",
                "null"
              ]
            },
            "used_cents": {
              "type": "integer"
            },
            "window": {
              "enum": [
                "1h",
                "1d",
                "7d",
                "daily",
                "weekly",
                "monthly",
                "lifetime"
              ],
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object",
          "unevaluatedProperties": false
        }
      ]
    },
    "generation_stage": {
      "enum": [
        "failed"
      ],
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error",
    "generation_stage"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": {
    "code": "generation_failed",
    "message": "Task processing failed."
  },
  "generation_stage": "failed",
  "id": "tsk_reference_demo",
  "status": "failed"
}
10

Fouten

HTTP 401

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Authentication required"
}
11

Fouten

HTTP 401

GET /api/v1/producer/text_to_music/:id

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Authentication required"
}
12

Fouten

HTTP 400

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Leesbare foutmelding.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Leesbare validatiesamenvatting.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validatieberichten gekoppeld aan het openbare aanvraagveld, met een reeks leesbare tekenreeksen per veld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Responsvoorbeeld

JSON 
{
  "error": "model must be one of: fuzz-0.8, fuzz-1.0, fuzz-1.0-pro, fuzz-1.1, fuzz-1.1-pro, fuzz-2.0, fuzz-2.0-pro, fuzz-2.0-raw"
}
13

Fouten

HTTP 402

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Insufficient balance"
}
14

Fouten

HTTP 429

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "API key credit limit exceeded"
}
15

Fouten

HTTP 409

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "The request uses features that are not supported for the selected model"
}
16

Fouten

HTTP 429

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Rate limit reached. Please retry later."
}
17

Fouten

HTTP 503

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Service under maintenance, please try again later"
}
18

Fouten

HTTP 504

POST /api/v1/producer/text_to_music

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "The request timed out"
}
19

Fouten

HTTP 404

GET /api/v1/producer/text_to_music/:id

Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON 
{
  "error": "Task with id 'tsk_reference_demo' not found"
}
20

Gegenereerde codevoorbeelden

Gebruik cURL rechtstreeks, of installeer een SDK voor uw taal. Elk voorbeeld dient het gevalideerde verzoek in dat in deze referentie wordt getoond.

Installeren

Shell 
pip install runapi-producer
PYTHON 
import os
from runapi.producer import ProducerClient

client = ProducerClient(api_key=os.environ["RUNAPI_API_KEY"])
task = client.text_to_music.create(
  model="fuzz-2.0",
  vocal_mode="instrumental",
  prompt="Soft piano with gentle percussion."
)