v0.4.0

OpenAPI 3.1.0

שליחת משימת יצירת וידאו

Felo API Support

MIT

שרת

https://openapi.felo.ai

ספריות לקוח

Shell Curl

שליחת משימת יצירת וידאו

יוצר משימת יצירת וידאו אסינכרונית ומחזיר task_id באופן מיידי (HTTP 202). בדקו שוב ב-GET /api/v1/videos/generations/{task_id} עד שהמשימה תצליח. אפשר לספק את גוף הבקשה בשטוח ({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. ערבוב של פריים ראשון/אחרון עם קלט ייחוס מולטימודלי כלשהו מחזיר 400 invalid_request_error.

כותרות

X-Request-Id
סוג: string

מזהה בקשה אופציונלי של הקורא שמוחזר בתגובה לצורכי אבחון.
X-Felo-Channel
סוג: string

קודי ערוץ ציבורי מופרדים בפסיקים ובסדר מוגדר. השמיטו את הכותרת כדי להשתמש ב-default; אסור להשתמש ב-default יחד עם ערכים אחרים. במצב ארנק, default סורק את סדר הערוצים הציבוריים האפקטיבי של המודל מהסוף להתחלה, מדלג על ערוצים לא מפורסמים או לא זמינים, ובוחר את הספק של הערוץ הזמין הראשון. הוא כולל נקודות קצה זמינות מאותו ספק עם אותו מזהה מודל חיצוני ואותה דרגת שירות. ערוצים מפורשים מאומתים לפי הסדר שהלקוח ציין; רק קבוצת הספק של הערוץ הראשון נשלחת. אין נפילה אוטומטית לספקים אחרים. כותרות ספק מדור קודם אינן יכולות לעקוף את ניתוב הערוצים.

גוף·VideoGenerationRequest

חובה

application/json

קלט ליצירת וידאו. שטוח ({model, prompt, ...}) או מקונן ({model, input: {...}}). input גובר. יש להשתמש במצב קלט אחד בדיוק; ערבוב של פריים ראשון/אחרון עם קלט ייחוס מולטימודלי נדחה.

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

אובייקט קלט מקונן אופציונלי; כשהוא קיים, השדות שלו גוברים על שדות אחים.
- 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
  
  הנחיה. חובה במצבי text-to-video ו-omni-reference.
- reference_audio_urls
  סוג: array string[] …3פורמט: uri
  
  מקטעי שמע לייחוס omni-reference.
- reference_image_urls
  סוג: array string[] …9פורמט: uri
  
  תמונות ייחוס omni-reference. בלעדיות עם מצב פריים ראשון/אחרון.
- reference_video_urls
  סוג: array string[] …3פורמט: uri
  
  סרטוני ייחוס omni-reference. בלעדיים עם מצב פריים ראשון/אחרון. אספקת וידאו משנה את מחיר יחידת החיוב ומוסיפה את משך הקלט לספירת הטוקנים.
- resolution
  סוג: string enum
  
  רזולוציית הפלט. רזולוציה גבוהה יותר צורכת יותר טוקנים ועולה יותר.
  
  ערכים
  480p
  720p
  1080p
  4k
- service_tier
  סוג: string | null
  
  נכון לעכשיו נתמך רק default (סטנדרטי). ערך שהושמט, null, כינויים ומחרוזות לא נתמכות נופלים חזרה ל-default; סוגים אחרים מחזירים HTTP 400. הערוצים והמחירים המוגדרים נשארים ללא שינוי. ממשקי טקסט שולחים את הערך הסטנדרטי של הספק; ממשקי Decisions ויצירה משמיטים את השדה מהבקשה לספק.
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 (סטנדרטי). ערך שהושמט, null, כינויים ומחרוזות לא נתמכות נופלים חזרה ל-default; סוגים אחרים מחזירים HTTP 400. הערוצים והמחירים המוגדרים נשארים ללא שינוי. ממשקי טקסט שולחים את הערך הסטנדרטי של הספק; ממשקי Decisions ויצירה משמיטים את השדה מהבקשה לספק.

תגובות

202
סוג: object · VideoGenerationAccepted

המשימה התקבלה
kind
enum
const:
video
חובה
ערכים
video
outputs
סוג: array string[]
חובה

ריק עד שהמשימה תצליח.

status
enum
const:
queued
חובה
ערכים
queued
task_id
סוג: string
חובה

מזהה המשימה לשימוש בבדיקה החוזרת.
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

מפתח API של Felo לא חוקי או חסר

מעטפת שגיאה תואמת 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

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"
  ]
}

המשימה התקבלה

שליחת משימת יצירת וידאו

אימותRequired

שליחת משימת יצירת וידאו