Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

ویڈیو جنریشن ٹاسک جمع کریں

سرور:https://openapi.felo.ai
کلائنٹ لائبریریاں

ویڈیو جنریشن ٹاسک جمع کریں

​

ایک async ویڈیو جنریشن ٹاسک بناتا ہے اور فوراً task_id واپس کرتا ہے (HTTP 202)۔ کامیاب ہونے تک GET /api/v1/videos/generations/{task_id} کو پول کریں۔ درخواست کا body یا تو فلیٹ شکل ({model, prompt, ...}) میں یا نیسٹڈ شکل ({model, input: {prompt, ...}}) میں دیا جا سکتا ہے؛ موجود ہونے پر input آبجیکٹ کو ترجیح ملتی ہے۔ callback فیلڈز (callBackUrl / callback_url / callbackUrl) نظر انداز کر دیے جاتے ہیں۔

تین باہمی طور پر الگ الگ ان پٹ موڈز:

  • text-to-video: صرف prompt؛
  • image-to-video (پہلا/آخری فریم): first_frame_url (+ اختیاری last_frame_url)؛
  • omni-reference: reference_image_urls / reference_video_urls / reference_audio_urls۔ first/last-frame کو کسی بھی ملٹی موڈل ریفرنس ان پٹ کے ساتھ ملانے پر 400 invalid_request_error واپس ہوتا ہے۔
ہیڈرز
  • X-Request-Id
    قسم: string

    اختیاری کالر درخواست ID جو تشخیص کے لیے واپس بھیجی جاتی ہے۔

  • X-Felo-Channel
    قسم: string

    ترتیب شدہ، کوما سے الگ کیے گئے پبلک چینل کوڈز۔ default استعمال کرنے کے لیے یہ ہیڈر چھوڑ دیں؛ default کو تنہا ہی استعمال کرنا ہوگا۔ wallet موڈ میں default ماڈل کے مؤثر پبلک چینل کی ترتیب کو الٹی سمت میں اسکین کرتا ہے، غیر شائع شدہ یا غیر دستیاب چینلز کو نظر انداز کرتا ہے، اور پہلے دستیاب چینل کے پرووائیڈر کا انتخاب کرتا ہے۔ اس میں اسی اپ اسٹریم ماڈل ID اور سروس ٹیئر والے اس پرووائیڈر کے دستیاب endpoints شامل کیے جاتے ہیں۔ واضح چینلز کی توثیق کلائنٹ کی بتائی ہوئی ترتیب میں ہوتی ہے؛ صرف پہلے چینل کا پرووائیڈر گروپ جمع کیا جاتا ہے۔ دیگر پرووائیڈرز کی طرف کوئی خودکار fallback نہیں ہے۔ پرانے پرووائیڈر ہیڈرز چینل روٹنگ کو اوور رائیڈ نہیں کر سکتے۔

باڈی·VideoGenerationRequest
لازمی
application/json

