Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

שליחת משימת יצירת תמונה

Felo API Support
MIT
שרת:https://openapi.felo.ai
ספריות לקוח
Shell Curl

שליחת משימת יצירת תמונה

​

מחזיר HTTP 202 עם task_id מתמשך. בדקו שוב ב-GET /api/v1/images/generations/{task_id}. נתמך קלט שטוח או מקונן; קלט מקונן גובר. שדות callback מתעלמים מהם. היכולות ופרמטרי הקלט תלויים במודל ובערוץ המוגדרים.

כותרות
  • X-Request-Id
    סוג: string

    מזהה בקשה אופציונלי של הקורא שמוחזר בתגובה לצורכי אבחון.

  • X-Felo-Channel
    סוג: string

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

גוף·ImageGenerationRequest
חובה
application/json

קלט תלוי-מודל עוקב אחר פרוטוקול המודל הציבורי המוגדר.

  • model
    סוג: string
    חובה
  • image_urls
    סוג: array string[]
  • input
    סוג: object

    קלט מקונן אופציונלי; גובר על קלט שטוח.

    • service_tier
      סוג: string | null

      נכון לעכשיו נתמך רק default (סטנדרטי). ערך שהושמט, null, כינויים ומחרוזות לא נתמכות נופלים חזרה ל-default; סוגים אחרים מחזירים HTTP 400. הערוצים והמחירים המוגדרים נשארים ללא שינוי. ממשקי טקסט שולחים את הערך הסטנדרטי של הספק; ממשקי Decisions ויצירה משמיטים את השדה מהבקשה לספק.

    • propertyName
      סוג: anything
  • n
    סוג: integer

    Integer numbers.

  • prompt
    סוג: string
  • service_tier
    סוג: string | null

    נכון לעכשיו נתמך רק default (סטנדרטי). ערך שהושמט, null, כינויים ומחרוזות לא נתמכות נופלים חזרה ל-default; סוגים אחרים מחזירים HTTP 400. הערוצים והמחירים המוגדרים נשארים ללא שינוי. ממשקי טקסט שולחים את הערך הסטנדרטי של הספק; ממשקי Decisions ויצירה משמיטים את השדה מהבקשה לספק.

  • size
    סוג: string
  • propertyName
    סוג: anything
תגובות
  • 202
    סוג: object · ImageGenerationAccepted

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

    • kind
      enum
      const:  
      image
      חובה
      ערכים
      • image
    • 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
Request Example for post/api/v1/images/generations
curl https://openapi.felo.ai/api/v1/images/generations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "configured-image-model",
  "prompt": "a cat"
}'

{
  "task_id": "string",
  "status": "queued",
  "kind": "image",
  "outputs": [
    "string"
  ]
}

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

Submit an image generation task