إدارة القوالب

يوفر دليل واجهة برمجة التطبيقات هذا نظرة عامة حول استخدام القوالب لتوليد الطلبات المجمعة.

---

تتيح لك القوالب إضافة وتخصيص النصوص والصور ومقاطع الفيديو والصوت والأصوات والصور الرمزية. إذا كنت تريد حفظ تكوينات الفيديو الخاصة بك لاستخدامها في المستقبل، فإن إنشاء قالب يعد خيارًا أفضل من إنشاء الفيديو مباشرةً. 🦊

البدء السريع

دعنا نتعمق في كيفية إنشاء قالب وإدراج قوالبك، حتى تتمكن من توليد مقاطع فيديو مجمعة بكفاءة باستخدامها لاحقًا.

إنشاء قالب

لإنشاء قالب فيديو مجمع، استخدم طلب واجهة برمجة التطبيقات التالي. يتيح لك تحديد إعدادات مختلفة، بما في ذلك النص الصوتي والصورة الرمزية والخلفية، لتوليد قالب فيديو قابل لإعادة الاستخدام بكفاءة. خصص المعلمات لتناسب احتياجاتك. بمجرد الإنشاء، يمكنك استخدام 'id' من الاستجابة كـ 'template_id' في إنشاء طلبات مجمعة لتوليد طلب مجمع باستخدام هذا القالب. يمكنك الحصول على 'audio_id' و'audio_service' من واجهة برمجة تطبيقات قائمة الصوت و"csv_id" من واجهة برمجة تطبيقات قائمة csv. يمكنك استخدام وحدات الماكرو بتنسيق '{{}}' ضمن 'audio_text'، والتي سيتم استبدالها ديناميكيًا بقيم من ملف CSV الذي قدمته. على سبيل المثال، إذا أضفت '{{First Name}}' في نصك، فسيتم استبداله بأسماء مثل "John" و"Smith" لكل إدخال مطابق في ملف CSV، مما يُنشئ صوتًا مخصصًا لكل فيديو في القائمة. ندعم ما يصل إلى 20 متغيرًا من متغيرات القالب لكل طلب. تأكد من تطابق عدد وأسماء هذه المتغيرات تمامًا بين نصك وملف CSV. أسماء متغيرات القالب لا تراعي حالة الأحرف. في حال عدم وجود أي متغير من متغيرات القالب في ملف CSV، سيتم إرجاع خطأ.

Requestالرد

curl --request POST  \
     --url 'https://api.immersive-fox.com/v1/template/create_bulk_template/'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'  \
     --data { \
         "csv_id": 45, \
         "template_name": "My new template", \
         "configurations": [ \
             { \
                 "audio_text": "Hi, My name is {{First Name}}", \
                 "avatar": 102, \
                 "avatar_size": 76, \
                 "background_color": "#ffffff", \
                 "background_music_is_personalized": "system", \
                 "background_music_volume": 0.1, \
                 "frame_height": 1080, \
                 "frame_width": 1920, \
                 "is_personalized_audio": false, \
                 "scene_number": 1, \
                 "scene_transition": "none", \
                 "audio_id": 2, \
                 "audio_service": "google_audio", \
                 "user_voice_speed": 1, \
                 "x_position": 0.604931, \
                 "y_position": 0.43101 \
             } \
         ] \
     }

{
    "id": 1142,
    "project_name": "My new template",
    "csv_id": 45,
    "user": 31,
}

إنشاء القوالب باستخدام الذكاء الاصطناعي: يوفر Immersive Fox ميزة فعّالة تُؤتمت إنشاء القوالب. بدلاً من تصميم كل قالب يدويًا، يمكنك الاستفادة من نماذج الذكاء الاصطناعي لدينا لإنشاء القوالب نيابةً عنك. ما عليك سوى تقديم نص وصفي، وستُنشئ خوارزمياتنا قالبًا شاملًا يتضمن المشاهد والنصوص والخلفيات والأصوات. كما سيستخدم الذكاء الاصطناعي لدينا البيانات من ملف CSV المحدد أثناء إنشاء الفيديو بالجملة. هذا يُمكّنك من إنشاء حملات تسويقية مُخصصة لعملائك بسهولة. يمكنك تحديد الحقول من ملف CSV التي سيتم استخدامها في الفيديو، من خلال إضافة حقل optional_params_for_scripts في ملف التحميل. استخدم أمر curl التالي لطلب قالب مُنشأ بواسطة الذكاء الاصطناعي:

Requestالرد

curl --request POST  \
     --url 'https://api.immersive-fox.com/v1/template/generate_bulk_template_with_ai/'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'  \
     --data { \
         "avatar_gender": "female", # male / female \
         "template_name": "Project_01", \
         "target_audience" : "Subscribers of Spotify", \
         "description" : "Tell our users that their subscription is going to finish soon", \
         "main_language" : "English", \
         "goal" : "Renew Subscription", \
         "allow_third_party_ml_models": true, \
         "length": "long", # short / medium / long \
         "optional_params_for_scripts": ["person_name", "subscription_type", "subscription_charges"] \
     }

{
    "id": 1142,
    "project_name": "Project_01",
    "user": 31,
}

قالب القائمة: لإدراج جميع القوالب التي أنشأها المستخدم، استخدم طلب واجهة برمجة التطبيقات التالي. يُرجع هذا الطلب تفاصيل جميع القوالب، مما يسمح لك بمراجعتها وإدارتها. بعد الحصول على القوالب، يمكنك استخدام المعرف 'id' من أيٍّ منها كـ 'template_id' في إنشاء طلبات مجمعة لإنشاء طلب مجمع باستخدام هذا القالب.

طلبالرد

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/template/bulk_templates'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'

[
    {
        "id": 1112,
        "project_name": "My old template",
        "csv_id": 41,
        "user": 31
    },
    {
        "id": 1142,
        "project_name": "My new template",
        "csv_id": 45,
        "user": 31
    }
]

الحصول على تفاصيل القالب: للحصول على تفاصيل قالب معين، استخدم طلب واجهة برمجة التطبيقات التالي. يوفر هذا الطلب معلومات حول القالب المحدد، مما يسمح لك بعرض الإعدادات قبل إنشاء الطلب المجمع. بعد الحصول على تفاصيل القالب، يمكنك استخدام 'id' كـ 'template_id' في إنشاء طلبات مجمعة لإنشاء طلب مجمع باستخدام هذا القالب.

طلبالرد

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/template/bulk_template/<template_id>'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'

{
    "csv_id": 47,
    "template_name": "My new template",
    "configurations": [ {
    "audio_text": "Hi, My name is {{First Name}}",
    "avatar": 223,
    "avatar_size": 75,
    "background_color": "#ffffff",
    "background_music_is_personalized": "system",
    "background_music_volume": 0.1,
    "frame_height": 1080,
    "frame_width": 1920,
    "is_personalized_audio": false,
    "scene_number": 1,
    "scene_transition": "none",
    "audio_id": 2,
    "audio_service": "google_audio",
    "user_voice_speed": 1,
    "x_position": 0.604931,
    "y_position": 0.431010,
}