ویڈیو جنریشن کا ان پٹ۔ یا فلیٹ شکل ({model, prompt, ...}) میں یا نیسٹڈ شکل ({model, input: {...}}) میں۔ input کو ترجیح ملتی ہے۔ صرف ایک ان پٹ موڈ استعمال کرنا ضروری ہے؛ first/last-frame کو ملٹی موڈل ریفرنس ان پٹس کے ساتھ ملانا مسترد کر دیا جاتا ہے۔

  • model
    قسم: string
    لازمی

    Felo کے سامنے ظاہر ہونے والا ماڈل نام، مثلاً seedance-2.0-mini۔

  • aspect_ratio
    قسم: string enum
    اقدار
    • 16:9
    • 9:16
    • 1:1
    • 4:3
    • 3:4
    • 21:9
    • adaptive
  • duration
    قسم: integer
    کم از کم:  
    4
    زیادہ سے زیادہ:  
    15

    Integer numbers.

  • first_frame_url
    قسم: string فارمیٹ: uri
  • generate_audio
    قسم: boolean
  • input
    قسم: object

    اختیاری نیسٹڈ input آبجیکٹ؛ موجود ہونے پر اس کے فیلڈز ہم سطح کے فیلڈز پر ترجیح پاتے ہیں۔

    • aspect_ratio
      قسم: string enum

      آؤٹ پٹ کا پہلو تناسب؛ adaptive ان پٹ امیج کے تناسب کی پیروی کرتا ہے۔

      اقدار
      • 16:9
      • 9:16
      • 1:1
      • 4:3
      • 3:4
      • 21:9
      • adaptive
    • duration
      قسم: integer
      کم از کم:  
      4
      زیادہ سے زیادہ:  
      15

      آؤٹ پٹ دورانیہ سیکنڈز میں۔

    • first_frame_url
      قسم: string فارمیٹ: uri

      پہلے فریم کی امیج URL (image-to-video موڈ)۔

    • generate_audio
      قسم: boolean

      ہم آہنگ آڈیو ٹریک بنانا ہے یا نہیں۔

    • last_frame_url
      قسم: string فارمیٹ: uri

      آخری فریم کی امیج URL؛ first_frame_url کے ساتھ مل کر استعمال ہونا چاہیے۔

    • prompt
      قسم: string
      زیادہ سے زیادہ لمبائی:  
      2000

      Prompt۔ text-to-video اور omni-reference موڈز کے لیے لازمی ہے۔

    • reference_audio_urls
      قسم: array string[] …3فارمیٹ: uri

      omni-reference آڈیو کلپس۔

    • reference_image_urls
      قسم: array string[] …9فارمیٹ: uri

      omni-reference امیجز۔ first/last-frame کے ساتھ بیک وقت استعمال نہیں ہو سکتیں۔

    • reference_video_urls
      قسم: array string[] …3فارمیٹ: uri

      omni-reference ویڈیوز۔ first/last-frame کے ساتھ بیک وقت استعمال نہیں ہو سکتیں۔ ویڈیو فراہم کرنے سے بلنگ یونٹ قیمت بدل جاتی ہے اور ان پٹ دورانیہ ٹوکن شمار میں شامل ہو جاتا ہے۔

    • resolution
      قسم: string enum

      آؤٹ پٹ ریزولوشن۔ زیادہ ریزولوشن زیادہ ٹوکن استعمال کرتا ہے اور زیادہ مہنگا ہوتا ہے۔

      اقدار
      • 480p
      • 720p
      • 1080p
      • 4k
    • service_tier
      قسم: string | null

      فی الحال صرف default (standard) معاون ہے۔ چھوڑا گیا، null، عرفی نام اور غیر معاون اسٹرنگز default پر fallback کرتے ہیں؛ دیگر اقسام HTTP 400 واپس کرتی ہیں۔ ترتیب شدہ چینلز اور قیمتیں تبدیل نہیں ہوتیں۔ Text APIs پرووائیڈر کی standard قدر بھیجتے ہیں؛ Decisions اور generation APIs اپ اسٹریم فیلڈ شامل نہیں کرتے۔

  • last_frame_url
    قسم: string فارمیٹ: uri
  • prompt
    قسم: string
    زیادہ سے زیادہ لمبائی:  
    2000
  • reference_audio_urls
    قسم: array string[] …3فارمیٹ: uri
  • reference_image_urls
    قسم: array string[] …9فارمیٹ: uri
  • reference_video_urls
    قسم: array string[] …3فارمیٹ: uri
  • resolution
    قسم: string enum
    اقدار
    • 480p
    • 720p
    • 1080p
    • 4k
  • service_tier
    قسم: string | null

    فی الحال صرف default (standard) معاون ہے۔ چھوڑا گیا، null، عرفی نام اور غیر معاون اسٹرنگز default پر fallback کرتے ہیں؛ دیگر اقسام HTTP 400 واپس کرتی ہیں۔ ترتیب شدہ چینلز اور قیمتیں تبدیل نہیں ہوتیں۔ Text APIs پرووائیڈر کی standard قدر بھیجتے ہیں؛ Decisions اور generation APIs اپ اسٹریم فیلڈ شامل نہیں کرتے۔

