مرجع API
Producer نص إلى موسيقى
استخدم نقطة نهاية تحويل النص إلى موسيقى لإنشاء مهمة غير متزامنة.
01
نظرة عامة
استخدم نقطة نهاية تحويل النص إلى موسيقى مع نموذج مدعوم. استخدم معرّف المهمة المُعاد لاسترداد حالتها، أو أدخل callback_url للتسليمات الموثقة أدناه.
البدء السريع
- أنشئ مفتاح API واضبطه كـ RUNAPI_API_KEY.
- اختر نموذجاً مدعوماً وأرسل طلب POST يطابق مخطط ذلك النموذج.
- احفظ معرّف المهمة المُعاد، ثم استطلع الحالة حتى تبلغ حالة نهائية أو تعالج عمليات الاستدعاء الموثقة أدناه.
نقطة النهاية
- عنوان URL الأساسي
https://runapi.ai- إصدار API
v1- المصادقة
Authorization: Bearer YOUR_API_TOKEN
02
النماذج المدعومة
افتح صفحة النموذج للاطلاع على التسعير الحالي وحدود المعدل وتفاصيل الاستخدام التجاري.
03
نص JSONمخطط الطلب
تعتمد الحقول والقيم المسموح بها على النموذج المحدد. عند التوفير، يستقبل callback_url عمليات تسليم المهمة الموثّقة أدناه.
fuzz-0.86 حقل
callback_urlstring
اختياري
رابط Webhook لإشعارات غير متزامنة.
lyricsstring
اختياري
كلمات الغناء الدقيقة.
modelstring
مطلوب
معرّف النموذج.
promptstring
مطلوب
أسلوب الموسيقى وموجز الإنتاج.
نطاق:1 - 200
titlestring
اختياري
عنوان الموسيقى.
vocal_modestring
مطلوب
وضع توليد الصوت الغنائي.
القيم المسموح بها:exact_lyrics, instrumental
fuzz-1.06 حقل
callback_urlstring
اختياري
رابط Webhook لإشعارات غير متزامنة.
lyricsstring
اختياري
كلمات الغناء الدقيقة.
modelstring
مطلوب
معرّف النموذج.
promptstring
مطلوب
أسلوب الموسيقى وموجز الإنتاج.
نطاق:1 - 200
titlestring
اختياري
عنوان الموسيقى.
vocal_modestring
مطلوب
وضع توليد الصوت الغنائي.
القيم المسموح بها:exact_lyrics, instrumental
fuzz-1.0-pro6 حقل
callback_urlstring
اختياري
رابط Webhook لإشعارات غير متزامنة.
lyricsstring
اختياري
كلمات الغناء الدقيقة.
modelstring
مطلوب
معرّف النموذج.
promptstring
مطلوب
أسلوب الموسيقى وموجز الإنتاج.
نطاق:1 - 200
titlestring
اختياري
عنوان الموسيقى.
vocal_modestring
مطلوب
وضع توليد الصوت الغنائي.
القيم المسموح بها:exact_lyrics, instrumental
fuzz-1.16 حقل
callback_urlstring
اختياري
رابط Webhook لإشعارات غير متزامنة.
lyricsstring
اختياري
كلمات الغناء الدقيقة.
modelstring
مطلوب
معرّف النموذج.
promptstring
مطلوب
أسلوب الموسيقى وموجز الإنتاج.
نطاق:1 - 200
titlestring
اختياري
عنوان الموسيقى.
vocal_modestring
مطلوب
وضع توليد الصوت الغنائي.
القيم المسموح بها:exact_lyrics, instrumental
fuzz-1.1-pro6 حقل
callback_urlstring
اختياري
رابط Webhook لإشعارات غير متزامنة.
lyricsstring
اختياري
كلمات الغناء الدقيقة.
modelstring
مطلوب
معرّف النموذج.
promptstring
مطلوب
أسلوب الموسيقى وموجز الإنتاج.
نطاق:1 - 200
titlestring
اختياري
عنوان الموسيقى.
vocal_modestring
مطلوب
وضع توليد الصوت الغنائي.
القيم المسموح بها:exact_lyrics, instrumental
fuzz-2.06 حقل
callback_urlstring
اختياري
رابط Webhook لإشعارات غير متزامنة.
lyricsstring
اختياري
كلمات الغناء الدقيقة.
modelstring
مطلوب
معرّف النموذج.
promptstring
مطلوب
أسلوب الموسيقى وموجز الإنتاج.
نطاق:1 - 200
titlestring
اختياري
عنوان الموسيقى.
vocal_modestring
مطلوب
وضع توليد الصوت الغنائي.
القيم المسموح بها:exact_lyrics, instrumental
fuzz-2.0-pro6 حقل
callback_urlstring
اختياري
رابط Webhook لإشعارات غير متزامنة.
lyricsstring
اختياري
كلمات الغناء الدقيقة.
modelstring
مطلوب
معرّف النموذج.
promptstring
مطلوب
أسلوب الموسيقى وموجز الإنتاج.
نطاق:1 - 200
titlestring
اختياري
عنوان الموسيقى.
vocal_modestring
مطلوب
وضع توليد الصوت الغنائي.
القيم المسموح بها:exact_lyrics, instrumental
fuzz-2.0-raw6 حقل
callback_urlstring
اختياري
رابط Webhook لإشعارات غير متزامنة.
lyricsstring
اختياري
كلمات الغناء الدقيقة.
modelstring
مطلوب
معرّف النموذج.
promptstring
مطلوب
أسلوب الموسيقى وموجز الإنتاج.
نطاق:1 - 200
titlestring
اختياري
عنوان الموسيقى.
vocal_modestring
مطلوب
وضع توليد الصوت الغنائي.
القيم المسموح بها:exact_lyrics, instrumental
القواعد الشرطية
تسري هذه المتطلبات عندما تتطابق جميع الشروط المدرجة.
-
عندما
vocal_mode = exact_lyrics- مطلوب
lyrics- غير مقبول
-
عندما
vocal_mode = instrumental- مطلوب
- غير مقبول
lyrics
04
HTTP 202إنشاء قبول
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"properties": {
"billing": {
"properties": {
"refund": {
"oneOf": [
{
"properties": {
"refunded_at": {
"type": "string"
}
},
"required": [
"refunded_at"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"reservation": {
"oneOf": [
{
"properties": {
"amount_cents": {
"type": "integer"
}
},
"required": [
"amount_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"settlement": {
"oneOf": [
{
"properties": {
"amount_micro_cents": {
"type": "integer"
},
"charged_amount_cents": {
"type": "integer"
}
},
"required": [
"charged_amount_cents",
"amount_micro_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
}
},
"required": [
"reservation",
"settlement",
"refund"
],
"type": "object",
"unevaluatedProperties": false
},
"id": {
"type": "string"
},
"status": {
"enum": [
"processing"
],
"type": "string"
},
"task_replayed": {
"type": "boolean"
}
},
"required": [
"id",
"status",
"billing"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"billing": {
"refund": null,
"reservation": null,
"settlement": null
},
"id": "tsk_reference_demo",
"status": "processing"
}05
HTTP 200الاستطلاع قيد المعالجة
GET /api/v1/producer/text_to_music/:id
مخطط الاستجابة
JSON
{
"properties": {
"billing": {
"properties": {
"refund": {
"oneOf": [
{
"properties": {
"refunded_at": {
"type": "string"
}
},
"required": [
"refunded_at"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"reservation": {
"oneOf": [
{
"properties": {
"amount_cents": {
"type": "integer"
}
},
"required": [
"amount_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"settlement": {
"oneOf": [
{
"properties": {
"amount_micro_cents": {
"type": "integer"
},
"charged_amount_cents": {
"type": "integer"
}
},
"required": [
"charged_amount_cents",
"amount_micro_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
}
},
"required": [
"reservation",
"settlement",
"refund"
],
"type": "object",
"unevaluatedProperties": false
},
"id": {
"type": "string"
},
"status": {
"enum": [
"processing"
],
"type": "string"
}
},
"required": [
"id",
"status",
"billing"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"billing": {
"refund": null,
"reservation": null,
"settlement": null
},
"id": "tsk_reference_demo",
"status": "processing"
}06
HTTP 200اكتمل الاستطلاع
GET /api/v1/producer/text_to_music/:id
مخطط الاستجابة
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"
},
"billing": {
"properties": {
"refund": {
"oneOf": [
{
"properties": {
"refunded_at": {
"type": "string"
}
},
"required": [
"refunded_at"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"reservation": {
"oneOf": [
{
"properties": {
"amount_cents": {
"type": "integer"
}
},
"required": [
"amount_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"settlement": {
"oneOf": [
{
"properties": {
"amount_micro_cents": {
"type": "integer"
},
"charged_amount_cents": {
"type": "integer"
}
},
"required": [
"charged_amount_cents",
"amount_micro_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
}
},
"required": [
"reservation",
"settlement",
"refund"
],
"type": "object",
"unevaluatedProperties": false
},
"generation_stage": {
"enum": [
"all_audios_ready"
],
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"enum": [
"completed"
],
"type": "string"
}
},
"required": [
"id",
"status",
"generation_stage",
"audios",
"billing"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
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"
}
],
"billing": {
"refund": null,
"reservation": null,
"settlement": null
},
"generation_stage": "all_audios_ready",
"id": "tsk_reference_demo",
"status": "completed"
}07
HTTP 200فشل الاستطلاع
GET /api/v1/producer/text_to_music/:id
مخطط الاستجابة
JSON
{
"properties": {
"billing": {
"properties": {
"refund": {
"oneOf": [
{
"properties": {
"refunded_at": {
"type": "string"
}
},
"required": [
"refunded_at"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"reservation": {
"oneOf": [
{
"properties": {
"amount_cents": {
"type": "integer"
}
},
"required": [
"amount_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
},
"settlement": {
"oneOf": [
{
"properties": {
"amount_micro_cents": {
"type": "integer"
},
"charged_amount_cents": {
"type": "integer"
}
},
"required": [
"charged_amount_cents",
"amount_micro_cents"
],
"type": "object",
"unevaluatedProperties": false
},
{
"enum": [
null
]
}
]
}
},
"required": [
"reservation",
"settlement",
"refund"
],
"type": "object",
"unevaluatedProperties": false
},
"error": {
"type": "string"
},
"generation_stage": {
"enum": [
"failed"
],
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"enum": [
"failed"
],
"type": "string"
}
},
"required": [
"id",
"status",
"error",
"generation_stage",
"billing"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"billing": {
"refund": null,
"reservation": null,
"settlement": null
},
"error": "Task processing failed.",
"generation_stage": "failed",
"id": "tsk_reference_demo",
"status": "failed"
}08
HTTP 200استدعاء العميل: مكتمل
POST callback_url
مخطط الاستجابة
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"
}
},
"required": [
"id",
"status",
"generation_stage",
"audios"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
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"
}09
HTTP 200استدعاء العميل: فشل
POST callback_url
مخطط الاستجابة
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
}مثال على الاستجابة
JSON
{
"error": {
"code": "generation_failed",
"message": "Task processing failed."
},
"generation_stage": "failed",
"id": "tsk_reference_demo",
"status": "failed"
}10
HTTP 401الأخطاء
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Authentication required"
}11
HTTP 401الأخطاء
GET /api/v1/producer/text_to_music/:id
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Authentication required"
}12
HTTP 400الأخطاء
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"oneOf": [
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
},
{
"properties": {
"error": {
"description": "ملخص التحقق القابل للقراءة البشرية.",
"type": "string"
},
"errors": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "رسائل التحقق مفتاحها حقل الطلب العام، مع مصفوفة من السلاسل القابلة للقراءة البشرية لكل حقل.",
"type": "object"
}
},
"required": [
"error",
"errors"
],
"type": "object",
"unevaluatedProperties": false
}
]
}مثال على الاستجابة
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
HTTP 402الأخطاء
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Insufficient balance"
}14
HTTP 429الأخطاء
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "API key credit limit exceeded"
}15
HTTP 409الأخطاء
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "The request uses features that are not supported for the selected model"
}16
HTTP 429الأخطاء
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Rate limit reached. Please retry later."
}17
HTTP 503الأخطاء
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Service under maintenance, please try again later"
}18
HTTP 504الأخطاء
POST /api/v1/producer/text_to_music
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "The request timed out"
}19
HTTP 404الأخطاء
GET /api/v1/producer/text_to_music/:id
مخطط الاستجابة
JSON
{
"properties": {
"error": {
"description": "رسالة خطأ قابلة للقراءة البشرية.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}مثال على الاستجابة
JSON
{
"error": "Task with id 'tsk_reference_demo' not found"
}20
نماذج الأكواد المولَّدة
استخدم cURL مباشرةً، أو ثبّت SDK للغة البرمجة التي تستخدمها. كل نموذج يُرسل الطلب الذي تم التحقق من صحته كما هو موضح في هذا المرجع.
التثبيت
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."
)