नेविगेशन पर जाएँ

विस्तृत रिस्पॉन्स के साथ कंपोज़ किया गया संगीत स्ट्रीम करें

Server-Sent Events (SSE) का उपयोग करके गीत और उसका विस्तृत मेटाडेटा स्ट्रीम करें।

हेडर

xi-api-keystringवैकल्पिक

क्वेरी पैरामीटर

output_formatenumवैकल्पिकडिफ़ॉल्ट: auto

जनरेट किए गए ऑडियो का output format। codec_sample_rate_bitrate के रूप में फ़ॉर्मैट किया जाता है। चुने गए मॉडल के लिए API को सबसे अच्छा format चुनने देने हेतु “auto” (डिफ़ॉल्ट) का उपयोग करें: v1 models के लिए mp3_44100_128 और v2 models के लिए mp3_48000_192।

enable_loggingbooleanवैकल्पिकडिफ़ॉल्ट: true

जब enable_logging को false पर सेट किया जाता है, तो अनुरोध के लिए ज़ीरो रिटेंशन मोड इस्तेमाल होगा। ज़ीरो रिटेंशन मोड का इस्तेमाल सिर्फ़ एंटरप्राइज़ ग्राहक कर सकते हैं।

अनुरोध

This endpoint expects an object.
promptstring or nullवैकल्पिक<=4100 characters

गाना जनरेट करने के लिए एक सरल टेक्स्ट प्रॉम्प्ट। इसका उपयोग composition_plan के साथ नहीं किया जा सकता।

composition_planobject or nullवैकल्पिक

संगीत जनरेशन को निर्देशित करने के लिए विस्तृत कंपोज़िशन प्लान। इसे prompt के साथ इस्तेमाल नहीं किया जा सकता।

music_length_msinteger or nullवैकल्पिक3000-600000

जनरेट किए जाने वाले गाने की लंबाई, मिलीसेकंड में। केवल prompt के साथ इस्तेमाल होता है। यह 3000ms से 600000ms के बीच होनी चाहिए। वैकल्पिक — न देने पर मॉडल prompt के आधार पर लंबाई चुनेगा।

model_idenumवैकल्पिकडिफ़ॉल्ट: music_v1

जनरेशन के लिए इस्तेमाल किया जाने वाला मॉडल।

अनुमत मान:
seedinteger or nullवैकल्पिक0-2147483647

म्यूज़िक जनरेशन प्रक्रिया शुरू करने के लिए रैंडम seed। समान पैरामीटर्स के साथ वही seed देने से अधिक सुसंगत नतीजे मिल सकते हैं, लेकिन एकदम समान परिणाम की गारंटी नहीं है और सिस्टम अपडेट के बीच आउटपुट बदल सकते हैं। prompt के साथ इस्तेमाल नहीं किया जा सकता।

force_instrumentalbooleanवैकल्पिकडिफ़ॉल्ट: false

अगर true है, तो जनरेट किया गया गाना इंस्ट्रूमेंटल होना सुनिश्चित करता है। अगर false है, तो prompt के आधार पर गाना इंस्ट्रूमेंटल हो भी सकता है और नहीं भी। इसका उपयोग केवल prompt के साथ किया जा सकता है।

finetune_idstring or nullवैकल्पिक<=100 characters

जनरेशन के लिए उपयोग किए जाने वाले Finetune की ID

store_for_inpaintingbooleanवैकल्पिकडिफ़ॉल्ट: false

इनपेंटिंग के लिए जनरेट किया गया गाना स्टोर करना है या नहीं।

with_timestampsbooleanवैकल्पिकडिफ़ॉल्ट: false

जनरेट किए गए गाने के शब्दों के टाइमस्टैम्प लौटाने हैं या नहीं।

with_waveform_visualbooleanवैकल्पिकडिफ़ॉल्ट: false

जनरेट किए गए गाने का विज़ुअल वेवफ़ॉर्म लौटाना है या नहीं।

रिस्पॉन्स हेडर

song-idstringवैकल्पिक

जनरेट किए गए गाने का विशिष्ट पहचानकर्ता

रिस्पॉन्स

composition plan, song metadata, वैकल्पिक word timestamps और visual waveform वाले audio chunks, और completion के लिए Server-Sent Events।

त्रुटियाँ

422
Unprocessable Entity Error