جوابات
  • 202
    قسم: object · VideoGenerationAccepted

    ٹاسک قبول ہو گیا

    • kind
      enum
      const:  
      video
      لازمی
      اقدار
      • video
    • outputs
      قسم: array string[]
      لازمی

      ٹاسک کامیاب ہونے تک خالی۔

    • status
      enum
      const:  
      queued
      لازمی
      اقدار
      • queued
    • task_id
      قسم: string
      لازمی

      پولنگ کے لیے استعمال ہونے والی ٹاسک ID۔

    application/json
  • 400
    قسم: object · GenerationError

    غلط درخواست (نامعلوم ماڈل، ملے جلے ان پٹ موڈز، غلط فیلڈز)

    OpenAI سے مطابقت رکھنے والا خرابی کا لفافہ۔

    • error
      قسم: object
      • message
        قسم: string
        لازمی
      • type
        قسم: string enum
        لازمی
        اقدار
        • invalid_request_error
        • server_error
      • code
        قسم: string
      • param
        قسم: string null کی اجازت
    application/json
  • 401
    قسم: object · GenerationError

    غلط یا غیر موجود Felo API کلید

    OpenAI سے مطابقت رکھنے والا خرابی کا لفافہ۔

    • error
      قسم: object
      • message
        قسم: string
        لازمی
      • type
        قسم: string enum
        لازمی
        اقدار
        • invalid_request_error
        • server_error
      • code
        قسم: string
      • param
        قسم: string null کی اجازت
    application/json
  • 402
    قسم: object · GenerationError

    ناکافی بیلنس / بلنگ کی شرط پوری نہیں ہوئی

    OpenAI سے مطابقت رکھنے والا خرابی کا لفافہ۔

    • error
      قسم: object
      • message
        قسم: string
        لازمی
      • type
        قسم: string enum
        لازمی
        اقدار
        • invalid_request_error
        • server_error
      • code
        قسم: string
      • param
        قسم: string null کی اجازت
    application/json
  • 403
    قسم: object · GenerationError

    اکاؤنٹ کو اجازت نہیں (سبسکرپشن درکار ہے یا صارف بین ہے)۔ غیر فعال ماڈلز بھی اپ اسٹریم کالز سے پہلے مسترد کر دیے جاتے ہیں۔ پہلے سے قبول شدہ درخواستیں اور ٹاسکس جاری رہتے ہیں۔

    OpenAI سے مطابقت رکھنے والا خرابی کا لفافہ۔

    • error
      قسم: object
      • message
        قسم: string
        لازمی
      • type
        قسم: string enum
        لازمی
        اقدار
        • invalid_request_error
        • server_error
      • code
        قسم: string
      • param
        قسم: string null کی اجازت
    application/json
  • 429
    قسم: object · GenerationError

    درخواست یا اخراجات کی حد پوری ہو گئی

    OpenAI سے مطابقت رکھنے والا خرابی کا لفافہ۔

    • error
      قسم: object
      • message
        قسم: string
        لازمی
      • type
        قسم: string enum
        لازمی
        اقدار
        • invalid_request_error
        • server_error
      • code
        قسم: string
      • param
        قسم: string null کی اجازت
    application/json
  • 502
    قسم: object · GenerationError

    اپ اسٹریم پرووائیڈر ناکام رہا

    OpenAI سے مطابقت رکھنے والا خرابی کا لفافہ۔

    • error
      قسم: object
      • message
        قسم: string
        لازمی
      • type
        قسم: string enum
        لازمی
        اقدار
        • invalid_request_error
        • server_error
      • code
        قسم: string
      • param
        قسم: string null کی اجازت
    application/json
  • 503
    قسم: object · GenerationError

    جنریشن سروس یا بلنگ سروس عارضی طور پر دستیاب نہیں

    OpenAI سے مطابقت رکھنے والا خرابی کا لفافہ۔

    • error
      قسم: object
      • message
        قسم: string
        لازمی
      • type
        قسم: string enum
        لازمی
        اقدار
        • invalid_request_error
        • server_error
      • code
        قسم: string
      • param
        قسم: string null کی اجازت
    application/json
Request Example for post/api/v1/videos/generations
curl https://openapi.felo.ai/api/v1/videos/generations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "seedance-2.0-mini",
  "prompt": "a cinematic trailer shot, 720p",
  "resolution": "720p",
  "duration": 5,
  "generate_audio": true
}'
{
  "task_id": "string",
  "status": "queued",
  "kind": "video",
  "outputs": [
    "string"
  ]
}
Submit a video generation task